api

package api

Ordering

Alphabetic

Visibility

Public
All

Type Members

final case class Advice(description: String = "", unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[Advice] with Product with Serializable
Generated advice about this change, used for providing more information about how a change will affect the existing service.
Generated advice about this change, used for providing more information about how a change will affect the existing service.
description
Useful description for why this advice was applied and what actions should be taken to mitigate any implied risks.

Annotations
@SerialVersionUID()
final case class AuthProvider(id: String = "", issuer: String = "", jwksUri: String = "", audiences: String = "", authorizationUrl: String = "", unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[AuthProvider] with Product with Serializable
Configuration for an authentication provider, including support for [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).
Configuration for an authentication provider, including support for [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).
id
The unique identifier of the auth provider. It will be referred to by AuthRequirement.provider_id. Example: "bookstore_auth".
issuer
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
jwksUri
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
audiences
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
authorizationUrl
Redirect URL if JWT token is required but not present or is expired. Implement authorizationUrl of securityDefinitions in OpenAPI spec.
Annotations
@SerialVersionUID()
final case class AuthRequirement(providerId: String = "", audiences: String = "", unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[AuthRequirement] with Product with Serializable
User-defined authentication requirements, including support for [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).
User-defined authentication requirements, including support for [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).
providerId
[id][google.api.AuthProvider.id] from authentication provider. Example: provider_id: bookstore_auth
audiences
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

Annotations
@SerialVersionUID()
final case class Authentication(rules: Seq[AuthenticationRule] = _root_.scala.Seq.empty, providers: Seq[AuthProvider] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[Authentication] with Product with Serializable
Authentication defines the authentication configuration for an API.
Authentication defines the authentication configuration for an API.
Example for an API targeted for external use:
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
rules
A list of authentication rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order.
providers
Defines a set of authentication providers that a service supports.

Annotations
@SerialVersionUID()
final case class AuthenticationRule(selector: String = "", oauth: Option[OAuthRequirements] = _root_.scala.None, allowWithoutCredential: Boolean = false, requirements: Seq[AuthRequirement] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[AuthenticationRule] with Product with Serializable
Authentication rules for the service.
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.
selector
Selects the methods to which this rule applies. Refer to [selector][google.api.DocumentationRule.selector] for syntax details.
oauth
The requirements for OAuth credentials.
allowWithoutCredential
If true, the service accepts API keys without any other credential.
requirements
Requirements for additional authentication providers.

Annotations
@SerialVersionUID()
final case class Backend(rules: Seq[BackendRule] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[Backend] with Product with Serializable
Backend defines the backend configuration for a service.
Backend defines the backend configuration for a service.
rules
A list of API backend rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order.

Annotations
@SerialVersionUID()
final case class BackendRule(selector: String = "", address: String = "", deadline: Double = 0.0, minDeadline: Double = 0.0, operationDeadline: Double = 0.0, pathTranslation: PathTranslation = ..., authentication: BackendRule.Authentication = ..., unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[BackendRule] with Product with Serializable
A backend rule provides configuration for an individual API element.
A backend rule provides configuration for an individual API element.
selector
Selects the methods to which this rule applies. Refer to [selector][google.api.DocumentationRule.selector] for syntax details.
address
The address of the API backend.
deadline
The number of seconds to wait for a response from a request. The default deadline for gRPC is infinite (no deadline) and HTTP requests is 5 seconds.
minDeadline
Minimum deadline in seconds needed for this method. Calls having deadline value lower than this will be rejected.
operationDeadline
The number of seconds to wait for the completion of a long running operation. The default is no deadline.

Annotations
@SerialVersionUID()
final case class Billing(consumerDestinations: Seq[BillingDestination] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[Billing] with Product with Serializable
Billing related configuration of the service.
Billing related configuration of the service.
The following example shows how to configure monitored resources and metrics for billing:
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. metrics:
- name: library.googleapis.com/book/borrowed_count metric_kind: DELTA value_type: INT64 billing: consumer_destinations:
  - monitored_resource: library.googleapis.com/branch metrics:
    library.googleapis.com/book/borrowed_count
consumerDestinations
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.

Annotations
@SerialVersionUID()
sealed abstract class ChangeType extends GeneratedEnum
Classifies set of possible modifications to an object in the service configuration.
final case class ConfigChange(element: String = "", oldValue: String = "", newValue: String = "", changeType: ChangeType = ..., advices: Seq[Advice] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[ConfigChange] with Product with Serializable
Output generated from semantically comparing two versions of a service configuration.
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.
element
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]
oldValue
Value of the changed object in the old Service configuration, in JSON format. This field will not be populated if ChangeType == ADDED.
newValue
Value of the changed object in the new Service configuration, in JSON format. This field will not be populated if ChangeType == REMOVED.
changeType
The type for this change, either ADDED, REMOVED, or MODIFIED.
advices
Collection of advice provided for this change, useful for determining the possible impact of this change.
Annotations
@SerialVersionUID()
final case class Context(rules: Seq[ContextRule] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[Context] with Product with Serializable
Context defines which contexts an API requests.
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 whitelist 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.
rules
A list of RPC context rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order.

Annotations
@SerialVersionUID()
final case class ContextRule(selector: String = "", requested: Seq[String] = _root_.scala.Seq.empty, provided: Seq[String] = _root_.scala.Seq.empty, allowedRequestExtensions: Seq[String] = _root_.scala.Seq.empty, allowedResponseExtensions: Seq[String] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[ContextRule] with Product with Serializable
A context rule provides information about the context for an individual API element.
A context rule provides information about the context for an individual API element.
selector
Selects the methods to which this rule applies. Refer to [selector][google.api.DocumentationRule.selector] for syntax details.
requested
A list of full type names of requested contexts.
provided
A list of full type names of provided contexts.
allowedRequestExtensions
A list of full type names or extension IDs of extensions allowed in grpc side channel from client to backend.
allowedResponseExtensions
A list of full type names or extension IDs of extensions allowed in grpc side channel from backend to client.

Annotations
@SerialVersionUID()
final case class Control(environment: String = "", unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[Control] with Product with Serializable
Selects and configures the service controller used by the service.
Selects and configures the service controller used by the service. The service controller handles features like abuse, quota, billing, logging, monitoring, etc.
environment
The service control environment to use. If empty, no control plane feature (like quota and billing) will be enabled.

Annotations
@SerialVersionUID()
final case class CustomHttpPattern(kind: String = "", path: String = "", unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[CustomHttpPattern] with Product with Serializable
A custom pattern is used for defining custom HTTP verb.
A custom pattern is used for defining custom HTTP verb.
kind
The name of this custom HTTP verb.
path
The path matched by this custom verb.

Annotations
@SerialVersionUID()
final case class Distribution(count: Long = 0L, mean: Double = 0.0, sumOfSquaredDeviation: Double = 0.0, range: Option[Range] = _root_.scala.None, bucketOptions: Option[BucketOptions] = _root_.scala.None, bucketCounts: Seq[Long] = _root_.scala.Seq.empty, exemplars: Seq[Exemplar] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[Distribution] with Product with Serializable
Distribution contains summary statistics for a population of values.
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.
count
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.
mean
The arithmetic mean of the values in the population. If count is zero then this field must be zero.
sumOfSquaredDeviation
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 323, 3rd edition describes Welford's method for accumulating this sum in one pass. If count is zero then this field must be zero.
range
If specified, contains the range of the population values. The field must not be present if the count is zero.
bucketOptions
Defines the histogram bucket boundaries. If the distribution does not contain a histogram, then omit this field.
bucketCounts
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).
exemplars
Must be in increasing order of value field.

Annotations
@SerialVersionUID()
final case class Documentation(summary: String = "", pages: Seq[Page] = _root_.scala.Seq.empty, rules: Seq[DocumentationRule] = _root_.scala.Seq.empty, documentationRootUrl: String = "", overview: String = "", unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[Documentation] with Product with Serializable
Documentation provides the information for describing a service.
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.
summary
A short summary of what the service does. Can only be provided by plain text.
pages
The top level pages for the documentation set.
rules
A list of documentation rules that apply to individual API elements. **NOTE:** All service configuration rules follow "last one wins" order.
documentationRootUrl
The URL to the root of documentation.
overview
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.
Annotations
@SerialVersionUID()
final case class DocumentationRule(selector: String = "", description: String = "", deprecationDescription: String = "", unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[DocumentationRule] with Product with Serializable
A documentation rule provides information about individual API elements.
A documentation rule provides information about individual API elements.
selector
The selector is a comma-separated list of patterns. 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.
description
Description of the selected API(s).
deprecationDescription
Deprecation description of the selected element(s). It can be provided if an element is marked as deprecated.

Annotations
@SerialVersionUID()
final case class Endpoint(name: String = "", aliases: Seq[String] = _root_.scala.Seq.empty, features: Seq[String] = _root_.scala.Seq.empty, target: String = "", allowCors: Boolean = false, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[Endpoint] with Product with Serializable
Endpoint describes a network endpoint that serves a set of APIs.
Endpoint describes a network endpoint that serves a set of APIs. A service may expose any number of endpoints, and all endpoints share the same service configuration, such as quota configuration and monitoring configuration.
Example service configuration:
name: library-example.googleapis.com endpoints: # Below entry makes 'google.example.library.v1.Library' # API be served from endpoint address library-example.googleapis.com. # It also allows HTTP OPTIONS calls to be passed to the backend, for # it to decide whether the subsequent cross-origin request is # allowed to proceed.
- name: library-example.googleapis.com allow_cors: true
name
The canonical name of this endpoint.
aliases
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.
features
The list of features enabled on this endpoint.
target
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".
allowCors
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.

Annotations
@SerialVersionUID()
sealed abstract class FieldBehavior extends GeneratedEnum
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).
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.
final case class Http(rules: Seq[HttpRule] = _root_.scala.Seq.empty, fullyDecodeReservedExpansion: Boolean = false, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[Http] with Product with Serializable
Defines the HTTP configuration for an API service.
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.
rules
A list of HTTP configuration rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order.
fullyDecodeReservedExpansion
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.

Annotations
@SerialVersionUID()
final case class HttpBody(contentType: String = "", data: ByteString = ..., extensions: Seq[Any] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[HttpBody] with Product with Serializable
Message that represents an arbitrary HTTP body.
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.
contentType
The HTTP Content-Type header value specifying the content type of the body.
data
The HTTP request/response body as raw binary.
extensions
Application specific response metadata. Must be set in the first response for streaming APIs.

Annotations
@SerialVersionUID()
final case class HttpRule(selector: String = "", pattern: Pattern = ..., body: String = "", responseBody: String = "", additionalBindings: Seq[HttpRule] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[HttpRule] with Product with Serializable
# gRPC Transcoding
# 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&param=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.
selector
Selects a method to which this rule applies. Refer to [selector][google.api.DocumentationRule.selector] for syntax details.
body
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.
responseBody
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.
additionalBindings
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).

Annotations
@SerialVersionUID()
final case class LabelDescriptor(key: String = "", valueType: ValueTypeEnum = ..., description: String = "", unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[LabelDescriptor] with Product with Serializable
A description of a label.
A description of a label.
key
The label key.
valueType
The type of data that can be assigned to the label.
description
A human-readable description for the label.

Annotations
@SerialVersionUID()
sealed abstract class LaunchStage extends GeneratedEnum
The launch stage as defined by [Google Cloud Platform Launch Stages](http://cloud.google.com/terms/launch-stages).
final case class LogDescriptor(name: String = "", labels: Seq[LabelDescriptor] = _root_.scala.Seq.empty, description: String = "", displayName: String = "", unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[LogDescriptor] with Product with Serializable
A description of a log type.
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
name
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 [/_-.].
labels
The set of labels that are available to describe a specific log entry. Runtime requests that contain labels not specified here are considered invalid.
description
A human-readable description of this log. This information appears in the documentation and can contain details.
displayName
The human-readable name for this log. This information appears on the user interface and should be concise.

Annotations
@SerialVersionUID()
final case class Logging(producerDestinations: Seq[LoggingDestination] = _root_.scala.Seq.empty, consumerDestinations: Seq[LoggingDestination] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[Logging] with Product with Serializable
Logging configuration of the service.
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
producerDestinations
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.
consumerDestinations
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.

Annotations
@SerialVersionUID()
final case class Metric(type: String = "", labels: Map[String, String] = ..., unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[Metric] with Product with Serializable
A specific metric, identified by specifying values for all of the labels of a [MetricDescriptor][google.api.MetricDescriptor].
A specific metric, identified by specifying values for all of the labels of a [MetricDescriptor][google.api.MetricDescriptor].
type
An existing metric type, see [google.api.MetricDescriptor][google.api.MetricDescriptor]. For example, custom.googleapis.com/invoice/paid/amount.
labels
The set of label values that uniquely identify this metric. All labels listed in the MetricDescriptor must be assigned values.

Annotations
@SerialVersionUID()
final case class MetricDescriptor(name: String = "", type: String = "", labels: Seq[LabelDescriptor] = _root_.scala.Seq.empty, metricKind: MetricKind = ..., valueType: ValueTypeEnum = ..., unit: String = "", description: String = "", displayName: String = "", metadata: Option[MetricDescriptorMetadata] = _root_.scala.None, launchStage: LaunchStage = ..., unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[MetricDescriptor] with Product with Serializable
Defines a metric type and its schema.
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.
name
The resource name of the metric descriptor.
type
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"
labels
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.
metricKind
Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metric_kind and value_type might not be supported.
valueType
Whether the measurement is an integer, a floating-point number, etc. Some combinations of metric_kind and value_type might not be supported.
unit
The unit in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The supported units are a subset of [The Unified Code for Units of Measure](http://unitsofmeasure.org/ucum.html) standard: **Basic units (UNIT)** * bit bit * By byte * s second * min minute * h hour * d day **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) **Grammar** The grammar also includes these connectors: * / division (as an infix operator, e.g. 1/s). * . multiplication (as an infix operator, e.g. GBy.d) 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 and is equivalent to 1 if it is used alone. For examples, {requests}/s == 1/s, By{transmitted}/s == By/s. * NAME is a sequence of non-blank printable ASCII characters not containing '{' or '}'. * 1 represents dimensionless value 1, such as in 1/s. * % represents dimensionless value 1/100, and annotates values giving a percentage.
description
A detailed description of the metric, which can be used in documentation.
displayName
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.
metadata
Optional. Metadata which can be used to guide usage of the metric.
launchStage
Optional. The launch stage of the metric definition.

Annotations
@SerialVersionUID()
final case class MetricRule(selector: String = "", metricCosts: Map[String, Long] = ..., unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[MetricRule] with Product with Serializable
Bind API methods to 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.
selector
Selects the methods to which this rule applies. Refer to [selector][google.api.DocumentationRule.selector] for syntax details.
metricCosts
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.

Annotations
@SerialVersionUID()
final case class MonitoredResource(type: String = "", labels: Map[String, String] = ..., unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[MonitoredResource] with Product with Serializable
An object representing a resource that can be used for monitoring, logging, billing, or other purposes.
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 "instance_id" and "zone":
{ "type": "gce_instance", "labels": { "instance_id": "12345678901234", "zone": "us-central1-a" }}
type
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.
labels
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".

Annotations
@SerialVersionUID()
final case class MonitoredResourceDescriptor(name: String = "", type: String = "", displayName: String = "", description: String = "", labels: Seq[LabelDescriptor] = _root_.scala.Seq.empty, launchStage: LaunchStage = ..., unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[MonitoredResourceDescriptor] with Product with Serializable
An object that describes the schema of a [MonitoredResource][google.api.MonitoredResource] object using a type name and a set of labels.
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.
name
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}".
type
Required. The monitored resource type. For example, the type "cloudsql_database" represents databases in Google Cloud SQL. The maximum length of this value is 256 characters.
displayName
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".
description
Optional. A detailed description of the monitored resource type that might be used in documentation.
labels
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".
launchStage
Optional. The launch stage of the monitored resource definition.

Annotations
@SerialVersionUID()
final case class MonitoredResourceMetadata(systemLabels: Option[Struct] = _root_.scala.None, userLabels: Map[String, String] = ..., unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[MonitoredResourceMetadata] with Product with Serializable
Auxiliary metadata for a [MonitoredResource][google.api.MonitoredResource] object.
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.
systemLabels
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 }
userLabels
Output only. A map of user-defined metadata labels.

Annotations
@SerialVersionUID()
final case class Monitoring(producerDestinations: Seq[MonitoringDestination] = _root_.scala.Seq.empty, consumerDestinations: Seq[MonitoringDestination] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[Monitoring] with Product with Serializable
Monitoring configuration of the service.
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/overdue_count metric is only sent to the consumer 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. metrics:
- name: library.googleapis.com/book/returned_count metric_kind: DELTA value_type: INT64 labels:
  - key: /customer_id
- name: library.googleapis.com/book/overdue_count metric_kind: GAUGE value_type: INT64 labels:
  - key: /customer_id 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/overdue_count
producerDestinations
Monitoring configurations for sending metrics to the producer project. There can be multiple producer destinations. A monitored resouce 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.
consumerDestinations
Monitoring configurations for sending metrics to the consumer project. There can be multiple consumer destinations. A monitored resouce 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.

Annotations
@SerialVersionUID()
final case class OAuthRequirements(canonicalScopes: String = "", unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[OAuthRequirements] with Product with Serializable
OAuth scopes are a way to define data and permissions on data.
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.
canonicalScopes
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

Annotations
@SerialVersionUID()
final case class Page(name: String = "", content: String = "", subpages: Seq[Page] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[Page] with Product with Serializable
Represents a documentation page.
Represents a documentation page. A page can contain subpages to represent nested documentation set structure.
name
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].
content
The Markdown content of the page. You can use <code>(== include {path}
)</code> to include content from a Markdown file.
subpages
Subpages of this page. The order of subpages specified here will be honored in the generated docset.
Annotations
@SerialVersionUID()
final case class ProjectProperties(properties: Seq[Property] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[ProjectProperties] with Product with Serializable
A descriptor for defining project properties for a service.
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
properties
List of per consumer project-specific properties.

Annotations
@SerialVersionUID()
final case class Property(name: String = "", type: PropertyType = ..., description: String = "", unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[Property] with Product with Serializable
Defines project 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.
name
The name of the property (a.k.a key).
type
The type of this property.
description
The description of the property

Annotations
@SerialVersionUID()
final case class Quota(limits: Seq[QuotaLimit] = _root_.scala.Seq.empty, metricRules: Seq[MetricRule] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[Quota] with Product with Serializable
Quota configuration helps to achieve fairness and budgeting in service usage.
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
limits
List of QuotaLimit definitions for the service.
metricRules
List of MetricRule definitions, each one mapping a selected method to one or more metrics.

Annotations
@SerialVersionUID()
final case class QuotaLimit(name: String = "", description: String = "", defaultLimit: Long = 0L, maxLimit: Long = 0L, freeTier: Long = 0L, duration: String = "", metric: String = "", unit: String = "", values: Map[String, Long] = ..., displayName: String = "", unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[QuotaLimit] with Product with Serializable
QuotaLimit defines a specific limit that applies over a specified duration for a limit type.
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.
name
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.
description
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).
defaultLimit
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.
maxLimit
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.
freeTier
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.
duration
Duration of this limit in textual notation. Example: "100s", "24h", "1d". For duration longer than a day, only multiple of days is supported. We support only "100s" and "1d" for now. Additional support will be added in the future. "0" indicates indefinite duration. Used by group-based quotas only.
metric
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.
unit
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.
values
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.
displayName
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.

Annotations
@SerialVersionUID()
final case class ResourceDescriptor(type: String = "", pattern: Seq[String] = _root_.scala.Seq.empty, nameField: String = "", history: History = ..., plural: String = "", singular: String = "", unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[ResourceDescriptor] with Product with Serializable
A simple descriptor of a resource type.
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" name_descriptor: { pattern: "projects/{project}/topics/{topic}" parent_type: "cloudresourcemanager.googleapis.com/Project" parent_name_extractor: "projects/{project}" } }; }
The ResourceDescriptor Yaml config will look like:
resources:
- type: "pubsub.googleapis.com/Topic" name_descriptor:
  - pattern: "projects/{project}/topics/{topic}" parent_type: "cloudresourcemanager.googleapis.com/Project" parent_name_extractor: "projects/{project}"
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" name_descriptor: { pattern: "projects/{project}/logs/{log}" parent_type: "cloudresourcemanager.googleapis.com/Project" parent_name_extractor: "projects/{project}" } name_descriptor: { pattern: "folders/{folder}/logs/{log}" parent_type: "cloudresourcemanager.googleapis.com/Folder" parent_name_extractor: "folders/{folder}" } name_descriptor: { pattern: "organizations/{organization}/logs/{log}" parent_type: "cloudresourcemanager.googleapis.com/Organization" parent_name_extractor: "organizations/{organization}" } name_descriptor: { pattern: "billingAccounts/{billing_account}/logs/{log}" parent_type: "billing.googleapis.com/BillingAccount" parent_name_extractor: "billingAccounts/{billing_account}" } }; }
The ResourceDescriptor Yaml config will look like:
resources:
- type: 'logging.googleapis.com/LogEntry' name_descriptor:
  - pattern: "projects/{project}/logs/{log}" parent_type: "cloudresourcemanager.googleapis.com/Project" parent_name_extractor: "projects/{project}"
  - pattern: "folders/{folder}/logs/{log}" parent_type: "cloudresourcemanager.googleapis.com/Folder" parent_name_extractor: "folders/{folder}"
  - pattern: "organizations/{organization}/logs/{log}" parent_type: "cloudresourcemanager.googleapis.com/Organization" parent_name_extractor: "organizations/{organization}"
  - pattern: "billingAccounts/{billing_account}/logs/{log}" parent_type: "billing.googleapis.com/BillingAccount" parent_name_extractor: "billingAccounts/{billing_account}"
For flexible resources, the resource name doesn't contain parent names, but the resource itself has parents for policy evaluation.
Example:
message Shelf { option (google.api.resource) = { type: "library.googleapis.com/Shelf" name_descriptor: { pattern: "shelves/{shelf}" parent_type: "cloudresourcemanager.googleapis.com/Project" } name_descriptor: { pattern: "shelves/{shelf}" parent_type: "cloudresourcemanager.googleapis.com/Folder" } }; }
The ResourceDescriptor Yaml config will look like:
resources:
- type: 'library.googleapis.com/Shelf' name_descriptor:
  - pattern: "shelves/{shelf}" parent_type: "cloudresourcemanager.googleapis.com/Project"
  - pattern: "shelves/{shelf}" parent_type: "cloudresourcemanager.googleapis.com/Folder"
type
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.
pattern
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.
nameField
Optional. The field on the resource that designates the resource name field. If omitted, this is assumed to be "name".
history
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 }; }
plural
The plural name used in the resource name, such as 'projects' for the name of 'projects/{project}'. 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/
singular
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.
Annotations
@SerialVersionUID()
final case class ResourceReference(type: String = "", childType: String = "", unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[ResourceReference] with Product with Serializable
Defines a proto annotation that describes a string field that refers to an API resource.
Defines a proto annotation that describes a string field that refers to an API resource.
type
The resource type that the annotated field references. Example: message Subscription { string topic = 2 [(google.api.resource_reference) = { type: "pubsub.googleapis.com/Topic" }]; }
childType
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" }; }

Annotations
@SerialVersionUID()
final case class Service(configVersion: Option[Int] = _root_.scala.None, name: String = "", id: String = "", title: String = "", producerProjectId: String = "", apis: Seq[Api] = _root_.scala.Seq.empty, types: Seq[Type] = _root_.scala.Seq.empty, enums: Seq[Enum] = _root_.scala.Seq.empty, documentation: Option[Documentation] = _root_.scala.None, backend: Option[Backend] = _root_.scala.None, http: Option[Http] = _root_.scala.None, quota: Option[Quota] = _root_.scala.None, authentication: Option[Authentication] = _root_.scala.None, context: Option[Context] = _root_.scala.None, usage: Option[Usage] = _root_.scala.None, endpoints: Seq[Endpoint] = _root_.scala.Seq.empty, control: Option[Control] = _root_.scala.None, logs: Seq[LogDescriptor] = _root_.scala.Seq.empty, metrics: Seq[MetricDescriptor] = _root_.scala.Seq.empty, monitoredResources: Seq[MonitoredResourceDescriptor] = _root_.scala.Seq.empty, billing: Option[Billing] = _root_.scala.None, logging: Option[Logging] = _root_.scala.None, monitoring: Option[Monitoring] = _root_.scala.None, systemParameters: Option[SystemParameters] = _root_.scala.None, sourceInfo: Option[SourceInfo] = _root_.scala.None, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[Service] with Product with Serializable
Service is the root object of Google service configuration schema.
Service is the root object of Google service configuration schema. It describes basic information about a service, such as the name and the 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. See each proto message definition for details.
Example:
type: google.api.Service config_version: 3 name: calendar.googleapis.com title: Google Calendar API apis:
- name: google.calendar.v3.Calendar 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
configVersion
The semantic version of the service configuration. The config version affects the interpretation of the service configuration. For example, certain features are enabled by default for certain config versions. The latest config version is 3.
name
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.
id
A unique ID for a specific instance of this message, typically assigned by the client for tracking purpose. If empty, the server may choose to generate one instead. Must be no longer than 60 characters.
title
The product title for this service.
producerProjectId
The Google project that owns this service.
apis
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.
types
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. Example: types:
- name: google.protobuf.Int32
enums
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. Example: enums:
- name: google.someapi.v1.SomeEnum
documentation
Additional API documentation.
backend
API backend configuration.
http
HTTP configuration.
quota
Quota configuration.
authentication
Auth configuration.
context
Context configuration.
usage
Configuration controlling usage of this service.
endpoints
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.
control
Configuration for the service control plane.
logs
Defines the logs used by this service.
metrics
Defines the metrics used by this service.
monitoredResources
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.
billing
Billing configuration.
logging
Logging configuration.
monitoring
Monitoring configuration.
systemParameters
System parameter configuration.
sourceInfo
Output only. The source information for this configuration if available.
Annotations
@SerialVersionUID()
final case class SourceInfo(sourceFiles: Seq[Any] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[SourceInfo] with Product with Serializable
Source information used to create a Service Config
Source information used to create a Service Config
sourceFiles
All files used during config generation.

Annotations
@SerialVersionUID()
final case class SystemParameter(name: String = "", httpHeader: String = "", urlQueryParameter: String = "", unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[SystemParameter] with Product with Serializable
Define a parameter's name and location.
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.
name
Define the name of the parameter, such as "api_key" . It is case sensitive.
httpHeader
Define the HTTP header name to use for the parameter. It is case insensitive.
urlQueryParameter
Define the URL query parameter name to use for the parameter. It is case sensitive.

Annotations
@SerialVersionUID()
final case class SystemParameterRule(selector: String = "", parameters: Seq[SystemParameter] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[SystemParameterRule] with Product with Serializable
Define a system parameter rule mapping system parameter definitions to methods.
Define a system parameter rule mapping system parameter definitions to methods.
selector
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.
parameters
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.

Annotations
@SerialVersionUID()
final case class SystemParameters(rules: Seq[SystemParameterRule] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[SystemParameters] with Product with Serializable
### System parameter configuration
### 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.
rules
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.
Annotations
@SerialVersionUID()
final case class Usage(requirements: Seq[String] = _root_.scala.Seq.empty, rules: Seq[UsageRule] = _root_.scala.Seq.empty, producerNotificationChannel: String = "", unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[Usage] with Product with Serializable
Configuration controlling usage of a service.
Configuration controlling usage of a service.
requirements
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'.
rules
A list of usage rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order.
producerNotificationChannel
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.

Annotations
@SerialVersionUID()
final case class UsageRule(selector: String = "", allowUnregisteredCalls: Boolean = false, skipServiceControl: Boolean = false, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[UsageRule] with Product with Serializable
Usage configuration rules for the service.
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
selector
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.
allowUnregisteredCalls
If true, the selected method allows unregistered calls, e.g. calls that don't identify any user or application.
skipServiceControl
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.

Annotations
@SerialVersionUID()

Value Members

object Advice extends GeneratedMessageCompanion[Advice] with Serializable
object AnnotationsProto extends GeneratedFileObject
object AuthProto extends GeneratedFileObject
object AuthProvider extends GeneratedMessageCompanion[AuthProvider] with Serializable
object AuthRequirement extends GeneratedMessageCompanion[AuthRequirement] with Serializable
object Authentication extends GeneratedMessageCompanion[Authentication] with Serializable
object AuthenticationRule extends GeneratedMessageCompanion[AuthenticationRule] with Serializable
object Backend extends GeneratedMessageCompanion[Backend] with Serializable
object BackendProto extends GeneratedFileObject
object BackendRule extends GeneratedMessageCompanion[BackendRule] with Serializable
object Billing extends GeneratedMessageCompanion[Billing] with Serializable
object BillingProto extends GeneratedFileObject
object ChangeType extends GeneratedEnumCompanion[ChangeType] with Serializable
object ClientProto extends GeneratedFileObject
object ConfigChange extends GeneratedMessageCompanion[ConfigChange] with Serializable
object ConfigChangeProto extends GeneratedFileObject
object ConsumerProto extends GeneratedFileObject
object Context extends GeneratedMessageCompanion[Context] with Serializable
object ContextProto extends GeneratedFileObject
object ContextRule extends GeneratedMessageCompanion[ContextRule] with Serializable
object Control extends GeneratedMessageCompanion[Control] with Serializable
object ControlProto extends GeneratedFileObject
object CustomHttpPattern extends GeneratedMessageCompanion[CustomHttpPattern] with Serializable
object Distribution extends GeneratedMessageCompanion[Distribution] with Serializable
object DistributionProto extends GeneratedFileObject
object Documentation extends GeneratedMessageCompanion[Documentation] with Serializable
object DocumentationProto extends GeneratedFileObject
object DocumentationRule extends GeneratedMessageCompanion[DocumentationRule] with Serializable
object Endpoint extends GeneratedMessageCompanion[Endpoint] with Serializable
object EndpointProto extends GeneratedFileObject
object FieldBehavior extends GeneratedEnumCompanion[FieldBehavior] with Serializable
object FieldBehaviorProto extends GeneratedFileObject
object Http extends GeneratedMessageCompanion[Http] with Serializable
object HttpBody extends GeneratedMessageCompanion[HttpBody] with Serializable
object HttpProto extends GeneratedFileObject
object HttpRule extends GeneratedMessageCompanion[HttpRule] with Serializable
object HttpbodyProto extends GeneratedFileObject
object LabelDescriptor extends GeneratedMessageCompanion[LabelDescriptor] with Serializable
object LabelProto extends GeneratedFileObject
object LaunchStage extends GeneratedEnumCompanion[LaunchStage] with Serializable
object LaunchStageProto extends GeneratedFileObject
object LogDescriptor extends GeneratedMessageCompanion[LogDescriptor] with Serializable
object LogProto extends GeneratedFileObject
object Logging extends GeneratedMessageCompanion[Logging] with Serializable
object LoggingProto extends GeneratedFileObject
object Metric extends GeneratedMessageCompanion[Metric] with Serializable
object MetricDescriptor extends GeneratedMessageCompanion[MetricDescriptor] with Serializable
object MetricProto extends GeneratedFileObject
object MetricRule extends GeneratedMessageCompanion[MetricRule] with Serializable
object MonitoredResource extends GeneratedMessageCompanion[MonitoredResource] with Serializable
object MonitoredResourceDescriptor extends GeneratedMessageCompanion[MonitoredResourceDescriptor] with Serializable
object MonitoredResourceMetadata extends GeneratedMessageCompanion[MonitoredResourceMetadata] with Serializable
object MonitoredResourceProto extends GeneratedFileObject
object Monitoring extends GeneratedMessageCompanion[Monitoring] with Serializable
object MonitoringProto extends GeneratedFileObject
object OAuthRequirements extends GeneratedMessageCompanion[OAuthRequirements] with Serializable
object Page extends GeneratedMessageCompanion[Page] with Serializable
object ProjectProperties extends GeneratedMessageCompanion[ProjectProperties] with Serializable
object Property extends GeneratedMessageCompanion[Property] with Serializable
object Quota extends GeneratedMessageCompanion[Quota] with Serializable
object QuotaLimit extends GeneratedMessageCompanion[QuotaLimit] with Serializable
object QuotaProto extends GeneratedFileObject
object ResourceDescriptor extends GeneratedMessageCompanion[ResourceDescriptor] with Serializable
object ResourceProto extends GeneratedFileObject
object ResourceReference extends GeneratedMessageCompanion[ResourceReference] with Serializable
object Service extends GeneratedMessageCompanion[Service] with Serializable
object ServiceProto extends GeneratedFileObject
object SourceInfo extends GeneratedMessageCompanion[SourceInfo] with Serializable
object SourceInfoProto extends GeneratedFileObject
object SystemParameter extends GeneratedMessageCompanion[SystemParameter] with Serializable
object SystemParameterProto extends GeneratedFileObject
object SystemParameterRule extends GeneratedMessageCompanion[SystemParameterRule] with Serializable
object SystemParameters extends GeneratedMessageCompanion[SystemParameters] with Serializable
object Usage extends GeneratedMessageCompanion[Usage] with Serializable
object UsageProto extends GeneratedFileObject
object UsageRule extends GeneratedMessageCompanion[UsageRule] with Serializable

Packages

api

package api

Type Members

)</code> to include content from a Markdown file.

Value Members

Ungrouped

Packages

api 

package api

Type Members

&#41;</code> to include content from a Markdown file.

Value Members

Ungrouped

api

)</code> to include content from a Markdown file.