Google.Api.CommonProtos
Holder for reflection information generated from google/api/annotations.proto
File descriptor for google/api/annotations.proto
Holder for extension identifiers generated from the top level of google/api/annotations.proto
See `HttpRule`.
Holder for reflection information generated from google/api/auth.proto
File descriptor for google/api/auth.proto
`Authentication` defines the authentication configuration for API methods
provided by an API service.
Example:
name: calendar.googleapis.com
authentication:
providers:
- id: google_calendar_auth
jwks_uri: https://www.googleapis.com/oauth2/v1/certs
issuer: https://securetoken.google.com
rules:
- selector: "*"
requirements:
provider_id: google_calendar_auth
- selector: google.calendar.Delegate
oauth:
canonical_scopes: https://www.googleapis.com/auth/calendar.read
Field number for the "rules" field.
A list of authentication rules that apply to individual API methods.
**NOTE:** All service configuration rules follow "last one wins" order.
Field number for the "providers" field.
Defines a set of authentication providers that a service supports.
Authentication rules for the service.
By default, if a method has any authentication requirements, every request
must include a valid credential matching one of the requirements.
It's an error to include more than one kind of credential in a single
request.
If a method doesn't have any auth requirements, request credentials will be
ignored.
Field number for the "selector" field.
Selects the methods to which this rule applies.
Refer to [selector][google.api.DocumentationRule.selector] for syntax
details.
Field number for the "oauth" field.
The requirements for OAuth credentials.
Field number for the "allow_without_credential" field.
If true, the service accepts API keys without any other credential.
This flag only applies to HTTP and gRPC requests.
Field number for the "requirements" field.
Requirements for additional authentication providers.
Specifies a location to extract JWT from an API request.
Field number for the "header" field.
Specifies HTTP header name to extract JWT token.
Gets whether the "header" field is set
Clears the value of the oneof if it's currently set to "header"
Field number for the "query" field.
Specifies URL query parameter name to extract JWT token.
Gets whether the "query" field is set
Clears the value of the oneof if it's currently set to "query"
Field number for the "cookie" field.
Specifies cookie name to extract JWT token.
Gets whether the "cookie" field is set
Clears the value of the oneof if it's currently set to "cookie"
Field number for the "value_prefix" field.
The value prefix. The value format is "value_prefix{token}"
Only applies to "in" header type. Must be empty for "in" query type.
If not empty, the header value has to match (case sensitive) this prefix.
If not matched, JWT will not be extracted. If matched, JWT will be
extracted after the prefix is removed.
For example, for "Authorization: Bearer {JWT}",
value_prefix="Bearer " with a space at the end.
Enum of possible cases for the "in" oneof.
Configuration for an authentication provider, including support for
[JSON Web Token
(JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).
Field number for the "id" field.
The unique identifier of the auth provider. It will be referred to by
`AuthRequirement.provider_id`.
Example: "bookstore_auth".
Field number for the "issuer" field.
Identifies the principal that issued the JWT. See
https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1
Usually a URL or an email address.
Example: https://securetoken.google.com
Example: 1234567-compute@developer.gserviceaccount.com
Field number for the "jwks_uri" field.
URL of the provider's public key set to validate signature of the JWT. See
[OpenID
Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata).
Optional if the key set document:
- can be retrieved from
[OpenID
Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html)
of the issuer.
- can be inferred from the email domain of the issuer (e.g. a Google
service account).
Example: https://www.googleapis.com/oauth2/v1/certs
Field number for the "audiences" field.
The list of JWT
[audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).
that are allowed to access. A JWT containing any of these audiences will
be accepted. When this setting is absent, JWTs with audiences:
- "https://[service.name]/[google.protobuf.Api.name]"
- "https://[service.name]/"
will be accepted.
For example, if no audiences are in the setting, LibraryService API will
accept JWTs with the following audiences:
-
https://library-example.googleapis.com/google.example.library.v1.LibraryService
- https://library-example.googleapis.com/
Example:
audiences: bookstore_android.apps.googleusercontent.com,
bookstore_web.apps.googleusercontent.com
Field number for the "authorization_url" field.
Redirect URL if JWT token is required but not present or is expired.
Implement authorizationUrl of securityDefinitions in OpenAPI spec.
Field number for the "jwt_locations" field.
Defines the locations to extract the JWT. For now it is only used by the
Cloud Endpoints to store the OpenAPI extension [x-google-jwt-locations]
(https://cloud.google.com/endpoints/docs/openapi/openapi-extensions#x-google-jwt-locations)
JWT locations can be one of HTTP headers, URL query parameters or
cookies. The rule is that the first match wins.
If not specified, default to use following 3 locations:
1) Authorization: Bearer
2) x-goog-iap-jwt-assertion
3) access_token query parameter
Default locations can be specified as followings:
jwt_locations:
- header: Authorization
value_prefix: "Bearer "
- header: x-goog-iap-jwt-assertion
- query: access_token
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.
OAuth scope specifications should be fairly coarse grained; a user will need
to see and understand the text description of what your scope means.
In most cases: use one or at most two OAuth scopes for an entire family of
products. If your product has multiple APIs, you should probably be sharing
the OAuth scope across all of those APIs.
When you need finer grained OAuth consent screens: talk with your product
management about how developers will use them in practice.
Please note that even though each of the canonical scopes is enough for a
request to be accepted and passed to the backend, a request can still fail
due to the backend requiring additional scopes or permissions.
Field number for the "canonical_scopes" field.
The list of publicly documented OAuth scopes that are allowed access. An
OAuth token containing any of these scopes will be accepted.
Example:
canonical_scopes: https://www.googleapis.com/auth/calendar,
https://www.googleapis.com/auth/calendar.read
User-defined authentication requirements, including support for
[JSON Web Token
(JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).
Field number for the "provider_id" field.
[id][google.api.AuthProvider.id] from authentication provider.
Example:
provider_id: bookstore_auth
Field number for the "audiences" field.
NOTE: This will be deprecated soon, once AuthProvider.audiences is
implemented and accepted in all the runtime components.
The list of JWT
[audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).
that are allowed to access. A JWT containing any of these audiences will
be accepted. When this setting is absent, only JWTs with audience
"https://[Service_name][google.api.Service.name]/[API_name][google.protobuf.Api.name]"
will be accepted. For example, if no audiences are in the setting,
LibraryService API will only accept JWTs with the following audience
"https://library-example.googleapis.com/google.example.library.v1.LibraryService".
Example:
audiences: bookstore_android.apps.googleusercontent.com,
bookstore_web.apps.googleusercontent.com
Holder for reflection information generated from google/api/backend.proto
File descriptor for google/api/backend.proto
`Backend` defines the backend configuration for a service.
Field number for the "rules" field.
A list of API backend rules that apply to individual API methods.
**NOTE:** All service configuration rules follow "last one wins" order.
A backend rule provides configuration for an individual API element.
Field number for the "selector" field.
Selects the methods to which this rule applies.
Refer to [selector][google.api.DocumentationRule.selector] for syntax
details.
Field number for the "address" field.
The address of the API backend.
The scheme is used to determine the backend protocol and security.
The following schemes are accepted:
SCHEME PROTOCOL SECURITY
http:// HTTP None
https:// HTTP TLS
grpc:// gRPC None
grpcs:// gRPC TLS
It is recommended to explicitly include a scheme. Leaving out the scheme
may cause constrasting behaviors across platforms.
If the port is unspecified, the default is:
- 80 for schemes without TLS
- 443 for schemes with TLS
For HTTP backends, use [protocol][google.api.BackendRule.protocol]
to specify the protocol version.
Field number for the "deadline" field.
The number of seconds to wait for a response from a request. The default
varies based on the request protocol and deployment environment.
Field number for the "min_deadline" field.
Deprecated, do not use.
Field number for the "operation_deadline" field.
The number of seconds to wait for the completion of a long running
operation. The default is no deadline.
Field number for the "path_translation" field.
Field number for the "jwt_audience" field.
The JWT audience is used when generating a JWT ID token for the backend.
This ID token will be added in the HTTP "authorization" header, and sent
to the backend.
Gets whether the "jwt_audience" field is set
Clears the value of the oneof if it's currently set to "jwt_audience"
Field number for the "disable_auth" field.
When disable_auth is true, a JWT ID token won't be generated and the
original "Authorization" HTTP header will be preserved. If the header is
used to carry the original token and is expected by the backend, this
field must be set to true to preserve the header.
Gets whether the "disable_auth" field is set
Clears the value of the oneof if it's currently set to "disable_auth"
Field number for the "protocol" field.
The protocol used for sending a request to the backend.
The supported values are "http/1.1" and "h2".
The default value is inferred from the scheme in the
[address][google.api.BackendRule.address] field:
SCHEME PROTOCOL
http:// http/1.1
https:// http/1.1
grpc:// h2
grpcs:// h2
For secure HTTP backends (https://) that support HTTP/2, set this field
to "h2" for improved performance.
Configuring this field to non-default values is only supported for secure
HTTP backends. This field will be ignored for all other backends.
See
https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids
for more details on the supported values.
Field number for the "overrides_by_request_protocol" field.
The map between request protocol and the backend address.
Enum of possible cases for the "authentication" oneof.
Container for nested types declared in the BackendRule message type.
Path Translation specifies how to combine the backend address with the
request path in order to produce the appropriate forwarding URL for the
request.
Path Translation is applicable only to HTTP-based backends. Backends which
do not accept requests over HTTP/HTTPS should leave `path_translation`
unspecified.
Use the backend address as-is, with no modification to the path. If the
URL pattern contains variables, the variable names and values will be
appended to the query string. If a query string parameter and a URL
pattern variable have the same name, this may result in duplicate keys in
the query string.
# Examples
Given the following operation config:
Method path: /api/company/{cid}/user/{uid}
Backend address: https://example.cloudfunctions.net/getUser
Requests to the following request paths will call the backend at the
translated path:
Request path: /api/company/widgetworks/user/johndoe
Translated:
https://example.cloudfunctions.net/getUser?cid=widgetworks&uid=johndoe
Request path: /api/company/widgetworks/user/johndoe?timezone=EST
Translated:
https://example.cloudfunctions.net/getUser?timezone=EST&cid=widgetworks&uid=johndoe
The request path will be appended to the backend address.
# Examples
Given the following operation config:
Method path: /api/company/{cid}/user/{uid}
Backend address: https://example.appspot.com
Requests to the following request paths will call the backend at the
translated path:
Request path: /api/company/widgetworks/user/johndoe
Translated:
https://example.appspot.com/api/company/widgetworks/user/johndoe
Request path: /api/company/widgetworks/user/johndoe?timezone=EST
Translated:
https://example.appspot.com/api/company/widgetworks/user/johndoe?timezone=EST
Holder for reflection information generated from google/api/billing.proto
File descriptor for google/api/billing.proto
Billing related configuration of the service.
The following example shows how to configure monitored resources and metrics
for billing, `consumer_destinations` is the only supported destination and
the monitored resources need at least one label key
`cloud.googleapis.com/location` to indicate the location of the billing
usage, using different monitored resources between monitoring and billing is
recommended so they can be evolved independently:
monitored_resources:
- type: library.googleapis.com/billing_branch
labels:
- key: cloud.googleapis.com/location
description: |
Predefined label to support billing location restriction.
- key: city
description: |
Custom label to define the city where the library branch is located
in.
- key: name
description: Custom label to define the name of the library branch.
metrics:
- name: library.googleapis.com/book/borrowed_count
metric_kind: DELTA
value_type: INT64
unit: "1"
billing:
consumer_destinations:
- monitored_resource: library.googleapis.com/billing_branch
metrics:
- library.googleapis.com/book/borrowed_count
Field number for the "consumer_destinations" field.
Billing configurations for sending metrics to the consumer project.
There can be multiple consumer destinations per service, each one must have
a different monitored resource type. A metric can be used in at most
one consumer destination.
Container for nested types declared in the Billing message type.
Configuration of a specific billing destination (Currently only support
bill against consumer project).
Field number for the "monitored_resource" field.
The monitored resource type. The type must be defined in
[Service.monitored_resources][google.api.Service.monitored_resources]
section.
Field number for the "metrics" field.
Names of the metrics to report to this billing destination.
Each name must be defined in
[Service.metrics][google.api.Service.metrics] section.
Holder for reflection information generated from google/api/client.proto
File descriptor for google/api/client.proto
Holder for extension identifiers generated from the top level of google/api/client.proto
A definition of a client library method signature.
In client libraries, each proto RPC corresponds to one or more methods
which the end user is able to call, and calls the underlying RPC.
Normally, this method receives a single argument (a struct or instance
corresponding to the RPC request object). Defining this field will
add one or more overloads providing flattened or simpler method signatures
in some languages.
The fields on the method signature are provided as a comma-separated
string.
For example, the proto RPC and annotation:
rpc CreateSubscription(CreateSubscriptionRequest)
returns (Subscription) {
option (google.api.method_signature) = "name,topic";
}
Would add the following Java overload (in addition to the method accepting
the request object):
public final Subscription createSubscription(String name, String topic)
The following backwards-compatibility guidelines apply:
* Adding this annotation to an unannotated method is backwards
compatible.
* Adding this annotation to a method which already has existing
method signature annotations is backwards compatible if and only if
the new method signature annotation is last in the sequence.
* Modifying or removing an existing method signature annotation is
a breaking change.
* Re-ordering existing method signature annotations is a breaking
change.
The hostname for this service.
This should be specified with no prefix or protocol.
Example:
service Foo {
option (google.api.default_host) = "foo.googleapi.com";
...
}
OAuth scopes needed for the client.
Example:
service Foo {
option (google.api.oauth_scopes) = \
"https://www.googleapis.com/auth/cloud-platform";
...
}
If there is more than one scope, use a comma-separated string:
Example:
service Foo {
option (google.api.oauth_scopes) = \
"https://www.googleapis.com/auth/cloud-platform,"
"https://www.googleapis.com/auth/monitoring";
...
}
The API version of this service, which should be sent by version-aware
clients to the service. This allows services to abide by the schema and
behavior of the service at the time this API version was deployed.
The format of the API version must be treated as opaque by clients.
Services may use a format with an apparent structure, but clients must
not rely on this to determine components within an API version, or attempt
to construct other valid API versions. Note that this is for upcoming
functionality and may not be implemented for all services.
Example:
service Foo {
option (google.api.api_version) = "v1_20230821_preview";
}
The organization for which the client libraries are being published.
Affects the url where generated docs are published, etc.
Not useful.
Google Cloud Platform Org.
Ads (Advertising) Org.
Photos Org.
Street View Org.
Shopping Org.
Geo Org.
Generative AI - https://developers.generativeai.google
To where should client libraries be published?
Client libraries will neither be generated nor published to package
managers.
Generate the client library in a repo under github.com/googleapis,
but don't publish it to package managers.
Publish the library to package managers like nuget.org and npmjs.com.
Required information for every language.
Field number for the "reference_docs_uri" field.
Link to automatically generated reference documentation. Example:
https://cloud.google.com/nodejs/docs/reference/asset/latest
Field number for the "destinations" field.
The destination where API teams want this client library to be published.
Details about how and where to publish client libraries.
Field number for the "version" field.
Version of the API to apply these settings to. This is the full protobuf
package for the API, ending in the version element.
Examples: "google.cloud.speech.v1" and "google.spanner.admin.database.v1".
Field number for the "launch_stage" field.
Launch stage of this version of the API.
Field number for the "rest_numeric_enums" field.
When using transport=rest, the client request will encode enums as
numbers rather than strings.
Field number for the "java_settings" field.
Settings for legacy Java features, supported in the Service YAML.
Field number for the "cpp_settings" field.
Settings for C++ client libraries.
Field number for the "php_settings" field.
Settings for PHP client libraries.
Field number for the "python_settings" field.
Settings for Python client libraries.
Field number for the "node_settings" field.
Settings for Node client libraries.
Field number for the "dotnet_settings" field.
Settings for .NET client libraries.
Field number for the "ruby_settings" field.
Settings for Ruby client libraries.
Field number for the "go_settings" field.
Settings for Go client libraries.
This message configures the settings for publishing [Google Cloud Client
libraries](https://cloud.google.com/apis/docs/cloud-client-libraries)
generated from the service config.
Field number for the "method_settings" field.
A list of API method settings, e.g. the behavior for methods that use the
long-running operation pattern.
Field number for the "new_issue_uri" field.
Link to a *public* URI where users can report issues. Example:
https://issuetracker.google.com/issues/new?component=190865&template=1161103
Field number for the "documentation_uri" field.
Link to product home page. Example:
https://cloud.google.com/asset-inventory/docs/overview
Field number for the "api_short_name" field.
Used as a tracking tag when collecting data about the APIs developer
relations artifacts like docs, packages delivered to package managers,
etc. Example: "speech".
Field number for the "github_label" field.
GitHub label to apply to issues and pull requests opened for this API.
Field number for the "codeowner_github_teams" field.
GitHub teams to be added to CODEOWNERS in the directory in GitHub
containing source code for the client libraries for this API.
Field number for the "doc_tag_prefix" field.
A prefix used in sample code when demarking regions to be included in
documentation.
Field number for the "organization" field.
For whom the client library is being published.
Field number for the "library_settings" field.
Client library settings. If the same version string appears multiple
times in this list, then the last one wins. Settings from earlier
settings with the same version string are discarded.
Field number for the "proto_reference_documentation_uri" field.
Optional link to proto reference documentation. Example:
https://cloud.google.com/pubsub/lite/docs/reference/rpc
Field number for the "rest_reference_documentation_uri" field.
Optional link to REST reference documentation. Example:
https://cloud.google.com/pubsub/lite/docs/reference/rest
Settings for Java client libraries.
Field number for the "library_package" field.
The package name to use in Java. Clobbers the java_package option
set in the protobuf. This should be used **only** by APIs
who have already set the language_settings.java.package_name" field
in gapic.yaml. API teams should use the protobuf java_package option
where possible.
Example of a YAML configuration::
publishing:
java_settings:
library_package: com.google.cloud.pubsub.v1
Field number for the "service_class_names" field.
Configure the Java class name to use instead of the service's for its
corresponding generated GAPIC client. Keys are fully-qualified
service names as they appear in the protobuf (including the full
the language_settings.java.interface_names" field in gapic.yaml. API
teams should otherwise use the service name as it appears in the
protobuf.
Example of a YAML configuration::
publishing:
java_settings:
service_class_names:
- google.pubsub.v1.Publisher: TopicAdmin
- google.pubsub.v1.Subscriber: SubscriptionAdmin
Field number for the "common" field.
Some settings.
Settings for C++ client libraries.
Field number for the "common" field.
Some settings.
Settings for Php client libraries.
Field number for the "common" field.
Some settings.
Settings for Python client libraries.
Field number for the "common" field.
Some settings.
Settings for Node client libraries.
Field number for the "common" field.
Some settings.
Settings for Dotnet client libraries.
Field number for the "common" field.
Some settings.
Field number for the "renamed_services" field.
Map from original service names to renamed versions.
This is used when the default generated types
would cause a naming conflict. (Neither name is
fully-qualified.)
Example: Subscriber to SubscriberServiceApi.
Field number for the "renamed_resources" field.
Map from full resource types to the effective short name
for the resource. This is used when otherwise resource
named from different services would cause naming collisions.
Example entry:
"datalabeling.googleapis.com/Dataset": "DataLabelingDataset"
Field number for the "ignored_resources" field.
List of full resource types to ignore during generation.
This is typically used for API-specific Location resources,
which should be handled by the generator as if they were actually
the common Location resources.
Example entry: "documentai.googleapis.com/Location"
Field number for the "forced_namespace_aliases" field.
Namespaces which must be aliased in snippets due to
a known (but non-generator-predictable) naming collision
Field number for the "handwritten_signatures" field.
Method signatures (in the form "service.method(signature)")
which are provided separately, so shouldn't be generated.
Snippets *calling* these methods are still generated, however.
Settings for Ruby client libraries.
Field number for the "common" field.
Some settings.
Settings for Go client libraries.
Field number for the "common" field.
Some settings.
Describes the generator configuration for a method.
Field number for the "selector" field.
The fully qualified name of the method, for which the options below apply.
This is used to find the method to apply the options.
Field number for the "long_running" field.
Describes settings to use for long-running operations when generating
API methods for RPCs. Complements RPCs that use the annotations in
google/longrunning/operations.proto.
Example of a YAML configuration::
publishing:
method_settings:
- selector: google.cloud.speech.v2.Speech.BatchRecognize
long_running:
initial_poll_delay:
seconds: 60 # 1 minute
poll_delay_multiplier: 1.5
max_poll_delay:
seconds: 360 # 6 minutes
total_poll_timeout:
seconds: 54000 # 90 minutes
Field number for the "auto_populated_fields" field.
List of top-level fields of the request message, that should be
automatically populated by the client libraries based on their
(google.api.field_info).format. Currently supported format: UUID4.
Example of a YAML configuration:
publishing:
method_settings:
- selector: google.example.v1.ExampleService.CreateExample
auto_populated_fields:
- request_id
Container for nested types declared in the MethodSettings message type.
Describes settings to use when generating API methods that use the
long-running operation pattern.
All default values below are from those used in the client library
generators (e.g.
[Java](https://github.com/googleapis/gapic-generator-java/blob/04c2faa191a9b5a10b92392fe8482279c4404803/src/main/java/com/google/api/generator/gapic/composer/common/RetrySettingsComposer.java)).
Field number for the "initial_poll_delay" field.
Initial delay after which the first poll request will be made.
Default value: 5 seconds.
Field number for the "poll_delay_multiplier" field.
Multiplier to gradually increase delay between subsequent polls until it
reaches max_poll_delay.
Default value: 1.5.
Field number for the "max_poll_delay" field.
Maximum time between two subsequent poll requests.
Default value: 45 seconds.
Field number for the "total_poll_timeout" field.
Total polling timeout.
Default value: 5 minutes.
Holder for reflection information generated from google/api/config_change.proto
File descriptor for google/api/config_change.proto
Classifies set of possible modifications to an object in the service
configuration.
No value was provided.
The changed object exists in the 'new' service configuration, but not
in the 'old' service configuration.
The changed object exists in the 'old' service configuration, but not
in the 'new' service configuration.
The changed object exists in both service configurations, but its value
is different.
Output generated from semantically comparing two versions of a service
configuration.
Includes detailed information about a field that have changed with
applicable advice about potential consequences for the change, such as
backwards-incompatibility.
Field number for the "element" field.
Object hierarchy path to the change, with levels separated by a '.'
character. For repeated fields, an applicable unique identifier field is
used for the index (usually selector, name, or id). For maps, the term
'key' is used. If the field has no unique identifier, the numeric index
is used.
Examples:
- visibility.rules[selector=="google.LibraryService.ListBooks"].restriction
- quota.metric_rules[selector=="google"].metric_costs[key=="reads"].value
- logging.producer_destinations[0]
Field number for the "old_value" field.
Value of the changed object in the old Service configuration,
in JSON format. This field will not be populated if ChangeType == ADDED.
Field number for the "new_value" field.
Value of the changed object in the new Service configuration,
in JSON format. This field will not be populated if ChangeType == REMOVED.
Field number for the "change_type" field.
The type for this change, either ADDED, REMOVED, or MODIFIED.
Field number for the "advices" field.
Collection of advice provided for this change, useful for determining the
possible impact of this change.
Generated advice about this change, used for providing more
information about how a change will affect the existing service.
Field number for the "description" field.
Useful description for why this advice was applied and what actions should
be taken to mitigate any implied risks.
Holder for reflection information generated from google/api/consumer.proto
File descriptor for google/api/consumer.proto
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.
Example:
project_properties:
properties:
- name: NO_WATERMARK
type: BOOL
description: Allows usage of the API without watermarks.
- name: EXTENDED_TILE_CACHE_PERIOD
type: INT64
Field number for the "properties" field.
List of per consumer project-specific properties.
Defines project properties.
API services can define properties that can be assigned to consumer projects
so that backends can perform response customization without having to make
additional calls or maintain additional storage. For example, Maps API
defines properties that controls map tile cache period, or whether to embed a
watermark in a result.
These values can be set via API producer console. Only API providers can
define and set these properties.
Field number for the "name" field.
The name of the property (a.k.a key).
Field number for the "type" field.
The type of this property.
Field number for the "description" field.
The description of the property
Container for nested types declared in the Property message type.
Supported data type of the property values
The type is unspecified, and will result in an error.
The type is `int64`.
The type is `bool`.
The type is `string`.
The type is 'double'.
Holder for reflection information generated from google/api/context.proto
File descriptor for google/api/context.proto
`Context` defines which contexts an API requests.
Example:
context:
rules:
- selector: "*"
requested:
- google.rpc.context.ProjectContext
- google.rpc.context.OriginContext
The above specifies that all methods in the API request
`google.rpc.context.ProjectContext` and
`google.rpc.context.OriginContext`.
Available context types are defined in package
`google.rpc.context`.
This also provides mechanism to allowlist any protobuf message extension that
can be sent in grpc metadata using “x-goog-ext-<extension_id>-bin” and
“x-goog-ext-<extension_id>-jspb” format. For example, list any service
specific protobuf types that can appear in grpc metadata as follows in your
yaml file:
Example:
context:
rules:
- selector: "google.example.library.v1.LibraryService.CreateBook"
allowed_request_extensions:
- google.foo.v1.NewExtension
allowed_response_extensions:
- google.foo.v1.NewExtension
You can also specify extension ID instead of fully qualified extension name
here.
Field number for the "rules" field.
A list of RPC context rules that apply to individual API methods.
**NOTE:** All service configuration rules follow "last one wins" order.
A context rule provides information about the context for an individual API
element.
Field number for the "selector" field.
Selects the methods to which this rule applies.
Refer to [selector][google.api.DocumentationRule.selector] for syntax
details.
Field number for the "requested" field.
A list of full type names of requested contexts.
Field number for the "provided" field.
A list of full type names of provided contexts.
Field number for the "allowed_request_extensions" field.
A list of full type names or extension IDs of extensions allowed in grpc
side channel from client to backend.
Field number for the "allowed_response_extensions" field.
A list of full type names or extension IDs of extensions allowed in grpc
side channel from backend to client.
Holder for reflection information generated from google/api/control.proto
File descriptor for google/api/control.proto
Selects and configures the service controller used by the service.
Example:
control:
environment: servicecontrol.googleapis.com
Field number for the "environment" field.
The service controller environment to use. If empty, no control plane
feature (like quota and billing) will be enabled. The recommended value for
most services is servicecontrol.googleapis.com
Field number for the "method_policies" field.
Defines policies applying to the API methods of the service.
Holder for reflection information generated from google/api/distribution.proto
File descriptor for google/api/distribution.proto
`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.
The summary statistics are the count, mean, sum of the squared deviation from
the mean, the minimum, and the maximum of the set of population of values.
The histogram is based on a sequence of buckets and gives a count of values
that fall into each bucket. The boundaries of the buckets are given either
explicitly or by formulas for buckets of fixed or exponentially increasing
widths.
Although it is not forbidden, it is generally a bad idea to include
non-finite values (infinities or NaNs) in the population of values, as this
will render the `mean` and `sum_of_squared_deviation` fields meaningless.
Field number for the "count" field.
The number of values in the population. Must be non-negative. This value
must equal the sum of the values in `bucket_counts` if a histogram is
provided.
Field number for the "mean" field.
The arithmetic mean of the values in the population. If `count` is zero
then this field must be zero.
Field number for the "sum_of_squared_deviation" field.
The sum of squared deviations from the mean of the values in the
population. For values x_i this is:
Sum[i=1..n]((x_i - mean)^2)
Knuth, "The Art of Computer Programming", Vol. 2, page 232, 3rd edition
describes Welford's method for accumulating this sum in one pass.
If `count` is zero then this field must be zero.
Field number for the "range" field.
If specified, contains the range of the population values. The field
must not be present if the `count` is zero.
Field number for the "bucket_options" field.
Defines the histogram bucket boundaries. If the distribution does not
contain a histogram, then omit this field.
Field number for the "bucket_counts" field.
The number of values in each bucket of the histogram, as described in
`bucket_options`. If the distribution does not have a histogram, then omit
this field. If there is a histogram, then the sum of the values in
`bucket_counts` must equal the value in the `count` field of the
distribution.
If present, `bucket_counts` should contain N values, where N is the number
of buckets specified in `bucket_options`. If you supply fewer than N
values, the remaining values are assumed to be 0.
The order of the values in `bucket_counts` follows the bucket numbering
schemes described for the three bucket types. The first value must be the
count for the underflow bucket (number 0). The next N-2 values are the
counts for the finite buckets (number 1 through N-2). The N'th value in
`bucket_counts` is the count for the overflow bucket (number N-1).
Field number for the "exemplars" field.
Must be in increasing order of `value` field.
Container for nested types declared in the Distribution message type.
The range of the population values.
Field number for the "min" field.
The minimum of the population values.
Field number for the "max" field.
The maximum of the population values.
`BucketOptions` describes the bucket boundaries used to create a histogram
for the distribution. The buckets can be in a linear sequence, an
exponential sequence, or each bucket can be specified explicitly.
`BucketOptions` does not include the number of values in each bucket.
A bucket has an inclusive lower bound and exclusive upper bound for the
values that are counted for that bucket. The upper bound of a bucket must
be strictly greater than the lower bound. The sequence of N buckets for a
distribution consists of an underflow bucket (number 0), zero or more
finite buckets (number 1 through N - 2) and an overflow bucket (number N -
1). The buckets are contiguous: the lower bound of bucket i (i > 0) is the
same as the upper bound of bucket i - 1. The buckets span the whole range
of finite values: lower bound of the underflow bucket is -infinity and the
upper bound of the overflow bucket is +infinity. The finite buckets are
so-called because both bounds are finite.
Field number for the "linear_buckets" field.
The linear bucket.
Field number for the "exponential_buckets" field.
The exponential buckets.
Field number for the "explicit_buckets" field.
The explicit buckets.
Enum of possible cases for the "options" oneof.
Container for nested types declared in the BucketOptions message type.
Specifies a linear sequence of buckets that all have the same width
(except overflow and underflow). Each bucket represents a constant
absolute uncertainty on the specific value in the bucket.
There are `num_finite_buckets + 2` (= N) buckets. Bucket `i` has the
following boundaries:
Upper bound (0 <= i < N-1): offset + (width * i).
Lower bound (1 <= i < N): offset + (width * (i - 1)).
Field number for the "num_finite_buckets" field.
Must be greater than 0.
Field number for the "width" field.
Must be greater than 0.
Field number for the "offset" field.
Lower bound of the first bucket.
Specifies an exponential sequence of buckets that have a width that is
proportional to the value of the lower bound. Each bucket represents a
constant relative uncertainty on a specific value in the bucket.
There are `num_finite_buckets + 2` (= N) buckets. Bucket `i` has the
following boundaries:
Upper bound (0 <= i < N-1): scale * (growth_factor ^ i).
Lower bound (1 <= i < N): scale * (growth_factor ^ (i - 1)).
Field number for the "num_finite_buckets" field.
Must be greater than 0.
Field number for the "growth_factor" field.
Must be greater than 1.
Field number for the "scale" field.
Must be greater than 0.
Specifies a set of buckets with arbitrary widths.
There are `size(bounds) + 1` (= N) buckets. Bucket `i` has the following
boundaries:
Upper bound (0 <= i < N-1): bounds[i]
Lower bound (1 <= i < N); bounds[i - 1]
The `bounds` field must contain at least one element. If `bounds` has
only one element, then there are no finite buckets, and that single
element is the common boundary of the overflow and underflow buckets.
Field number for the "bounds" field.
The values must be monotonically increasing.
Exemplars are example points that may be used to annotate aggregated
distribution values. They are metadata that gives information about a
particular value added to a Distribution bucket, such as a trace ID that
was active when a value was added. They may contain further information,
such as a example values and timestamps, origin, etc.
Field number for the "value" field.
Value of the exemplar point. This value determines to which bucket the
exemplar belongs.
Field number for the "timestamp" field.
The observation (sampling) time of the above value.
Field number for the "attachments" field.
Contextual information about the example value. Examples are:
Trace: type.googleapis.com/google.monitoring.v3.SpanContext
Literal string: type.googleapis.com/google.protobuf.StringValue
Labels dropped during aggregation:
type.googleapis.com/google.monitoring.v3.DroppedLabels
There may be only a single attachment of any given message type in a
single exemplar, and this is enforced by the system.
Holder for reflection information generated from google/api/documentation.proto
File descriptor for google/api/documentation.proto
`Documentation` provides the information for describing a service.
Example:
<pre><code>documentation:
summary: >
The Google Calendar API gives access
to most calendar features.
pages:
- name: Overview
content: (== include google/foo/overview.md ==)
- name: Tutorial
content: (== include google/foo/tutorial.md ==)
subpages:
- name: Java
content: (== include google/foo/tutorial_java.md ==)
rules:
- selector: google.calendar.Calendar.Get
description: >
...
- selector: google.calendar.Calendar.Put
description: >
...
</code></pre>
Documentation is provided in markdown syntax. In addition to
standard markdown features, definition lists, tables and fenced
code blocks are supported. Section headers can be provided and are
interpreted relative to the section nesting of the context where
a documentation fragment is embedded.
Documentation from the IDL is merged with documentation defined
via the config at normalization time, where documentation provided
by config rules overrides IDL provided.
A number of constructs specific to the API platform are supported
in documentation text.
In order to reference a proto element, the following
notation can be used:
<pre><code>[fully.qualified.proto.name][]</code></pre>
To override the display text used for the link, this can be used:
<pre><code>[display text][fully.qualified.proto.name]</code></pre>
Text can be excluded from doc using the following notation:
<pre><code>(-- internal comment --)</code></pre>
A few directives are available in documentation. Note that
directives must appear on a single line to be properly
identified. The `include` directive includes a markdown file from
an external source:
<pre><code>(== include path/to/file ==)</code></pre>
The `resource_for` directive marks a message to be the resource of
a collection in REST view. If it is not specified, tools attempt
to infer the resource from the operations in a collection:
<pre><code>(== resource_for v1.shelves.books ==)</code></pre>
The directive `suppress_warning` does not directly affect documentation
and is documented together with service config validation.
Field number for the "summary" field.
A short description of what the service does. The summary must be plain
text. It becomes the overview of the service displayed in Google Cloud
Console.
NOTE: This field is equivalent to the standard field `description`.
Field number for the "pages" field.
The top level pages for the documentation set.
Field number for the "rules" field.
A list of documentation rules that apply to individual API elements.
**NOTE:** All service configuration rules follow "last one wins" order.
Field number for the "documentation_root_url" field.
The URL to the root of documentation.
Field number for the "service_root_url" field.
Specifies the service root url if the default one (the service name
from the yaml file) is not suitable. This can be seen in any fully
specified service urls as well as sections that show a base that other
urls are relative to.
Field number for the "overview" field.
Declares a single overview page. For example:
<pre><code>documentation:
summary: ...
overview: (== include overview.md ==)
</code></pre>
This is a shortcut for the following declaration (using pages style):
<pre><code>documentation:
summary: ...
pages:
- name: Overview
content: (== include overview.md ==)
</code></pre>
Note: you cannot specify both `overview` field and `pages` field.
A documentation rule provides information about individual API elements.
Field number for the "selector" field.
The selector is a comma-separated list of patterns for any element such as
a method, a field, an enum value. Each pattern is a qualified name of the
element which may end in "*", indicating a wildcard. Wildcards are only
allowed at the end and for a whole component of the qualified name,
i.e. "foo.*" is ok, but not "foo.b*" or "foo.*.bar". A wildcard will match
one or more components. To specify a default for all applicable elements,
the whole pattern "*" is used.
Field number for the "description" field.
Description of the selected proto element (e.g. a message, a method, a
'service' definition, or a field). Defaults to leading & trailing comments
taken from the proto source definition of the proto element.
Field number for the "deprecation_description" field.
Deprecation description of the selected element(s). It can be provided if
an element is marked as `deprecated`.
Represents a documentation page. A page can contain subpages to represent
nested documentation set structure.
Field number for the "name" field.
The name of the page. It will be used as an identity of the page to
generate URI of the page, text of the link to this page in navigation,
etc. The full page name (start from the root page name to this page
concatenated with `.`) can be used as reference to the page in your
documentation. For example:
<pre><code>pages:
- name: Tutorial
content: (== include tutorial.md ==)
subpages:
- name: Java
content: (== include tutorial_java.md ==)
</code></pre>
You can reference `Java` page using Markdown reference link syntax:
`[Java][Tutorial.Java]`.
Field number for the "content" field.
The Markdown content of the page. You can use <code>(== include {path}
==)</code> to include content from a Markdown file. The content can be
used to produce the documentation page such as HTML format page.
Field number for the "subpages" field.
Subpages of this page. The order of subpages specified here will be
honored in the generated docset.
Holder for reflection information generated from google/api/endpoint.proto
File descriptor for google/api/endpoint.proto
`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.
Example:
type: google.api.Service
name: library-example.googleapis.com
endpoints:
# Declares network address `https://library-example.googleapis.com`
# for service `library-example.googleapis.com`. The `https` scheme
# is implicit for all service endpoints. Other schemes may be
# supported in the future.
- name: library-example.googleapis.com
allow_cors: false
- name: content-staging-library-example.googleapis.com
# Allows HTTP OPTIONS calls to be passed to the API frontend, for it
# to decide whether the subsequent cross-origin request is allowed
# to proceed.
allow_cors: true
Field number for the "name" field.
The canonical name of this endpoint.
Field number for the "aliases" field.
Unimplemented. Dot not use.
DEPRECATED: This field is no longer supported. Instead of using aliases,
please specify multiple [google.api.Endpoint][google.api.Endpoint] for each
of the intended aliases.
Additional names that this endpoint will be hosted on.
Field number for the "target" field.
The specification of an Internet routable address of API frontend that will
handle requests to this [API
Endpoint](https://cloud.google.com/apis/design/glossary). It should be
either a valid IPv4 address or a fully-qualified domain name. For example,
"8.8.8.8" or "myservice.appspot.com".
Field number for the "allow_cors" field.
Allowing
[CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka
cross-domain traffic, would allow the backends served from this endpoint to
receive and respond to HTTP OPTIONS requests. The response will be used by
the browser to determine whether the subsequent cross-origin request is
allowed to proceed.
Holder for reflection information generated from google/api/error_reason.proto
File descriptor for google/api/error_reason.proto
Defines the supported values for `google.rpc.ErrorInfo.reason` for the
`googleapis.com` error domain. This error domain is reserved for [Service
Infrastructure](https://cloud.google.com/service-infrastructure/docs/overview).
For each error info of this domain, the metadata key "service" refers to the
logical identifier of an API service, such as "pubsub.googleapis.com". The
"consumer" refers to the entity that consumes an API Service. It typically is
a Google project that owns the client application or the server resource,
such as "projects/123". Other metadata keys are specific to each error
reason. For more information, see the definition of the specific error
reason.
Do not use this default value.
The request is calling a disabled service for a consumer.
Example of an ErrorInfo when the consumer "projects/123" contacting
"pubsub.googleapis.com" service which is disabled:
{ "reason": "SERVICE_DISABLED",
"domain": "googleapis.com",
"metadata": {
"consumer": "projects/123",
"service": "pubsub.googleapis.com"
}
}
This response indicates the "pubsub.googleapis.com" has been disabled in
"projects/123".
The request whose associated billing account is disabled.
Example of an ErrorInfo when the consumer "projects/123" fails to contact
"pubsub.googleapis.com" service because the associated billing account is
disabled:
{ "reason": "BILLING_DISABLED",
"domain": "googleapis.com",
"metadata": {
"consumer": "projects/123",
"service": "pubsub.googleapis.com"
}
}
This response indicates the billing account associated has been disabled.
The request is denied because the provided [API
key](https://cloud.google.com/docs/authentication/api-keys) is invalid. It
may be in a bad format, cannot be found, or has been expired).
Example of an ErrorInfo when the request is contacting
"storage.googleapis.com" service with an invalid API key:
{ "reason": "API_KEY_INVALID",
"domain": "googleapis.com",
"metadata": {
"service": "storage.googleapis.com",
}
}
The request is denied because it violates [API key API
restrictions](https://cloud.google.com/docs/authentication/api-keys#adding_api_restrictions).
Example of an ErrorInfo when the consumer "projects/123" fails to call the
"storage.googleapis.com" service because this service is restricted in the
API key:
{ "reason": "API_KEY_SERVICE_BLOCKED",
"domain": "googleapis.com",
"metadata": {
"consumer": "projects/123",
"service": "storage.googleapis.com"
}
}
The request is denied because it violates [API key HTTP
restrictions](https://cloud.google.com/docs/authentication/api-keys#adding_http_restrictions).
Example of an ErrorInfo when the consumer "projects/123" fails to call
"storage.googleapis.com" service because the http referrer of the request
violates API key HTTP restrictions:
{ "reason": "API_KEY_HTTP_REFERRER_BLOCKED",
"domain": "googleapis.com",
"metadata": {
"consumer": "projects/123",
"service": "storage.googleapis.com",
}
}
The request is denied because it violates [API key IP address
restrictions](https://cloud.google.com/docs/authentication/api-keys#adding_application_restrictions).
Example of an ErrorInfo when the consumer "projects/123" fails to call
"storage.googleapis.com" service because the caller IP of the request
violates API key IP address restrictions:
{ "reason": "API_KEY_IP_ADDRESS_BLOCKED",
"domain": "googleapis.com",
"metadata": {
"consumer": "projects/123",
"service": "storage.googleapis.com",
}
}
The request is denied because it violates [API key Android application
restrictions](https://cloud.google.com/docs/authentication/api-keys#adding_application_restrictions).
Example of an ErrorInfo when the consumer "projects/123" fails to call
"storage.googleapis.com" service because the request from the Android apps
violates the API key Android application restrictions:
{ "reason": "API_KEY_ANDROID_APP_BLOCKED",
"domain": "googleapis.com",
"metadata": {
"consumer": "projects/123",
"service": "storage.googleapis.com"
}
}
The request is denied because it violates [API key iOS application
restrictions](https://cloud.google.com/docs/authentication/api-keys#adding_application_restrictions).
Example of an ErrorInfo when the consumer "projects/123" fails to call
"storage.googleapis.com" service because the request from the iOS apps
violates the API key iOS application restrictions:
{ "reason": "API_KEY_IOS_APP_BLOCKED",
"domain": "googleapis.com",
"metadata": {
"consumer": "projects/123",
"service": "storage.googleapis.com"
}
}
The request is denied because there is not enough rate quota for the
consumer.
Example of an ErrorInfo when the consumer "projects/123" fails to contact
"pubsub.googleapis.com" service because consumer's rate quota usage has
reached the maximum value set for the quota limit
"ReadsPerMinutePerProject" on the quota metric
"pubsub.googleapis.com/read_requests":
{ "reason": "RATE_LIMIT_EXCEEDED",
"domain": "googleapis.com",
"metadata": {
"consumer": "projects/123",
"service": "pubsub.googleapis.com",
"quota_metric": "pubsub.googleapis.com/read_requests",
"quota_limit": "ReadsPerMinutePerProject"
}
}
Example of an ErrorInfo when the consumer "projects/123" checks quota on
the service "dataflow.googleapis.com" and hits the organization quota
limit "DefaultRequestsPerMinutePerOrganization" on the metric
"dataflow.googleapis.com/default_requests".
{ "reason": "RATE_LIMIT_EXCEEDED",
"domain": "googleapis.com",
"metadata": {
"consumer": "projects/123",
"service": "dataflow.googleapis.com",
"quota_metric": "dataflow.googleapis.com/default_requests",
"quota_limit": "DefaultRequestsPerMinutePerOrganization"
}
}
The request is denied because there is not enough resource quota for the
consumer.
Example of an ErrorInfo when the consumer "projects/123" fails to contact
"compute.googleapis.com" service because consumer's resource quota usage
has reached the maximum value set for the quota limit "VMsPerProject"
on the quota metric "compute.googleapis.com/vms":
{ "reason": "RESOURCE_QUOTA_EXCEEDED",
"domain": "googleapis.com",
"metadata": {
"consumer": "projects/123",
"service": "compute.googleapis.com",
"quota_metric": "compute.googleapis.com/vms",
"quota_limit": "VMsPerProject"
}
}
Example of an ErrorInfo when the consumer "projects/123" checks resource
quota on the service "dataflow.googleapis.com" and hits the organization
quota limit "jobs-per-organization" on the metric
"dataflow.googleapis.com/job_count".
{ "reason": "RESOURCE_QUOTA_EXCEEDED",
"domain": "googleapis.com",
"metadata": {
"consumer": "projects/123",
"service": "dataflow.googleapis.com",
"quota_metric": "dataflow.googleapis.com/job_count",
"quota_limit": "jobs-per-organization"
}
}
The request whose associated billing account address is in a tax restricted
location, violates the local tax restrictions when creating resources in
the restricted region.
Example of an ErrorInfo when creating the Cloud Storage Bucket in the
container "projects/123" under a tax restricted region
"locations/asia-northeast3":
{ "reason": "LOCATION_TAX_POLICY_VIOLATED",
"domain": "googleapis.com",
"metadata": {
"consumer": "projects/123",
"service": "storage.googleapis.com",
"location": "locations/asia-northeast3"
}
}
This response indicates creating the Cloud Storage Bucket in
"locations/asia-northeast3" violates the location tax restriction.
The request is denied because the caller does not have required permission
on the user project "projects/123" or the user project is invalid. For more
information, check the [userProject System
Parameters](https://cloud.google.com/apis/docs/system-parameters).
Example of an ErrorInfo when the caller is calling Cloud Storage service
with insufficient permissions on the user project:
{ "reason": "USER_PROJECT_DENIED",
"domain": "googleapis.com",
"metadata": {
"consumer": "projects/123",
"service": "storage.googleapis.com"
}
}
The request is denied because the consumer "projects/123" is suspended due
to Terms of Service(Tos) violations. Check [Project suspension
guidelines](https://cloud.google.com/resource-manager/docs/project-suspension-guidelines)
for more information.
Example of an ErrorInfo when calling Cloud Storage service with the
suspended consumer "projects/123":
{ "reason": "CONSUMER_SUSPENDED",
"domain": "googleapis.com",
"metadata": {
"consumer": "projects/123",
"service": "storage.googleapis.com"
}
}
The request is denied because the associated consumer is invalid. It may be
in a bad format, cannot be found, or have been deleted.
Example of an ErrorInfo when calling Cloud Storage service with the
invalid consumer "projects/123":
{ "reason": "CONSUMER_INVALID",
"domain": "googleapis.com",
"metadata": {
"consumer": "projects/123",
"service": "storage.googleapis.com"
}
}
The request is denied because it violates [VPC Service
Controls](https://cloud.google.com/vpc-service-controls/docs/overview).
The 'uid' field is a random generated identifier that customer can use it
to search the audit log for a request rejected by VPC Service Controls. For
more information, please refer [VPC Service Controls
Troubleshooting](https://cloud.google.com/vpc-service-controls/docs/troubleshooting#unique-id)
Example of an ErrorInfo when the consumer "projects/123" fails to call
Cloud Storage service because the request is prohibited by the VPC Service
Controls.
{ "reason": "SECURITY_POLICY_VIOLATED",
"domain": "googleapis.com",
"metadata": {
"uid": "123456789abcde",
"consumer": "projects/123",
"service": "storage.googleapis.com"
}
}
The request is denied because the provided access token has expired.
Example of an ErrorInfo when the request is calling Cloud Storage service
with an expired access token:
{ "reason": "ACCESS_TOKEN_EXPIRED",
"domain": "googleapis.com",
"metadata": {
"service": "storage.googleapis.com",
"method": "google.storage.v1.Storage.GetObject"
}
}
The request is denied because the provided access token doesn't have at
least one of the acceptable scopes required for the API. Please check
[OAuth 2.0 Scopes for Google
APIs](https://developers.google.com/identity/protocols/oauth2/scopes) for
the list of the OAuth 2.0 scopes that you might need to request to access
the API.
Example of an ErrorInfo when the request is calling Cloud Storage service
with an access token that is missing required scopes:
{ "reason": "ACCESS_TOKEN_SCOPE_INSUFFICIENT",
"domain": "googleapis.com",
"metadata": {
"service": "storage.googleapis.com",
"method": "google.storage.v1.Storage.GetObject"
}
}
The request is denied because the account associated with the provided
access token is in an invalid state, such as disabled or deleted.
For more information, see https://cloud.google.com/docs/authentication.
Warning: For privacy reasons, the server may not be able to disclose the
email address for some accounts. The client MUST NOT depend on the
availability of the `email` attribute.
Example of an ErrorInfo when the request is to the Cloud Storage API with
an access token that is associated with a disabled or deleted [service
account](http://cloud/iam/docs/service-accounts):
{ "reason": "ACCOUNT_STATE_INVALID",
"domain": "googleapis.com",
"metadata": {
"service": "storage.googleapis.com",
"method": "google.storage.v1.Storage.GetObject",
"email": "user@123.iam.gserviceaccount.com"
}
}
The request is denied because the type of the provided access token is not
supported by the API being called.
Example of an ErrorInfo when the request is to the Cloud Storage API with
an unsupported token type.
{ "reason": "ACCESS_TOKEN_TYPE_UNSUPPORTED",
"domain": "googleapis.com",
"metadata": {
"service": "storage.googleapis.com",
"method": "google.storage.v1.Storage.GetObject"
}
}
The request is denied because the request doesn't have any authentication
credentials. For more information regarding the supported authentication
strategies for Google Cloud APIs, see
https://cloud.google.com/docs/authentication.
Example of an ErrorInfo when the request is to the Cloud Storage API
without any authentication credentials.
{ "reason": "CREDENTIALS_MISSING",
"domain": "googleapis.com",
"metadata": {
"service": "storage.googleapis.com",
"method": "google.storage.v1.Storage.GetObject"
}
}
The request is denied because the provided project owning the resource
which acts as the [API
consumer](https://cloud.google.com/apis/design/glossary#api_consumer) is
invalid. It may be in a bad format or empty.
Example of an ErrorInfo when the request is to the Cloud Functions API,
but the offered resource project in the request in a bad format which can't
perform the ListFunctions method.
{ "reason": "RESOURCE_PROJECT_INVALID",
"domain": "googleapis.com",
"metadata": {
"service": "cloudfunctions.googleapis.com",
"method":
"google.cloud.functions.v1.CloudFunctionsService.ListFunctions"
}
}
The request is denied because the provided session cookie is missing,
invalid or failed to decode.
Example of an ErrorInfo when the request is calling Cloud Storage service
with a SID cookie which can't be decoded.
{ "reason": "SESSION_COOKIE_INVALID",
"domain": "googleapis.com",
"metadata": {
"service": "storage.googleapis.com",
"method": "google.storage.v1.Storage.GetObject",
"cookie": "SID"
}
}
The request is denied because the user is from a Google Workspace customer
that blocks their users from accessing a particular service.
Example scenario: https://support.google.com/a/answer/9197205?hl=en
Example of an ErrorInfo when access to Google Cloud Storage service is
blocked by the Google Workspace administrator:
{ "reason": "USER_BLOCKED_BY_ADMIN",
"domain": "googleapis.com",
"metadata": {
"service": "storage.googleapis.com",
"method": "google.storage.v1.Storage.GetObject",
}
}
The request is denied because the resource service usage is restricted
by administrators according to the organization policy constraint.
For more information see
https://cloud.google.com/resource-manager/docs/organization-policy/restricting-services.
Example of an ErrorInfo when access to Google Cloud Storage service is
restricted by Resource Usage Restriction policy:
{ "reason": "RESOURCE_USAGE_RESTRICTION_VIOLATED",
"domain": "googleapis.com",
"metadata": {
"consumer": "projects/project-123",
"service": "storage.googleapis.com"
}
}
Unimplemented. Do not use.
The request is denied because it contains unsupported system parameters in
URL query parameters or HTTP headers. For more information,
see https://cloud.google.com/apis/docs/system-parameters
Example of an ErrorInfo when access "pubsub.googleapis.com" service with
a request header of "x-goog-user-ip":
{ "reason": "SYSTEM_PARAMETER_UNSUPPORTED",
"domain": "googleapis.com",
"metadata": {
"service": "pubsub.googleapis.com"
"parameter": "x-goog-user-ip"
}
}
The request is denied because it violates Org Restriction: the requested
resource does not belong to allowed organizations specified in
"X-Goog-Allowed-Resources" header.
Example of an ErrorInfo when accessing a GCP resource that is restricted by
Org Restriction for "pubsub.googleapis.com" service.
{
reason: "ORG_RESTRICTION_VIOLATION"
domain: "googleapis.com"
metadata {
"consumer":"projects/123456"
"service": "pubsub.googleapis.com"
}
}
The request is denied because "X-Goog-Allowed-Resources" header is in a bad
format.
Example of an ErrorInfo when
accessing "pubsub.googleapis.com" service with an invalid
"X-Goog-Allowed-Resources" request header.
{
reason: "ORG_RESTRICTION_HEADER_INVALID"
domain: "googleapis.com"
metadata {
"consumer":"projects/123456"
"service": "pubsub.googleapis.com"
}
}
Unimplemented. Do not use.
The request is calling a service that is not visible to the consumer.
Example of an ErrorInfo when the consumer "projects/123" contacting
"pubsub.googleapis.com" service which is not visible to the consumer.
{ "reason": "SERVICE_NOT_VISIBLE",
"domain": "googleapis.com",
"metadata": {
"consumer": "projects/123",
"service": "pubsub.googleapis.com"
}
}
This response indicates the "pubsub.googleapis.com" is not visible to
"projects/123" (or it may not exist).
The request is related to a project for which GCP access is suspended.
Example of an ErrorInfo when the consumer "projects/123" fails to contact
"pubsub.googleapis.com" service because GCP access is suspended:
{ "reason": "GCP_SUSPENDED",
"domain": "googleapis.com",
"metadata": {
"consumer": "projects/123",
"service": "pubsub.googleapis.com"
}
}
This response indicates the associated GCP account has been suspended.
The request violates the location policies when creating resources in
the restricted region.
Example of an ErrorInfo when creating the Cloud Storage Bucket by
"projects/123" for service storage.googleapis.com:
{ "reason": "LOCATION_POLICY_VIOLATED",
"domain": "googleapis.com",
"metadata": {
"consumer": "projects/123",
"service": "storage.googleapis.com",
}
}
This response indicates creating the Cloud Storage Bucket in
"locations/asia-northeast3" violates at least one location policy.
The troubleshooting guidance is provided in the Help links.
Holder for reflection information generated from google/api/field_behavior.proto
File descriptor for google/api/field_behavior.proto
Holder for extension identifiers generated from the top level of google/api/field_behavior.proto
A designation of a specific field behavior (required, output only, etc.)
in protobuf messages.
Examples:
string name = 1 [(google.api.field_behavior) = REQUIRED];
State state = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
google.protobuf.Duration ttl = 1
[(google.api.field_behavior) = INPUT_ONLY];
google.protobuf.Timestamp expire_time = 1
[(google.api.field_behavior) = OUTPUT_ONLY,
(google.api.field_behavior) = IMMUTABLE];
An indicator of the behavior of a given field (for example, that a field
is required in requests, or given as output but ignored as input).
This **does not** change the behavior in protocol buffers itself; it only
denotes the behavior and may affect how API tooling handles the field.
Note: This enum **may** receive new values in the future.
Conventional default for enums. Do not use this.
Specifically denotes a field as optional.
While all fields in protocol buffers are optional, this may be specified
for emphasis if appropriate.
Denotes a field as required.
This indicates that the field **must** be provided as part of the request,
and failure to do so will cause an error (usually `INVALID_ARGUMENT`).
Denotes a field as output only.
This indicates that the field is provided in responses, but including the
field in a request does nothing (the server *must* ignore it and
*must not* throw an error as a result of the field's presence).
Denotes a field as input only.
This indicates that the field is provided in requests, and the
corresponding field is not included in output.
Denotes a field as immutable.
This indicates that the field may be set once in a request to create a
resource, but may not be changed thereafter.
Denotes that a (repeated) field is an unordered list.
This indicates that the service may provide the elements of the list
in any arbitrary order, rather than the order the user originally
provided. Additionally, the list's order may or may not be stable.
Denotes that this field returns a non-empty default value if not set.
This indicates that if the user provides the empty value in a request,
a non-empty value will be returned. The user will not be aware of what
non-empty value to expect.
Denotes that the field in a resource (a message annotated with
google.api.resource) is used in the resource name to uniquely identify the
resource. For AIP-compliant APIs, this should only be applied to the
`name` field on the resource.
This behavior should not be applied to references to other resources within
the message.
The identifier field of resources often have different field behavior
depending on the request it is embedded in (e.g. for Create methods name
is optional and unused, while for Update methods it is required). Instead
of method-specific annotations, only `IDENTIFIER` is required.
Holder for reflection information generated from google/api/field_info.proto
File descriptor for google/api/field_info.proto
Holder for extension identifiers generated from the top level of google/api/field_info.proto
Rich semantic descriptor of an API field beyond the basic typing.
Examples:
string request_id = 1 [(google.api.field_info).format = UUID4];
string old_ip_address = 2 [(google.api.field_info).format = IPV4];
string new_ip_address = 3 [(google.api.field_info).format = IPV6];
string actual_ip_address = 4 [
(google.api.field_info).format = IPV4_OR_IPV6
];
Rich semantic information of an API field beyond basic typing.
Field number for the "format" field.
The standard format of a field value. This does not explicitly configure
any API consumer, just documents the API's format for the field it is
applied to.
Container for nested types declared in the FieldInfo message type.
The standard format of a field value. The supported formats are all backed
by either an RFC defined by the IETF or a Google-defined AIP.
Default, unspecified value.
Universally Unique Identifier, version 4, value as defined by
https://datatracker.ietf.org/doc/html/rfc4122. The value may be
normalized to entirely lowercase letters. For example, the value
`F47AC10B-58CC-0372-8567-0E02B2C3D479` would be normalized to
`f47ac10b-58cc-0372-8567-0e02b2c3d479`.
Internet Protocol v4 value as defined by [RFC
791](https://datatracker.ietf.org/doc/html/rfc791). The value may be
condensed, with leading zeros in each octet stripped. For example,
`001.022.233.040` would be condensed to `1.22.233.40`.
Internet Protocol v6 value as defined by [RFC
2460](https://datatracker.ietf.org/doc/html/rfc2460). The value may be
normalized to entirely lowercase letters with zeros compressed, following
[RFC 5952](https://datatracker.ietf.org/doc/html/rfc5952). For example,
the value `2001:0DB8:0::0` would be normalized to `2001:db8::`.
An IP address in either v4 or v6 format as described by the individual
values defined herein. See the comments on the IPV4 and IPV6 types for
allowed normalizations of each.
Holder for reflection information generated from google/api/http.proto
File descriptor for google/api/http.proto
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.
Field number for the "rules" field.
A list of HTTP configuration rules that apply to individual API methods.
**NOTE:** All service configuration rules follow "last one wins" order.
Field number for the "fully_decode_reserved_expansion" field.
When set to true, URL path parameters will be fully URI-decoded except in
cases of single segment matches in reserved expansion, where "%2F" will be
left encoded.
The default behavior is to not decode RFC 6570 reserved characters in multi
segment matches.
# gRPC Transcoding
gRPC Transcoding is a feature for mapping between a gRPC method and one or
more HTTP REST endpoints. It allows developers to build a single API service
that supports both gRPC APIs and REST APIs. Many systems, including [Google
APIs](https://github.com/googleapis/googleapis),
[Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC
Gateway](https://github.com/grpc-ecosystem/grpc-gateway),
and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature
and use it for large scale production services.
`HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies
how different portions of the gRPC request message are mapped to the URL
path, URL query parameters, and HTTP request body. It also controls how the
gRPC response message is mapped to the HTTP response body. `HttpRule` is
typically specified as an `google.api.http` annotation on the gRPC method.
Each mapping specifies a URL path template and an HTTP method. The path
template may refer to one or more fields in the gRPC request message, as long
as each field is a non-repeated field with a primitive (non-message) type.
The path template controls how fields of the request message are mapped to
the URL path.
Example:
service Messaging {
rpc GetMessage(GetMessageRequest) returns (Message) {
option (google.api.http) = {
get: "/v1/{name=messages/*}"
};
}
}
message GetMessageRequest {
string name = 1; // Mapped to URL path.
}
message Message {
string text = 1; // The resource content.
}
This enables an HTTP REST to gRPC mapping as below:
HTTP | gRPC
-----|-----
`GET /v1/messages/123456` | `GetMessage(name: "messages/123456")`
Any fields in the request message which are not bound by the path template
automatically become HTTP query parameters if there is no HTTP request body.
For example:
service Messaging {
rpc GetMessage(GetMessageRequest) returns (Message) {
option (google.api.http) = {
get:"/v1/messages/{message_id}"
};
}
}
message GetMessageRequest {
message SubMessage {
string subfield = 1;
}
string message_id = 1; // Mapped to URL path.
int64 revision = 2; // Mapped to URL query parameter `revision`.
SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`.
}
This enables a HTTP JSON to RPC mapping as below:
HTTP | gRPC
-----|-----
`GET /v1/messages/123456?revision=2&sub.subfield=foo` |
`GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield:
"foo"))`
Note that fields which are mapped to URL query parameters must have a
primitive type or a repeated primitive type or a non-repeated message type.
In the case of a repeated type, the parameter can be repeated in the URL
as `...?param=A¶m=B`. In the case of a message type, each field of the
message is mapped to a separate parameter, such as
`...?foo.a=A&foo.b=B&foo.c=C`.
For HTTP methods that allow a request body, the `body` field
specifies the mapping. Consider a REST update method on the
message resource collection:
service Messaging {
rpc UpdateMessage(UpdateMessageRequest) returns (Message) {
option (google.api.http) = {
patch: "/v1/messages/{message_id}"
body: "message"
};
}
}
message UpdateMessageRequest {
string message_id = 1; // mapped to the URL
Message message = 2; // mapped to the body
}
The following HTTP JSON to RPC mapping is enabled, where the
representation of the JSON in the request body is determined by
protos JSON encoding:
HTTP | gRPC
-----|-----
`PATCH /v1/messages/123456 { "text": "Hi!" }` | `UpdateMessage(message_id:
"123456" message { text: "Hi!" })`
The special name `*` can be used in the body mapping to define that
every field not bound by the path template should be mapped to the
request body. This enables the following alternative definition of
the update method:
service Messaging {
rpc UpdateMessage(Message) returns (Message) {
option (google.api.http) = {
patch: "/v1/messages/{message_id}"
body: "*"
};
}
}
message Message {
string message_id = 1;
string text = 2;
}
The following HTTP JSON to RPC mapping is enabled:
HTTP | gRPC
-----|-----
`PATCH /v1/messages/123456 { "text": "Hi!" }` | `UpdateMessage(message_id:
"123456" text: "Hi!")`
Note that when using `*` in the body mapping, it is not possible to
have HTTP parameters, as all fields not bound by the path end in
the body. This makes this option more rarely used in practice when
defining REST APIs. The common usage of `*` is in custom methods
which don't use the URL at all for transferring data.
It is possible to define multiple HTTP methods for one RPC by using
the `additional_bindings` option. Example:
service Messaging {
rpc GetMessage(GetMessageRequest) returns (Message) {
option (google.api.http) = {
get: "/v1/messages/{message_id}"
additional_bindings {
get: "/v1/users/{user_id}/messages/{message_id}"
}
};
}
}
message GetMessageRequest {
string message_id = 1;
string user_id = 2;
}
This enables the following two alternative HTTP JSON to RPC mappings:
HTTP | gRPC
-----|-----
`GET /v1/messages/123456` | `GetMessage(message_id: "123456")`
`GET /v1/users/me/messages/123456` | `GetMessage(user_id: "me" message_id:
"123456")`
## Rules for HTTP mapping
1. Leaf request fields (recursive expansion nested messages in the request
message) are classified into three categories:
- Fields referred by the path template. They are passed via the URL path.
- Fields referred by the [HttpRule.body][google.api.HttpRule.body]. They
are passed via the HTTP
request body.
- All other fields are passed via the URL query parameters, and the
parameter name is the field path in the request message. A repeated
field can be represented as multiple query parameters under the same
name.
2. If [HttpRule.body][google.api.HttpRule.body] is "*", there is no URL
query parameter, all fields
are passed via URL path and HTTP request body.
3. If [HttpRule.body][google.api.HttpRule.body] is omitted, there is no HTTP
request body, all
fields are passed via URL path and URL query parameters.
### Path template syntax
Template = "/" Segments [ Verb ] ;
Segments = Segment { "/" Segment } ;
Segment = "*" | "**" | LITERAL | Variable ;
Variable = "{" FieldPath [ "=" Segments ] "}" ;
FieldPath = IDENT { "." IDENT } ;
Verb = ":" LITERAL ;
The syntax `*` matches a single URL path segment. The syntax `**` matches
zero or more URL path segments, which must be the last part of the URL path
except the `Verb`.
The syntax `Variable` matches part of the URL path as specified by its
template. A variable template must not contain other variables. If a variable
matches a single path segment, its template may be omitted, e.g. `{var}`
is equivalent to `{var=*}`.
The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL`
contains any reserved character, such characters should be percent-encoded
before the matching.
If a variable contains exactly one path segment, such as `"{var}"` or
`"{var=*}"`, when such a variable is expanded into a URL path on the client
side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The
server side does the reverse decoding. Such variables show up in the
[Discovery
Document](https://developers.google.com/discovery/v1/reference/apis) as
`{var}`.
If a variable contains multiple path segments, such as `"{var=foo/*}"`
or `"{var=**}"`, when such a variable is expanded into a URL path on the
client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded.
The server side does the reverse decoding, except "%2F" and "%2f" are left
unchanged. Such variables show up in the
[Discovery
Document](https://developers.google.com/discovery/v1/reference/apis) as
`{+var}`.
## Using gRPC API Service Configuration
gRPC API Service Configuration (service config) is a configuration language
for configuring a gRPC service to become a user-facing product. The
service config is simply the YAML representation of the `google.api.Service`
proto message.
As an alternative to annotating your proto file, you can configure gRPC
transcoding in your service config YAML files. You do this by specifying a
`HttpRule` that maps the gRPC method to a REST endpoint, achieving the same
effect as the proto annotation. This can be particularly useful if you
have a proto that is reused in multiple services. Note that any transcoding
specified in the service config will override any matching transcoding
configuration in the proto.
Example:
http:
rules:
# Selects a gRPC method and applies HttpRule to it.
- selector: example.v1.Messaging.GetMessage
get: /v1/messages/{message_id}/{sub.subfield}
## Special notes
When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the
proto to JSON conversion must follow the [proto3
specification](https://developers.google.com/protocol-buffers/docs/proto3#json).
While the single segment variable follows the semantics of
[RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String
Expansion, the multi segment variable **does not** follow RFC 6570 Section
3.2.3 Reserved Expansion. The reason is that the Reserved Expansion
does not expand special characters like `?` and `#`, which would lead
to invalid URLs. As the result, gRPC Transcoding uses a custom encoding
for multi segment variables.
The path variables **must not** refer to any repeated or mapped field,
because client libraries are not capable of handling such variable expansion.
The path variables **must not** capture the leading "/" character. The reason
is that the most common use case "{var}" does not capture the leading "/"
character. For consistency, all path variables must share the same behavior.
Repeated message fields must not be mapped to URL query parameters, because
no client library can support such complicated mapping.
If an API needs to use a JSON array for request or response body, it can map
the request or response body to a repeated field. However, some gRPC
Transcoding implementations may not support this feature.
Field number for the "selector" field.
Selects a method to which this rule applies.
Refer to [selector][google.api.DocumentationRule.selector] for syntax
details.
Field number for the "get" field.
Maps to HTTP GET. Used for listing and getting information about
resources.
Gets whether the "get" field is set
Clears the value of the oneof if it's currently set to "get"
Field number for the "put" field.
Maps to HTTP PUT. Used for replacing a resource.
Gets whether the "put" field is set
Clears the value of the oneof if it's currently set to "put"
Field number for the "post" field.
Maps to HTTP POST. Used for creating a resource or performing an action.
Gets whether the "post" field is set
Clears the value of the oneof if it's currently set to "post"
Field number for the "delete" field.
Maps to HTTP DELETE. Used for deleting a resource.
Gets whether the "delete" field is set
Clears the value of the oneof if it's currently set to "delete"
Field number for the "patch" field.
Maps to HTTP PATCH. Used for updating a resource.
Gets whether the "patch" field is set
Clears the value of the oneof if it's currently set to "patch"
Field number for the "custom" field.
The custom pattern is used for specifying an HTTP method that is not
included in the `pattern` field, such as HEAD, or "*" to leave the
HTTP method unspecified for this rule. The wild-card rule is useful
for services that provide content to Web (HTML) clients.
Field number for the "body" field.
The name of the request field whose value is mapped to the HTTP request
body, or `*` for mapping all request fields not captured by the path
pattern to the HTTP body, or omitted for not having any HTTP request body.
NOTE: the referred field must be present at the top-level of the request
message type.
Field number for the "response_body" field.
Optional. The name of the response field whose value is mapped to the HTTP
response body. When omitted, the entire response message will be used
as the HTTP response body.
NOTE: The referred field must be present at the top-level of the response
message type.
Field number for the "additional_bindings" field.
Additional HTTP bindings for the selector. Nested bindings must
not contain an `additional_bindings` field themselves (that is,
the nesting may only be one level deep).
Enum of possible cases for the "pattern" oneof.
A custom pattern is used for defining custom HTTP verb.
Field number for the "kind" field.
The name of this custom HTTP verb.
Field number for the "path" field.
The path matched by this custom verb.
Holder for reflection information generated from google/api/httpbody.proto
File descriptor for google/api/httpbody.proto
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.
This message can be used both in streaming and non-streaming API methods in
the request as well as the response.
It can be used as a top-level request field, which is convenient if one
wants to extract parameters from either the URL or HTTP template into the
request fields and also want access to the raw HTTP body.
Example:
message GetResourceRequest {
// A unique request id.
string request_id = 1;
// The raw HTTP body is bound to this field.
google.api.HttpBody http_body = 2;
}
service ResourceService {
rpc GetResource(GetResourceRequest)
returns (google.api.HttpBody);
rpc UpdateResource(google.api.HttpBody)
returns (google.protobuf.Empty);
}
Example with streaming methods:
service CaldavService {
rpc GetCalendar(stream google.api.HttpBody)
returns (stream google.api.HttpBody);
rpc UpdateCalendar(stream google.api.HttpBody)
returns (stream google.api.HttpBody);
}
Use of this type only changes how the request and response bodies are
handled, all other features will continue to work unchanged.
Field number for the "content_type" field.
The HTTP Content-Type header value specifying the content type of the body.
Field number for the "data" field.
The HTTP request/response body as raw binary.
Field number for the "extensions" field.
Application specific response metadata. Must be set in the first response
for streaming APIs.
Holder for reflection information generated from google/api/label.proto
File descriptor for google/api/label.proto
A description of a label.
Field number for the "key" field.
The label key.
Field number for the "value_type" field.
The type of data that can be assigned to the label.
Field number for the "description" field.
A human-readable description for the label.
Container for nested types declared in the LabelDescriptor message type.
Value types that can be used as label values.
A variable-length string. This is the default.
Boolean; true or false.
A 64-bit signed integer.
Holder for reflection information generated from google/api/launch_stage.proto
File descriptor for google/api/launch_stage.proto
The launch stage as defined by [Google Cloud Platform
Launch Stages](https://cloud.google.com/terms/launch-stages).
Do not use this default value.
The feature is not yet implemented. Users can not use it.
Prelaunch features are hidden from users and are only visible internally.
Early Access features are limited to a closed group of testers. To use
these features, you must sign up in advance and sign a Trusted Tester
agreement (which includes confidentiality provisions). These features may
be unstable, changed in backward-incompatible ways, and are not
guaranteed to be released.
Alpha is a limited availability test for releases before they are cleared
for widespread use. By Alpha, all significant design issues are resolved
and we are in the process of verifying functionality. Alpha customers
need to apply for access, agree to applicable terms, and have their
projects allowlisted. Alpha releases don't have to be feature complete,
no SLAs are provided, and there are no technical support obligations, but
they will be far enough along that customers can actually use them in
test environments or for limited-use tests -- just like they would in
normal production cases.
Beta is the point at which we are ready to open a release for any
customer to use. There are no SLA or technical support obligations in a
Beta release. Products will be complete from a feature perspective, but
may have some open outstanding issues. Beta releases are suitable for
limited production use cases.
GA features are open to all developers and are considered stable and
fully qualified for production use.
Deprecated features are scheduled to be shut down and removed. For more
information, see the "Deprecation Policy" section of our [Terms of
Service](https://cloud.google.com/terms/)
and the [Google Cloud Platform Subject to the Deprecation
Policy](https://cloud.google.com/terms/deprecation) documentation.
Holder for reflection information generated from google/api/log.proto
File descriptor for google/api/log.proto
A description of a log type. Example in YAML format:
- name: library.googleapis.com/activity_history
description: The history of borrowing and returning library items.
display_name: Activity
labels:
- key: /customer_id
description: Identifier of a library customer
Field number for the "name" field.
The name of the log. It must be less than 512 characters long and can
include the following characters: upper- and lower-case alphanumeric
characters [A-Za-z0-9], and punctuation characters including
slash, underscore, hyphen, period [/_-.].
Field number for the "labels" field.
The set of labels that are available to describe a specific log entry.
Runtime requests that contain labels not specified here are
considered invalid.
Field number for the "description" field.
A human-readable description of this log. This information appears in
the documentation and can contain details.
Field number for the "display_name" field.
The human-readable name for this log. This information appears on
the user interface and should be concise.
Holder for reflection information generated from google/api/logging.proto
File descriptor for google/api/logging.proto
Logging configuration of the service.
The following example shows how to configure logs to be sent to the
producer and consumer projects. In the example, the `activity_history`
log is sent to both the producer and consumer projects, whereas the
`purchase_history` log is only sent to the producer project.
monitored_resources:
- type: library.googleapis.com/branch
labels:
- key: /city
description: The city where the library branch is located in.
- key: /name
description: The name of the branch.
logs:
- name: activity_history
labels:
- key: /customer_id
- name: purchase_history
logging:
producer_destinations:
- monitored_resource: library.googleapis.com/branch
logs:
- activity_history
- purchase_history
consumer_destinations:
- monitored_resource: library.googleapis.com/branch
logs:
- activity_history
Field number for the "producer_destinations" field.
Logging configurations for sending logs to the producer project.
There can be multiple producer destinations, each one must have a
different monitored resource type. A log can be used in at most
one producer destination.
Field number for the "consumer_destinations" field.
Logging configurations for sending logs to the consumer project.
There can be multiple consumer destinations, each one must have a
different monitored resource type. A log can be used in at most
one consumer destination.
Container for nested types declared in the Logging message type.
Configuration of a specific logging destination (the producer project
or the consumer project).
Field number for the "monitored_resource" field.
The monitored resource type. The type must be defined in the
[Service.monitored_resources][google.api.Service.monitored_resources]
section.
Field number for the "logs" field.
Names of the logs to be sent to this destination. Each name must
be defined in the [Service.logs][google.api.Service.logs] section. If the
log name is not a domain scoped name, it will be automatically prefixed
with the service name followed by "/".
Holder for reflection information generated from google/api/metric.proto
File descriptor for google/api/metric.proto
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.
Field number for the "name" field.
The resource name of the metric descriptor.
Field number for the "type" field.
The metric type, including its DNS name prefix. The type is not
URL-encoded. All user-defined metric types have the DNS name
`custom.googleapis.com` or `external.googleapis.com`. Metric types should
use a natural hierarchical grouping. For example:
"custom.googleapis.com/invoice/paid/amount"
"external.googleapis.com/prometheus/up"
"appengine.googleapis.com/http/server/response_latencies"
Field number for the "labels" field.
The set of labels that can be used to describe a specific
instance of this metric type. For example, the
`appengine.googleapis.com/http/server/response_latencies` metric
type has a label for the HTTP response code, `response_code`, so
you can look at latencies for successful responses or just
for responses that failed.
Field number for the "metric_kind" field.
Whether the metric records instantaneous values, changes to a value, etc.
Some combinations of `metric_kind` and `value_type` might not be supported.
Field number for the "value_type" field.
Whether the measurement is an integer, a floating-point number, etc.
Some combinations of `metric_kind` and `value_type` might not be supported.
Field number for the "unit" field.
The units in which the metric value is reported. It is only applicable
if the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The `unit`
defines the representation of the stored metric values.
Different systems might scale the values to be more easily displayed (so a
value of `0.02kBy` _might_ be displayed as `20By`, and a value of
`3523kBy` _might_ be displayed as `3.5MBy`). However, if the `unit` is
`kBy`, then the value of the metric is always in thousands of bytes, no
matter how it might be displayed.
If you want a custom metric to record the exact number of CPU-seconds used
by a job, you can create an `INT64 CUMULATIVE` metric whose `unit` is
`s{CPU}` (or equivalently `1s{CPU}` or just `s`). If the job uses 12,005
CPU-seconds, then the value is written as `12005`.
Alternatively, if you want a custom metric to record data in a more
granular way, you can create a `DOUBLE CUMULATIVE` metric whose `unit` is
`ks{CPU}`, and then write the value `12.005` (which is `12005/1000`),
or use `Kis{CPU}` and write `11.723` (which is `12005/1024`).
The supported units are a subset of [The Unified Code for Units of
Measure](https://unitsofmeasure.org/ucum.html) standard:
**Basic units (UNIT)**
* `bit` bit
* `By` byte
* `s` second
* `min` minute
* `h` hour
* `d` day
* `1` dimensionless
**Prefixes (PREFIX)**
* `k` kilo (10^3)
* `M` mega (10^6)
* `G` giga (10^9)
* `T` tera (10^12)
* `P` peta (10^15)
* `E` exa (10^18)
* `Z` zetta (10^21)
* `Y` yotta (10^24)
* `m` milli (10^-3)
* `u` micro (10^-6)
* `n` nano (10^-9)
* `p` pico (10^-12)
* `f` femto (10^-15)
* `a` atto (10^-18)
* `z` zepto (10^-21)
* `y` yocto (10^-24)
* `Ki` kibi (2^10)
* `Mi` mebi (2^20)
* `Gi` gibi (2^30)
* `Ti` tebi (2^40)
* `Pi` pebi (2^50)
**Grammar**
The grammar also includes these connectors:
* `/` division or ratio (as an infix operator). For examples,
`kBy/{email}` or `MiBy/10ms` (although you should almost never
have `/s` in a metric `unit`; rates should always be computed at
query time from the underlying cumulative or delta value).
* `.` multiplication or composition (as an infix operator). For
examples, `GBy.d` or `k{watt}.h`.
The grammar for a unit is as follows:
Expression = Component { "." Component } { "/" Component } ;
Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ]
| Annotation
| "1"
;
Annotation = "{" NAME "}" ;
Notes:
* `Annotation` is just a comment if it follows a `UNIT`. If the annotation
is used alone, then the unit is equivalent to `1`. For examples,
`{request}/s == 1/s`, `By{transmitted}/s == By/s`.
* `NAME` is a sequence of non-blank printable ASCII characters not
containing `{` or `}`.
* `1` represents a unitary [dimensionless
unit](https://en.wikipedia.org/wiki/Dimensionless_quantity) of 1, such
as in `1/s`. It is typically used when none of the basic units are
appropriate. For example, "new users per day" can be represented as
`1/d` or `{new-users}/d` (and a metric value `5` would mean "5 new
users). Alternatively, "thousands of page views per day" would be
represented as `1000/d` or `k1/d` or `k{page_views}/d` (and a metric
value of `5.3` would mean "5300 page views per day").
* `%` represents dimensionless value of 1/100, and annotates values giving
a percentage (so the metric values are typically in the range of 0..100,
and a metric value `3` means "3 percent").
* `10^2.%` indicates a metric contains a ratio, typically in the range
0..1, that will be multiplied by 100 and displayed as a percentage
(so a metric value `0.03` means "3 percent").
Field number for the "description" field.
A detailed description of the metric, which can be used in documentation.
Field number for the "display_name" field.
A concise name for the metric, which can be displayed in user interfaces.
Use sentence case without an ending period, for example "Request count".
This field is optional but it is recommended to be set for any metrics
associated with user-visible concepts, such as Quota.
Field number for the "metadata" field.
Optional. Metadata which can be used to guide usage of the metric.
Field number for the "launch_stage" field.
Optional. The launch stage of the metric definition.
Field number for the "monitored_resource_types" field.
Read-only. If present, then a [time
series][google.monitoring.v3.TimeSeries], which is identified partially by
a metric type and a
[MonitoredResourceDescriptor][google.api.MonitoredResourceDescriptor], that
is associated with this metric type can only be associated with one of the
monitored resource types listed here.
Container for nested types declared in the MetricDescriptor message type.
The kind of measurement. It describes how the data is reported.
For information on setting the start time and end time based on
the MetricKind, see [TimeInterval][google.monitoring.v3.TimeInterval].
Do not use this default value.
An instantaneous measurement of a value.
The change in a value during a time interval.
A value accumulated over a time interval. Cumulative
measurements in a time series should have the same start time
and increasing end times, until an event resets the cumulative
value to zero and sets a new start time for the following
points.
The value type of a metric.
Do not use this default value.
The value is a boolean.
This value type can be used only if the metric kind is `GAUGE`.
The value is a signed 64-bit integer.
The value is a double precision floating point number.
The value is a text string.
This value type can be used only if the metric kind is `GAUGE`.
The value is a [`Distribution`][google.api.Distribution].
The value is money.
Additional annotations that can be used to guide the usage of a metric.
Field number for the "launch_stage" field.
Deprecated. Must use the
[MetricDescriptor.launch_stage][google.api.MetricDescriptor.launch_stage]
instead.
Field number for the "sample_period" field.
The sampling period of metric data points. For metrics which are written
periodically, consecutive data points are stored at this time interval,
excluding data loss due to errors. Metrics with a higher granularity have
a smaller sampling period.
Field number for the "ingest_delay" field.
The delay of data points caused by ingestion. Data points older than this
age are guaranteed to be ingested and available to be read, excluding
data loss due to errors.
A specific metric, identified by specifying values for all of the
labels of a [`MetricDescriptor`][google.api.MetricDescriptor].
Field number for the "type" field.
An existing metric type, see
[google.api.MetricDescriptor][google.api.MetricDescriptor]. For example,
`custom.googleapis.com/invoice/paid/amount`.
Field number for the "labels" field.
The set of label values that uniquely identify this metric. All
labels listed in the `MetricDescriptor` must be assigned values.
Holder for reflection information generated from google/api/monitored_resource.proto
File descriptor for google/api/monitored_resource.proto
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.
Different APIs can support different monitored resource types. APIs generally
provide a `list` method that returns the monitored resource descriptors used
by the API.
Field number for the "name" field.
Optional. The resource name of the monitored resource descriptor:
`"projects/{project_id}/monitoredResourceDescriptors/{type}"` where
{type} is the value of the `type` field in this object and
{project_id} is a project ID that provides API-specific context for
accessing the type. APIs that do not use project information can use the
resource name format `"monitoredResourceDescriptors/{type}"`.
Field number for the "type" field.
Required. The monitored resource type. For example, the type
`"cloudsql_database"` represents databases in Google Cloud SQL.
For a list of types, see [Monitored resource
types](https://cloud.google.com/monitoring/api/resources)
and [Logging resource
types](https://cloud.google.com/logging/docs/api/v2/resource-list).
Field number for the "display_name" field.
Optional. A concise name for the monitored resource type that might be
displayed in user interfaces. It should be a Title Cased Noun Phrase,
without any article or other determiners. For example,
`"Google Cloud SQL Database"`.
Field number for the "description" field.
Optional. A detailed description of the monitored resource type that might
be used in documentation.
Field number for the "labels" field.
Required. A set of labels used to describe instances of this monitored
resource type. For example, an individual Google Cloud SQL database is
identified by values for the labels `"database_id"` and `"zone"`.
Field number for the "launch_stage" field.
Optional. The launch stage of the monitored resource definition.
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"`:
{ "type": "gce_instance",
"labels": { "project_id": "my-project",
"instance_id": "12345678901234",
"zone": "us-central1-a" }}
Field number for the "type" field.
Required. The monitored resource type. This field must match
the `type` field of a
[MonitoredResourceDescriptor][google.api.MonitoredResourceDescriptor]
object. For example, the type of a Compute Engine VM instance is
`gce_instance`. Some descriptors include the service name in the type; for
example, the type of a Datastream stream is
`datastream.googleapis.com/Stream`.
Field number for the "labels" field.
Required. Values for all of the labels listed in the associated monitored
resource descriptor. For example, Compute Engine VM instances use the
labels `"project_id"`, `"instance_id"`, and `"zone"`.
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.
Field number for the "system_labels" field.
Output only. Values for predefined system metadata labels.
System labels are a kind of metadata extracted by Google, including
"machine_image", "vpc", "subnet_id",
"security_group", "name", etc.
System label values can be only strings, Boolean values, or a list of
strings. For example:
{ "name": "my-test-instance",
"security_group": ["a", "b", "c"],
"spot_instance": false }
Field number for the "user_labels" field.
Output only. A map of user-defined metadata labels.
Holder for reflection information generated from google/api/monitoring.proto
File descriptor for google/api/monitoring.proto
Monitoring configuration of the service.
The example below shows how to configure monitored resources and metrics
for monitoring. In the example, a monitored resource and two metrics are
defined. The `library.googleapis.com/book/returned_count` metric is sent
to both producer and consumer projects, whereas the
`library.googleapis.com/book/num_overdue` metric is only sent to the
consumer project.
monitored_resources:
- type: library.googleapis.com/Branch
display_name: "Library Branch"
description: "A branch of a library."
launch_stage: GA
labels:
- key: resource_container
description: "The Cloud container (ie. project id) for the Branch."
- key: location
description: "The location of the library branch."
- key: branch_id
description: "The id of the branch."
metrics:
- name: library.googleapis.com/book/returned_count
display_name: "Books Returned"
description: "The count of books that have been returned."
launch_stage: GA
metric_kind: DELTA
value_type: INT64
unit: "1"
labels:
- key: customer_id
description: "The id of the customer."
- name: library.googleapis.com/book/num_overdue
display_name: "Books Overdue"
description: "The current number of overdue books."
launch_stage: GA
metric_kind: GAUGE
value_type: INT64
unit: "1"
labels:
- key: customer_id
description: "The id of the customer."
monitoring:
producer_destinations:
- monitored_resource: library.googleapis.com/Branch
metrics:
- library.googleapis.com/book/returned_count
consumer_destinations:
- monitored_resource: library.googleapis.com/Branch
metrics:
- library.googleapis.com/book/returned_count
- library.googleapis.com/book/num_overdue
Field number for the "producer_destinations" field.
Monitoring configurations for sending metrics to the producer project.
There can be multiple producer destinations. A monitored resource type may
appear in multiple monitoring destinations if different aggregations are
needed for different sets of metrics associated with that monitored
resource type. A monitored resource and metric pair may only be used once
in the Monitoring configuration.
Field number for the "consumer_destinations" field.
Monitoring configurations for sending metrics to the consumer project.
There can be multiple consumer destinations. A monitored resource type may
appear in multiple monitoring destinations if different aggregations are
needed for different sets of metrics associated with that monitored
resource type. A monitored resource and metric pair may only be used once
in the Monitoring configuration.
Container for nested types declared in the Monitoring message type.
Configuration of a specific monitoring destination (the producer project
or the consumer project).
Field number for the "monitored_resource" field.
The monitored resource type. The type must be defined in
[Service.monitored_resources][google.api.Service.monitored_resources]
section.
Field number for the "metrics" field.
Types of the metrics to report to this monitoring destination.
Each type must be defined in
[Service.metrics][google.api.Service.metrics] section.
Holder for reflection information generated from google/api/policy.proto
File descriptor for google/api/policy.proto
Holder for extension identifiers generated from the top level of google/api/policy.proto
See [FieldPolicy][].
See [MethodPolicy][].
Google API Policy Annotation
This message defines a simple API policy annotation that can be used to
annotate API request and response message fields with applicable policies.
One field may have multiple applicable policies that must all be satisfied
before a request can be processed. This policy annotation is used to
generate the overall policy that will be used for automatic runtime
policy enforcement and documentation generation.
Field number for the "selector" field.
Selects one or more request or response message fields to apply this
`FieldPolicy`.
When a `FieldPolicy` is used in proto annotation, the selector must
be left as empty. The service config generator will automatically fill
the correct value.
When a `FieldPolicy` is used in service config, the selector must be a
comma-separated string with valid request or response field paths,
such as "foo.bar" or "foo.bar,foo.baz".
Field number for the "resource_permission" field.
Specifies the required permission(s) for the resource referred to by the
field. It requires the field contains a valid resource reference, and
the request must pass the permission checks to proceed. For example,
"resourcemanager.projects.get".
Field number for the "resource_type" field.
Specifies the resource type for the resource referred to by the field.
Defines policies applying to an RPC method.
Field number for the "selector" field.
Selects a method to which these policies should be enforced, for example,
"google.pubsub.v1.Subscriber.CreateSubscription".
Refer to [selector][google.api.DocumentationRule.selector] for syntax
details.
NOTE: This field must not be set in the proto annotation. It will be
automatically filled by the service config compiler .
Field number for the "request_policies" field.
Policies that are applicable to the request message.
Holder for reflection information generated from google/api/quota.proto
File descriptor for google/api/quota.proto
Quota configuration helps to achieve fairness and budgeting in service
usage.
The metric based quota configuration works this way:
- The service configuration defines a set of metrics.
- For API calls, the quota.metric_rules maps methods to metrics with
corresponding costs.
- The quota.limits defines limits on the metrics, which will be used for
quota checks at runtime.
An example quota configuration in yaml format:
quota:
limits:
- name: apiWriteQpsPerProject
metric: library.googleapis.com/write_calls
unit: "1/min/{project}" # rate limit for consumer projects
values:
STANDARD: 10000
(The metric rules bind all methods to the read_calls metric,
except for the UpdateBook and DeleteBook methods. These two methods
are mapped to the write_calls metric, with the UpdateBook method
consuming at twice rate as the DeleteBook method.)
metric_rules:
- selector: "*"
metric_costs:
library.googleapis.com/read_calls: 1
- selector: google.example.library.v1.LibraryService.UpdateBook
metric_costs:
library.googleapis.com/write_calls: 2
- selector: google.example.library.v1.LibraryService.DeleteBook
metric_costs:
library.googleapis.com/write_calls: 1
Corresponding Metric definition:
metrics:
- name: library.googleapis.com/read_calls
display_name: Read requests
metric_kind: DELTA
value_type: INT64
- name: library.googleapis.com/write_calls
display_name: Write requests
metric_kind: DELTA
value_type: INT64
Field number for the "limits" field.
List of QuotaLimit definitions for the service.
Field number for the "metric_rules" field.
List of MetricRule definitions, each one mapping a selected method to one
or more metrics.
Bind API methods to metrics. Binding a method to a metric causes that
metric's configured quota behaviors to apply to the method call.
Field number for the "selector" field.
Selects the methods to which this rule applies.
Refer to [selector][google.api.DocumentationRule.selector] for syntax
details.
Field number for the "metric_costs" field.
Metrics to update when the selected methods are called, and the associated
cost applied to each metric.
The key of the map is the metric name, and the values are the amount
increased for the metric against which the quota limits are defined.
The value must not be negative.
`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`.
Field number for the "name" field.
Name of the quota limit.
The name must be provided, and it must be unique within the service. The
name can only include alphanumeric characters as well as '-'.
The maximum length of the limit name is 64 characters.
Field number for the "description" field.
Optional. User-visible, extended description for this quota limit.
Should be used only when more context is needed to understand this limit
than provided by the limit's display name (see: `display_name`).
Field number for the "default_limit" field.
Default number of tokens that can be consumed during the specified
duration. This is the number of tokens assigned when a client
application developer activates the service for his/her project.
Specifying a value of 0 will block all requests. This can be used if you
are provisioning quota to selected consumers and blocking others.
Similarly, a value of -1 will indicate an unlimited quota. No other
negative values are allowed.
Used by group-based quotas only.
Field number for the "max_limit" field.
Maximum number of tokens that can be consumed during the specified
duration. Client application developers can override the default limit up
to this maximum. If specified, this value cannot be set to a value less
than the default limit. If not specified, it is set to the default limit.
To allow clients to apply overrides with no upper bound, set this to -1,
indicating unlimited maximum quota.
Used by group-based quotas only.
Field number for the "free_tier" field.
Free tier value displayed in the Developers Console for this limit.
The free tier is the number of tokens that will be subtracted from the
billed amount when billing is enabled.
This field can only be set on a limit with duration "1d", in a billable
group; it is invalid on any other limit. If this field is not set, it
defaults to 0, indicating that there is no free tier for this service.
Used by group-based quotas only.
Field number for the "duration" field.
Duration of this limit in textual notation. Must be "100s" or "1d".
Used by group-based quotas only.
Field number for the "metric" field.
The name of the metric this quota limit applies to. The quota limits with
the same metric will be checked together during runtime. The metric must be
defined within the service config.
Field number for the "unit" field.
Specify the unit of the quota limit. It uses the same syntax as
[Metric.unit][]. The supported unit kinds are determined by the quota
backend system.
Here are some examples:
* "1/min/{project}" for quota per minute per project.
Note: the order of unit components is insignificant.
The "1" at the beginning is required to follow the metric unit syntax.
Field number for the "values" field.
Tiered limit values. You must specify this as a key:value pair, with an
integer value that is the maximum number of requests allowed for the
specified unit. Currently only STANDARD is supported.
Field number for the "display_name" field.
User-visible display name for this limit.
Optional. If not set, the UI will provide a default display name based on
the quota configuration. This field can be used to override the default
display name generated from the configuration.
Holder for reflection information generated from google/api/resource.proto
File descriptor for google/api/resource.proto
Holder for extension identifiers generated from the top level of google/api/resource.proto
An annotation that describes a resource reference, see
[ResourceReference][].
An annotation that describes a resource definition without a corresponding
message; see [ResourceDescriptor][].
An annotation that describes a resource definition, see
[ResourceDescriptor][].
A simple descriptor of a resource type.
ResourceDescriptor annotates a resource message (either by means of a
protobuf annotation or use in the service config), and associates the
resource's schema, the resource type, and the pattern of the resource name.
Example:
message Topic {
// Indicates this message defines a resource schema.
// Declares the resource type in the format of {service}/{kind}.
// For Kubernetes resources, the format is {api group}/{kind}.
option (google.api.resource) = {
type: "pubsub.googleapis.com/Topic"
pattern: "projects/{project}/topics/{topic}"
};
}
The ResourceDescriptor Yaml config will look like:
resources:
- type: "pubsub.googleapis.com/Topic"
pattern: "projects/{project}/topics/{topic}"
Sometimes, resources have multiple patterns, typically because they can
live under multiple parents.
Example:
message LogEntry {
option (google.api.resource) = {
type: "logging.googleapis.com/LogEntry"
pattern: "projects/{project}/logs/{log}"
pattern: "folders/{folder}/logs/{log}"
pattern: "organizations/{organization}/logs/{log}"
pattern: "billingAccounts/{billing_account}/logs/{log}"
};
}
The ResourceDescriptor Yaml config will look like:
resources:
- type: 'logging.googleapis.com/LogEntry'
pattern: "projects/{project}/logs/{log}"
pattern: "folders/{folder}/logs/{log}"
pattern: "organizations/{organization}/logs/{log}"
pattern: "billingAccounts/{billing_account}/logs/{log}"
Field number for the "type" field.
The resource type. It must be in the format of
{service_name}/{resource_type_kind}. The `resource_type_kind` must be
singular and must not include version numbers.
Example: `storage.googleapis.com/Bucket`
The value of the resource_type_kind must follow the regular expression
/[A-Za-z][a-zA-Z0-9]+/. It should start with an upper case character and
should use PascalCase (UpperCamelCase). The maximum number of
characters allowed for the `resource_type_kind` is 100.
Field number for the "pattern" field.
Optional. The relative resource name pattern associated with this resource
type. The DNS prefix of the full resource name shouldn't be specified here.
The path pattern must follow the syntax, which aligns with HTTP binding
syntax:
Template = Segment { "/" Segment } ;
Segment = LITERAL | Variable ;
Variable = "{" LITERAL "}" ;
Examples:
- "projects/{project}/topics/{topic}"
- "projects/{project}/knowledgeBases/{knowledge_base}"
The components in braces correspond to the IDs for each resource in the
hierarchy. It is expected that, if multiple patterns are provided,
the same component name (e.g. "project") refers to IDs of the same
type of resource.
Field number for the "name_field" field.
Optional. The field on the resource that designates the resource name
field. If omitted, this is assumed to be "name".
Field number for the "history" field.
Optional. The historical or future-looking state of the resource pattern.
Example:
// The InspectTemplate message originally only supported resource
// names with organization, and project was added later.
message InspectTemplate {
option (google.api.resource) = {
type: "dlp.googleapis.com/InspectTemplate"
pattern:
"organizations/{organization}/inspectTemplates/{inspect_template}"
pattern: "projects/{project}/inspectTemplates/{inspect_template}"
history: ORIGINALLY_SINGLE_PATTERN
};
}
Field number for the "plural" field.
The plural name used in the resource name and permission names, such as
'projects' for the resource name of 'projects/{project}' and the permission
name of 'cloudresourcemanager.googleapis.com/projects.get'. It is the same
concept of the `plural` field in k8s CRD spec
https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
Note: The plural form is required even for singleton resources. See
https://aip.dev/156
Field number for the "singular" field.
The same concept of the `singular` field in k8s CRD spec
https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
Such as "project" for the `resourcemanager.googleapis.com/Project` type.
Field number for the "style" field.
Style flag(s) for this resource.
These indicate that a resource is expected to conform to a given
style. See the specific style flags for additional information.
Container for nested types declared in the ResourceDescriptor message type.
A description of the historical or future-looking state of the
resource pattern.
The "unset" value.
The resource originally had one pattern and launched as such, and
additional patterns were added later.
The resource has one pattern, but the API owner expects to add more
later. (This is the inverse of ORIGINALLY_SINGLE_PATTERN, and prevents
that from being necessary once there are multiple patterns.)
A flag representing a specific style that a resource claims to conform to.
The unspecified value. Do not use.
This resource is intended to be "declarative-friendly".
Declarative-friendly resources must be more strictly consistent, and
setting this to true communicates to tools that this resource should
adhere to declarative-friendly expectations.
Note: This is used by the API linter (linter.aip.dev) to enable
additional checks.
Defines a proto annotation that describes a string field that refers to
an API resource.
Field number for the "type" field.
The resource type that the annotated field references.
Example:
message Subscription {
string topic = 2 [(google.api.resource_reference) = {
type: "pubsub.googleapis.com/Topic"
}];
}
Occasionally, a field may reference an arbitrary resource. In this case,
APIs use the special value * in their resource reference.
Example:
message GetIamPolicyRequest {
string resource = 2 [(google.api.resource_reference) = {
type: "*"
}];
}
Field number for the "child_type" field.
The resource type of a child collection that the annotated field
references. This is useful for annotating the `parent` field that
doesn't have a fixed resource type.
Example:
message ListLogEntriesRequest {
string parent = 1 [(google.api.resource_reference) = {
child_type: "logging.googleapis.com/LogEntry"
};
}
Holder for reflection information generated from google/api/routing.proto
File descriptor for google/api/routing.proto
Holder for extension identifiers generated from the top level of google/api/routing.proto
See RoutingRule.
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.
The examples below will apply to an RPC which has the following request type:
Message Definition:
message Request {
// The name of the Table
// Values can be of the following formats:
// - `projects/<project>/tables/<table>`
// - `projects/<project>/instances/<instance>/tables/<table>`
// - `region/<region>/zones/<zone>/tables/<table>`
string table_name = 1;
// This value specifies routing for replication.
// It can be in the following formats:
// - `profiles/<profile_id>`
// - a legacy `profile_id` that can be any string
string app_profile_id = 2;
}
Example message:
{
table_name: projects/proj_foo/instances/instance_bar/table/table_baz,
app_profile_id: profiles/prof_qux
}
The routing header consists of one or multiple key-value pairs. Every key
and value must be percent-encoded, and joined together in the format of
`key1=value1&key2=value2`.
In the examples below I am skipping the percent-encoding for readablity.
Example 1
Extracting a field from the request to put into the routing header
unchanged, with the key equal to the field name.
annotation:
option (google.api.routing) = {
// Take the `app_profile_id`.
routing_parameters {
field: "app_profile_id"
}
};
result:
x-goog-request-params: app_profile_id=profiles/prof_qux
Example 2
Extracting a field from the request to put into the routing header
unchanged, with the key different from the field name.
annotation:
option (google.api.routing) = {
// Take the `app_profile_id`, but name it `routing_id` in the header.
routing_parameters {
field: "app_profile_id"
path_template: "{routing_id=**}"
}
};
result:
x-goog-request-params: routing_id=profiles/prof_qux
Example 3
Extracting a field from the request to put into the routing
header, while matching a path template syntax on the field's value.
NB: it is more useful to send nothing than to send garbage for the purpose
of dynamic routing, since garbage pollutes cache. Thus the matching.
Sub-example 3a
The field matches the template.
annotation:
option (google.api.routing) = {
// Take the `table_name`, if it's well-formed (with project-based
// syntax).
routing_parameters {
field: "table_name"
path_template: "{table_name=projects/*/instances/*/**}"
}
};
result:
x-goog-request-params:
table_name=projects/proj_foo/instances/instance_bar/table/table_baz
Sub-example 3b
The field does not match the template.
annotation:
option (google.api.routing) = {
// Take the `table_name`, if it's well-formed (with region-based
// syntax).
routing_parameters {
field: "table_name"
path_template: "{table_name=regions/*/zones/*/**}"
}
};
result:
<no routing header will be sent>
Sub-example 3c
Multiple alternative conflictingly named path templates are
specified. The one that matches is used to construct the header.
annotation:
option (google.api.routing) = {
// Take the `table_name`, if it's well-formed, whether
// using the region- or projects-based syntax.
routing_parameters {
field: "table_name"
path_template: "{table_name=regions/*/zones/*/**}"
}
routing_parameters {
field: "table_name"
path_template: "{table_name=projects/*/instances/*/**}"
}
};
result:
x-goog-request-params:
table_name=projects/proj_foo/instances/instance_bar/table/table_baz
Example 4
Extracting a single routing header key-value pair by matching a
template syntax on (a part of) a single request field.
annotation:
option (google.api.routing) = {
// Take just the project id from the `table_name` field.
routing_parameters {
field: "table_name"
path_template: "{routing_id=projects/*}/**"
}
};
result:
x-goog-request-params: routing_id=projects/proj_foo
Example 5
Extracting a single routing header key-value pair by matching
several conflictingly named path templates on (parts of) a single request
field. The last template to match "wins" the conflict.
annotation:
option (google.api.routing) = {
// If the `table_name` does not have instances information,
// take just the project id for routing.
// Otherwise take project + instance.
routing_parameters {
field: "table_name"
path_template: "{routing_id=projects/*}/**"
}
routing_parameters {
field: "table_name"
path_template: "{routing_id=projects/*/instances/*}/**"
}
};
result:
x-goog-request-params:
routing_id=projects/proj_foo/instances/instance_bar
Example 6
Extracting multiple routing header key-value pairs by matching
several non-conflicting path templates on (parts of) a single request field.
Sub-example 6a
Make the templates strict, so that if the `table_name` does not
have an instance information, nothing is sent.
annotation:
option (google.api.routing) = {
// The routing code needs two keys instead of one composite
// but works only for the tables with the "project-instance" name
// syntax.
routing_parameters {
field: "table_name"
path_template: "{project_id=projects/*}/instances/*/**"
}
routing_parameters {
field: "table_name"
path_template: "projects/*/{instance_id=instances/*}/**"
}
};
result:
x-goog-request-params:
project_id=projects/proj_foo&instance_id=instances/instance_bar
Sub-example 6b
Make the templates loose, so that if the `table_name` does not
have an instance information, just the project id part is sent.
annotation:
option (google.api.routing) = {
// The routing code wants two keys instead of one composite
// but will work with just the `project_id` for tables without
// an instance in the `table_name`.
routing_parameters {
field: "table_name"
path_template: "{project_id=projects/*}/**"
}
routing_parameters {
field: "table_name"
path_template: "projects/*/{instance_id=instances/*}/**"
}
};
result (is the same as 6a for our example message because it has the instance
information):
x-goog-request-params:
project_id=projects/proj_foo&instance_id=instances/instance_bar
Example 7
Extracting multiple routing header key-value pairs by matching
several path templates on multiple request fields.
NB: note that here there is no way to specify sending nothing if one of the
fields does not match its template. E.g. if the `table_name` is in the wrong
format, the `project_id` will not be sent, but the `routing_id` will be.
The backend routing code has to be aware of that and be prepared to not
receive a full complement of keys if it expects multiple.
annotation:
option (google.api.routing) = {
// The routing needs both `project_id` and `routing_id`
// (from the `app_profile_id` field) for routing.
routing_parameters {
field: "table_name"
path_template: "{project_id=projects/*}/**"
}
routing_parameters {
field: "app_profile_id"
path_template: "{routing_id=**}"
}
};
result:
x-goog-request-params:
project_id=projects/proj_foo&routing_id=profiles/prof_qux
Example 8
Extracting a single routing header key-value pair by matching
several conflictingly named path templates on several request fields. The
last template to match "wins" the conflict.
annotation:
option (google.api.routing) = {
// The `routing_id` can be a project id or a region id depending on
// the table name format, but only if the `app_profile_id` is not set.
// If `app_profile_id` is set it should be used instead.
routing_parameters {
field: "table_name"
path_template: "{routing_id=projects/*}/**"
}
routing_parameters {
field: "table_name"
path_template: "{routing_id=regions/*}/**"
}
routing_parameters {
field: "app_profile_id"
path_template: "{routing_id=**}"
}
};
result:
x-goog-request-params: routing_id=profiles/prof_qux
Example 9
Bringing it all together.
annotation:
option (google.api.routing) = {
// For routing both `table_location` and a `routing_id` are needed.
//
// table_location can be either an instance id or a region+zone id.
//
// For `routing_id`, take the value of `app_profile_id`
// - If it's in the format `profiles/<profile_id>`, send
// just the `<profile_id>` part.
// - If it's any other literal, send it as is.
// If the `app_profile_id` is empty, and the `table_name` starts with
// the project_id, send that instead.
routing_parameters {
field: "table_name"
path_template: "projects/*/{table_location=instances/*}/tables/*"
}
routing_parameters {
field: "table_name"
path_template: "{table_location=regions/*/zones/*}/tables/*"
}
routing_parameters {
field: "table_name"
path_template: "{routing_id=projects/*}/**"
}
routing_parameters {
field: "app_profile_id"
path_template: "{routing_id=**}"
}
routing_parameters {
field: "app_profile_id"
path_template: "profiles/{routing_id=*}"
}
};
result:
x-goog-request-params:
table_location=instances/instance_bar&routing_id=prof_qux
Field number for the "routing_parameters" field.
A collection of Routing Parameter specifications.
**NOTE:** If multiple Routing Parameters describe the same key
(via the `path_template` field or via the `field` field when
`path_template` is not provided), "last one wins" rule
determines which Parameter gets used.
See the examples for more details.
A projection from an input message to the GRPC or REST header.
Field number for the "field" field.
A request field to extract the header key-value pair from.
Field number for the "path_template" field.
A pattern matching the key-value field. Optional.
If not specified, the whole field specified in the `field` field will be
taken as value, and its name used as key. If specified, it MUST contain
exactly one named segment (along with any number of unnamed segments) The
pattern will be matched over the field specified in the `field` field, then
if the match is successful:
- the name of the single named segment will be used as a header name,
- the match value of the segment will be used as a header value;
if the match is NOT successful, nothing will be sent.
Example:
-- This is a field in the request message
| that the header value will be extracted from.
|
| -- This is the key name in the
| | routing header.
V |
field: "table_name" v
path_template: "projects/*/{table_location=instances/*}/tables/*"
^ ^
| |
In the {} brackets is the pattern that -- |
specifies what to extract from the |
field as a value to be sent. |
|
The string in the field must match the whole pattern --
before brackets, inside brackets, after brackets.
When looking at this specific example, we can see that:
- A key-value pair with the key `table_location`
and the value matching `instances/*` should be added
to the x-goog-request-params routing header.
- The value is extracted from the request message's `table_name` field
if it matches the full pattern specified:
`projects/*/instances/*/tables/*`.
**NB:** If the `path_template` field is not provided, the key name is
equal to the field name, and the whole field should be sent as a value.
This makes the pattern for the field and the value functionally equivalent
to `**`, and the configuration
{
field: "table_name"
}
is a functionally equivalent shorthand to:
{
field: "table_name"
path_template: "{table_name=**}"
}
See Example 1 for more details.
Holder for reflection information generated from google/api/service.proto
File descriptor for google/api/service.proto
`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.
Example:
type: google.api.Service
name: calendar.googleapis.com
title: Google Calendar API
apis:
- name: google.calendar.v3.Calendar
visibility:
rules:
- selector: "google.calendar.v3.*"
restriction: PREVIEW
backend:
rules:
- selector: "google.calendar.v3.*"
address: calendar.example.com
authentication:
providers:
- id: google_calendar_auth
jwks_uri: https://www.googleapis.com/oauth2/v1/certs
issuer: https://securetoken.google.com
rules:
- selector: "*"
requirements:
provider_id: google_calendar_auth
Field number for the "name" field.
The service name, which is a DNS-like logical identifier for the
service, such as `calendar.googleapis.com`. The service name
typically goes through DNS verification to make sure the owner
of the service also owns the DNS name.
Field number for the "title" field.
The product title for this service, it is the name displayed in Google
Cloud Console.
Field number for the "producer_project_id" field.
The Google project that owns this service.
Field number for the "id" field.
A unique ID for a specific instance of this message, typically assigned
by the client for tracking purpose. Must be no longer than 63 characters
and only lower case letters, digits, '.', '_' and '-' are allowed. If
empty, the server may choose to generate one instead.
Field number for the "apis" field.
A list of API interfaces exported by this service. Only the `name` field
of the [google.protobuf.Api][google.protobuf.Api] needs to be provided by
the configuration author, as the remaining fields will be derived from the
IDL during the normalization process. It is an error to specify an API
interface here which cannot be resolved against the associated IDL files.
Field number for the "types" field.
A list of all proto message types included in this API service.
Types referenced directly or indirectly by the `apis` are automatically
included. Messages which are not referenced but shall be included, such as
types used by the `google.protobuf.Any` type, should be listed here by
name by the configuration author. Example:
types:
- name: google.protobuf.Int32
Field number for the "enums" field.
A list of all enum types included in this API service. Enums referenced
directly or indirectly by the `apis` are automatically included. Enums
which are not referenced but shall be included should be listed here by
name by the configuration author. Example:
enums:
- name: google.someapi.v1.SomeEnum
Field number for the "documentation" field.
Additional API documentation.
Field number for the "backend" field.
API backend configuration.
Field number for the "http" field.
HTTP configuration.
Field number for the "quota" field.
Quota configuration.
Field number for the "authentication" field.
Auth configuration.
Field number for the "context" field.
Context configuration.
Field number for the "usage" field.
Configuration controlling usage of this service.
Field number for the "endpoints" field.
Configuration for network endpoints. If this is empty, then an endpoint
with the same name as the service is automatically generated to service all
defined APIs.
Field number for the "control" field.
Configuration for the service control plane.
Field number for the "logs" field.
Defines the logs used by this service.
Field number for the "metrics" field.
Defines the metrics used by this service.
Field number for the "monitored_resources" field.
Defines the monitored resources used by this service. This is required
by the [Service.monitoring][google.api.Service.monitoring] and
[Service.logging][google.api.Service.logging] configurations.
Field number for the "billing" field.
Billing configuration.
Field number for the "logging" field.
Logging configuration.
Field number for the "monitoring" field.
Monitoring configuration.
Field number for the "system_parameters" field.
System parameter configuration.
Field number for the "source_info" field.
Output only. The source information for this configuration if available.
Field number for the "publishing" field.
Settings for [Google Cloud Client
libraries](https://cloud.google.com/apis/docs/cloud-client-libraries)
generated from APIs defined as protocol buffers.
Field number for the "config_version" field.
Obsolete. Do not use.
This field has no semantic meaning. The service config compiler always
sets this field to `3`.
Holder for reflection information generated from google/api/source_info.proto
File descriptor for google/api/source_info.proto
Source information used to create a Service Config
Field number for the "source_files" field.
All files used during config generation.
Holder for reflection information generated from google/api/system_parameter.proto
File descriptor for google/api/system_parameter.proto
### System parameter configuration
A system parameter is a special kind of parameter defined by the API
system, not by an individual API. It is typically mapped to an HTTP header
and/or a URL query parameter. This configuration specifies which methods
change the names of the system parameters.
Field number for the "rules" field.
Define system parameters.
The parameters defined here will override the default parameters
implemented by the system. If this field is missing from the service
config, default system parameters will be used. Default system parameters
and names is implementation-dependent.
Example: define api key for all methods
system_parameters
rules:
- selector: "*"
parameters:
- name: api_key
url_query_parameter: api_key
Example: define 2 api key names for a specific method.
system_parameters
rules:
- selector: "/ListShelves"
parameters:
- name: api_key
http_header: Api-Key1
- name: api_key
http_header: Api-Key2
**NOTE:** All service configuration rules follow "last one wins" order.
Define a system parameter rule mapping system parameter definitions to
methods.
Field number for the "selector" field.
Selects the methods to which this rule applies. Use '*' to indicate all
methods in all APIs.
Refer to [selector][google.api.DocumentationRule.selector] for syntax
details.
Field number for the "parameters" field.
Define parameters. Multiple names may be defined for a parameter.
For a given method call, only one of them should be used. If multiple
names are used the behavior is implementation-dependent.
If none of the specified names are present the behavior is
parameter-dependent.
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.
Field number for the "name" field.
Define the name of the parameter, such as "api_key" . It is case sensitive.
Field number for the "http_header" field.
Define the HTTP header name to use for the parameter. It is case
insensitive.
Field number for the "url_query_parameter" field.
Define the URL query parameter name to use for the parameter. It is case
sensitive.
Holder for reflection information generated from google/api/usage.proto
File descriptor for google/api/usage.proto
Configuration controlling usage of a service.
Field number for the "requirements" field.
Requirements that must be satisfied before a consumer project can use the
service. Each requirement is of the form <service.name>/<requirement-id>;
for example 'serviceusage.googleapis.com/billing-enabled'.
For Google APIs, a Terms of Service requirement must be included here.
Google Cloud APIs must include "serviceusage.googleapis.com/tos/cloud".
Other Google APIs should include
"serviceusage.googleapis.com/tos/universal". Additional ToS can be
included based on the business needs.
Field number for the "rules" field.
A list of usage rules that apply to individual API methods.
**NOTE:** All service configuration rules follow "last one wins" order.
Field number for the "producer_notification_channel" field.
The full resource name of a channel used for sending notifications to the
service producer.
Google Service Management currently only supports
[Google Cloud Pub/Sub](https://cloud.google.com/pubsub) as a notification
channel. To use Google Cloud Pub/Sub as the channel, this must be the name
of a Cloud Pub/Sub topic that uses the Cloud Pub/Sub topic name format
documented in https://cloud.google.com/pubsub/docs/overview.
Usage configuration rules for the service.
NOTE: Under development.
Use this rule to configure unregistered calls for the service. Unregistered
calls are calls that do not contain consumer project identity.
(Example: calls that do not contain an API key).
By default, API methods do not allow unregistered calls, and each method call
must be identified by a consumer project identity. Use this rule to
allow/disallow unregistered calls.
Example of an API that wants to allow unregistered calls for entire service.
usage:
rules:
- selector: "*"
allow_unregistered_calls: true
Example of a method that wants to allow unregistered calls.
usage:
rules:
- selector: "google.example.library.v1.LibraryService.CreateBook"
allow_unregistered_calls: true
Field number for the "selector" field.
Selects the methods to which this rule applies. Use '*' to indicate all
methods in all APIs.
Refer to [selector][google.api.DocumentationRule.selector] for syntax
details.
Field number for the "allow_unregistered_calls" field.
If true, the selected method allows unregistered calls, e.g. calls
that don't identify any user or application.
Field number for the "skip_service_control" field.
If true, the selected method should skip service control and the control
plane features, such as quota and billing, will not be available.
This flag is used by Google Cloud Endpoints to bypass checks for internal
methods, such as service health check methods.
Holder for reflection information generated from google/api/visibility.proto
File descriptor for google/api/visibility.proto
Holder for extension identifiers generated from the top level of google/api/visibility.proto
See `VisibilityRule`.
See `VisibilityRule`.
See `VisibilityRule`.
See `VisibilityRule`.
See `VisibilityRule`.
See `VisibilityRule`.
`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 service can define multiple visibility labels, but a service consumer
should be granted at most one visibility label. Multiple visibility
labels for a single service consumer are not supported.
If an element and all its parents have no visibility label, its visibility
is unconditionally granted.
Example:
visibility:
rules:
- selector: google.calendar.Calendar.EnhancedSearch
restriction: PREVIEW
- selector: google.calendar.Calendar.Delegate
restriction: INTERNAL
Here, all methods are publicly visible except for the restricted methods
EnhancedSearch and Delegate.
Field number for the "rules" field.
A list of visibility rules that apply to individual API elements.
**NOTE:** All service configuration rules follow "last one wins" order.
A visibility rule provides visibility configuration for an individual API
element.
Field number for the "selector" field.
Selects methods, messages, fields, enums, etc. to which this rule applies.
Refer to [selector][google.api.DocumentationRule.selector] for syntax
details.
Field number for the "restriction" field.
A comma-separated list of visibility labels that apply to the `selector`.
Any of the listed labels can be used to grant the visibility.
If a rule has multiple labels, removing one of the labels but not all of
them can break clients.
Example:
visibility:
rules:
- selector: google.calendar.Calendar.EnhancedSearch
restriction: INTERNAL, PREVIEW
Removing INTERNAL from this restriction will break clients that rely on
this method and only had access to it through INTERNAL.
Holder for reflection information generated from google/rpc/code.proto
File descriptor for google/rpc/code.proto
The canonical error codes for gRPC APIs.
Sometimes multiple error codes may apply. Services should return
the most specific error code that applies. For example, prefer
`OUT_OF_RANGE` over `FAILED_PRECONDITION` if both codes apply.
Similarly prefer `NOT_FOUND` or `ALREADY_EXISTS` over `FAILED_PRECONDITION`.
Not an error; returned on success.
HTTP Mapping: 200 OK
The operation was cancelled, typically by the caller.
HTTP Mapping: 499 Client Closed Request
Unknown error. For example, this error may be returned when
a `Status` value received from another address space belongs to
an error space that is not known in this address space. Also
errors raised by APIs that do not return enough error information
may be converted to this error.
HTTP Mapping: 500 Internal Server Error
The client specified an invalid argument. Note that this differs
from `FAILED_PRECONDITION`. `INVALID_ARGUMENT` indicates arguments
that are problematic regardless of the state of the system
(e.g., a malformed file name).
HTTP Mapping: 400 Bad Request
The deadline expired before the operation could complete. For operations
that change the state of the system, this error may be returned
even if the operation has completed successfully. For example, a
successful response from a server could have been delayed long
enough for the deadline to expire.
HTTP Mapping: 504 Gateway Timeout
Some requested entity (e.g., file or directory) was not found.
Note to server developers: if a request is denied for an entire class
of users, such as gradual feature rollout or undocumented allowlist,
`NOT_FOUND` may be used. If a request is denied for some users within
a class of users, such as user-based access control, `PERMISSION_DENIED`
must be used.
HTTP Mapping: 404 Not Found
The entity that a client attempted to create (e.g., file or directory)
already exists.
HTTP Mapping: 409 Conflict
The caller does not have permission to execute the specified
operation. `PERMISSION_DENIED` must not be used for rejections
caused by exhausting some resource (use `RESOURCE_EXHAUSTED`
instead for those errors). `PERMISSION_DENIED` must not be
used if the caller can not be identified (use `UNAUTHENTICATED`
instead for those errors). This error code does not imply the
request is valid or the requested entity exists or satisfies
other pre-conditions.
HTTP Mapping: 403 Forbidden
The request does not have valid authentication credentials for the
operation.
HTTP Mapping: 401 Unauthorized
Some resource has been exhausted, perhaps a per-user quota, or
perhaps the entire file system is out of space.
HTTP Mapping: 429 Too Many Requests
The operation was rejected because the system is not in a state
required for the operation's execution. For example, the directory
to be deleted is non-empty, an rmdir operation is applied to
a non-directory, etc.
Service implementors can use the following guidelines to decide
between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`:
(a) Use `UNAVAILABLE` if the client can retry just the failing call.
(b) Use `ABORTED` if the client should retry at a higher level. For
example, when a client-specified test-and-set fails, indicating the
client should restart a read-modify-write sequence.
(c) Use `FAILED_PRECONDITION` if the client should not retry until
the system state has been explicitly fixed. For example, if an "rmdir"
fails because the directory is non-empty, `FAILED_PRECONDITION`
should be returned since the client should not retry unless
the files are deleted from the directory.
HTTP Mapping: 400 Bad Request
The operation was aborted, typically due to a concurrency issue such as
a sequencer check failure or transaction abort.
See the guidelines above for deciding between `FAILED_PRECONDITION`,
`ABORTED`, and `UNAVAILABLE`.
HTTP Mapping: 409 Conflict
The operation was attempted past the valid range. E.g., seeking or
reading past end-of-file.
Unlike `INVALID_ARGUMENT`, this error indicates a problem that may
be fixed if the system state changes. For example, a 32-bit file
system will generate `INVALID_ARGUMENT` if asked to read at an
offset that is not in the range [0,2^32-1], but it will generate
`OUT_OF_RANGE` if asked to read from an offset past the current
file size.
There is a fair bit of overlap between `FAILED_PRECONDITION` and
`OUT_OF_RANGE`. We recommend using `OUT_OF_RANGE` (the more specific
error) when it applies so that callers who are iterating through
a space can easily look for an `OUT_OF_RANGE` error to detect when
they are done.
HTTP Mapping: 400 Bad Request
The operation is not implemented or is not supported/enabled in this
service.
HTTP Mapping: 501 Not Implemented
Internal errors. This means that some invariants expected by the
underlying system have been broken. This error code is reserved
for serious errors.
HTTP Mapping: 500 Internal Server Error
The service is currently unavailable. This is most likely a
transient condition, which can be corrected by retrying with
a backoff. Note that it is not always safe to retry
non-idempotent operations.
See the guidelines above for deciding between `FAILED_PRECONDITION`,
`ABORTED`, and `UNAVAILABLE`.
HTTP Mapping: 503 Service Unavailable
Unrecoverable data loss or corruption.
HTTP Mapping: 500 Internal Server Error
Holder for reflection information generated from google/rpc/context/attribute_context.proto
File descriptor for google/rpc/context/attribute_context.proto
This message defines the standard attribute vocabulary for Google APIs.
An attribute is a piece of metadata that describes an activity on a network
service. For example, the size of an HTTP request, or the status code of
an HTTP response.
Each attribute has a type and a name, which is logically defined as
a proto message field in `AttributeContext`. The field type becomes the
attribute type, and the field path becomes the attribute name. For example,
the attribute `source.ip` maps to field `AttributeContext.source.ip`.
This message definition is guaranteed not to have any wire breaking change.
So you can use it directly for passing attributes across different systems.
NOTE: Different system may generate different subset of attributes. Please
verify the system specification before relying on an attribute generated
a system.
Field number for the "origin" field.
The origin of a network activity. In a multi hop network activity,
the origin represents the sender of the first hop. For the first hop,
the `source` and the `origin` must have the same content.
Field number for the "source" field.
The source of a network activity, such as starting a TCP connection.
In a multi hop network activity, the source represents the sender of the
last hop.
Field number for the "destination" field.
The destination of a network activity, such as accepting a TCP connection.
In a multi hop network activity, the destination represents the receiver of
the last hop.
Field number for the "request" field.
Represents a network request, such as an HTTP request.
Field number for the "response" field.
Represents a network response, such as an HTTP response.
Field number for the "resource" field.
Represents a target resource that is involved with a network activity.
If multiple resources are involved with an activity, this must be the
primary one.
Field number for the "api" field.
Represents an API operation that is involved to a network activity.
Field number for the "extensions" field.
Supports extensions for advanced use cases, such as logs and metrics.
Container for nested types declared in the AttributeContext message type.
This message defines attributes for a node that handles a network request.
The node can be either a service or an application that sends, forwards,
or receives the request. Service peers should fill in
`principal` and `labels` as appropriate.
Field number for the "ip" field.
The IP address of the peer.
Field number for the "port" field.
The network port of the peer.
Field number for the "labels" field.
The labels associated with the peer.
Field number for the "principal" field.
The identity of this peer. Similar to `Request.auth.principal`, but
relative to the peer instead of the request. For example, the
identity associated with a load balancer that forwarded the request.
Field number for the "region_code" field.
The CLDR country/region code associated with the above IP address.
If the IP address is private, the `region_code` should reflect the
physical location where this peer is running.
This message defines attributes associated with API operations, such as
a network API request. The terminology is based on the conventions used
by Google APIs, Istio, and OpenAPI.
Field number for the "service" field.
The API service name. It is a logical identifier for a networked API,
such as "pubsub.googleapis.com". The naming syntax depends on the
API management system being used for handling the request.
Field number for the "operation" field.
The API operation name. For gRPC requests, it is the fully qualified API
method name, such as "google.pubsub.v1.Publisher.Publish". For OpenAPI
requests, it is the `operationId`, such as "getPet".
Field number for the "protocol" field.
The API protocol used for sending the request, such as "http", "https",
"grpc", or "internal".
Field number for the "version" field.
The API version associated with the API operation above, such as "v1" or
"v1alpha1".
This message defines request authentication attributes. Terminology is
based on the JSON Web Token (JWT) standard, but the terms also
correlate to concepts in other standards.
Field number for the "principal" field.
The authenticated principal. Reflects the issuer (`iss`) and subject
(`sub`) claims within a JWT. The issuer and subject should be `/`
delimited, with `/` percent-encoded within the subject fragment. For
Google accounts, the principal format is:
"https://accounts.google.com/{id}"
Field number for the "audiences" field.
The intended audience(s) for this authentication information. Reflects
the audience (`aud`) claim within a JWT. The audience
value(s) depends on the `issuer`, but typically include one or more of
the following pieces of information:
* The services intended to receive the credential. For example,
["https://pubsub.googleapis.com/", "https://storage.googleapis.com/"].
* A set of service-based scopes. For example,
["https://www.googleapis.com/auth/cloud-platform"].
* The client id of an app, such as the Firebase project id for JWTs
from Firebase Auth.
Consult the documentation for the credential issuer to determine the
information provided.
Field number for the "presenter" field.
The authorized presenter of the credential. Reflects the optional
Authorized Presenter (`azp`) claim within a JWT or the
OAuth client id. For example, a Google Cloud Platform client id looks
as follows: "123456789012.apps.googleusercontent.com".
Field number for the "claims" field.
Structured claims presented with the credential. JWTs include
`{key: value}` pairs for standard and private claims. The following
is a subset of the standard required and optional claims that would
typically be presented for a Google-based JWT:
{'iss': 'accounts.google.com',
'sub': '113289723416554971153',
'aud': ['123456789012', 'pubsub.googleapis.com'],
'azp': '123456789012.apps.googleusercontent.com',
'email': 'jsmith@example.com',
'iat': 1353601026,
'exp': 1353604926}
SAML assertions are similarly specified, but with an identity provider
dependent structure.
Field number for the "access_levels" field.
A list of access level resource names that allow resources to be
accessed by authenticated requester. It is part of Secure GCP processing
for the incoming request. An access level string has the format:
"//{api_service_name}/accessPolicies/{policy_id}/accessLevels/{short_name}"
Example:
"//accesscontextmanager.googleapis.com/accessPolicies/MY_POLICY_ID/accessLevels/MY_LEVEL"
This message defines attributes for an HTTP request. If the actual
request is not an HTTP request, the runtime system should try to map
the actual request to an equivalent HTTP request.
Field number for the "id" field.
The unique ID for a request, which can be propagated to downstream
systems. The ID should have low probability of collision
within a single day for a specific service.
Field number for the "method" field.
The HTTP request method, such as `GET`, `POST`.
Field number for the "headers" field.
The HTTP request headers. If multiple headers share the same key, they
must be merged according to the HTTP spec. All header keys must be
lowercased, because HTTP header keys are case-insensitive.
Field number for the "path" field.
The HTTP URL path, excluding the query parameters.
Field number for the "host" field.
The HTTP request `Host` header value.
Field number for the "scheme" field.
The HTTP URL scheme, such as `http` and `https`.
Field number for the "query" field.
The HTTP URL query in the format of `name1=value1&name2=value2`, as it
appears in the first line of the HTTP request. No decoding is performed.
Field number for the "time" field.
The timestamp when the `destination` service receives the last byte of
the request.
Field number for the "size" field.
The HTTP request size in bytes. If unknown, it must be -1.
Field number for the "protocol" field.
The network protocol used with the request, such as "http/1.1",
"spdy/3", "h2", "h2c", "webrtc", "tcp", "udp", "quic". See
https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids
for details.
Field number for the "reason" field.
A special parameter for request reason. It is used by security systems
to associate auditing information with a request.
Field number for the "auth" field.
The request authentication. May be absent for unauthenticated requests.
Derived from the HTTP request `Authorization` header or equivalent.
This message defines attributes for a typical network response. It
generally models semantics of an HTTP response.
Field number for the "code" field.
The HTTP response status code, such as `200` and `404`.
Field number for the "size" field.
The HTTP response size in bytes. If unknown, it must be -1.
Field number for the "headers" field.
The HTTP response headers. If multiple headers share the same key, they
must be merged according to HTTP spec. All header keys must be
lowercased, because HTTP header keys are case-insensitive.
Field number for the "time" field.
The timestamp when the `destination` service sends the last byte of
the response.
Field number for the "backend_latency" field.
The amount of time it takes the backend service to fully respond to a
request. Measured from when the destination service starts to send the
request to the backend until when the destination service receives the
complete response from the backend.
This message defines core attributes for a resource. A resource is an
addressable (named) entity provided by the destination service. For
example, a file stored on a network storage service.
Field number for the "service" field.
The name of the service that this resource belongs to, such as
`pubsub.googleapis.com`. The service may be different from the DNS
hostname that actually serves the request.
Field number for the "name" field.
The stable identifier (name) of a resource on the `service`. A resource
can be logically identified as "//{resource.service}/{resource.name}".
The differences between a resource name and a URI are:
* Resource name is a logical identifier, independent of network
protocol and API version. For example,
`//pubsub.googleapis.com/projects/123/topics/news-feed`.
* URI often includes protocol and version information, so it can
be used directly by applications. For example,
`https://pubsub.googleapis.com/v1/projects/123/topics/news-feed`.
See https://cloud.google.com/apis/design/resource_names for details.
Field number for the "type" field.
The type of the resource. The syntax is platform-specific because
different platforms define their resources differently.
For Google APIs, the type format must be "{service}/{kind}", such as
"pubsub.googleapis.com/Topic".
Field number for the "labels" field.
The labels or tags on the resource, such as AWS resource tags and
Kubernetes resource labels.
Field number for the "uid" field.
The unique identifier of the resource. UID is unique in the time
and space for this resource within the scope of the service. It is
typically generated by the server on successful creation of a resource
and must not be changed. UID is used to uniquely identify resources
with resource name reuses. This should be a UUID4.
Field number for the "annotations" field.
Annotations is an unstructured key-value map stored with a resource that
may be set by external tools to store and retrieve arbitrary metadata.
They are not queryable and should be preserved when modifying objects.
More info: https://kubernetes.io/docs/user-guide/annotations
Field number for the "display_name" field.
Mutable. The display name set by clients. Must be <= 63 characters.
Field number for the "create_time" field.
Output only. The timestamp when the resource was created. This may
be either the time creation was initiated or when it was completed.
Field number for the "update_time" field.
Output only. The timestamp when the resource was last updated. Any
change to the resource made by users must refresh this value.
Changes to a resource made by the service should refresh this value.
Field number for the "delete_time" field.
Output only. The timestamp when the resource was deleted.
If the resource is not deleted, this must be empty.
Field number for the "etag" field.
Output only. An opaque value that uniquely identifies a version or
generation of a resource. It can be used to confirm that the client
and server agree on the ordering of a resource being written.
Field number for the "location" field.
Immutable. The location of the resource. The location encoding is
specific to the service provider, and new encoding may be introduced
as the service evolves.
For Google Cloud products, the encoding is what is used by Google Cloud
APIs, such as `us-east1`, `aws-us-east-1`, and `azure-eastus2`. The
semantics of `location` is identical to the
`cloud.googleapis.com/location` label used by some Google Cloud APIs.
Holder for reflection information generated from google/rpc/context/audit_context.proto
File descriptor for google/rpc/context/audit_context.proto
`AuditContext` provides information that is needed for audit logging.
Field number for the "audit_log" field.
Serialized audit log.
Field number for the "scrubbed_request" field.
An API request message that is scrubbed based on the method annotation.
This field should only be filled if audit_log field is present.
Service Control will use this to assemble a complete log for Cloud Audit
Logs and Google internal audit logs.
Field number for the "scrubbed_response" field.
An API response message that is scrubbed based on the method annotation.
This field should only be filled if audit_log field is present.
Service Control will use this to assemble a complete log for Cloud Audit
Logs and Google internal audit logs.
Field number for the "scrubbed_response_item_count" field.
Number of scrubbed response items.
Field number for the "target_resource" field.
Audit resource name which is scrubbed.
Holder for reflection information generated from google/rpc/error_details.proto
File descriptor for google/rpc/error_details.proto
Describes the cause of the error with structured details.
Example of an error when contacting the "pubsub.googleapis.com" API when it
is not enabled:
{ "reason": "API_DISABLED"
"domain": "googleapis.com"
"metadata": {
"resource": "projects/123",
"service": "pubsub.googleapis.com"
}
}
This response indicates that the pubsub.googleapis.com API is not enabled.
Example of an error that is returned when attempting to create a Spanner
instance in a region that is out of stock:
{ "reason": "STOCKOUT"
"domain": "spanner.googleapis.com",
"metadata": {
"availableRegions": "us-central1,us-east2"
}
}
Field number for the "reason" field.
The reason of the error. This is a constant value that identifies the
proximate cause of the error. Error reasons are unique within a particular
domain of errors. This should be at most 63 characters and match a
regular expression of `[A-Z][A-Z0-9_]+[A-Z0-9]`, which represents
UPPER_SNAKE_CASE.
Field number for the "domain" field.
The logical grouping to which the "reason" belongs. The error domain
is typically the registered service name of the tool or product that
generates the error. Example: "pubsub.googleapis.com". If the error is
generated by some common infrastructure, the error domain must be a
globally unique value that identifies the infrastructure. For Google API
infrastructure, the error domain is "googleapis.com".
Field number for the "metadata" field.
Additional structured details about this error.
Keys should match /[a-zA-Z0-9-_]/ and be limited to 64 characters in
length. When identifying the current value of an exceeded limit, the units
should be contained in the key, not the value. For example, rather than
{"instanceLimit": "100/request"}, should be returned as,
{"instanceLimitPerRequest": "100"}, if the client exceeds the number of
instances that can be created in a single (batch) request.
Describes when the clients can retry a failed request. Clients could ignore
the recommendation here or retry when this information is missing from error
responses.
It's always recommended that clients should use exponential backoff when
retrying.
Clients should wait until `retry_delay` amount of time has passed since
receiving the error response before retrying. If retrying requests also
fail, clients should use an exponential backoff scheme to gradually increase
the delay between retries based on `retry_delay`, until either a maximum
number of retries have been reached or a maximum retry delay cap has been
reached.
Field number for the "retry_delay" field.
Clients should wait at least this long between retrying the same request.
Describes additional debugging info.
Field number for the "stack_entries" field.
The stack trace entries indicating where the error occurred.
Field number for the "detail" field.
Additional debugging information provided by the server.
Describes how a quota check failed.
For example if a daily limit was exceeded for the calling project,
a service could respond with a QuotaFailure detail containing the project
id and the description of the quota limit that was exceeded. If the
calling project hasn't enabled the service in the developer console, then
a service could respond with the project id and set `service_disabled`
to true.
Also see RetryInfo and Help types for other details about handling a
quota failure.
Field number for the "violations" field.
Describes all quota violations.
Container for nested types declared in the QuotaFailure message type.
A message type used to describe a single quota violation. For example, a
daily quota or a custom quota that was exceeded.
Field number for the "subject" field.
The subject on which the quota check failed.
For example, "clientip:<ip address of client>" or "project:<Google
developer project id>".
Field number for the "description" field.
A description of how the quota check failed. Clients can use this
description to find more about the quota configuration in the service's
public documentation, or find the relevant quota limit to adjust through
developer console.
For example: "Service disabled" or "Daily Limit for read operations
exceeded".
Describes what preconditions have failed.
For example, if an RPC failed because it required the Terms of Service to be
acknowledged, it could list the terms of service violation in the
PreconditionFailure message.
Field number for the "violations" field.
Describes all precondition violations.
Container for nested types declared in the PreconditionFailure message type.
A message type used to describe a single precondition failure.
Field number for the "type" field.
The type of PreconditionFailure. We recommend using a service-specific
enum type to define the supported precondition violation subjects. For
example, "TOS" for "Terms of Service violation".
Field number for the "subject" field.
The subject, relative to the type, that failed.
For example, "google.com/cloud" relative to the "TOS" type would indicate
which terms of service is being referenced.
Field number for the "description" field.
A description of how the precondition failed. Developers can use this
description to understand how to fix the failure.
For example: "Terms of service not accepted".
Describes violations in a client request. This error type focuses on the
syntactic aspects of the request.
Field number for the "field_violations" field.
Describes all violations in a client request.
Container for nested types declared in the BadRequest message type.
A message type used to describe a single bad request field.
Field number for the "field" field.
A path that leads to a field in the request body. The value will be a
sequence of dot-separated identifiers that identify a protocol buffer
field.
Consider the following:
message CreateContactRequest {
message EmailAddress {
enum Type {
TYPE_UNSPECIFIED = 0;
HOME = 1;
WORK = 2;
}
optional string email = 1;
repeated EmailType type = 2;
}
string full_name = 1;
repeated EmailAddress email_addresses = 2;
}
In this example, in proto `field` could take one of the following values:
* `full_name` for a violation in the `full_name` value
* `email_addresses[1].email` for a violation in the `email` field of the
first `email_addresses` message
* `email_addresses[3].type[2]` for a violation in the second `type`
value in the third `email_addresses` message.
In JSON, the same values are represented as:
* `fullName` for a violation in the `fullName` value
* `emailAddresses[1].email` for a violation in the `email` field of the
first `emailAddresses` message
* `emailAddresses[3].type[2]` for a violation in the second `type`
value in the third `emailAddresses` message.
Field number for the "description" field.
A description of why the request element is bad.
Contains metadata about the request that clients can attach when filing a bug
or providing other forms of feedback.
Field number for the "request_id" field.
An opaque string that should only be interpreted by the service generating
it. For example, it can be used to identify requests in the service's logs.
Field number for the "serving_data" field.
Any data that was used to serve this request. For example, an encrypted
stack trace that can be sent back to the service provider for debugging.
Describes the resource that is being accessed.
Field number for the "resource_type" field.
A name for the type of resource being accessed, e.g. "sql table",
"cloud storage bucket", "file", "Google calendar"; or the type URL
of the resource: e.g. "type.googleapis.com/google.pubsub.v1.Topic".
Field number for the "resource_name" field.
The name of the resource being accessed. For example, a shared calendar
name: "example.com_4fghdhgsrgh@group.calendar.google.com", if the current
error is
[google.rpc.Code.PERMISSION_DENIED][google.rpc.Code.PERMISSION_DENIED].
Field number for the "owner" field.
The owner of the resource (optional).
For example, "user:<owner email>" or "project:<Google developer project
id>".
Field number for the "description" field.
Describes what error is encountered when accessing this resource.
For example, updating a cloud project may require the `writer` permission
on the developer console project.
Provides links to documentation or for performing an out of band action.
For example, if a quota check failed with an error indicating the calling
project hasn't enabled the accessed service, this can contain a URL pointing
directly to the right place in the developer console to flip the bit.
Field number for the "links" field.
URL(s) pointing to additional information on handling the current error.
Container for nested types declared in the Help message type.
Describes a URL link.
Field number for the "description" field.
Describes what the link offers.
Field number for the "url" field.
The URL of the link.
Provides a localized error message that is safe to return to the user
which can be attached to an RPC error.
Field number for the "locale" field.
The locale used following the specification defined at
https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
Examples are: "en-US", "fr-CH", "es-MX"
Field number for the "message" field.
The localized error message in the above locale.
Holder for reflection information generated from google/rpc/http.proto
File descriptor for google/rpc/http.proto
Represents an HTTP request.
Field number for the "method" field.
The HTTP request method.
Field number for the "uri" field.
The HTTP request URI.
Field number for the "headers" field.
The HTTP request headers. The ordering of the headers is significant.
Multiple headers with the same key may present for the request.
Field number for the "body" field.
The HTTP request body. If the body is not expected, it should be empty.
Represents an HTTP response.
Field number for the "status" field.
The HTTP status code, such as 200 or 404.
Field number for the "reason" field.
The HTTP reason phrase, such as "OK" or "Not Found".
Field number for the "headers" field.
The HTTP response headers. The ordering of the headers is significant.
Multiple headers with the same key may present for the response.
Field number for the "body" field.
The HTTP response body. If the body is not expected, it should be empty.
Represents an HTTP header.
Field number for the "key" field.
The HTTP header key. It is case insensitive.
Field number for the "value" field.
The HTTP header value.
Registry of the
standard set of error types defined in the richer error model developed and used by Google.
These can be sepcified in the .
Get the registry
Note: experimental API that can change or be removed without any prior notice.
Holder for reflection information generated from google/rpc/status.proto
File descriptor for google/rpc/status.proto
The `Status` type defines a logical error model that is suitable for
different programming environments, including REST APIs and RPC APIs. It is
used by [gRPC](https://github.com/grpc). Each `Status` message contains
three pieces of data: error code, error message, and error details.
You can find out more about this error model and how to work with it in the
[API Design Guide](https://cloud.google.com/apis/design/errors).
Field number for the "code" field.
The status code, which should be an enum value of
[google.rpc.Code][google.rpc.Code].
Field number for the "message" field.
A developer-facing error message, which should be in English. Any
user-facing error message should be localized and sent in the
[google.rpc.Status.details][google.rpc.Status.details] field, or localized
by the client.
Field number for the "details" field.
A list of messages that carry the error details. There is a common set of
message types for APIs to use.
Cache for the full names of the messages types.
The message type whose name is cached.
Retrieves the error details of type from the
message.
For example, to retrieve any that might be in the status details:
var errorInfo = status.GetDetail<ErrorInfo>();
if (errorInfo is not null)
{
// ...
}
The message type to decode from within the error details.
The first error details of type found, or null if not present.
Iterate over all the messages in the
Iterate over the messages in the that are messages
in the
standard set of error types defined in the richer error model. Any other messages found in
the Details are ignored and not returned.
Example:
foreach (var msg in status.UnpackDetailMessages())
{
switch (msg)
{
case ErrorInfo errorInfo:
// Handle errorInfo ...
break;
// Other cases ...
}
}
Iterate over all the messages in the that match types
in the given
Iterate over the messages in the that are messages
in the given . Any other messages found in the Details are ignored
and not returned. This allows iterating over custom messages if you are not using the
standard set of error types defined in the rich error model.
Example:
TypeRegistry myTypes = TypeRegistry.FromMessages(FooMessage.Descriptor, BarMessage.Descriptor);
foreach (var msg in status.UnpackDetailMessages(myTypes))
{
switch (msg)
{
case FooMessage foo:
// Handle foo ...
break;
// Other cases ...
}
}
The type registry to use to unpack detail messages.
A (possibly-empty) sequence of detail messages.
Holder for reflection information generated from google/type/calendar_period.proto
File descriptor for google/type/calendar_period.proto
A `CalendarPeriod` represents the abstract concept of a time period that has
a canonical start. Grammatically, "the start of the current
`CalendarPeriod`." All calendar times begin at midnight UTC.
Undefined period, raises an error.
A day.
A week. Weeks begin on Monday, following
[ISO 8601](https://en.wikipedia.org/wiki/ISO_week_date).
A fortnight. The first calendar fortnight of the year begins at the start
of week 1 according to
[ISO 8601](https://en.wikipedia.org/wiki/ISO_week_date).
A month.
A quarter. Quarters start on dates 1-Jan, 1-Apr, 1-Jul, and 1-Oct of each
year.
A half-year. Half-years start on dates 1-Jan and 1-Jul.
A year.
Holder for reflection information generated from google/type/color.proto
File descriptor for google/type/color.proto
Represents a color in the RGBA color space. This representation is designed
for simplicity of conversion to/from color representations in various
languages over compactness. For example, the fields of this representation
can be trivially provided to the constructor of `java.awt.Color` in Java; it
can also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha`
method in iOS; and, with just a little work, it can be easily formatted into
a CSS `rgba()` string in JavaScript.
This reference page doesn't carry information about the absolute color
space
that should be used to interpret the RGB value (e.g. sRGB, Adobe RGB,
DCI-P3, BT.2020, etc.). By default, applications should assume the sRGB color
space.
When color equality needs to be decided, implementations, unless
documented otherwise, treat two colors as equal if all their red,
green, blue, and alpha values each differ by at most 1e-5.
Example (Java):
import com.google.type.Color;
// ...
public static java.awt.Color fromProto(Color protocolor) {
float alpha = protocolor.hasAlpha()
? protocolor.getAlpha().getValue()
: 1.0;
return new java.awt.Color(
protocolor.getRed(),
protocolor.getGreen(),
protocolor.getBlue(),
alpha);
}
public static Color toProto(java.awt.Color color) {
float red = (float) color.getRed();
float green = (float) color.getGreen();
float blue = (float) color.getBlue();
float denominator = 255.0;
Color.Builder resultBuilder =
Color
.newBuilder()
.setRed(red / denominator)
.setGreen(green / denominator)
.setBlue(blue / denominator);
int alpha = color.getAlpha();
if (alpha != 255) {
result.setAlpha(
FloatValue
.newBuilder()
.setValue(((float) alpha) / denominator)
.build());
}
return resultBuilder.build();
}
// ...
Example (iOS / Obj-C):
// ...
static UIColor* fromProto(Color* protocolor) {
float red = [protocolor red];
float green = [protocolor green];
float blue = [protocolor blue];
FloatValue* alpha_wrapper = [protocolor alpha];
float alpha = 1.0;
if (alpha_wrapper != nil) {
alpha = [alpha_wrapper value];
}
return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
}
static Color* toProto(UIColor* color) {
CGFloat red, green, blue, alpha;
if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
return nil;
}
Color* result = [[Color alloc] init];
[result setRed:red];
[result setGreen:green];
[result setBlue:blue];
if (alpha <= 0.9999) {
[result setAlpha:floatWrapperWithValue(alpha)];
}
[result autorelease];
return result;
}
// ...
Example (JavaScript):
// ...
var protoToCssColor = function(rgb_color) {
var redFrac = rgb_color.red || 0.0;
var greenFrac = rgb_color.green || 0.0;
var blueFrac = rgb_color.blue || 0.0;
var red = Math.floor(redFrac * 255);
var green = Math.floor(greenFrac * 255);
var blue = Math.floor(blueFrac * 255);
if (!('alpha' in rgb_color)) {
return rgbToCssColor(red, green, blue);
}
var alphaFrac = rgb_color.alpha.value || 0.0;
var rgbParams = [red, green, blue].join(',');
return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
};
var rgbToCssColor = function(red, green, blue) {
var rgbNumber = new Number((red << 16) | (green << 8) | blue);
var hexString = rgbNumber.toString(16);
var missingZeros = 6 - hexString.length;
var resultBuilder = ['#'];
for (var i = 0; i < missingZeros; i++) {
resultBuilder.push('0');
}
resultBuilder.push(hexString);
return resultBuilder.join('');
};
// ...
Field number for the "red" field.
The amount of red in the color as a value in the interval [0, 1].
Field number for the "green" field.
The amount of green in the color as a value in the interval [0, 1].
Field number for the "blue" field.
The amount of blue in the color as a value in the interval [0, 1].
Field number for the "alpha" field.
The fraction of this color that should be applied to the pixel. That is,
the final pixel color is defined by the equation:
`pixel color = alpha * (this color) + (1.0 - alpha) * (background color)`
This means that a value of 1.0 corresponds to a solid color, whereas
a value of 0.0 corresponds to a completely transparent color. This
uses a wrapper message rather than a simple float scalar so that it is
possible to distinguish between a default value and the value being unset.
If omitted, this color object is rendered as a solid color
(as if the alpha value had been explicitly given a value of 1.0).
Holder for reflection information generated from google/type/date.proto
File descriptor for google/type/date.proto
Represents a whole or partial calendar date, such as a birthday. The time of
day and time zone are either specified elsewhere or are insignificant. The
date is relative to the Gregorian Calendar. This can represent one of the
following:
* A full date, with non-zero year, month, and day values
* A month and day value, with a zero year, such as an anniversary
* A year on its own, with zero month and day values
* A year and month value, with a zero day, such as a credit card expiration
date
Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and
`google.protobuf.Timestamp`.
Field number for the "year" field.
Year of the date. Must be from 1 to 9999, or 0 to specify a date without
a year.
Field number for the "month" field.
Month of a year. Must be from 1 to 12, or 0 to specify a year without a
month and day.
Field number for the "day" field.
Day of a month. Must be from 1 to 31 and valid for the year and month, or 0
to specify a year by itself or a year and month where the day isn't
significant.
Converts to .
The converted with time at midnight and of .
Thrown when , , and/or are not within the valid range.
Converts to .
The converted with time at midnight, of , and an of .
Thrown when , , and/or are not within the valid range.
Creates a instance from the part of .
The value being converted.
The created .
Creates a instance from the part of .
The value being converted.
The created .
Extension methods built for .
Converts the part of to .
The instance being converted.
The .
Converts the part of to .
The instance being converted.
The converted .
Holder for reflection information generated from google/type/datetime.proto
File descriptor for google/type/datetime.proto
Represents civil time (or occasionally physical time).
This type can represent a civil time in one of a few possible ways:
* When utc_offset is set and time_zone is unset: a civil time on a calendar
day with a particular offset from UTC.
* When time_zone is set and utc_offset is unset: a civil time on a calendar
day in a particular time zone.
* When neither time_zone nor utc_offset is set: a civil time on a calendar
day in local time.
The date is relative to the Proleptic Gregorian Calendar.
If year is 0, the DateTime is considered not to have a specific year. month
and day must have valid, non-zero values.
This type may also be used to represent a physical time if all the date and
time fields are set and either case of the `time_offset` oneof is set.
Consider using `Timestamp` message for physical time instead. If your use
case also would like to store the user's timezone, that can be done in
another field.
This type is more flexible than some applications may want. Make sure to
document and validate your application's limitations.
Field number for the "year" field.
Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a
datetime without a year.
Field number for the "month" field.
Required. Month of year. Must be from 1 to 12.
Field number for the "day" field.
Required. Day of month. Must be from 1 to 31 and valid for the year and
month.
Field number for the "hours" field.
Required. Hours of day in 24 hour format. Should be from 0 to 23. An API
may choose to allow the value "24:00:00" for scenarios like business
closing time.
Field number for the "minutes" field.
Required. Minutes of hour of day. Must be from 0 to 59.
Field number for the "seconds" field.
Required. Seconds of minutes of the time. Must normally be from 0 to 59. An
API may allow the value 60 if it allows leap-seconds.
Field number for the "nanos" field.
Required. Fractions of seconds in nanoseconds. Must be from 0 to
999,999,999.
Field number for the "utc_offset" field.
UTC offset. Must be whole seconds, between -18 hours and +18 hours.
For example, a UTC offset of -4:00 would be represented as
{ seconds: -14400 }.
Field number for the "time_zone" field.
Time zone.
Enum of possible cases for the "time_offset" oneof.
Represents a time zone from the
[IANA Time Zone Database](https://www.iana.org/time-zones).
Field number for the "id" field.
IANA Time Zone Database time zone, e.g. "America/New_York".
Field number for the "version" field.
Optional. IANA Time Zone Database version number, e.g. "2019a".
Holder for reflection information generated from google/type/dayofweek.proto
File descriptor for google/type/dayofweek.proto
Represents a day of the week.
The day of the week is unspecified.
Monday
Tuesday
Wednesday
Thursday
Friday
Saturday
Sunday
A representation of a decimal value, such as 2.5. Clients may convert values
into language-native decimal formats, such as Java's [BigDecimal][] or
Python's [decimal.Decimal][].
[BigDecimal]:
https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/math/BigDecimal.html
[decimal.Decimal]: https://docs.python.org/3/library/decimal.html
Converts the given value to the protobuf
representation. If the input value naturally contains trailing decimal zeroes (e.g. "1.00")
these are preserved in the protobuf representation.
The value to convert.
The protobuf representation.
Converts this protobuf value to a CLR
value. If the value is within the range of but contains
more than 29 significant digits, the returned value is truncated towards zero.
The CLR representation of this value.
This protobuf value is invalid, either because
has not been set, or because it does not represent a valid decimal value.
The protobuf value is too large or small to be represented
by .
Field number for the "value" field.
The decimal value, as a string.
The string representation consists of an optional sign, `+` (`U+002B`)
or `-` (`U+002D`), followed by a sequence of zero or more decimal digits
("the integer"), optionally followed by a fraction, optionally followed
by an exponent.
The fraction consists of a decimal point followed by zero or more decimal
digits. The string must contain at least one digit in either the integer
or the fraction. The number formed by the sign, the integer and the
fraction is referred to as the significand.
The exponent consists of the character `e` (`U+0065`) or `E` (`U+0045`)
followed by one or more decimal digits.
Services **should** normalize decimal values before storing them by:
- Removing an explicitly-provided `+` sign (`+2.5` -> `2.5`).
- Replacing a zero-length integer value with `0` (`.5` -> `0.5`).
- Coercing the exponent character to lower-case (`2.5E8` -> `2.5e8`).
- Removing an explicitly-provided zero exponent (`2.5e0` -> `2.5`).
Services **may** perform additional normalization based on its own needs
and the internal decimal implementation selected, such as shifting the
decimal point and exponent value together (example: `2.5e-1` <-> `0.25`).
Additionally, services **may** preserve trailing zeroes in the fraction
to indicate increased precision, but are not required to do so.
Note that only the `.` character is supported to divide the integer
and the fraction; `,` **should not** be supported regardless of locale.
Additionally, thousand separators **should not** be supported. If a
service does support them, values **must** be normalized.
The ENBF grammar is:
DecimalString =
[Sign] Significand [Exponent];
Sign = '+' | '-';
Significand =
Digits ['.'] [Digits] | [Digits] '.' Digits;
Exponent = ('e' | 'E') [Sign] Digits;
Digits = { '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' };
Services **should** clearly document the range of supported values, the
maximum supported precision (total number of digits), and, if applicable,
the scale (number of digits after the decimal point), as well as how it
behaves when receiving out-of-bounds values.
Services **may** choose to accept values passed as input even when the
value has a higher precision or scale than the service supports, and
**should** round the value to fit the supported scale. Alternatively, the
service **may** error with `400 Bad Request` (`INVALID_ARGUMENT` in gRPC)
if precision would be lost.
Services **should** error with `400 Bad Request` (`INVALID_ARGUMENT` in
gRPC) if the service receives a value outside of the supported range.
Holder for reflection information generated from google/type/decimal.proto
File descriptor for google/type/decimal.proto
Holder for reflection information generated from google/type/expr.proto
File descriptor for google/type/expr.proto
Represents a textual expression in the Common Expression Language (CEL)
syntax. CEL is a C-like expression language. The syntax and semantics of CEL
are documented at https://github.com/google/cel-spec.
Example (Comparison):
title: "Summary size limit"
description: "Determines if a summary is less than 100 chars"
expression: "document.summary.size() < 100"
Example (Equality):
title: "Requestor is owner"
description: "Determines if requestor is the document owner"
expression: "document.owner == request.auth.claims.email"
Example (Logic):
title: "Public documents"
description: "Determine whether the document should be publicly visible"
expression: "document.type != 'private' && document.type != 'internal'"
Example (Data Manipulation):
title: "Notification string"
description: "Create a notification string with a timestamp."
expression: "'New message received at ' + string(document.create_time)"
The exact variables and functions that may be referenced within an expression
are determined by the service that evaluates it. See the service
documentation for additional information.
Field number for the "expression" field.
Textual representation of an expression in Common Expression Language
syntax.
Field number for the "title" field.
Optional. Title for the expression, i.e. a short string describing
its purpose. This can be used e.g. in UIs which allow to enter the
expression.
Field number for the "description" field.
Optional. Description of the expression. This is a longer text which
describes the expression, e.g. when hovered over it in a UI.
Field number for the "location" field.
Optional. String indicating the location of the expression for error
reporting, e.g. a file name and a position in the file.
Holder for reflection information generated from google/type/fraction.proto
File descriptor for google/type/fraction.proto
Represents a fraction in terms of a numerator divided by a denominator.
Field number for the "numerator" field.
The numerator in the fraction, e.g. 2 in 2/3.
Field number for the "denominator" field.
The value by which the numerator is divided, e.g. 3 in 2/3. Must be
positive.
Holder for reflection information generated from google/type/interval.proto
File descriptor for google/type/interval.proto
Represents a time interval, encoded as a Timestamp start (inclusive) and a
Timestamp end (exclusive).
The start must be less than or equal to the end.
When the start equals the end, the interval is empty (matches no time).
When both start and end are unspecified, the interval matches any time.
Field number for the "start_time" field.
Optional. Inclusive start of the interval.
If specified, a Timestamp matching this interval will have to be the same
or after the start.
Field number for the "end_time" field.
Optional. Exclusive end of the interval.
If specified, a Timestamp matching this interval will have to be before the
end.
Holder for reflection information generated from google/type/latlng.proto
File descriptor for google/type/latlng.proto
An object that represents a latitude/longitude pair. This is expressed as a
pair of doubles to represent degrees latitude and degrees longitude. Unless
specified otherwise, this must conform to the
<a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84
standard</a>. Values must be within normalized ranges.
Field number for the "latitude" field.
The latitude in degrees. It must be in the range [-90.0, +90.0].
Field number for the "longitude" field.
The longitude in degrees. It must be in the range [-180.0, +180.0].
Holder for reflection information generated from google/type/localized_text.proto
File descriptor for google/type/localized_text.proto
Localized variant of a text in a particular language.
Field number for the "text" field.
Localized string in the language corresponding to `language_code' below.
Field number for the "language_code" field.
The text's BCP-47 language code, such as "en-US" or "sr-Latn".
For more information, see
http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
Holder for reflection information generated from google/type/money.proto
File descriptor for google/type/money.proto
Represents an amount of money with its currency type.
Field number for the "currency_code" field.
The three-letter currency code defined in ISO 4217.
Field number for the "units" field.
The whole units of the amount.
For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
Field number for the "nanos" field.
Number of nano (10^-9) units of the amount.
The value must be between -999,999,999 and +999,999,999 inclusive.
If `units` is positive, `nanos` must be positive or zero.
If `units` is zero, `nanos` can be positive, zero, or negative.
If `units` is negative, `nanos` must be negative or zero.
For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
The amount of money in format. This is an abstraction of the Units and Nanos properties.
Getting this property combines those property values, and setting this property will set both of those properties.
The integral part of the decimal must be a valid , and the fractional part must have a maximum of 9 digits of precision.
Holder for reflection information generated from google/type/month.proto
File descriptor for google/type/month.proto
Represents a month in the Gregorian calendar.
The unspecified month.
The month of January.
The month of February.
The month of March.
The month of April.
The month of May.
The month of June.
The month of July.
The month of August.
The month of September.
The month of October.
The month of November.
The month of December.
Holder for reflection information generated from google/type/phone_number.proto
File descriptor for google/type/phone_number.proto
An object representing a phone number, suitable as an API wire format.
This representation:
- should not be used for locale-specific formatting of a phone number, such
as "+1 (650) 253-0000 ext. 123"
- is not designed for efficient storage
- may not be suitable for dialing - specialized libraries (see references)
should be used to parse the number for that purpose
To do something meaningful with this number, such as format it for various
use-cases, convert it to an `i18n.phonenumbers.PhoneNumber` object first.
For instance, in Java this would be:
com.google.type.PhoneNumber wireProto =
com.google.type.PhoneNumber.newBuilder().build();
com.google.i18n.phonenumbers.Phonenumber.PhoneNumber phoneNumber =
PhoneNumberUtil.getInstance().parse(wireProto.getE164Number(), "ZZ");
if (!wireProto.getExtension().isEmpty()) {
phoneNumber.setExtension(wireProto.getExtension());
}
Reference(s):
- https://github.com/google/libphonenumber
Field number for the "e164_number" field.
The phone number, represented as a leading plus sign ('+'), followed by a
phone number that uses a relaxed ITU E.164 format consisting of the
country calling code (1 to 3 digits) and the subscriber number, with no
additional spaces or formatting, e.g.:
- correct: "+15552220123"
- incorrect: "+1 (555) 222-01234 x123".
The ITU E.164 format limits the latter to 12 digits, but in practice not
all countries respect that, so we relax that restriction here.
National-only numbers are not allowed.
References:
- https://www.itu.int/rec/T-REC-E.164-201011-I
- https://en.wikipedia.org/wiki/E.164.
- https://en.wikipedia.org/wiki/List_of_country_calling_codes
Gets whether the "e164_number" field is set
Clears the value of the oneof if it's currently set to "e164_number"
Field number for the "short_code" field.
A short code.
Reference(s):
- https://en.wikipedia.org/wiki/Short_code
Field number for the "extension" field.
The phone number's extension. The extension is not standardized in ITU
recommendations, except for being defined as a series of numbers with a
maximum length of 40 digits. Other than digits, some other dialing
characters such as ',' (indicating a wait) or '#' may be stored here.
Note that no regions currently use extensions with short codes, so this
field is normally only set in conjunction with an E.164 number. It is held
separately from the E.164 number to allow for short code extensions in the
future.
Enum of possible cases for the "kind" oneof.
Container for nested types declared in the PhoneNumber message type.
An object representing a short code, which is a phone number that is
typically much shorter than regular phone numbers and can be used to
address messages in MMS and SMS systems, as well as for abbreviated dialing
(e.g. "Text 611 to see how many minutes you have remaining on your plan.").
Short codes are restricted to a region and are not internationally
dialable, which means the same short code can exist in different regions,
with different usage and pricing, even if those regions share the same
country calling code (e.g. US and CA).
Field number for the "region_code" field.
Required. The BCP-47 region code of the location where calls to this
short code can be made, such as "US" and "BB".
Reference(s):
- http://www.unicode.org/reports/tr35/#unicode_region_subtag
Field number for the "number" field.
Required. The short code digits, without a leading plus ('+') or country
calling code, e.g. "611".
Holder for reflection information generated from google/type/postal_address.proto
File descriptor for google/type/postal_address.proto
Represents a postal address, e.g. for postal delivery or payments addresses.
Given a postal address, a postal service can deliver items to a premise, P.O.
Box or similar.
It is not intended to model geographical locations (roads, towns,
mountains).
In typical usage an address would be created via user input or from importing
existing data, depending on the type of process.
Advice on address input / editing:
- Use an i18n-ready address widget such as
https://github.com/google/libaddressinput)
- Users should not be presented with UI elements for input or editing of
fields outside countries where that field is used.
For more guidance on how to use this schema, please see:
https://support.google.com/business/answer/6397478
Field number for the "revision" field.
The schema revision of the `PostalAddress`. This must be set to 0, which is
the latest revision.
All new revisions **must** be backward compatible with old revisions.
Field number for the "region_code" field.
Required. CLDR region code of the country/region of the address. This
is never inferred and it is up to the user to ensure the value is
correct. See http://cldr.unicode.org/ and
http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html
for details. Example: "CH" for Switzerland.
Field number for the "language_code" field.
Optional. BCP-47 language code of the contents of this address (if
known). This is often the UI language of the input form or is expected
to match one of the languages used in the address' country/region, or their
transliterated equivalents.
This can affect formatting in certain countries, but is not critical
to the correctness of the data and will never affect any validation or
other non-formatting related operations.
If this value is not known, it should be omitted (rather than specifying a
possibly incorrect default).
Examples: "zh-Hant", "ja", "ja-Latn", "en".
Field number for the "postal_code" field.
Optional. Postal code of the address. Not all countries use or require
postal codes to be present, but where they are used, they may trigger
additional validation with other parts of the address (e.g. state/zip
validation in the U.S.A.).
Field number for the "sorting_code" field.
Optional. Additional, country-specific, sorting code. This is not used
in most regions. Where it is used, the value is either a string like
"CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number
alone, representing the "sector code" (Jamaica), "delivery area indicator"
(Malawi) or "post office indicator" (e.g. Côte d'Ivoire).
Field number for the "administrative_area" field.
Optional. Highest administrative subdivision which is used for postal
addresses of a country or region.
For example, this can be a state, a province, an oblast, or a prefecture.
Specifically, for Spain this is the province and not the autonomous
community (e.g. "Barcelona" and not "Catalonia").
Many countries don't use an administrative area in postal addresses. E.g.
in Switzerland this should be left unpopulated.
Field number for the "locality" field.
Optional. Generally refers to the city/town portion of the address.
Examples: US city, IT comune, UK post town.
In regions of the world where localities are not well defined or do not fit
into this structure well, leave locality empty and use address_lines.
Field number for the "sublocality" field.
Optional. Sublocality of the address.
For example, this can be neighborhoods, boroughs, districts.
Field number for the "address_lines" field.
Unstructured address lines describing the lower levels of an address.
Because values in address_lines do not have type information and may
sometimes contain multiple values in a single field (e.g.
"Austin, TX"), it is important that the line order is clear. The order of
address lines should be "envelope order" for the country/region of the
address. In places where this can vary (e.g. Japan), address_language is
used to make it explicit (e.g. "ja" for large-to-small ordering and
"ja-Latn" or "en" for small-to-large). This way, the most specific line of
an address can be selected based on the language.
The minimum permitted structural representation of an address consists
of a region_code with all remaining information placed in the
address_lines. It would be possible to format such an address very
approximately without geocoding, but no semantic reasoning could be
made about any of the address components until it was at least
partially resolved.
Creating an address only containing a region_code and address_lines, and
then geocoding is the recommended way to handle completely unstructured
addresses (as opposed to guessing which parts of the address should be
localities or administrative areas).
Field number for the "recipients" field.
Optional. The recipient at the address.
This field may, under certain circumstances, contain multiline information.
For example, it might contain "care of" information.
Field number for the "organization" field.
Optional. The name of the organization at the address.
Holder for reflection information generated from google/type/quaternion.proto
File descriptor for google/type/quaternion.proto
A quaternion is defined as the quotient of two directed lines in a
three-dimensional space or equivalently as the quotient of two Euclidean
vectors (https://en.wikipedia.org/wiki/Quaternion).
Quaternions are often used in calculations involving three-dimensional
rotations (https://en.wikipedia.org/wiki/Quaternions_and_spatial_rotation),
as they provide greater mathematical robustness by avoiding the gimbal lock
problems that can be encountered when using Euler angles
(https://en.wikipedia.org/wiki/Gimbal_lock).
Quaternions are generally represented in this form:
w + xi + yj + zk
where x, y, z, and w are real numbers, and i, j, and k are three imaginary
numbers.
Our naming choice `(x, y, z, w)` comes from the desire to avoid confusion for
those interested in the geometric properties of the quaternion in the 3D
Cartesian space. Other texts often use alternative names or subscripts, such
as `(a, b, c, d)`, `(1, i, j, k)`, or `(0, 1, 2, 3)`, which are perhaps
better suited for mathematical interpretations.
To avoid any confusion, as well as to maintain compatibility with a large
number of software libraries, the quaternions represented using the protocol
buffer below *must* follow the Hamilton convention, which defines `ij = k`
(i.e. a right-handed algebra), and therefore:
i^2 = j^2 = k^2 = ijk = −1
ij = −ji = k
jk = −kj = i
ki = −ik = j
Please DO NOT use this to represent quaternions that follow the JPL
convention, or any of the other quaternion flavors out there.
Definitions:
- Quaternion norm (or magnitude): `sqrt(x^2 + y^2 + z^2 + w^2)`.
- Unit (or normalized) quaternion: a quaternion whose norm is 1.
- Pure quaternion: a quaternion whose scalar component (`w`) is 0.
- Rotation quaternion: a unit quaternion used to represent rotation.
- Orientation quaternion: a unit quaternion used to represent orientation.
A quaternion can be normalized by dividing it by its norm. The resulting
quaternion maintains the same direction, but has a norm of 1, i.e. it moves
on the unit sphere. This is generally necessary for rotation and orientation
quaternions, to avoid rounding errors:
https://en.wikipedia.org/wiki/Rotation_formalisms_in_three_dimensions
Note that `(x, y, z, w)` and `(-x, -y, -z, -w)` represent the same rotation,
but normalization would be even more useful, e.g. for comparison purposes, if
it would produce a unique representation. It is thus recommended that `w` be
kept positive, which can be achieved by changing all the signs when `w` is
negative.
Field number for the "x" field.
The x component.
Field number for the "y" field.
The y component.
Field number for the "z" field.
The z component.
Field number for the "w" field.
The scalar component.
Holder for reflection information generated from google/type/timeofday.proto
File descriptor for google/type/timeofday.proto
Represents a time of day. The date and time zone are either not significant
or are specified elsewhere. An API may choose to allow leap seconds. Related
types are [google.type.Date][google.type.Date] and
`google.protobuf.Timestamp`.
Field number for the "hours" field.
Hours of day in 24 hour format. Should be from 0 to 23. An API may choose
to allow the value "24:00:00" for scenarios like business closing time.
Field number for the "minutes" field.
Minutes of hour of day. Must be from 0 to 59.
Field number for the "seconds" field.
Seconds of minutes of the time. Must normally be from 0 to 59. An API may
allow the value 60 if it allows leap-seconds.
Field number for the "nanos" field.
Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.