Generated advice about this change, used for providing more
information about how a change will affect the existing service.
Authentication defines the authentication configuration for API methods
provided by an API service.
Authentication rules for the service.
Backend defines the backend configuration for a service.
A backend rule provides configuration for an individual API element.
Billing related configuration of the service.
Details about how and where to publish client libraries.
Required information for every language.
Output generated from semantically comparing two versions of a service
configuration.
Context defines which contexts an API requests.
A context rule provides information about the context for an individual API
element.
Selects and configures the service controller used by the service.
Settings for C++ client libraries.
A custom pattern is used for defining custom HTTP verb.
Distribution contains summary statistics for a population of values. It
optionally contains a histogram representing the distribution of those values
across a set of buckets.
Documentation provides the information for describing a service.
A documentation rule provides information about individual API elements.
Settings for Dotnet client libraries.
Endpoint describes a network address of a service that serves a set of
APIs. It is commonly known as a service endpoint. A service may expose
any number of service endpoints, and all service endpoints share the same
service definition, such as quota limits and monitoring metrics.
Rich semantic information of an API field beyond basic typing.
Google API Policy Annotation
Settings for Go client libraries.
Defines the HTTP configuration for an API service. It contains a list of
[HttpRule][google.api.HttpRule], each specifying the mapping of an RPC method
to one or more HTTP REST API methods.
Message that represents an arbitrary HTTP body. It should only be used for
payload formats that can’t be represented as JSON, such as raw binary or
an HTML page.
gRPC Transcoding
Settings for Java client libraries.
Specifies a location to extract JWT from an API request.
A description of a label.
A description of a log type. Example in YAML format:
Logging configuration of the service.
Defines policies applying to an RPC method.
Describes the generator configuration for a method.
A specific metric, identified by specifying values for all of the
labels of a [MetricDescriptor][google.api.MetricDescriptor].
Defines a metric type and its schema. Once a metric descriptor is created,
deleting or altering it stops data collection and makes the metric type’s
existing data unusable.
Bind API methods to metrics. Binding a method to a metric causes that
metric’s configured quota behaviors to apply to the method call.
An object representing a resource that can be used for monitoring, logging,
billing, or other purposes. Examples include virtual machine instances,
databases, and storage devices such as disks. The type field identifies a
[MonitoredResourceDescriptor][google.api.MonitoredResourceDescriptor] object
that describes the resource’s schema. Information in the labels field
identifies the actual resource and its attributes according to the schema.
For example, a particular Compute Engine VM instance could be represented by
the following object, because the
[MonitoredResourceDescriptor][google.api.MonitoredResourceDescriptor] for
"gce_instance" has labels
"project_id", "instance_id" and "zone":
An object that describes the schema of a
[MonitoredResource][google.api.MonitoredResource] object using a type name
and a set of labels. For example, the monitored resource descriptor for
Google Compute Engine VM instances has a type of
"gce_instance" and specifies the use of the labels "instance_id" and
"zone" to identify particular VM instances.
Auxiliary metadata for a [MonitoredResource][google.api.MonitoredResource]
object. [MonitoredResource][google.api.MonitoredResource] objects contain the
minimum set of information to uniquely identify a monitored resource
instance. There is some other useful auxiliary metadata. Monitoring and
Logging use an ingestion pipeline to extract metadata for cloud resources of
all types, and store the metadata in this message.
Monitoring configuration of the service.
Settings for Node client libraries.
OAuth scopes are a way to define data and permissions on data. For example,
there are scopes defined for “Read-only access to Google Calendar” and
“Access to Cloud Platform”. Users can consent to a scope for an application,
giving it permission to access that data on their behalf.
Represents a documentation page. A page can contain subpages to represent
nested documentation set structure.
Settings for Php client libraries.
A descriptor for defining project properties for a service. One service may
have many consumer projects, and the service may want to behave differently
depending on some properties on the project. For example, a project may be
associated with a school, or a business, or a government agency, a business
type property on the project may affect how a service responds to the client.
This descriptor defines which properties are allowed to be set on a project.
Defines project properties.
Settings for Python client libraries.
Quota configuration helps to achieve fairness and budgeting in service
usage.
QuotaLimit defines a specific limit that applies over a specified duration
for a limit type. There can be at most one limit for a duration and limit
type combination defined within a QuotaGroup.
A simple descriptor of a resource type.
Defines a proto annotation that describes a string field that refers to
an API resource.
A projection from an input message to the GRPC or REST header.
Specifies the routing information that should be sent along with the request
in the form of routing header.
NOTE: All service configuration rules follow the “last one wins” order.
Settings for Ruby client libraries.
This message is used to configure the generation of a subset of the RPCs in
a service for client libraries.
Service is the root object of Google API service configuration (service
config). It describes the basic information about a logical service,
such as the service name and the user-facing title, and delegates other
aspects to sub-sections. Each sub-section is either a proto message or a
repeated proto message that configures a specific aspect, such as auth.
For more information, see each proto message definition.
Source information used to create a Service Config
Define a parameter’s name and location. The parameter may be passed as either
an HTTP header or a URL query parameter, and if both are passed the behavior
is implementation-dependent.
Define a system parameter rule mapping system parameter definitions to
methods.
System parameter configuration
A reference to a message type, for use in [FieldInfo][google.api.FieldInfo].
Configuration controlling usage of a service.
Usage configuration rules for the service.
Visibility restricts service consumer’s access to service elements,
such as whether an application can call a visibility-restricted method.
The restriction is expressed by applying visibility labels on service
elements. The visibility labels are elsewhere linked to service consumers.
A visibility rule provides visibility configuration for an individual API
element.