Update documentation
diff --git a/docs/dyn/servicemanagement_v1.services.configs.html b/docs/dyn/servicemanagement_v1.services.configs.html
new file mode 100644
index 0000000..01578cb
--- /dev/null
+++ b/docs/dyn/servicemanagement_v1.services.configs.html
@@ -0,0 +1,5574 @@
+<html><body>
+<style>
+
+body, h1, h2, h3, div, span, p, pre, a {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-weight: inherit;
+ font-style: inherit;
+ font-size: 100%;
+ font-family: inherit;
+ vertical-align: baseline;
+}
+
+body {
+ font-size: 13px;
+ padding: 1em;
+}
+
+h1 {
+ font-size: 26px;
+ margin-bottom: 1em;
+}
+
+h2 {
+ font-size: 24px;
+ margin-bottom: 1em;
+}
+
+h3 {
+ font-size: 20px;
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+pre, code {
+ line-height: 1.5;
+ font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
+}
+
+pre {
+ margin-top: 0.5em;
+}
+
+h1, h2, h3, p {
+ font-family: Arial, sans serif;
+}
+
+h1, h2, h3 {
+ border-bottom: solid #CCC 1px;
+}
+
+.toc_element {
+ margin-top: 0.5em;
+}
+
+.firstline {
+ margin-left: 2 em;
+}
+
+.method {
+ margin-top: 1em;
+ border: solid 1px #CCC;
+ padding: 1em;
+ background: #EEE;
+}
+
+.details {
+ font-weight: bold;
+ font-size: 14px;
+}
+
+</style>
+
+<h1><a href="servicemanagement_v1.html">Google Service Management API</a> . <a href="servicemanagement_v1.services.html">services</a> . <a href="servicemanagement_v1.services.configs.html">configs</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#create">create(serviceName=None, body, x__xgafv=None)</a></code></p>
+<p class="firstline">Creates a new service configuration (version) for a managed service.</p>
+<p class="toc_element">
+ <code><a href="#get">get(serviceName=None, configId, x__xgafv=None)</a></code></p>
+<p class="firstline">Gets a service configuration (version) for a managed service.</p>
+<p class="toc_element">
+ <code><a href="#list">list(serviceName=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Lists the history of the service configuration for a managed service,</p>
+<p class="toc_element">
+ <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
+<p class="firstline">Retrieves the next page of results.</p>
+<p class="toc_element">
+ <code><a href="#submit">submit(serviceName=None, body, x__xgafv=None)</a></code></p>
+<p class="firstline">Creates a new service configuration (version) for a managed service based</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="create">create(serviceName=None, body, x__xgafv=None)</code>
+ <pre>Creates a new service configuration (version) for a managed service.
+This method only stores the service configuration. To roll out the service
+configuration to backend systems please call
+CreateServiceRollout.
+
+Args:
+ serviceName: string, The name of the service. See the [overview](/service-management/overview)
+for naming requirements. For example: `example.googleapis.com`. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # `Service` is the root object of the configuration schema. It
+ # describes basic information like the name of the service and the
+ # exposed API interfaces, and delegates other aspects to configuration
+ # sub-sections.
+ #
+ # Example:
+ #
+ # type: google.api.Service
+ # config_version: 1
+ # name: calendar.googleapis.com
+ # title: Google Calendar API
+ # apis:
+ # - name: google.calendar.Calendar
+ # backend:
+ # rules:
+ # - selector: "*"
+ # address: calendar.example.com
+ "control": { # Selects and configures the service controller used by the service. The # Configuration for the service control plane.
+ # service controller handles features like abuse, quota, billing, logging,
+ # monitoring, etc.
+ "environment": "A String", # The service control environment to use. If empty, no control plane
+ # feature (like quota and billing) will be enabled.
+ },
+ "monitoredResources": [ # Defines the monitored resources used by this service. This is required
+ # by the Service.monitoring and Service.logging configurations.
+ { # An object that describes the schema of a 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.
+ "type": "A String", # 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.
+ "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"`.
+ { # A description of a label.
+ "valueType": "A String", # The type of data that can be assigned to the label.
+ "description": "A String", # A human-readable description for the label.
+ "key": "A String", # The label key.
+ },
+ ],
+ "displayName": "A String", # Optional. A concise name for the monitored resource type that might be
+ # displayed in user interfaces. For example, `"Google Cloud SQL Database"`.
+ "description": "A String", # Optional. A detailed description of the monitored resource type that might
+ # be used in documentation.
+ "name": "A String", # 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}"`.
+ },
+ ],
+ "logs": [ # Defines the logs used by this service.
+ { # 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
+ "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.
+ { # A description of a label.
+ "valueType": "A String", # The type of data that can be assigned to the label.
+ "description": "A String", # A human-readable description for the label.
+ "key": "A String", # The label key.
+ },
+ ],
+ "displayName": "A String", # The human-readable name for this log. This information appears on
+ # the user interface and should be concise.
+ "description": "A String", # A human-readable description of this log. This information appears in
+ # the documentation and can contain details.
+ "name": "A String", # 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 [/_-.].
+ },
+ ],
+ "systemParameters": { # ### System parameter configuration # Configuration for system parameters.
+ #
+ # 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 and alt name for all methods
+ #
+ # system_parameters
+ # rules:
+ # - selector: "*"
+ # parameters:
+ # - name: api_key
+ # url_query_parameter: api_key
+ # - name: alt
+ # http_header: Response-Content-Type
+ #
+ # 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.
+ "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.
+ { # 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.
+ "urlQueryParameter": "A String", # Define the URL query parameter name to use for the parameter. It is case
+ # sensitive.
+ "name": "A String", # Define the name of the parameter, such as "api_key", "alt", "callback",
+ # and etc. It is case sensitive.
+ "httpHeader": "A String", # Define the HTTP header name to use for the parameter. It is case
+ # insensitive.
+ },
+ ],
+ "selector": "A String", # Selects the methods to which this rule applies. Use '*' to indicate all
+ # methods in all APIs.
+ #
+ # Refer to selector for syntax details.
+ },
+ ],
+ },
+ "backend": { # `Backend` defines the backend configuration for a service. # API backend configuration.
+ "rules": [ # 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.
+ "selector": "A String", # Selects the methods to which this rule applies.
+ #
+ # Refer to selector for syntax details.
+ "deadline": 3.14, # The number of seconds to wait for a response from a request. The
+ # default depends on the deployment context.
+ "address": "A String", # The address of the API backend.
+ },
+ ],
+ },
+ "monitoring": { # 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, each one must have a
+ # different monitored resource type. A metric can be used in at most
+ # one producer destination.
+ { # Configuration of a specific monitoring destination (the producer project
+ # or the consumer project).
+ "monitoredResource": "A String", # The monitored resource type. The type must be defined in
+ # Service.monitored_resources section.
+ "metrics": [ # Names of the metrics to report to this monitoring destination.
+ # Each name must be defined in Service.metrics section.
+ "A String",
+ ],
+ },
+ ],
+ "consumerDestinations": [ # Monitoring configurations for sending metrics to the consumer project.
+ # There can be multiple consumer destinations, each one must have a
+ # different monitored resource type. A metric can be used in at most
+ # one consumer destination.
+ { # Configuration of a specific monitoring destination (the producer project
+ # or the consumer project).
+ "monitoredResource": "A String", # The monitored resource type. The type must be defined in
+ # Service.monitored_resources section.
+ "metrics": [ # Names of the metrics to report to this monitoring destination.
+ # Each name must be defined in Service.metrics section.
+ "A String",
+ ],
+ },
+ ],
+ },
+ "title": "A String", # The product title associated with this service.
+ "id": "A String", # 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.
+ "authentication": { # `Authentication` defines the authentication configuration for an API. # Auth configuration.
+ #
+ # Example for an API targeted for external use:
+ #
+ # name: calendar.googleapis.com
+ # authentication:
+ # rules:
+ # - selector: "*"
+ # oauth:
+ # canonical_scopes: https://www.googleapis.com/auth/calendar
+ #
+ # - selector: google.calendar.Delegate
+ # oauth:
+ # canonical_scopes: https://www.googleapis.com/auth/calendar.read
+ "rules": [ # A list of authentication rules that apply to individual API methods.
+ #
+ # **NOTE:** All service configuration rules follow "last one wins" order.
+ { # 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.
+ "oauth": { # OAuth scopes are a way to define data and permissions on data. For example, # The requirements for OAuth credentials.
+ # 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": "A String", # 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
+ },
+ "requirements": [ # Requirements for additional authentication providers.
+ { # User-defined authentication requirements, including support for
+ # [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).
+ "providerId": "A String", # id from authentication provider.
+ #
+ # Example:
+ #
+ # provider_id: bookstore_auth
+ "audiences": "A String", # 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/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
+ },
+ ],
+ "allowWithoutCredential": True or False, # Whether to allow requests without a credential. If quota is enabled, an
+ # API key is required for such request to pass the quota check.
+ "selector": "A String", # Selects the methods to which this rule applies.
+ #
+ # Refer to selector for syntax details.
+ },
+ ],
+ "providers": [ # Defines a set of authentication providers that a service supports.
+ { # Configuration for an anthentication provider, including support for
+ # [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).
+ "jwksUri": "A String", # 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
+ "id": "A String", # The unique identifier of the auth provider. It will be referred to by
+ # `AuthRequirement.provider_id`.
+ #
+ # Example: "bookstore_auth".
+ "issuer": "A String", # 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
+ },
+ ],
+ },
+ "usage": { # Configuration controlling usage of a service. # Configuration controlling usage of this service.
+ "rules": [ # A list of usage rules that apply to individual API methods.
+ #
+ # **NOTE:** All service configuration rules follow "last one wins" order.
+ { # 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": "A String", # Selects the methods to which this rule applies. Use '*' to indicate all
+ # methods in all APIs.
+ #
+ # Refer to selector for syntax details.
+ "allowUnregisteredCalls": True or False, # True, if the method allows unregistered calls; false otherwise.
+ },
+ ],
+ "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'.
+ "A String",
+ ],
+ },
+ "configVersion": 42, # The version of the service configuration. The config version may
+ # influence interpretation of the configuration, for example, to
+ # determine defaults. This is documented together with applicable
+ # options. The current default for the config version itself is `3`.
+ "producerProjectId": "A String", # The id of the Google developer project that owns the service.
+ # Members of this project can manage the service configuration,
+ # manage consumption of the service, etc.
+ "http": { # Defines the HTTP configuration for a service. It contains a list of # HTTP configuration.
+ # 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.
+ { # `HttpRule` defines the mapping of an RPC method to one or more HTTP
+ # REST APIs. The mapping determines what portions of the request
+ # message are populated from the path, query parameters, or body of
+ # the HTTP request. The mapping is typically specified as an
+ # `google.api.http` annotation, see "google/api/annotations.proto"
+ # for details.
+ #
+ # The mapping consists of a field specifying the path template and
+ # method kind. The path template can refer to fields in the request
+ # message, as in the example below which describes a REST GET
+ # operation on a resource collection of messages:
+ #
+ # ```proto
+ # service Messaging {
+ # rpc GetMessage(GetMessageRequest) returns (Message) {
+ # option (google.api.http).get = "/v1/messages/{message_id}/{sub.subfield}";
+ # }
+ # }
+ # message GetMessageRequest {
+ # message SubMessage {
+ # string subfield = 1;
+ # }
+ # string message_id = 1; // mapped to the URL
+ # SubMessage sub = 2; // `sub.subfield` is url-mapped
+ # }
+ # message Message {
+ # string text = 1; // content of the resource
+ # }
+ # ```
+ #
+ # This definition enables an automatic, bidrectional mapping of HTTP
+ # JSON to RPC. Example:
+ #
+ # HTTP | RPC
+ # -----|-----
+ # `GET /v1/messages/123456/foo` | `GetMessage(message_id: "123456" sub: SubMessage(subfield: "foo"))`
+ #
+ # In general, not only fields but also field paths can be referenced
+ # from a path pattern. Fields mapped to the path pattern cannot be
+ # repeated and must have a primitive (non-message) type.
+ #
+ # Any fields in the request message which are not bound by the path
+ # pattern automatically become (optional) HTTP query
+ # parameters. Assume the following definition of the request message:
+ #
+ # ```proto
+ # message GetMessageRequest {
+ # message SubMessage {
+ # string subfield = 1;
+ # }
+ # string message_id = 1; // mapped to the URL
+ # int64 revision = 2; // becomes a parameter
+ # SubMessage sub = 3; // `sub.subfield` becomes a parameter
+ # }
+ # ```
+ #
+ # This enables a HTTP JSON to RPC mapping as below:
+ #
+ # HTTP | RPC
+ # -----|-----
+ # `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 HTTP parameters must have a
+ # primitive type or a repeated primitive type. Message types are not
+ # allowed. In the case of a repeated type, the parameter can be
+ # repeated in the URL, as in `...?param=A¶m=B`.
+ #
+ # For HTTP method kinds which allow a request body, the `body` field
+ # specifies the mapping. Consider a REST update method on the
+ # message resource collection:
+ #
+ # ```proto
+ # service Messaging {
+ # rpc UpdateMessage(UpdateMessageRequest) returns (Message) {
+ # option (google.api.http) = {
+ # put: "/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 | RPC
+ # -----|-----
+ # `PUT /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:
+ #
+ # ```proto
+ # service Messaging {
+ # rpc UpdateMessage(Message) returns (Message) {
+ # option (google.api.http) = {
+ # put: "/v1/messages/{message_id}"
+ # body: "*"
+ # };
+ # }
+ # }
+ # message Message {
+ # string message_id = 1;
+ # string text = 2;
+ # }
+ # ```
+ #
+ # The following HTTP JSON to RPC mapping is enabled:
+ #
+ # HTTP | RPC
+ # -----|-----
+ # `PUT /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 of
+ # 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:
+ #
+ # ```proto
+ # 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 | RPC
+ # -----|-----
+ # `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
+ #
+ # The rules for mapping HTTP path, query parameters, and body fields
+ # to the request message are as follows:
+ #
+ # 1. The `body` field specifies either `*` or a field path, or is
+ # omitted. If omitted, it assumes there is no HTTP body.
+ # 2. Leaf fields (recursive expansion of nested messages in the
+ # request) can be classified into three types:
+ # (a) Matched in the URL template.
+ # (b) Covered by body (if body is `*`, everything except (a) fields;
+ # else everything under the body field)
+ # (c) All other fields.
+ # 3. URL query parameters found in the HTTP request are mapped to (c) fields.
+ # 4. Any body sent with an HTTP request can contain only (b) fields.
+ #
+ # The syntax of the path template is as follows:
+ #
+ # Template = "/" Segments [ Verb ] ;
+ # Segments = Segment { "/" Segment } ;
+ # Segment = "*" | "**" | LITERAL | Variable ;
+ # Variable = "{" FieldPath [ "=" Segments ] "}" ;
+ # FieldPath = IDENT { "." IDENT } ;
+ # Verb = ":" LITERAL ;
+ #
+ # The syntax `*` matches a single path segment. It follows the semantics of
+ # [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String
+ # Expansion.
+ #
+ # The syntax `**` matches zero or more path segments. It follows the semantics
+ # of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.3 Reserved
+ # Expansion.
+ #
+ # The syntax `LITERAL` matches literal text in the URL path.
+ #
+ # The syntax `Variable` matches the entire path as specified by its template;
+ # this nested template must not contain further variables. If a variable
+ # matches a single path segment, its template may be omitted, e.g. `{var}`
+ # is equivalent to `{var=*}`.
+ #
+ # NOTE: the field paths in variables and in the `body` must not refer to
+ # repeated fields or map fields.
+ #
+ # Use CustomHttpPattern to specify any HTTP method that is not included in the
+ # `pattern` field, such as HEAD, or "*" to leave the HTTP method unspecified for
+ # a given URL path rule. The wild-card rule is useful for services that provide
+ # content to Web (HTML) clients.
+ "body": "A String", # The name of the request field whose value is mapped to the HTTP body, or
+ # `*` for mapping all fields not captured by the path pattern to the HTTP
+ # body. NOTE: the referred field must not be a repeated field and must be
+ # present at the top-level of response message type.
+ "get": "A String", # Used for listing and getting information about resources.
+ "mediaDownload": { # Do not use this. For media support, add instead # Do not use this. For media support, add instead
+ # [][google.bytestream.RestByteStream] as an API to your
+ # configuration.
+ # [][google.bytestream.RestByteStream] as an API to your
+ # configuration.
+ "enabled": True or False, # Whether download is enabled.
+ },
+ "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).
+ # Object with schema name: HttpRule
+ ],
+ "mediaUpload": { # Do not use this. For media support, add instead # Do not use this. For media support, add instead
+ # [][google.bytestream.RestByteStream] as an API to your
+ # configuration.
+ # [][google.bytestream.RestByteStream] as an API to your
+ # configuration.
+ "enabled": True or False, # Whether upload is enabled.
+ },
+ "custom": { # A custom pattern is used for defining custom HTTP verb. # Custom pattern is used for defining custom verbs.
+ "path": "A String", # The path matched by this custom verb.
+ "kind": "A String", # The name of this custom HTTP verb.
+ },
+ "responseBody": "A String", # The name of the response field whose value is mapped to the HTTP body of
+ # response. Other response fields are ignored. This field is optional. When
+ # not set, the response message will be used as HTTP body of response.
+ # NOTE: the referred field must be not a repeated field and must be present
+ # at the top-level of response message type.
+ "put": "A String", # Used for updating a resource.
+ "patch": "A String", # Used for updating a resource.
+ "post": "A String", # Used for creating a resource.
+ "selector": "A String", # Selects methods to which this rule applies.
+ #
+ # Refer to selector for syntax details.
+ "delete": "A String", # Used for deleting a resource.
+ },
+ ],
+ },
+ "apis": [ # A list of API interfaces exported by this service. Only the `name` field
+ # of the 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.
+ { # Api is a light-weight descriptor for a protocol buffer service.
+ "methods": [ # The methods of this api, in unspecified order.
+ { # Method represents a method of an api.
+ "name": "A String", # The simple name of this method.
+ "requestStreaming": True or False, # If true, the request is streamed.
+ "responseTypeUrl": "A String", # The URL of the output message type.
+ "requestTypeUrl": "A String", # A URL of the input message type.
+ "responseStreaming": True or False, # If true, the response is streamed.
+ "syntax": "A String", # The source syntax of this method.
+ "options": [ # Any metadata attached to the method.
+ { # A protocol buffer option, which can be attached to a message, field,
+ # enumeration, etc.
+ "name": "A String", # The option's name. For example, `"java_package"`.
+ "value": { # The option's value. For example, `"com.google.protobuf"`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ },
+ ],
+ },
+ ],
+ "sourceContext": { # `SourceContext` represents information about the source of a # Source context for the protocol buffer service represented by this
+ # message.
+ # protobuf element, like the file in which it is defined.
+ "fileName": "A String", # The path-qualified name of the .proto file that contained the associated
+ # protobuf element. For example: `"google/protobuf/source_context.proto"`.
+ },
+ "mixins": [ # Included APIs. See Mixin.
+ { # Declares an API to be included in this API. The including API must
+ # redeclare all the methods from the included API, but documentation
+ # and options are inherited as follows:
+ #
+ # - If after comment and whitespace stripping, the documentation
+ # string of the redeclared method is empty, it will be inherited
+ # from the original method.
+ #
+ # - Each annotation belonging to the service config (http,
+ # visibility) which is not set in the redeclared method will be
+ # inherited.
+ #
+ # - If an http annotation is inherited, the path pattern will be
+ # modified as follows. Any version prefix will be replaced by the
+ # version of the including API plus the root path if specified.
+ #
+ # Example of a simple mixin:
+ #
+ # package google.acl.v1;
+ # service AccessControl {
+ # // Get the underlying ACL object.
+ # rpc GetAcl(GetAclRequest) returns (Acl) {
+ # option (google.api.http).get = "/v1/{resource=**}:getAcl";
+ # }
+ # }
+ #
+ # package google.storage.v2;
+ # service Storage {
+ # // rpc GetAcl(GetAclRequest) returns (Acl);
+ #
+ # // Get a data record.
+ # rpc GetData(GetDataRequest) returns (Data) {
+ # option (google.api.http).get = "/v2/{resource=**}";
+ # }
+ # }
+ #
+ # Example of a mixin configuration:
+ #
+ # apis:
+ # - name: google.storage.v2.Storage
+ # mixins:
+ # - name: google.acl.v1.AccessControl
+ #
+ # The mixin construct implies that all methods in `AccessControl` are
+ # also declared with same name and request/response types in
+ # `Storage`. A documentation generator or annotation processor will
+ # see the effective `Storage.GetAcl` method after inherting
+ # documentation and annotations as follows:
+ #
+ # service Storage {
+ # // Get the underlying ACL object.
+ # rpc GetAcl(GetAclRequest) returns (Acl) {
+ # option (google.api.http).get = "/v2/{resource=**}:getAcl";
+ # }
+ # ...
+ # }
+ #
+ # Note how the version in the path pattern changed from `v1` to `v2`.
+ #
+ # If the `root` field in the mixin is specified, it should be a
+ # relative path under which inherited HTTP paths are placed. Example:
+ #
+ # apis:
+ # - name: google.storage.v2.Storage
+ # mixins:
+ # - name: google.acl.v1.AccessControl
+ # root: acls
+ #
+ # This implies the following inherited HTTP annotation:
+ #
+ # service Storage {
+ # // Get the underlying ACL object.
+ # rpc GetAcl(GetAclRequest) returns (Acl) {
+ # option (google.api.http).get = "/v2/acls/{resource=**}:getAcl";
+ # }
+ # ...
+ # }
+ "root": "A String", # If non-empty specifies a path under which inherited HTTP paths
+ # are rooted.
+ "name": "A String", # The fully qualified name of the API which is included.
+ },
+ ],
+ "syntax": "A String", # The source syntax of the service.
+ "version": "A String", # A version string for this api. If specified, must have the form
+ # `major-version.minor-version`, as in `1.10`. If the minor version
+ # is omitted, it defaults to zero. If the entire version field is
+ # empty, the major version is derived from the package name, as
+ # outlined below. If the field is not empty, the version in the
+ # package name will be verified to be consistent with what is
+ # provided here.
+ #
+ # The versioning schema uses [semantic
+ # versioning](http://semver.org) where the major version number
+ # indicates a breaking change and the minor version an additive,
+ # non-breaking change. Both version numbers are signals to users
+ # what to expect from different versions, and should be carefully
+ # chosen based on the product plan.
+ #
+ # The major version is also reflected in the package name of the
+ # API, which must end in `v<major-version>`, as in
+ # `google.feature.v1`. For major versions 0 and 1, the suffix can
+ # be omitted. Zero major versions must only be used for
+ # experimental, none-GA apis.
+ "options": [ # Any metadata attached to the API.
+ { # A protocol buffer option, which can be attached to a message, field,
+ # enumeration, etc.
+ "name": "A String", # The option's name. For example, `"java_package"`.
+ "value": { # The option's value. For example, `"com.google.protobuf"`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ },
+ ],
+ "name": "A String", # The fully qualified name of this api, including package name
+ # followed by the api's simple name.
+ },
+ ],
+ "customError": { # Customize service error responses. For example, list any service # Custom error configuration.
+ # specific protobuf types that can appear in error detail lists of
+ # error responses.
+ #
+ # Example:
+ #
+ # custom_error:
+ # types:
+ # - google.foo.v1.CustomError
+ # - google.foo.v1.AnotherError
+ "rules": [ # The list of custom error rules that apply to individual API messages.
+ #
+ # **NOTE:** All service configuration rules follow "last one wins" order.
+ { # A custom error rule.
+ "isErrorType": True or False, # Mark this message as possible payload in error response. Otherwise,
+ # objects of this type will be filtered when they appear in error payload.
+ "selector": "A String", # Selects messages to which this rule applies.
+ #
+ # Refer to selector for syntax details.
+ },
+ ],
+ "types": [ # The list of custom error detail types, e.g. 'google.foo.v1.CustomError'.
+ "A String",
+ ],
+ },
+ "visibility": { # `Visibility` defines restrictions for the visibility of service # API visibility configuration.
+ # elements. Restrictions are specified using visibility labels
+ # (e.g., TRUSTED_TESTER) that are elsewhere linked to users and projects.
+ #
+ # Users and projects can have access to more than one visibility label. The
+ # effective visibility for multiple labels is the union of each label's
+ # elements, plus any unrestricted elements.
+ #
+ # If an element and its parents have no restrictions, visibility is
+ # unconditionally granted.
+ #
+ # Example:
+ #
+ # visibility:
+ # rules:
+ # - selector: google.calendar.Calendar.EnhancedSearch
+ # restriction: TRUSTED_TESTER
+ # - selector: google.calendar.Calendar.Delegate
+ # restriction: GOOGLE_INTERNAL
+ #
+ # Here, all methods are publicly visible except for the restricted methods
+ # EnhancedSearch and Delegate.
+ "rules": [ # 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.
+ "restriction": "A String", # Lists the visibility labels for this rule. Any of the listed labels grants
+ # visibility to the element.
+ #
+ # 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: GOOGLE_INTERNAL, TRUSTED_TESTER
+ #
+ # Removing GOOGLE_INTERNAL from this restriction will break clients that
+ # rely on this method and only had access to it through GOOGLE_INTERNAL.
+ "selector": "A String", # Selects methods, messages, fields, enums, etc. to which this rule applies.
+ #
+ # Refer to selector for syntax details.
+ },
+ ],
+ },
+ "metrics": [ # Defines the metrics used by this service.
+ { # Defines a metric type and its schema.
+ "displayName": "A String", # A concise name for the metric, which can be displayed in user interfaces.
+ # Use sentence case without an ending period, for example "Request count".
+ "description": "A String", # A detailed description of the metric, which can be used in documentation.
+ "metricKind": "A String", # Whether the metric records instantaneous values, changes to a value, etc.
+ "valueType": "A String", # Whether the measurement is an integer, a floating-point number, etc.
+ "labels": [ # The set of labels that can be used to describe a specific instance of this
+ # metric type. For example, the
+ # `compute.googleapis.com/instance/network/received_bytes_count` metric type
+ # has a label, `loadbalanced`, that specifies whether the traffic was
+ # received through a load balanced IP address.
+ { # A description of a label.
+ "valueType": "A String", # The type of data that can be assigned to the label.
+ "description": "A String", # A human-readable description for the label.
+ "key": "A String", # The label key.
+ },
+ ],
+ "type": "A String", # The metric type including a DNS name prefix, for example
+ # `"compute.googleapis.com/instance/cpu/utilization"`. Metric types
+ # should use a natural hierarchical grouping such as the following:
+ #
+ # compute.googleapis.com/instance/cpu/utilization
+ # compute.googleapis.com/instance/disk/read_ops_count
+ # compute.googleapis.com/instance/network/received_bytes_count
+ #
+ # Note that if the metric type changes, the monitoring data will be
+ # discontinued, and anything depends on it will break, such as monitoring
+ # dashboards, alerting rules and quota limits. Therefore, once a metric has
+ # been published, its type should be immutable.
+ "unit": "A String", # 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 includes the dimensionless unit `1`, such as `1/s`.
+ #
+ # 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 '}'.
+ "name": "A String", # Resource name. The format of the name may vary between different
+ # implementations. For examples:
+ #
+ # projects/{project_id}/metricDescriptors/{type=**}
+ # metricDescriptors/{type=**}
+ },
+ ],
+ "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
+ { # Enum type definition.
+ "sourceContext": { # `SourceContext` represents information about the source of a # The source context.
+ # protobuf element, like the file in which it is defined.
+ "fileName": "A String", # The path-qualified name of the .proto file that contained the associated
+ # protobuf element. For example: `"google/protobuf/source_context.proto"`.
+ },
+ "enumvalue": [ # Enum value definitions.
+ { # Enum value definition.
+ "number": 42, # Enum value number.
+ "options": [ # Protocol buffer options.
+ { # A protocol buffer option, which can be attached to a message, field,
+ # enumeration, etc.
+ "name": "A String", # The option's name. For example, `"java_package"`.
+ "value": { # The option's value. For example, `"com.google.protobuf"`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ },
+ ],
+ "name": "A String", # Enum value name.
+ },
+ ],
+ "options": [ # Protocol buffer options.
+ { # A protocol buffer option, which can be attached to a message, field,
+ # enumeration, etc.
+ "name": "A String", # The option's name. For example, `"java_package"`.
+ "value": { # The option's value. For example, `"com.google.protobuf"`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ },
+ ],
+ "name": "A String", # Enum type name.
+ "syntax": "A String", # The source syntax.
+ },
+ ],
+ "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
+ { # A protocol buffer message type.
+ "oneofs": [ # The list of types appearing in `oneof` definitions in this type.
+ "A String",
+ ],
+ "name": "A String", # The fully qualified message name.
+ "sourceContext": { # `SourceContext` represents information about the source of a # The source context.
+ # protobuf element, like the file in which it is defined.
+ "fileName": "A String", # The path-qualified name of the .proto file that contained the associated
+ # protobuf element. For example: `"google/protobuf/source_context.proto"`.
+ },
+ "syntax": "A String", # The source syntax.
+ "fields": [ # The list of fields.
+ { # A single field of a message type.
+ "kind": "A String", # The field type.
+ "oneofIndex": 42, # The index of the field type in `Type.oneofs`, for message or enumeration
+ # types. The first type has index 1; zero means the type is not in the list.
+ "typeUrl": "A String", # The field type URL, without the scheme, for message or enumeration
+ # types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`.
+ "name": "A String", # The field name.
+ "defaultValue": "A String", # The string value of the default value of this field. Proto2 syntax only.
+ "jsonName": "A String", # The field JSON name.
+ "number": 42, # The field number.
+ "cardinality": "A String", # The field cardinality.
+ "options": [ # The protocol buffer options.
+ { # A protocol buffer option, which can be attached to a message, field,
+ # enumeration, etc.
+ "name": "A String", # The option's name. For example, `"java_package"`.
+ "value": { # The option's value. For example, `"com.google.protobuf"`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ },
+ ],
+ "packed": True or False, # Whether to use alternative packed wire representation.
+ },
+ ],
+ "options": [ # The protocol buffer options.
+ { # A protocol buffer option, which can be attached to a message, field,
+ # enumeration, etc.
+ "name": "A String", # The option's name. For example, `"java_package"`.
+ "value": { # The option's value. For example, `"com.google.protobuf"`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ },
+ ],
+ },
+ ],
+ "logging": { # 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 `library.googleapis.com/activity_history` log is
+ # sent to both the producer and consumer projects, whereas
+ # the `library.googleapis.com/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: library.googleapis.com/activity_history
+ # labels:
+ # - key: /customer_id
+ # - name: library.googleapis.com/purchase_history
+ # logging:
+ # producer_destinations:
+ # - monitored_resource: library.googleapis.com/branch
+ # logs:
+ # - library.googleapis.com/activity_history
+ # - library.googleapis.com/purchase_history
+ # consumer_destinations:
+ # - monitored_resource: library.googleapis.com/branch
+ # logs:
+ # - library.googleapis.com/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.
+ { # Configuration of a specific logging destination (the producer project
+ # or the consumer project).
+ "monitoredResource": "A String", # The monitored resource type. The type must be defined in
+ # Service.monitored_resources section.
+ "logs": [ # Names of the logs to be sent to this destination. Each name must
+ # be defined in the Service.logs section.
+ "A String",
+ ],
+ },
+ ],
+ "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.
+ { # Configuration of a specific logging destination (the producer project
+ # or the consumer project).
+ "monitoredResource": "A String", # The monitored resource type. The type must be defined in
+ # Service.monitored_resources section.
+ "logs": [ # Names of the logs to be sent to this destination. Each name must
+ # be defined in the Service.logs section.
+ "A String",
+ ],
+ },
+ ],
+ },
+ "name": "A String", # The DNS address at which this service is available,
+ # e.g. `calendar.googleapis.com`.
+ "documentation": { # `Documentation` provides the information for describing a service. # Additional API documentation.
+ #
+ # 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>
+ # Comments can be made conditional using a visibility label. The below
+ # text will be only rendered if the `BETA` label is available:
+ # <pre><code>(--BETA: comment for BETA users --)</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.
+ "rules": [ # A list of documentation rules that apply to individual API elements.
+ #
+ # **NOTE:** All service configuration rules follow "last one wins" order.
+ { # A documentation rule provides information about individual API elements.
+ "description": "A String", # Description of the selected API(s).
+ "deprecationDescription": "A String", # Deprecation description of the selected element(s). It can be provided if an
+ # element is marked as `deprecated`.
+ "selector": "A String", # 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". To
+ # specify a default for all applicable elements, the whole pattern "*"
+ # is used.
+ },
+ ],
+ "overview": "A String", # 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.
+ "summary": "A String", # A short summary of what the service does. Can only be provided by
+ # plain text.
+ "pages": [ # The top level pages for the documentation set.
+ { # Represents a documentation page. A page can contain subpages to represent
+ # nested documentation set structure.
+ "content": "A String", # 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.
+ # Object with schema name: Page
+ ],
+ "name": "A String", # 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`.
+ },
+ ],
+ "documentationRootUrl": "A String", # The URL to the root of documentation.
+ },
+ "systemTypes": [ # A list of all proto message types included in this API service.
+ # It serves similar purpose as [google.api.Service.types], except that
+ # these types are not needed by user-defined APIs. Therefore, they will not
+ # show up in the generated discovery doc. This field should only be used
+ # to define system APIs in ESF.
+ { # A protocol buffer message type.
+ "oneofs": [ # The list of types appearing in `oneof` definitions in this type.
+ "A String",
+ ],
+ "name": "A String", # The fully qualified message name.
+ "sourceContext": { # `SourceContext` represents information about the source of a # The source context.
+ # protobuf element, like the file in which it is defined.
+ "fileName": "A String", # The path-qualified name of the .proto file that contained the associated
+ # protobuf element. For example: `"google/protobuf/source_context.proto"`.
+ },
+ "syntax": "A String", # The source syntax.
+ "fields": [ # The list of fields.
+ { # A single field of a message type.
+ "kind": "A String", # The field type.
+ "oneofIndex": 42, # The index of the field type in `Type.oneofs`, for message or enumeration
+ # types. The first type has index 1; zero means the type is not in the list.
+ "typeUrl": "A String", # The field type URL, without the scheme, for message or enumeration
+ # types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`.
+ "name": "A String", # The field name.
+ "defaultValue": "A String", # The string value of the default value of this field. Proto2 syntax only.
+ "jsonName": "A String", # The field JSON name.
+ "number": 42, # The field number.
+ "cardinality": "A String", # The field cardinality.
+ "options": [ # The protocol buffer options.
+ { # A protocol buffer option, which can be attached to a message, field,
+ # enumeration, etc.
+ "name": "A String", # The option's name. For example, `"java_package"`.
+ "value": { # The option's value. For example, `"com.google.protobuf"`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ },
+ ],
+ "packed": True or False, # Whether to use alternative packed wire representation.
+ },
+ ],
+ "options": [ # The protocol buffer options.
+ { # A protocol buffer option, which can be attached to a message, field,
+ # enumeration, etc.
+ "name": "A String", # The option's name. For example, `"java_package"`.
+ "value": { # The option's value. For example, `"com.google.protobuf"`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ },
+ ],
+ },
+ ],
+ "context": { # `Context` defines which contexts an API requests. # Context configuration.
+ #
+ # 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`.
+ "rules": [ # 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.
+ "provided": [ # A list of full type names of provided contexts.
+ "A String",
+ ],
+ "requested": [ # A list of full type names of requested contexts.
+ "A String",
+ ],
+ "selector": "A String", # Selects the methods to which this rule applies.
+ #
+ # Refer to selector for syntax details.
+ },
+ ],
+ },
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # `Service` is the root object of the configuration schema. It
+ # describes basic information like the name of the service and the
+ # exposed API interfaces, and delegates other aspects to configuration
+ # sub-sections.
+ #
+ # Example:
+ #
+ # type: google.api.Service
+ # config_version: 1
+ # name: calendar.googleapis.com
+ # title: Google Calendar API
+ # apis:
+ # - name: google.calendar.Calendar
+ # backend:
+ # rules:
+ # - selector: "*"
+ # address: calendar.example.com
+ "control": { # Selects and configures the service controller used by the service. The # Configuration for the service control plane.
+ # service controller handles features like abuse, quota, billing, logging,
+ # monitoring, etc.
+ "environment": "A String", # The service control environment to use. If empty, no control plane
+ # feature (like quota and billing) will be enabled.
+ },
+ "monitoredResources": [ # Defines the monitored resources used by this service. This is required
+ # by the Service.monitoring and Service.logging configurations.
+ { # An object that describes the schema of a 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.
+ "type": "A String", # 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.
+ "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"`.
+ { # A description of a label.
+ "valueType": "A String", # The type of data that can be assigned to the label.
+ "description": "A String", # A human-readable description for the label.
+ "key": "A String", # The label key.
+ },
+ ],
+ "displayName": "A String", # Optional. A concise name for the monitored resource type that might be
+ # displayed in user interfaces. For example, `"Google Cloud SQL Database"`.
+ "description": "A String", # Optional. A detailed description of the monitored resource type that might
+ # be used in documentation.
+ "name": "A String", # 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}"`.
+ },
+ ],
+ "logs": [ # Defines the logs used by this service.
+ { # 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
+ "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.
+ { # A description of a label.
+ "valueType": "A String", # The type of data that can be assigned to the label.
+ "description": "A String", # A human-readable description for the label.
+ "key": "A String", # The label key.
+ },
+ ],
+ "displayName": "A String", # The human-readable name for this log. This information appears on
+ # the user interface and should be concise.
+ "description": "A String", # A human-readable description of this log. This information appears in
+ # the documentation and can contain details.
+ "name": "A String", # 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 [/_-.].
+ },
+ ],
+ "systemParameters": { # ### System parameter configuration # Configuration for system parameters.
+ #
+ # 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 and alt name for all methods
+ #
+ # system_parameters
+ # rules:
+ # - selector: "*"
+ # parameters:
+ # - name: api_key
+ # url_query_parameter: api_key
+ # - name: alt
+ # http_header: Response-Content-Type
+ #
+ # 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.
+ "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.
+ { # 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.
+ "urlQueryParameter": "A String", # Define the URL query parameter name to use for the parameter. It is case
+ # sensitive.
+ "name": "A String", # Define the name of the parameter, such as "api_key", "alt", "callback",
+ # and etc. It is case sensitive.
+ "httpHeader": "A String", # Define the HTTP header name to use for the parameter. It is case
+ # insensitive.
+ },
+ ],
+ "selector": "A String", # Selects the methods to which this rule applies. Use '*' to indicate all
+ # methods in all APIs.
+ #
+ # Refer to selector for syntax details.
+ },
+ ],
+ },
+ "backend": { # `Backend` defines the backend configuration for a service. # API backend configuration.
+ "rules": [ # 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.
+ "selector": "A String", # Selects the methods to which this rule applies.
+ #
+ # Refer to selector for syntax details.
+ "deadline": 3.14, # The number of seconds to wait for a response from a request. The
+ # default depends on the deployment context.
+ "address": "A String", # The address of the API backend.
+ },
+ ],
+ },
+ "monitoring": { # 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, each one must have a
+ # different monitored resource type. A metric can be used in at most
+ # one producer destination.
+ { # Configuration of a specific monitoring destination (the producer project
+ # or the consumer project).
+ "monitoredResource": "A String", # The monitored resource type. The type must be defined in
+ # Service.monitored_resources section.
+ "metrics": [ # Names of the metrics to report to this monitoring destination.
+ # Each name must be defined in Service.metrics section.
+ "A String",
+ ],
+ },
+ ],
+ "consumerDestinations": [ # Monitoring configurations for sending metrics to the consumer project.
+ # There can be multiple consumer destinations, each one must have a
+ # different monitored resource type. A metric can be used in at most
+ # one consumer destination.
+ { # Configuration of a specific monitoring destination (the producer project
+ # or the consumer project).
+ "monitoredResource": "A String", # The monitored resource type. The type must be defined in
+ # Service.monitored_resources section.
+ "metrics": [ # Names of the metrics to report to this monitoring destination.
+ # Each name must be defined in Service.metrics section.
+ "A String",
+ ],
+ },
+ ],
+ },
+ "title": "A String", # The product title associated with this service.
+ "id": "A String", # 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.
+ "authentication": { # `Authentication` defines the authentication configuration for an API. # Auth configuration.
+ #
+ # Example for an API targeted for external use:
+ #
+ # name: calendar.googleapis.com
+ # authentication:
+ # rules:
+ # - selector: "*"
+ # oauth:
+ # canonical_scopes: https://www.googleapis.com/auth/calendar
+ #
+ # - selector: google.calendar.Delegate
+ # oauth:
+ # canonical_scopes: https://www.googleapis.com/auth/calendar.read
+ "rules": [ # A list of authentication rules that apply to individual API methods.
+ #
+ # **NOTE:** All service configuration rules follow "last one wins" order.
+ { # 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.
+ "oauth": { # OAuth scopes are a way to define data and permissions on data. For example, # The requirements for OAuth credentials.
+ # 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": "A String", # 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
+ },
+ "requirements": [ # Requirements for additional authentication providers.
+ { # User-defined authentication requirements, including support for
+ # [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).
+ "providerId": "A String", # id from authentication provider.
+ #
+ # Example:
+ #
+ # provider_id: bookstore_auth
+ "audiences": "A String", # 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/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
+ },
+ ],
+ "allowWithoutCredential": True or False, # Whether to allow requests without a credential. If quota is enabled, an
+ # API key is required for such request to pass the quota check.
+ "selector": "A String", # Selects the methods to which this rule applies.
+ #
+ # Refer to selector for syntax details.
+ },
+ ],
+ "providers": [ # Defines a set of authentication providers that a service supports.
+ { # Configuration for an anthentication provider, including support for
+ # [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).
+ "jwksUri": "A String", # 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
+ "id": "A String", # The unique identifier of the auth provider. It will be referred to by
+ # `AuthRequirement.provider_id`.
+ #
+ # Example: "bookstore_auth".
+ "issuer": "A String", # 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
+ },
+ ],
+ },
+ "usage": { # Configuration controlling usage of a service. # Configuration controlling usage of this service.
+ "rules": [ # A list of usage rules that apply to individual API methods.
+ #
+ # **NOTE:** All service configuration rules follow "last one wins" order.
+ { # 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": "A String", # Selects the methods to which this rule applies. Use '*' to indicate all
+ # methods in all APIs.
+ #
+ # Refer to selector for syntax details.
+ "allowUnregisteredCalls": True or False, # True, if the method allows unregistered calls; false otherwise.
+ },
+ ],
+ "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'.
+ "A String",
+ ],
+ },
+ "configVersion": 42, # The version of the service configuration. The config version may
+ # influence interpretation of the configuration, for example, to
+ # determine defaults. This is documented together with applicable
+ # options. The current default for the config version itself is `3`.
+ "producerProjectId": "A String", # The id of the Google developer project that owns the service.
+ # Members of this project can manage the service configuration,
+ # manage consumption of the service, etc.
+ "http": { # Defines the HTTP configuration for a service. It contains a list of # HTTP configuration.
+ # 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.
+ { # `HttpRule` defines the mapping of an RPC method to one or more HTTP
+ # REST APIs. The mapping determines what portions of the request
+ # message are populated from the path, query parameters, or body of
+ # the HTTP request. The mapping is typically specified as an
+ # `google.api.http` annotation, see "google/api/annotations.proto"
+ # for details.
+ #
+ # The mapping consists of a field specifying the path template and
+ # method kind. The path template can refer to fields in the request
+ # message, as in the example below which describes a REST GET
+ # operation on a resource collection of messages:
+ #
+ # ```proto
+ # service Messaging {
+ # rpc GetMessage(GetMessageRequest) returns (Message) {
+ # option (google.api.http).get = "/v1/messages/{message_id}/{sub.subfield}";
+ # }
+ # }
+ # message GetMessageRequest {
+ # message SubMessage {
+ # string subfield = 1;
+ # }
+ # string message_id = 1; // mapped to the URL
+ # SubMessage sub = 2; // `sub.subfield` is url-mapped
+ # }
+ # message Message {
+ # string text = 1; // content of the resource
+ # }
+ # ```
+ #
+ # This definition enables an automatic, bidrectional mapping of HTTP
+ # JSON to RPC. Example:
+ #
+ # HTTP | RPC
+ # -----|-----
+ # `GET /v1/messages/123456/foo` | `GetMessage(message_id: "123456" sub: SubMessage(subfield: "foo"))`
+ #
+ # In general, not only fields but also field paths can be referenced
+ # from a path pattern. Fields mapped to the path pattern cannot be
+ # repeated and must have a primitive (non-message) type.
+ #
+ # Any fields in the request message which are not bound by the path
+ # pattern automatically become (optional) HTTP query
+ # parameters. Assume the following definition of the request message:
+ #
+ # ```proto
+ # message GetMessageRequest {
+ # message SubMessage {
+ # string subfield = 1;
+ # }
+ # string message_id = 1; // mapped to the URL
+ # int64 revision = 2; // becomes a parameter
+ # SubMessage sub = 3; // `sub.subfield` becomes a parameter
+ # }
+ # ```
+ #
+ # This enables a HTTP JSON to RPC mapping as below:
+ #
+ # HTTP | RPC
+ # -----|-----
+ # `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 HTTP parameters must have a
+ # primitive type or a repeated primitive type. Message types are not
+ # allowed. In the case of a repeated type, the parameter can be
+ # repeated in the URL, as in `...?param=A¶m=B`.
+ #
+ # For HTTP method kinds which allow a request body, the `body` field
+ # specifies the mapping. Consider a REST update method on the
+ # message resource collection:
+ #
+ # ```proto
+ # service Messaging {
+ # rpc UpdateMessage(UpdateMessageRequest) returns (Message) {
+ # option (google.api.http) = {
+ # put: "/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 | RPC
+ # -----|-----
+ # `PUT /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:
+ #
+ # ```proto
+ # service Messaging {
+ # rpc UpdateMessage(Message) returns (Message) {
+ # option (google.api.http) = {
+ # put: "/v1/messages/{message_id}"
+ # body: "*"
+ # };
+ # }
+ # }
+ # message Message {
+ # string message_id = 1;
+ # string text = 2;
+ # }
+ # ```
+ #
+ # The following HTTP JSON to RPC mapping is enabled:
+ #
+ # HTTP | RPC
+ # -----|-----
+ # `PUT /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 of
+ # 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:
+ #
+ # ```proto
+ # 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 | RPC
+ # -----|-----
+ # `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
+ #
+ # The rules for mapping HTTP path, query parameters, and body fields
+ # to the request message are as follows:
+ #
+ # 1. The `body` field specifies either `*` or a field path, or is
+ # omitted. If omitted, it assumes there is no HTTP body.
+ # 2. Leaf fields (recursive expansion of nested messages in the
+ # request) can be classified into three types:
+ # (a) Matched in the URL template.
+ # (b) Covered by body (if body is `*`, everything except (a) fields;
+ # else everything under the body field)
+ # (c) All other fields.
+ # 3. URL query parameters found in the HTTP request are mapped to (c) fields.
+ # 4. Any body sent with an HTTP request can contain only (b) fields.
+ #
+ # The syntax of the path template is as follows:
+ #
+ # Template = "/" Segments [ Verb ] ;
+ # Segments = Segment { "/" Segment } ;
+ # Segment = "*" | "**" | LITERAL | Variable ;
+ # Variable = "{" FieldPath [ "=" Segments ] "}" ;
+ # FieldPath = IDENT { "." IDENT } ;
+ # Verb = ":" LITERAL ;
+ #
+ # The syntax `*` matches a single path segment. It follows the semantics of
+ # [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String
+ # Expansion.
+ #
+ # The syntax `**` matches zero or more path segments. It follows the semantics
+ # of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.3 Reserved
+ # Expansion.
+ #
+ # The syntax `LITERAL` matches literal text in the URL path.
+ #
+ # The syntax `Variable` matches the entire path as specified by its template;
+ # this nested template must not contain further variables. If a variable
+ # matches a single path segment, its template may be omitted, e.g. `{var}`
+ # is equivalent to `{var=*}`.
+ #
+ # NOTE: the field paths in variables and in the `body` must not refer to
+ # repeated fields or map fields.
+ #
+ # Use CustomHttpPattern to specify any HTTP method that is not included in the
+ # `pattern` field, such as HEAD, or "*" to leave the HTTP method unspecified for
+ # a given URL path rule. The wild-card rule is useful for services that provide
+ # content to Web (HTML) clients.
+ "body": "A String", # The name of the request field whose value is mapped to the HTTP body, or
+ # `*` for mapping all fields not captured by the path pattern to the HTTP
+ # body. NOTE: the referred field must not be a repeated field and must be
+ # present at the top-level of response message type.
+ "get": "A String", # Used for listing and getting information about resources.
+ "mediaDownload": { # Do not use this. For media support, add instead # Do not use this. For media support, add instead
+ # [][google.bytestream.RestByteStream] as an API to your
+ # configuration.
+ # [][google.bytestream.RestByteStream] as an API to your
+ # configuration.
+ "enabled": True or False, # Whether download is enabled.
+ },
+ "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).
+ # Object with schema name: HttpRule
+ ],
+ "mediaUpload": { # Do not use this. For media support, add instead # Do not use this. For media support, add instead
+ # [][google.bytestream.RestByteStream] as an API to your
+ # configuration.
+ # [][google.bytestream.RestByteStream] as an API to your
+ # configuration.
+ "enabled": True or False, # Whether upload is enabled.
+ },
+ "custom": { # A custom pattern is used for defining custom HTTP verb. # Custom pattern is used for defining custom verbs.
+ "path": "A String", # The path matched by this custom verb.
+ "kind": "A String", # The name of this custom HTTP verb.
+ },
+ "responseBody": "A String", # The name of the response field whose value is mapped to the HTTP body of
+ # response. Other response fields are ignored. This field is optional. When
+ # not set, the response message will be used as HTTP body of response.
+ # NOTE: the referred field must be not a repeated field and must be present
+ # at the top-level of response message type.
+ "put": "A String", # Used for updating a resource.
+ "patch": "A String", # Used for updating a resource.
+ "post": "A String", # Used for creating a resource.
+ "selector": "A String", # Selects methods to which this rule applies.
+ #
+ # Refer to selector for syntax details.
+ "delete": "A String", # Used for deleting a resource.
+ },
+ ],
+ },
+ "apis": [ # A list of API interfaces exported by this service. Only the `name` field
+ # of the 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.
+ { # Api is a light-weight descriptor for a protocol buffer service.
+ "methods": [ # The methods of this api, in unspecified order.
+ { # Method represents a method of an api.
+ "name": "A String", # The simple name of this method.
+ "requestStreaming": True or False, # If true, the request is streamed.
+ "responseTypeUrl": "A String", # The URL of the output message type.
+ "requestTypeUrl": "A String", # A URL of the input message type.
+ "responseStreaming": True or False, # If true, the response is streamed.
+ "syntax": "A String", # The source syntax of this method.
+ "options": [ # Any metadata attached to the method.
+ { # A protocol buffer option, which can be attached to a message, field,
+ # enumeration, etc.
+ "name": "A String", # The option's name. For example, `"java_package"`.
+ "value": { # The option's value. For example, `"com.google.protobuf"`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ },
+ ],
+ },
+ ],
+ "sourceContext": { # `SourceContext` represents information about the source of a # Source context for the protocol buffer service represented by this
+ # message.
+ # protobuf element, like the file in which it is defined.
+ "fileName": "A String", # The path-qualified name of the .proto file that contained the associated
+ # protobuf element. For example: `"google/protobuf/source_context.proto"`.
+ },
+ "mixins": [ # Included APIs. See Mixin.
+ { # Declares an API to be included in this API. The including API must
+ # redeclare all the methods from the included API, but documentation
+ # and options are inherited as follows:
+ #
+ # - If after comment and whitespace stripping, the documentation
+ # string of the redeclared method is empty, it will be inherited
+ # from the original method.
+ #
+ # - Each annotation belonging to the service config (http,
+ # visibility) which is not set in the redeclared method will be
+ # inherited.
+ #
+ # - If an http annotation is inherited, the path pattern will be
+ # modified as follows. Any version prefix will be replaced by the
+ # version of the including API plus the root path if specified.
+ #
+ # Example of a simple mixin:
+ #
+ # package google.acl.v1;
+ # service AccessControl {
+ # // Get the underlying ACL object.
+ # rpc GetAcl(GetAclRequest) returns (Acl) {
+ # option (google.api.http).get = "/v1/{resource=**}:getAcl";
+ # }
+ # }
+ #
+ # package google.storage.v2;
+ # service Storage {
+ # // rpc GetAcl(GetAclRequest) returns (Acl);
+ #
+ # // Get a data record.
+ # rpc GetData(GetDataRequest) returns (Data) {
+ # option (google.api.http).get = "/v2/{resource=**}";
+ # }
+ # }
+ #
+ # Example of a mixin configuration:
+ #
+ # apis:
+ # - name: google.storage.v2.Storage
+ # mixins:
+ # - name: google.acl.v1.AccessControl
+ #
+ # The mixin construct implies that all methods in `AccessControl` are
+ # also declared with same name and request/response types in
+ # `Storage`. A documentation generator or annotation processor will
+ # see the effective `Storage.GetAcl` method after inherting
+ # documentation and annotations as follows:
+ #
+ # service Storage {
+ # // Get the underlying ACL object.
+ # rpc GetAcl(GetAclRequest) returns (Acl) {
+ # option (google.api.http).get = "/v2/{resource=**}:getAcl";
+ # }
+ # ...
+ # }
+ #
+ # Note how the version in the path pattern changed from `v1` to `v2`.
+ #
+ # If the `root` field in the mixin is specified, it should be a
+ # relative path under which inherited HTTP paths are placed. Example:
+ #
+ # apis:
+ # - name: google.storage.v2.Storage
+ # mixins:
+ # - name: google.acl.v1.AccessControl
+ # root: acls
+ #
+ # This implies the following inherited HTTP annotation:
+ #
+ # service Storage {
+ # // Get the underlying ACL object.
+ # rpc GetAcl(GetAclRequest) returns (Acl) {
+ # option (google.api.http).get = "/v2/acls/{resource=**}:getAcl";
+ # }
+ # ...
+ # }
+ "root": "A String", # If non-empty specifies a path under which inherited HTTP paths
+ # are rooted.
+ "name": "A String", # The fully qualified name of the API which is included.
+ },
+ ],
+ "syntax": "A String", # The source syntax of the service.
+ "version": "A String", # A version string for this api. If specified, must have the form
+ # `major-version.minor-version`, as in `1.10`. If the minor version
+ # is omitted, it defaults to zero. If the entire version field is
+ # empty, the major version is derived from the package name, as
+ # outlined below. If the field is not empty, the version in the
+ # package name will be verified to be consistent with what is
+ # provided here.
+ #
+ # The versioning schema uses [semantic
+ # versioning](http://semver.org) where the major version number
+ # indicates a breaking change and the minor version an additive,
+ # non-breaking change. Both version numbers are signals to users
+ # what to expect from different versions, and should be carefully
+ # chosen based on the product plan.
+ #
+ # The major version is also reflected in the package name of the
+ # API, which must end in `v<major-version>`, as in
+ # `google.feature.v1`. For major versions 0 and 1, the suffix can
+ # be omitted. Zero major versions must only be used for
+ # experimental, none-GA apis.
+ "options": [ # Any metadata attached to the API.
+ { # A protocol buffer option, which can be attached to a message, field,
+ # enumeration, etc.
+ "name": "A String", # The option's name. For example, `"java_package"`.
+ "value": { # The option's value. For example, `"com.google.protobuf"`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ },
+ ],
+ "name": "A String", # The fully qualified name of this api, including package name
+ # followed by the api's simple name.
+ },
+ ],
+ "customError": { # Customize service error responses. For example, list any service # Custom error configuration.
+ # specific protobuf types that can appear in error detail lists of
+ # error responses.
+ #
+ # Example:
+ #
+ # custom_error:
+ # types:
+ # - google.foo.v1.CustomError
+ # - google.foo.v1.AnotherError
+ "rules": [ # The list of custom error rules that apply to individual API messages.
+ #
+ # **NOTE:** All service configuration rules follow "last one wins" order.
+ { # A custom error rule.
+ "isErrorType": True or False, # Mark this message as possible payload in error response. Otherwise,
+ # objects of this type will be filtered when they appear in error payload.
+ "selector": "A String", # Selects messages to which this rule applies.
+ #
+ # Refer to selector for syntax details.
+ },
+ ],
+ "types": [ # The list of custom error detail types, e.g. 'google.foo.v1.CustomError'.
+ "A String",
+ ],
+ },
+ "visibility": { # `Visibility` defines restrictions for the visibility of service # API visibility configuration.
+ # elements. Restrictions are specified using visibility labels
+ # (e.g., TRUSTED_TESTER) that are elsewhere linked to users and projects.
+ #
+ # Users and projects can have access to more than one visibility label. The
+ # effective visibility for multiple labels is the union of each label's
+ # elements, plus any unrestricted elements.
+ #
+ # If an element and its parents have no restrictions, visibility is
+ # unconditionally granted.
+ #
+ # Example:
+ #
+ # visibility:
+ # rules:
+ # - selector: google.calendar.Calendar.EnhancedSearch
+ # restriction: TRUSTED_TESTER
+ # - selector: google.calendar.Calendar.Delegate
+ # restriction: GOOGLE_INTERNAL
+ #
+ # Here, all methods are publicly visible except for the restricted methods
+ # EnhancedSearch and Delegate.
+ "rules": [ # 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.
+ "restriction": "A String", # Lists the visibility labels for this rule. Any of the listed labels grants
+ # visibility to the element.
+ #
+ # 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: GOOGLE_INTERNAL, TRUSTED_TESTER
+ #
+ # Removing GOOGLE_INTERNAL from this restriction will break clients that
+ # rely on this method and only had access to it through GOOGLE_INTERNAL.
+ "selector": "A String", # Selects methods, messages, fields, enums, etc. to which this rule applies.
+ #
+ # Refer to selector for syntax details.
+ },
+ ],
+ },
+ "metrics": [ # Defines the metrics used by this service.
+ { # Defines a metric type and its schema.
+ "displayName": "A String", # A concise name for the metric, which can be displayed in user interfaces.
+ # Use sentence case without an ending period, for example "Request count".
+ "description": "A String", # A detailed description of the metric, which can be used in documentation.
+ "metricKind": "A String", # Whether the metric records instantaneous values, changes to a value, etc.
+ "valueType": "A String", # Whether the measurement is an integer, a floating-point number, etc.
+ "labels": [ # The set of labels that can be used to describe a specific instance of this
+ # metric type. For example, the
+ # `compute.googleapis.com/instance/network/received_bytes_count` metric type
+ # has a label, `loadbalanced`, that specifies whether the traffic was
+ # received through a load balanced IP address.
+ { # A description of a label.
+ "valueType": "A String", # The type of data that can be assigned to the label.
+ "description": "A String", # A human-readable description for the label.
+ "key": "A String", # The label key.
+ },
+ ],
+ "type": "A String", # The metric type including a DNS name prefix, for example
+ # `"compute.googleapis.com/instance/cpu/utilization"`. Metric types
+ # should use a natural hierarchical grouping such as the following:
+ #
+ # compute.googleapis.com/instance/cpu/utilization
+ # compute.googleapis.com/instance/disk/read_ops_count
+ # compute.googleapis.com/instance/network/received_bytes_count
+ #
+ # Note that if the metric type changes, the monitoring data will be
+ # discontinued, and anything depends on it will break, such as monitoring
+ # dashboards, alerting rules and quota limits. Therefore, once a metric has
+ # been published, its type should be immutable.
+ "unit": "A String", # 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 includes the dimensionless unit `1`, such as `1/s`.
+ #
+ # 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 '}'.
+ "name": "A String", # Resource name. The format of the name may vary between different
+ # implementations. For examples:
+ #
+ # projects/{project_id}/metricDescriptors/{type=**}
+ # metricDescriptors/{type=**}
+ },
+ ],
+ "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
+ { # Enum type definition.
+ "sourceContext": { # `SourceContext` represents information about the source of a # The source context.
+ # protobuf element, like the file in which it is defined.
+ "fileName": "A String", # The path-qualified name of the .proto file that contained the associated
+ # protobuf element. For example: `"google/protobuf/source_context.proto"`.
+ },
+ "enumvalue": [ # Enum value definitions.
+ { # Enum value definition.
+ "number": 42, # Enum value number.
+ "options": [ # Protocol buffer options.
+ { # A protocol buffer option, which can be attached to a message, field,
+ # enumeration, etc.
+ "name": "A String", # The option's name. For example, `"java_package"`.
+ "value": { # The option's value. For example, `"com.google.protobuf"`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ },
+ ],
+ "name": "A String", # Enum value name.
+ },
+ ],
+ "options": [ # Protocol buffer options.
+ { # A protocol buffer option, which can be attached to a message, field,
+ # enumeration, etc.
+ "name": "A String", # The option's name. For example, `"java_package"`.
+ "value": { # The option's value. For example, `"com.google.protobuf"`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ },
+ ],
+ "name": "A String", # Enum type name.
+ "syntax": "A String", # The source syntax.
+ },
+ ],
+ "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
+ { # A protocol buffer message type.
+ "oneofs": [ # The list of types appearing in `oneof` definitions in this type.
+ "A String",
+ ],
+ "name": "A String", # The fully qualified message name.
+ "sourceContext": { # `SourceContext` represents information about the source of a # The source context.
+ # protobuf element, like the file in which it is defined.
+ "fileName": "A String", # The path-qualified name of the .proto file that contained the associated
+ # protobuf element. For example: `"google/protobuf/source_context.proto"`.
+ },
+ "syntax": "A String", # The source syntax.
+ "fields": [ # The list of fields.
+ { # A single field of a message type.
+ "kind": "A String", # The field type.
+ "oneofIndex": 42, # The index of the field type in `Type.oneofs`, for message or enumeration
+ # types. The first type has index 1; zero means the type is not in the list.
+ "typeUrl": "A String", # The field type URL, without the scheme, for message or enumeration
+ # types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`.
+ "name": "A String", # The field name.
+ "defaultValue": "A String", # The string value of the default value of this field. Proto2 syntax only.
+ "jsonName": "A String", # The field JSON name.
+ "number": 42, # The field number.
+ "cardinality": "A String", # The field cardinality.
+ "options": [ # The protocol buffer options.
+ { # A protocol buffer option, which can be attached to a message, field,
+ # enumeration, etc.
+ "name": "A String", # The option's name. For example, `"java_package"`.
+ "value": { # The option's value. For example, `"com.google.protobuf"`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ },
+ ],
+ "packed": True or False, # Whether to use alternative packed wire representation.
+ },
+ ],
+ "options": [ # The protocol buffer options.
+ { # A protocol buffer option, which can be attached to a message, field,
+ # enumeration, etc.
+ "name": "A String", # The option's name. For example, `"java_package"`.
+ "value": { # The option's value. For example, `"com.google.protobuf"`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ },
+ ],
+ },
+ ],
+ "logging": { # 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 `library.googleapis.com/activity_history` log is
+ # sent to both the producer and consumer projects, whereas
+ # the `library.googleapis.com/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: library.googleapis.com/activity_history
+ # labels:
+ # - key: /customer_id
+ # - name: library.googleapis.com/purchase_history
+ # logging:
+ # producer_destinations:
+ # - monitored_resource: library.googleapis.com/branch
+ # logs:
+ # - library.googleapis.com/activity_history
+ # - library.googleapis.com/purchase_history
+ # consumer_destinations:
+ # - monitored_resource: library.googleapis.com/branch
+ # logs:
+ # - library.googleapis.com/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.
+ { # Configuration of a specific logging destination (the producer project
+ # or the consumer project).
+ "monitoredResource": "A String", # The monitored resource type. The type must be defined in
+ # Service.monitored_resources section.
+ "logs": [ # Names of the logs to be sent to this destination. Each name must
+ # be defined in the Service.logs section.
+ "A String",
+ ],
+ },
+ ],
+ "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.
+ { # Configuration of a specific logging destination (the producer project
+ # or the consumer project).
+ "monitoredResource": "A String", # The monitored resource type. The type must be defined in
+ # Service.monitored_resources section.
+ "logs": [ # Names of the logs to be sent to this destination. Each name must
+ # be defined in the Service.logs section.
+ "A String",
+ ],
+ },
+ ],
+ },
+ "name": "A String", # The DNS address at which this service is available,
+ # e.g. `calendar.googleapis.com`.
+ "documentation": { # `Documentation` provides the information for describing a service. # Additional API documentation.
+ #
+ # 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>
+ # Comments can be made conditional using a visibility label. The below
+ # text will be only rendered if the `BETA` label is available:
+ # <pre><code>(--BETA: comment for BETA users --)</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.
+ "rules": [ # A list of documentation rules that apply to individual API elements.
+ #
+ # **NOTE:** All service configuration rules follow "last one wins" order.
+ { # A documentation rule provides information about individual API elements.
+ "description": "A String", # Description of the selected API(s).
+ "deprecationDescription": "A String", # Deprecation description of the selected element(s). It can be provided if an
+ # element is marked as `deprecated`.
+ "selector": "A String", # 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". To
+ # specify a default for all applicable elements, the whole pattern "*"
+ # is used.
+ },
+ ],
+ "overview": "A String", # 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.
+ "summary": "A String", # A short summary of what the service does. Can only be provided by
+ # plain text.
+ "pages": [ # The top level pages for the documentation set.
+ { # Represents a documentation page. A page can contain subpages to represent
+ # nested documentation set structure.
+ "content": "A String", # 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.
+ # Object with schema name: Page
+ ],
+ "name": "A String", # 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`.
+ },
+ ],
+ "documentationRootUrl": "A String", # The URL to the root of documentation.
+ },
+ "systemTypes": [ # A list of all proto message types included in this API service.
+ # It serves similar purpose as [google.api.Service.types], except that
+ # these types are not needed by user-defined APIs. Therefore, they will not
+ # show up in the generated discovery doc. This field should only be used
+ # to define system APIs in ESF.
+ { # A protocol buffer message type.
+ "oneofs": [ # The list of types appearing in `oneof` definitions in this type.
+ "A String",
+ ],
+ "name": "A String", # The fully qualified message name.
+ "sourceContext": { # `SourceContext` represents information about the source of a # The source context.
+ # protobuf element, like the file in which it is defined.
+ "fileName": "A String", # The path-qualified name of the .proto file that contained the associated
+ # protobuf element. For example: `"google/protobuf/source_context.proto"`.
+ },
+ "syntax": "A String", # The source syntax.
+ "fields": [ # The list of fields.
+ { # A single field of a message type.
+ "kind": "A String", # The field type.
+ "oneofIndex": 42, # The index of the field type in `Type.oneofs`, for message or enumeration
+ # types. The first type has index 1; zero means the type is not in the list.
+ "typeUrl": "A String", # The field type URL, without the scheme, for message or enumeration
+ # types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`.
+ "name": "A String", # The field name.
+ "defaultValue": "A String", # The string value of the default value of this field. Proto2 syntax only.
+ "jsonName": "A String", # The field JSON name.
+ "number": 42, # The field number.
+ "cardinality": "A String", # The field cardinality.
+ "options": [ # The protocol buffer options.
+ { # A protocol buffer option, which can be attached to a message, field,
+ # enumeration, etc.
+ "name": "A String", # The option's name. For example, `"java_package"`.
+ "value": { # The option's value. For example, `"com.google.protobuf"`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ },
+ ],
+ "packed": True or False, # Whether to use alternative packed wire representation.
+ },
+ ],
+ "options": [ # The protocol buffer options.
+ { # A protocol buffer option, which can be attached to a message, field,
+ # enumeration, etc.
+ "name": "A String", # The option's name. For example, `"java_package"`.
+ "value": { # The option's value. For example, `"com.google.protobuf"`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ },
+ ],
+ },
+ ],
+ "context": { # `Context` defines which contexts an API requests. # Context configuration.
+ #
+ # 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`.
+ "rules": [ # 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.
+ "provided": [ # A list of full type names of provided contexts.
+ "A String",
+ ],
+ "requested": [ # A list of full type names of requested contexts.
+ "A String",
+ ],
+ "selector": "A String", # Selects the methods to which this rule applies.
+ #
+ # Refer to selector for syntax details.
+ },
+ ],
+ },
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(serviceName=None, configId, x__xgafv=None)</code>
+ <pre>Gets a service configuration (version) for a managed service.
+
+Args:
+ serviceName: string, The name of the service. See the [overview](/service-management/overview)
+for naming requirements. For example: `example.googleapis.com`. (required)
+ configId: string, A parameter (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # `Service` is the root object of the configuration schema. It
+ # describes basic information like the name of the service and the
+ # exposed API interfaces, and delegates other aspects to configuration
+ # sub-sections.
+ #
+ # Example:
+ #
+ # type: google.api.Service
+ # config_version: 1
+ # name: calendar.googleapis.com
+ # title: Google Calendar API
+ # apis:
+ # - name: google.calendar.Calendar
+ # backend:
+ # rules:
+ # - selector: "*"
+ # address: calendar.example.com
+ "control": { # Selects and configures the service controller used by the service. The # Configuration for the service control plane.
+ # service controller handles features like abuse, quota, billing, logging,
+ # monitoring, etc.
+ "environment": "A String", # The service control environment to use. If empty, no control plane
+ # feature (like quota and billing) will be enabled.
+ },
+ "monitoredResources": [ # Defines the monitored resources used by this service. This is required
+ # by the Service.monitoring and Service.logging configurations.
+ { # An object that describes the schema of a 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.
+ "type": "A String", # 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.
+ "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"`.
+ { # A description of a label.
+ "valueType": "A String", # The type of data that can be assigned to the label.
+ "description": "A String", # A human-readable description for the label.
+ "key": "A String", # The label key.
+ },
+ ],
+ "displayName": "A String", # Optional. A concise name for the monitored resource type that might be
+ # displayed in user interfaces. For example, `"Google Cloud SQL Database"`.
+ "description": "A String", # Optional. A detailed description of the monitored resource type that might
+ # be used in documentation.
+ "name": "A String", # 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}"`.
+ },
+ ],
+ "logs": [ # Defines the logs used by this service.
+ { # 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
+ "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.
+ { # A description of a label.
+ "valueType": "A String", # The type of data that can be assigned to the label.
+ "description": "A String", # A human-readable description for the label.
+ "key": "A String", # The label key.
+ },
+ ],
+ "displayName": "A String", # The human-readable name for this log. This information appears on
+ # the user interface and should be concise.
+ "description": "A String", # A human-readable description of this log. This information appears in
+ # the documentation and can contain details.
+ "name": "A String", # 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 [/_-.].
+ },
+ ],
+ "systemParameters": { # ### System parameter configuration # Configuration for system parameters.
+ #
+ # 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 and alt name for all methods
+ #
+ # system_parameters
+ # rules:
+ # - selector: "*"
+ # parameters:
+ # - name: api_key
+ # url_query_parameter: api_key
+ # - name: alt
+ # http_header: Response-Content-Type
+ #
+ # 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.
+ "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.
+ { # 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.
+ "urlQueryParameter": "A String", # Define the URL query parameter name to use for the parameter. It is case
+ # sensitive.
+ "name": "A String", # Define the name of the parameter, such as "api_key", "alt", "callback",
+ # and etc. It is case sensitive.
+ "httpHeader": "A String", # Define the HTTP header name to use for the parameter. It is case
+ # insensitive.
+ },
+ ],
+ "selector": "A String", # Selects the methods to which this rule applies. Use '*' to indicate all
+ # methods in all APIs.
+ #
+ # Refer to selector for syntax details.
+ },
+ ],
+ },
+ "backend": { # `Backend` defines the backend configuration for a service. # API backend configuration.
+ "rules": [ # 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.
+ "selector": "A String", # Selects the methods to which this rule applies.
+ #
+ # Refer to selector for syntax details.
+ "deadline": 3.14, # The number of seconds to wait for a response from a request. The
+ # default depends on the deployment context.
+ "address": "A String", # The address of the API backend.
+ },
+ ],
+ },
+ "monitoring": { # 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, each one must have a
+ # different monitored resource type. A metric can be used in at most
+ # one producer destination.
+ { # Configuration of a specific monitoring destination (the producer project
+ # or the consumer project).
+ "monitoredResource": "A String", # The monitored resource type. The type must be defined in
+ # Service.monitored_resources section.
+ "metrics": [ # Names of the metrics to report to this monitoring destination.
+ # Each name must be defined in Service.metrics section.
+ "A String",
+ ],
+ },
+ ],
+ "consumerDestinations": [ # Monitoring configurations for sending metrics to the consumer project.
+ # There can be multiple consumer destinations, each one must have a
+ # different monitored resource type. A metric can be used in at most
+ # one consumer destination.
+ { # Configuration of a specific monitoring destination (the producer project
+ # or the consumer project).
+ "monitoredResource": "A String", # The monitored resource type. The type must be defined in
+ # Service.monitored_resources section.
+ "metrics": [ # Names of the metrics to report to this monitoring destination.
+ # Each name must be defined in Service.metrics section.
+ "A String",
+ ],
+ },
+ ],
+ },
+ "title": "A String", # The product title associated with this service.
+ "id": "A String", # 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.
+ "authentication": { # `Authentication` defines the authentication configuration for an API. # Auth configuration.
+ #
+ # Example for an API targeted for external use:
+ #
+ # name: calendar.googleapis.com
+ # authentication:
+ # rules:
+ # - selector: "*"
+ # oauth:
+ # canonical_scopes: https://www.googleapis.com/auth/calendar
+ #
+ # - selector: google.calendar.Delegate
+ # oauth:
+ # canonical_scopes: https://www.googleapis.com/auth/calendar.read
+ "rules": [ # A list of authentication rules that apply to individual API methods.
+ #
+ # **NOTE:** All service configuration rules follow "last one wins" order.
+ { # 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.
+ "oauth": { # OAuth scopes are a way to define data and permissions on data. For example, # The requirements for OAuth credentials.
+ # 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": "A String", # 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
+ },
+ "requirements": [ # Requirements for additional authentication providers.
+ { # User-defined authentication requirements, including support for
+ # [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).
+ "providerId": "A String", # id from authentication provider.
+ #
+ # Example:
+ #
+ # provider_id: bookstore_auth
+ "audiences": "A String", # 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/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
+ },
+ ],
+ "allowWithoutCredential": True or False, # Whether to allow requests without a credential. If quota is enabled, an
+ # API key is required for such request to pass the quota check.
+ "selector": "A String", # Selects the methods to which this rule applies.
+ #
+ # Refer to selector for syntax details.
+ },
+ ],
+ "providers": [ # Defines a set of authentication providers that a service supports.
+ { # Configuration for an anthentication provider, including support for
+ # [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).
+ "jwksUri": "A String", # 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
+ "id": "A String", # The unique identifier of the auth provider. It will be referred to by
+ # `AuthRequirement.provider_id`.
+ #
+ # Example: "bookstore_auth".
+ "issuer": "A String", # 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
+ },
+ ],
+ },
+ "usage": { # Configuration controlling usage of a service. # Configuration controlling usage of this service.
+ "rules": [ # A list of usage rules that apply to individual API methods.
+ #
+ # **NOTE:** All service configuration rules follow "last one wins" order.
+ { # 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": "A String", # Selects the methods to which this rule applies. Use '*' to indicate all
+ # methods in all APIs.
+ #
+ # Refer to selector for syntax details.
+ "allowUnregisteredCalls": True or False, # True, if the method allows unregistered calls; false otherwise.
+ },
+ ],
+ "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'.
+ "A String",
+ ],
+ },
+ "configVersion": 42, # The version of the service configuration. The config version may
+ # influence interpretation of the configuration, for example, to
+ # determine defaults. This is documented together with applicable
+ # options. The current default for the config version itself is `3`.
+ "producerProjectId": "A String", # The id of the Google developer project that owns the service.
+ # Members of this project can manage the service configuration,
+ # manage consumption of the service, etc.
+ "http": { # Defines the HTTP configuration for a service. It contains a list of # HTTP configuration.
+ # 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.
+ { # `HttpRule` defines the mapping of an RPC method to one or more HTTP
+ # REST APIs. The mapping determines what portions of the request
+ # message are populated from the path, query parameters, or body of
+ # the HTTP request. The mapping is typically specified as an
+ # `google.api.http` annotation, see "google/api/annotations.proto"
+ # for details.
+ #
+ # The mapping consists of a field specifying the path template and
+ # method kind. The path template can refer to fields in the request
+ # message, as in the example below which describes a REST GET
+ # operation on a resource collection of messages:
+ #
+ # ```proto
+ # service Messaging {
+ # rpc GetMessage(GetMessageRequest) returns (Message) {
+ # option (google.api.http).get = "/v1/messages/{message_id}/{sub.subfield}";
+ # }
+ # }
+ # message GetMessageRequest {
+ # message SubMessage {
+ # string subfield = 1;
+ # }
+ # string message_id = 1; // mapped to the URL
+ # SubMessage sub = 2; // `sub.subfield` is url-mapped
+ # }
+ # message Message {
+ # string text = 1; // content of the resource
+ # }
+ # ```
+ #
+ # This definition enables an automatic, bidrectional mapping of HTTP
+ # JSON to RPC. Example:
+ #
+ # HTTP | RPC
+ # -----|-----
+ # `GET /v1/messages/123456/foo` | `GetMessage(message_id: "123456" sub: SubMessage(subfield: "foo"))`
+ #
+ # In general, not only fields but also field paths can be referenced
+ # from a path pattern. Fields mapped to the path pattern cannot be
+ # repeated and must have a primitive (non-message) type.
+ #
+ # Any fields in the request message which are not bound by the path
+ # pattern automatically become (optional) HTTP query
+ # parameters. Assume the following definition of the request message:
+ #
+ # ```proto
+ # message GetMessageRequest {
+ # message SubMessage {
+ # string subfield = 1;
+ # }
+ # string message_id = 1; // mapped to the URL
+ # int64 revision = 2; // becomes a parameter
+ # SubMessage sub = 3; // `sub.subfield` becomes a parameter
+ # }
+ # ```
+ #
+ # This enables a HTTP JSON to RPC mapping as below:
+ #
+ # HTTP | RPC
+ # -----|-----
+ # `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 HTTP parameters must have a
+ # primitive type or a repeated primitive type. Message types are not
+ # allowed. In the case of a repeated type, the parameter can be
+ # repeated in the URL, as in `...?param=A¶m=B`.
+ #
+ # For HTTP method kinds which allow a request body, the `body` field
+ # specifies the mapping. Consider a REST update method on the
+ # message resource collection:
+ #
+ # ```proto
+ # service Messaging {
+ # rpc UpdateMessage(UpdateMessageRequest) returns (Message) {
+ # option (google.api.http) = {
+ # put: "/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 | RPC
+ # -----|-----
+ # `PUT /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:
+ #
+ # ```proto
+ # service Messaging {
+ # rpc UpdateMessage(Message) returns (Message) {
+ # option (google.api.http) = {
+ # put: "/v1/messages/{message_id}"
+ # body: "*"
+ # };
+ # }
+ # }
+ # message Message {
+ # string message_id = 1;
+ # string text = 2;
+ # }
+ # ```
+ #
+ # The following HTTP JSON to RPC mapping is enabled:
+ #
+ # HTTP | RPC
+ # -----|-----
+ # `PUT /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 of
+ # 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:
+ #
+ # ```proto
+ # 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 | RPC
+ # -----|-----
+ # `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
+ #
+ # The rules for mapping HTTP path, query parameters, and body fields
+ # to the request message are as follows:
+ #
+ # 1. The `body` field specifies either `*` or a field path, or is
+ # omitted. If omitted, it assumes there is no HTTP body.
+ # 2. Leaf fields (recursive expansion of nested messages in the
+ # request) can be classified into three types:
+ # (a) Matched in the URL template.
+ # (b) Covered by body (if body is `*`, everything except (a) fields;
+ # else everything under the body field)
+ # (c) All other fields.
+ # 3. URL query parameters found in the HTTP request are mapped to (c) fields.
+ # 4. Any body sent with an HTTP request can contain only (b) fields.
+ #
+ # The syntax of the path template is as follows:
+ #
+ # Template = "/" Segments [ Verb ] ;
+ # Segments = Segment { "/" Segment } ;
+ # Segment = "*" | "**" | LITERAL | Variable ;
+ # Variable = "{" FieldPath [ "=" Segments ] "}" ;
+ # FieldPath = IDENT { "." IDENT } ;
+ # Verb = ":" LITERAL ;
+ #
+ # The syntax `*` matches a single path segment. It follows the semantics of
+ # [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String
+ # Expansion.
+ #
+ # The syntax `**` matches zero or more path segments. It follows the semantics
+ # of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.3 Reserved
+ # Expansion.
+ #
+ # The syntax `LITERAL` matches literal text in the URL path.
+ #
+ # The syntax `Variable` matches the entire path as specified by its template;
+ # this nested template must not contain further variables. If a variable
+ # matches a single path segment, its template may be omitted, e.g. `{var}`
+ # is equivalent to `{var=*}`.
+ #
+ # NOTE: the field paths in variables and in the `body` must not refer to
+ # repeated fields or map fields.
+ #
+ # Use CustomHttpPattern to specify any HTTP method that is not included in the
+ # `pattern` field, such as HEAD, or "*" to leave the HTTP method unspecified for
+ # a given URL path rule. The wild-card rule is useful for services that provide
+ # content to Web (HTML) clients.
+ "body": "A String", # The name of the request field whose value is mapped to the HTTP body, or
+ # `*` for mapping all fields not captured by the path pattern to the HTTP
+ # body. NOTE: the referred field must not be a repeated field and must be
+ # present at the top-level of response message type.
+ "get": "A String", # Used for listing and getting information about resources.
+ "mediaDownload": { # Do not use this. For media support, add instead # Do not use this. For media support, add instead
+ # [][google.bytestream.RestByteStream] as an API to your
+ # configuration.
+ # [][google.bytestream.RestByteStream] as an API to your
+ # configuration.
+ "enabled": True or False, # Whether download is enabled.
+ },
+ "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).
+ # Object with schema name: HttpRule
+ ],
+ "mediaUpload": { # Do not use this. For media support, add instead # Do not use this. For media support, add instead
+ # [][google.bytestream.RestByteStream] as an API to your
+ # configuration.
+ # [][google.bytestream.RestByteStream] as an API to your
+ # configuration.
+ "enabled": True or False, # Whether upload is enabled.
+ },
+ "custom": { # A custom pattern is used for defining custom HTTP verb. # Custom pattern is used for defining custom verbs.
+ "path": "A String", # The path matched by this custom verb.
+ "kind": "A String", # The name of this custom HTTP verb.
+ },
+ "responseBody": "A String", # The name of the response field whose value is mapped to the HTTP body of
+ # response. Other response fields are ignored. This field is optional. When
+ # not set, the response message will be used as HTTP body of response.
+ # NOTE: the referred field must be not a repeated field and must be present
+ # at the top-level of response message type.
+ "put": "A String", # Used for updating a resource.
+ "patch": "A String", # Used for updating a resource.
+ "post": "A String", # Used for creating a resource.
+ "selector": "A String", # Selects methods to which this rule applies.
+ #
+ # Refer to selector for syntax details.
+ "delete": "A String", # Used for deleting a resource.
+ },
+ ],
+ },
+ "apis": [ # A list of API interfaces exported by this service. Only the `name` field
+ # of the 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.
+ { # Api is a light-weight descriptor for a protocol buffer service.
+ "methods": [ # The methods of this api, in unspecified order.
+ { # Method represents a method of an api.
+ "name": "A String", # The simple name of this method.
+ "requestStreaming": True or False, # If true, the request is streamed.
+ "responseTypeUrl": "A String", # The URL of the output message type.
+ "requestTypeUrl": "A String", # A URL of the input message type.
+ "responseStreaming": True or False, # If true, the response is streamed.
+ "syntax": "A String", # The source syntax of this method.
+ "options": [ # Any metadata attached to the method.
+ { # A protocol buffer option, which can be attached to a message, field,
+ # enumeration, etc.
+ "name": "A String", # The option's name. For example, `"java_package"`.
+ "value": { # The option's value. For example, `"com.google.protobuf"`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ },
+ ],
+ },
+ ],
+ "sourceContext": { # `SourceContext` represents information about the source of a # Source context for the protocol buffer service represented by this
+ # message.
+ # protobuf element, like the file in which it is defined.
+ "fileName": "A String", # The path-qualified name of the .proto file that contained the associated
+ # protobuf element. For example: `"google/protobuf/source_context.proto"`.
+ },
+ "mixins": [ # Included APIs. See Mixin.
+ { # Declares an API to be included in this API. The including API must
+ # redeclare all the methods from the included API, but documentation
+ # and options are inherited as follows:
+ #
+ # - If after comment and whitespace stripping, the documentation
+ # string of the redeclared method is empty, it will be inherited
+ # from the original method.
+ #
+ # - Each annotation belonging to the service config (http,
+ # visibility) which is not set in the redeclared method will be
+ # inherited.
+ #
+ # - If an http annotation is inherited, the path pattern will be
+ # modified as follows. Any version prefix will be replaced by the
+ # version of the including API plus the root path if specified.
+ #
+ # Example of a simple mixin:
+ #
+ # package google.acl.v1;
+ # service AccessControl {
+ # // Get the underlying ACL object.
+ # rpc GetAcl(GetAclRequest) returns (Acl) {
+ # option (google.api.http).get = "/v1/{resource=**}:getAcl";
+ # }
+ # }
+ #
+ # package google.storage.v2;
+ # service Storage {
+ # // rpc GetAcl(GetAclRequest) returns (Acl);
+ #
+ # // Get a data record.
+ # rpc GetData(GetDataRequest) returns (Data) {
+ # option (google.api.http).get = "/v2/{resource=**}";
+ # }
+ # }
+ #
+ # Example of a mixin configuration:
+ #
+ # apis:
+ # - name: google.storage.v2.Storage
+ # mixins:
+ # - name: google.acl.v1.AccessControl
+ #
+ # The mixin construct implies that all methods in `AccessControl` are
+ # also declared with same name and request/response types in
+ # `Storage`. A documentation generator or annotation processor will
+ # see the effective `Storage.GetAcl` method after inherting
+ # documentation and annotations as follows:
+ #
+ # service Storage {
+ # // Get the underlying ACL object.
+ # rpc GetAcl(GetAclRequest) returns (Acl) {
+ # option (google.api.http).get = "/v2/{resource=**}:getAcl";
+ # }
+ # ...
+ # }
+ #
+ # Note how the version in the path pattern changed from `v1` to `v2`.
+ #
+ # If the `root` field in the mixin is specified, it should be a
+ # relative path under which inherited HTTP paths are placed. Example:
+ #
+ # apis:
+ # - name: google.storage.v2.Storage
+ # mixins:
+ # - name: google.acl.v1.AccessControl
+ # root: acls
+ #
+ # This implies the following inherited HTTP annotation:
+ #
+ # service Storage {
+ # // Get the underlying ACL object.
+ # rpc GetAcl(GetAclRequest) returns (Acl) {
+ # option (google.api.http).get = "/v2/acls/{resource=**}:getAcl";
+ # }
+ # ...
+ # }
+ "root": "A String", # If non-empty specifies a path under which inherited HTTP paths
+ # are rooted.
+ "name": "A String", # The fully qualified name of the API which is included.
+ },
+ ],
+ "syntax": "A String", # The source syntax of the service.
+ "version": "A String", # A version string for this api. If specified, must have the form
+ # `major-version.minor-version`, as in `1.10`. If the minor version
+ # is omitted, it defaults to zero. If the entire version field is
+ # empty, the major version is derived from the package name, as
+ # outlined below. If the field is not empty, the version in the
+ # package name will be verified to be consistent with what is
+ # provided here.
+ #
+ # The versioning schema uses [semantic
+ # versioning](http://semver.org) where the major version number
+ # indicates a breaking change and the minor version an additive,
+ # non-breaking change. Both version numbers are signals to users
+ # what to expect from different versions, and should be carefully
+ # chosen based on the product plan.
+ #
+ # The major version is also reflected in the package name of the
+ # API, which must end in `v<major-version>`, as in
+ # `google.feature.v1`. For major versions 0 and 1, the suffix can
+ # be omitted. Zero major versions must only be used for
+ # experimental, none-GA apis.
+ "options": [ # Any metadata attached to the API.
+ { # A protocol buffer option, which can be attached to a message, field,
+ # enumeration, etc.
+ "name": "A String", # The option's name. For example, `"java_package"`.
+ "value": { # The option's value. For example, `"com.google.protobuf"`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ },
+ ],
+ "name": "A String", # The fully qualified name of this api, including package name
+ # followed by the api's simple name.
+ },
+ ],
+ "customError": { # Customize service error responses. For example, list any service # Custom error configuration.
+ # specific protobuf types that can appear in error detail lists of
+ # error responses.
+ #
+ # Example:
+ #
+ # custom_error:
+ # types:
+ # - google.foo.v1.CustomError
+ # - google.foo.v1.AnotherError
+ "rules": [ # The list of custom error rules that apply to individual API messages.
+ #
+ # **NOTE:** All service configuration rules follow "last one wins" order.
+ { # A custom error rule.
+ "isErrorType": True or False, # Mark this message as possible payload in error response. Otherwise,
+ # objects of this type will be filtered when they appear in error payload.
+ "selector": "A String", # Selects messages to which this rule applies.
+ #
+ # Refer to selector for syntax details.
+ },
+ ],
+ "types": [ # The list of custom error detail types, e.g. 'google.foo.v1.CustomError'.
+ "A String",
+ ],
+ },
+ "visibility": { # `Visibility` defines restrictions for the visibility of service # API visibility configuration.
+ # elements. Restrictions are specified using visibility labels
+ # (e.g., TRUSTED_TESTER) that are elsewhere linked to users and projects.
+ #
+ # Users and projects can have access to more than one visibility label. The
+ # effective visibility for multiple labels is the union of each label's
+ # elements, plus any unrestricted elements.
+ #
+ # If an element and its parents have no restrictions, visibility is
+ # unconditionally granted.
+ #
+ # Example:
+ #
+ # visibility:
+ # rules:
+ # - selector: google.calendar.Calendar.EnhancedSearch
+ # restriction: TRUSTED_TESTER
+ # - selector: google.calendar.Calendar.Delegate
+ # restriction: GOOGLE_INTERNAL
+ #
+ # Here, all methods are publicly visible except for the restricted methods
+ # EnhancedSearch and Delegate.
+ "rules": [ # 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.
+ "restriction": "A String", # Lists the visibility labels for this rule. Any of the listed labels grants
+ # visibility to the element.
+ #
+ # 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: GOOGLE_INTERNAL, TRUSTED_TESTER
+ #
+ # Removing GOOGLE_INTERNAL from this restriction will break clients that
+ # rely on this method and only had access to it through GOOGLE_INTERNAL.
+ "selector": "A String", # Selects methods, messages, fields, enums, etc. to which this rule applies.
+ #
+ # Refer to selector for syntax details.
+ },
+ ],
+ },
+ "metrics": [ # Defines the metrics used by this service.
+ { # Defines a metric type and its schema.
+ "displayName": "A String", # A concise name for the metric, which can be displayed in user interfaces.
+ # Use sentence case without an ending period, for example "Request count".
+ "description": "A String", # A detailed description of the metric, which can be used in documentation.
+ "metricKind": "A String", # Whether the metric records instantaneous values, changes to a value, etc.
+ "valueType": "A String", # Whether the measurement is an integer, a floating-point number, etc.
+ "labels": [ # The set of labels that can be used to describe a specific instance of this
+ # metric type. For example, the
+ # `compute.googleapis.com/instance/network/received_bytes_count` metric type
+ # has a label, `loadbalanced`, that specifies whether the traffic was
+ # received through a load balanced IP address.
+ { # A description of a label.
+ "valueType": "A String", # The type of data that can be assigned to the label.
+ "description": "A String", # A human-readable description for the label.
+ "key": "A String", # The label key.
+ },
+ ],
+ "type": "A String", # The metric type including a DNS name prefix, for example
+ # `"compute.googleapis.com/instance/cpu/utilization"`. Metric types
+ # should use a natural hierarchical grouping such as the following:
+ #
+ # compute.googleapis.com/instance/cpu/utilization
+ # compute.googleapis.com/instance/disk/read_ops_count
+ # compute.googleapis.com/instance/network/received_bytes_count
+ #
+ # Note that if the metric type changes, the monitoring data will be
+ # discontinued, and anything depends on it will break, such as monitoring
+ # dashboards, alerting rules and quota limits. Therefore, once a metric has
+ # been published, its type should be immutable.
+ "unit": "A String", # 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 includes the dimensionless unit `1`, such as `1/s`.
+ #
+ # 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 '}'.
+ "name": "A String", # Resource name. The format of the name may vary between different
+ # implementations. For examples:
+ #
+ # projects/{project_id}/metricDescriptors/{type=**}
+ # metricDescriptors/{type=**}
+ },
+ ],
+ "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
+ { # Enum type definition.
+ "sourceContext": { # `SourceContext` represents information about the source of a # The source context.
+ # protobuf element, like the file in which it is defined.
+ "fileName": "A String", # The path-qualified name of the .proto file that contained the associated
+ # protobuf element. For example: `"google/protobuf/source_context.proto"`.
+ },
+ "enumvalue": [ # Enum value definitions.
+ { # Enum value definition.
+ "number": 42, # Enum value number.
+ "options": [ # Protocol buffer options.
+ { # A protocol buffer option, which can be attached to a message, field,
+ # enumeration, etc.
+ "name": "A String", # The option's name. For example, `"java_package"`.
+ "value": { # The option's value. For example, `"com.google.protobuf"`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ },
+ ],
+ "name": "A String", # Enum value name.
+ },
+ ],
+ "options": [ # Protocol buffer options.
+ { # A protocol buffer option, which can be attached to a message, field,
+ # enumeration, etc.
+ "name": "A String", # The option's name. For example, `"java_package"`.
+ "value": { # The option's value. For example, `"com.google.protobuf"`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ },
+ ],
+ "name": "A String", # Enum type name.
+ "syntax": "A String", # The source syntax.
+ },
+ ],
+ "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
+ { # A protocol buffer message type.
+ "oneofs": [ # The list of types appearing in `oneof` definitions in this type.
+ "A String",
+ ],
+ "name": "A String", # The fully qualified message name.
+ "sourceContext": { # `SourceContext` represents information about the source of a # The source context.
+ # protobuf element, like the file in which it is defined.
+ "fileName": "A String", # The path-qualified name of the .proto file that contained the associated
+ # protobuf element. For example: `"google/protobuf/source_context.proto"`.
+ },
+ "syntax": "A String", # The source syntax.
+ "fields": [ # The list of fields.
+ { # A single field of a message type.
+ "kind": "A String", # The field type.
+ "oneofIndex": 42, # The index of the field type in `Type.oneofs`, for message or enumeration
+ # types. The first type has index 1; zero means the type is not in the list.
+ "typeUrl": "A String", # The field type URL, without the scheme, for message or enumeration
+ # types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`.
+ "name": "A String", # The field name.
+ "defaultValue": "A String", # The string value of the default value of this field. Proto2 syntax only.
+ "jsonName": "A String", # The field JSON name.
+ "number": 42, # The field number.
+ "cardinality": "A String", # The field cardinality.
+ "options": [ # The protocol buffer options.
+ { # A protocol buffer option, which can be attached to a message, field,
+ # enumeration, etc.
+ "name": "A String", # The option's name. For example, `"java_package"`.
+ "value": { # The option's value. For example, `"com.google.protobuf"`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ },
+ ],
+ "packed": True or False, # Whether to use alternative packed wire representation.
+ },
+ ],
+ "options": [ # The protocol buffer options.
+ { # A protocol buffer option, which can be attached to a message, field,
+ # enumeration, etc.
+ "name": "A String", # The option's name. For example, `"java_package"`.
+ "value": { # The option's value. For example, `"com.google.protobuf"`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ },
+ ],
+ },
+ ],
+ "logging": { # 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 `library.googleapis.com/activity_history` log is
+ # sent to both the producer and consumer projects, whereas
+ # the `library.googleapis.com/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: library.googleapis.com/activity_history
+ # labels:
+ # - key: /customer_id
+ # - name: library.googleapis.com/purchase_history
+ # logging:
+ # producer_destinations:
+ # - monitored_resource: library.googleapis.com/branch
+ # logs:
+ # - library.googleapis.com/activity_history
+ # - library.googleapis.com/purchase_history
+ # consumer_destinations:
+ # - monitored_resource: library.googleapis.com/branch
+ # logs:
+ # - library.googleapis.com/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.
+ { # Configuration of a specific logging destination (the producer project
+ # or the consumer project).
+ "monitoredResource": "A String", # The monitored resource type. The type must be defined in
+ # Service.monitored_resources section.
+ "logs": [ # Names of the logs to be sent to this destination. Each name must
+ # be defined in the Service.logs section.
+ "A String",
+ ],
+ },
+ ],
+ "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.
+ { # Configuration of a specific logging destination (the producer project
+ # or the consumer project).
+ "monitoredResource": "A String", # The monitored resource type. The type must be defined in
+ # Service.monitored_resources section.
+ "logs": [ # Names of the logs to be sent to this destination. Each name must
+ # be defined in the Service.logs section.
+ "A String",
+ ],
+ },
+ ],
+ },
+ "name": "A String", # The DNS address at which this service is available,
+ # e.g. `calendar.googleapis.com`.
+ "documentation": { # `Documentation` provides the information for describing a service. # Additional API documentation.
+ #
+ # 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>
+ # Comments can be made conditional using a visibility label. The below
+ # text will be only rendered if the `BETA` label is available:
+ # <pre><code>(--BETA: comment for BETA users --)</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.
+ "rules": [ # A list of documentation rules that apply to individual API elements.
+ #
+ # **NOTE:** All service configuration rules follow "last one wins" order.
+ { # A documentation rule provides information about individual API elements.
+ "description": "A String", # Description of the selected API(s).
+ "deprecationDescription": "A String", # Deprecation description of the selected element(s). It can be provided if an
+ # element is marked as `deprecated`.
+ "selector": "A String", # 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". To
+ # specify a default for all applicable elements, the whole pattern "*"
+ # is used.
+ },
+ ],
+ "overview": "A String", # 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.
+ "summary": "A String", # A short summary of what the service does. Can only be provided by
+ # plain text.
+ "pages": [ # The top level pages for the documentation set.
+ { # Represents a documentation page. A page can contain subpages to represent
+ # nested documentation set structure.
+ "content": "A String", # 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.
+ # Object with schema name: Page
+ ],
+ "name": "A String", # 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`.
+ },
+ ],
+ "documentationRootUrl": "A String", # The URL to the root of documentation.
+ },
+ "systemTypes": [ # A list of all proto message types included in this API service.
+ # It serves similar purpose as [google.api.Service.types], except that
+ # these types are not needed by user-defined APIs. Therefore, they will not
+ # show up in the generated discovery doc. This field should only be used
+ # to define system APIs in ESF.
+ { # A protocol buffer message type.
+ "oneofs": [ # The list of types appearing in `oneof` definitions in this type.
+ "A String",
+ ],
+ "name": "A String", # The fully qualified message name.
+ "sourceContext": { # `SourceContext` represents information about the source of a # The source context.
+ # protobuf element, like the file in which it is defined.
+ "fileName": "A String", # The path-qualified name of the .proto file that contained the associated
+ # protobuf element. For example: `"google/protobuf/source_context.proto"`.
+ },
+ "syntax": "A String", # The source syntax.
+ "fields": [ # The list of fields.
+ { # A single field of a message type.
+ "kind": "A String", # The field type.
+ "oneofIndex": 42, # The index of the field type in `Type.oneofs`, for message or enumeration
+ # types. The first type has index 1; zero means the type is not in the list.
+ "typeUrl": "A String", # The field type URL, without the scheme, for message or enumeration
+ # types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`.
+ "name": "A String", # The field name.
+ "defaultValue": "A String", # The string value of the default value of this field. Proto2 syntax only.
+ "jsonName": "A String", # The field JSON name.
+ "number": 42, # The field number.
+ "cardinality": "A String", # The field cardinality.
+ "options": [ # The protocol buffer options.
+ { # A protocol buffer option, which can be attached to a message, field,
+ # enumeration, etc.
+ "name": "A String", # The option's name. For example, `"java_package"`.
+ "value": { # The option's value. For example, `"com.google.protobuf"`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ },
+ ],
+ "packed": True or False, # Whether to use alternative packed wire representation.
+ },
+ ],
+ "options": [ # The protocol buffer options.
+ { # A protocol buffer option, which can be attached to a message, field,
+ # enumeration, etc.
+ "name": "A String", # The option's name. For example, `"java_package"`.
+ "value": { # The option's value. For example, `"com.google.protobuf"`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ },
+ ],
+ },
+ ],
+ "context": { # `Context` defines which contexts an API requests. # Context configuration.
+ #
+ # 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`.
+ "rules": [ # 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.
+ "provided": [ # A list of full type names of provided contexts.
+ "A String",
+ ],
+ "requested": [ # A list of full type names of requested contexts.
+ "A String",
+ ],
+ "selector": "A String", # Selects the methods to which this rule applies.
+ #
+ # Refer to selector for syntax details.
+ },
+ ],
+ },
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(serviceName=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
+ <pre>Lists the history of the service configuration for a managed service,
+from the newest to the oldest.
+
+Args:
+ serviceName: string, The name of the service. See the [overview](/service-management/overview)
+for naming requirements. For example: `example.googleapis.com`. (required)
+ pageSize: integer, The max number of items to include in the response list.
+ pageToken: string, The token of the page to retrieve.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response message for ListServiceConfigs method.
+ "nextPageToken": "A String", # The token of the next page of results.
+ "serviceConfigs": [ # The list of service configuration resources.
+ { # `Service` is the root object of the configuration schema. It
+ # describes basic information like the name of the service and the
+ # exposed API interfaces, and delegates other aspects to configuration
+ # sub-sections.
+ #
+ # Example:
+ #
+ # type: google.api.Service
+ # config_version: 1
+ # name: calendar.googleapis.com
+ # title: Google Calendar API
+ # apis:
+ # - name: google.calendar.Calendar
+ # backend:
+ # rules:
+ # - selector: "*"
+ # address: calendar.example.com
+ "control": { # Selects and configures the service controller used by the service. The # Configuration for the service control plane.
+ # service controller handles features like abuse, quota, billing, logging,
+ # monitoring, etc.
+ "environment": "A String", # The service control environment to use. If empty, no control plane
+ # feature (like quota and billing) will be enabled.
+ },
+ "monitoredResources": [ # Defines the monitored resources used by this service. This is required
+ # by the Service.monitoring and Service.logging configurations.
+ { # An object that describes the schema of a 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.
+ "type": "A String", # 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.
+ "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"`.
+ { # A description of a label.
+ "valueType": "A String", # The type of data that can be assigned to the label.
+ "description": "A String", # A human-readable description for the label.
+ "key": "A String", # The label key.
+ },
+ ],
+ "displayName": "A String", # Optional. A concise name for the monitored resource type that might be
+ # displayed in user interfaces. For example, `"Google Cloud SQL Database"`.
+ "description": "A String", # Optional. A detailed description of the monitored resource type that might
+ # be used in documentation.
+ "name": "A String", # 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}"`.
+ },
+ ],
+ "logs": [ # Defines the logs used by this service.
+ { # 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
+ "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.
+ { # A description of a label.
+ "valueType": "A String", # The type of data that can be assigned to the label.
+ "description": "A String", # A human-readable description for the label.
+ "key": "A String", # The label key.
+ },
+ ],
+ "displayName": "A String", # The human-readable name for this log. This information appears on
+ # the user interface and should be concise.
+ "description": "A String", # A human-readable description of this log. This information appears in
+ # the documentation and can contain details.
+ "name": "A String", # 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 [/_-.].
+ },
+ ],
+ "systemParameters": { # ### System parameter configuration # Configuration for system parameters.
+ #
+ # 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 and alt name for all methods
+ #
+ # system_parameters
+ # rules:
+ # - selector: "*"
+ # parameters:
+ # - name: api_key
+ # url_query_parameter: api_key
+ # - name: alt
+ # http_header: Response-Content-Type
+ #
+ # 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.
+ "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.
+ { # 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.
+ "urlQueryParameter": "A String", # Define the URL query parameter name to use for the parameter. It is case
+ # sensitive.
+ "name": "A String", # Define the name of the parameter, such as "api_key", "alt", "callback",
+ # and etc. It is case sensitive.
+ "httpHeader": "A String", # Define the HTTP header name to use for the parameter. It is case
+ # insensitive.
+ },
+ ],
+ "selector": "A String", # Selects the methods to which this rule applies. Use '*' to indicate all
+ # methods in all APIs.
+ #
+ # Refer to selector for syntax details.
+ },
+ ],
+ },
+ "backend": { # `Backend` defines the backend configuration for a service. # API backend configuration.
+ "rules": [ # 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.
+ "selector": "A String", # Selects the methods to which this rule applies.
+ #
+ # Refer to selector for syntax details.
+ "deadline": 3.14, # The number of seconds to wait for a response from a request. The
+ # default depends on the deployment context.
+ "address": "A String", # The address of the API backend.
+ },
+ ],
+ },
+ "monitoring": { # 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, each one must have a
+ # different monitored resource type. A metric can be used in at most
+ # one producer destination.
+ { # Configuration of a specific monitoring destination (the producer project
+ # or the consumer project).
+ "monitoredResource": "A String", # The monitored resource type. The type must be defined in
+ # Service.monitored_resources section.
+ "metrics": [ # Names of the metrics to report to this monitoring destination.
+ # Each name must be defined in Service.metrics section.
+ "A String",
+ ],
+ },
+ ],
+ "consumerDestinations": [ # Monitoring configurations for sending metrics to the consumer project.
+ # There can be multiple consumer destinations, each one must have a
+ # different monitored resource type. A metric can be used in at most
+ # one consumer destination.
+ { # Configuration of a specific monitoring destination (the producer project
+ # or the consumer project).
+ "monitoredResource": "A String", # The monitored resource type. The type must be defined in
+ # Service.monitored_resources section.
+ "metrics": [ # Names of the metrics to report to this monitoring destination.
+ # Each name must be defined in Service.metrics section.
+ "A String",
+ ],
+ },
+ ],
+ },
+ "title": "A String", # The product title associated with this service.
+ "id": "A String", # 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.
+ "authentication": { # `Authentication` defines the authentication configuration for an API. # Auth configuration.
+ #
+ # Example for an API targeted for external use:
+ #
+ # name: calendar.googleapis.com
+ # authentication:
+ # rules:
+ # - selector: "*"
+ # oauth:
+ # canonical_scopes: https://www.googleapis.com/auth/calendar
+ #
+ # - selector: google.calendar.Delegate
+ # oauth:
+ # canonical_scopes: https://www.googleapis.com/auth/calendar.read
+ "rules": [ # A list of authentication rules that apply to individual API methods.
+ #
+ # **NOTE:** All service configuration rules follow "last one wins" order.
+ { # 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.
+ "oauth": { # OAuth scopes are a way to define data and permissions on data. For example, # The requirements for OAuth credentials.
+ # 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": "A String", # 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
+ },
+ "requirements": [ # Requirements for additional authentication providers.
+ { # User-defined authentication requirements, including support for
+ # [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).
+ "providerId": "A String", # id from authentication provider.
+ #
+ # Example:
+ #
+ # provider_id: bookstore_auth
+ "audiences": "A String", # 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/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
+ },
+ ],
+ "allowWithoutCredential": True or False, # Whether to allow requests without a credential. If quota is enabled, an
+ # API key is required for such request to pass the quota check.
+ "selector": "A String", # Selects the methods to which this rule applies.
+ #
+ # Refer to selector for syntax details.
+ },
+ ],
+ "providers": [ # Defines a set of authentication providers that a service supports.
+ { # Configuration for an anthentication provider, including support for
+ # [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).
+ "jwksUri": "A String", # 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
+ "id": "A String", # The unique identifier of the auth provider. It will be referred to by
+ # `AuthRequirement.provider_id`.
+ #
+ # Example: "bookstore_auth".
+ "issuer": "A String", # 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
+ },
+ ],
+ },
+ "usage": { # Configuration controlling usage of a service. # Configuration controlling usage of this service.
+ "rules": [ # A list of usage rules that apply to individual API methods.
+ #
+ # **NOTE:** All service configuration rules follow "last one wins" order.
+ { # 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": "A String", # Selects the methods to which this rule applies. Use '*' to indicate all
+ # methods in all APIs.
+ #
+ # Refer to selector for syntax details.
+ "allowUnregisteredCalls": True or False, # True, if the method allows unregistered calls; false otherwise.
+ },
+ ],
+ "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'.
+ "A String",
+ ],
+ },
+ "configVersion": 42, # The version of the service configuration. The config version may
+ # influence interpretation of the configuration, for example, to
+ # determine defaults. This is documented together with applicable
+ # options. The current default for the config version itself is `3`.
+ "producerProjectId": "A String", # The id of the Google developer project that owns the service.
+ # Members of this project can manage the service configuration,
+ # manage consumption of the service, etc.
+ "http": { # Defines the HTTP configuration for a service. It contains a list of # HTTP configuration.
+ # 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.
+ { # `HttpRule` defines the mapping of an RPC method to one or more HTTP
+ # REST APIs. The mapping determines what portions of the request
+ # message are populated from the path, query parameters, or body of
+ # the HTTP request. The mapping is typically specified as an
+ # `google.api.http` annotation, see "google/api/annotations.proto"
+ # for details.
+ #
+ # The mapping consists of a field specifying the path template and
+ # method kind. The path template can refer to fields in the request
+ # message, as in the example below which describes a REST GET
+ # operation on a resource collection of messages:
+ #
+ # ```proto
+ # service Messaging {
+ # rpc GetMessage(GetMessageRequest) returns (Message) {
+ # option (google.api.http).get = "/v1/messages/{message_id}/{sub.subfield}";
+ # }
+ # }
+ # message GetMessageRequest {
+ # message SubMessage {
+ # string subfield = 1;
+ # }
+ # string message_id = 1; // mapped to the URL
+ # SubMessage sub = 2; // `sub.subfield` is url-mapped
+ # }
+ # message Message {
+ # string text = 1; // content of the resource
+ # }
+ # ```
+ #
+ # This definition enables an automatic, bidrectional mapping of HTTP
+ # JSON to RPC. Example:
+ #
+ # HTTP | RPC
+ # -----|-----
+ # `GET /v1/messages/123456/foo` | `GetMessage(message_id: "123456" sub: SubMessage(subfield: "foo"))`
+ #
+ # In general, not only fields but also field paths can be referenced
+ # from a path pattern. Fields mapped to the path pattern cannot be
+ # repeated and must have a primitive (non-message) type.
+ #
+ # Any fields in the request message which are not bound by the path
+ # pattern automatically become (optional) HTTP query
+ # parameters. Assume the following definition of the request message:
+ #
+ # ```proto
+ # message GetMessageRequest {
+ # message SubMessage {
+ # string subfield = 1;
+ # }
+ # string message_id = 1; // mapped to the URL
+ # int64 revision = 2; // becomes a parameter
+ # SubMessage sub = 3; // `sub.subfield` becomes a parameter
+ # }
+ # ```
+ #
+ # This enables a HTTP JSON to RPC mapping as below:
+ #
+ # HTTP | RPC
+ # -----|-----
+ # `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 HTTP parameters must have a
+ # primitive type or a repeated primitive type. Message types are not
+ # allowed. In the case of a repeated type, the parameter can be
+ # repeated in the URL, as in `...?param=A¶m=B`.
+ #
+ # For HTTP method kinds which allow a request body, the `body` field
+ # specifies the mapping. Consider a REST update method on the
+ # message resource collection:
+ #
+ # ```proto
+ # service Messaging {
+ # rpc UpdateMessage(UpdateMessageRequest) returns (Message) {
+ # option (google.api.http) = {
+ # put: "/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 | RPC
+ # -----|-----
+ # `PUT /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:
+ #
+ # ```proto
+ # service Messaging {
+ # rpc UpdateMessage(Message) returns (Message) {
+ # option (google.api.http) = {
+ # put: "/v1/messages/{message_id}"
+ # body: "*"
+ # };
+ # }
+ # }
+ # message Message {
+ # string message_id = 1;
+ # string text = 2;
+ # }
+ # ```
+ #
+ # The following HTTP JSON to RPC mapping is enabled:
+ #
+ # HTTP | RPC
+ # -----|-----
+ # `PUT /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 of
+ # 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:
+ #
+ # ```proto
+ # 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 | RPC
+ # -----|-----
+ # `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
+ #
+ # The rules for mapping HTTP path, query parameters, and body fields
+ # to the request message are as follows:
+ #
+ # 1. The `body` field specifies either `*` or a field path, or is
+ # omitted. If omitted, it assumes there is no HTTP body.
+ # 2. Leaf fields (recursive expansion of nested messages in the
+ # request) can be classified into three types:
+ # (a) Matched in the URL template.
+ # (b) Covered by body (if body is `*`, everything except (a) fields;
+ # else everything under the body field)
+ # (c) All other fields.
+ # 3. URL query parameters found in the HTTP request are mapped to (c) fields.
+ # 4. Any body sent with an HTTP request can contain only (b) fields.
+ #
+ # The syntax of the path template is as follows:
+ #
+ # Template = "/" Segments [ Verb ] ;
+ # Segments = Segment { "/" Segment } ;
+ # Segment = "*" | "**" | LITERAL | Variable ;
+ # Variable = "{" FieldPath [ "=" Segments ] "}" ;
+ # FieldPath = IDENT { "." IDENT } ;
+ # Verb = ":" LITERAL ;
+ #
+ # The syntax `*` matches a single path segment. It follows the semantics of
+ # [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String
+ # Expansion.
+ #
+ # The syntax `**` matches zero or more path segments. It follows the semantics
+ # of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.3 Reserved
+ # Expansion.
+ #
+ # The syntax `LITERAL` matches literal text in the URL path.
+ #
+ # The syntax `Variable` matches the entire path as specified by its template;
+ # this nested template must not contain further variables. If a variable
+ # matches a single path segment, its template may be omitted, e.g. `{var}`
+ # is equivalent to `{var=*}`.
+ #
+ # NOTE: the field paths in variables and in the `body` must not refer to
+ # repeated fields or map fields.
+ #
+ # Use CustomHttpPattern to specify any HTTP method that is not included in the
+ # `pattern` field, such as HEAD, or "*" to leave the HTTP method unspecified for
+ # a given URL path rule. The wild-card rule is useful for services that provide
+ # content to Web (HTML) clients.
+ "body": "A String", # The name of the request field whose value is mapped to the HTTP body, or
+ # `*` for mapping all fields not captured by the path pattern to the HTTP
+ # body. NOTE: the referred field must not be a repeated field and must be
+ # present at the top-level of response message type.
+ "get": "A String", # Used for listing and getting information about resources.
+ "mediaDownload": { # Do not use this. For media support, add instead # Do not use this. For media support, add instead
+ # [][google.bytestream.RestByteStream] as an API to your
+ # configuration.
+ # [][google.bytestream.RestByteStream] as an API to your
+ # configuration.
+ "enabled": True or False, # Whether download is enabled.
+ },
+ "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).
+ # Object with schema name: HttpRule
+ ],
+ "mediaUpload": { # Do not use this. For media support, add instead # Do not use this. For media support, add instead
+ # [][google.bytestream.RestByteStream] as an API to your
+ # configuration.
+ # [][google.bytestream.RestByteStream] as an API to your
+ # configuration.
+ "enabled": True or False, # Whether upload is enabled.
+ },
+ "custom": { # A custom pattern is used for defining custom HTTP verb. # Custom pattern is used for defining custom verbs.
+ "path": "A String", # The path matched by this custom verb.
+ "kind": "A String", # The name of this custom HTTP verb.
+ },
+ "responseBody": "A String", # The name of the response field whose value is mapped to the HTTP body of
+ # response. Other response fields are ignored. This field is optional. When
+ # not set, the response message will be used as HTTP body of response.
+ # NOTE: the referred field must be not a repeated field and must be present
+ # at the top-level of response message type.
+ "put": "A String", # Used for updating a resource.
+ "patch": "A String", # Used for updating a resource.
+ "post": "A String", # Used for creating a resource.
+ "selector": "A String", # Selects methods to which this rule applies.
+ #
+ # Refer to selector for syntax details.
+ "delete": "A String", # Used for deleting a resource.
+ },
+ ],
+ },
+ "apis": [ # A list of API interfaces exported by this service. Only the `name` field
+ # of the 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.
+ { # Api is a light-weight descriptor for a protocol buffer service.
+ "methods": [ # The methods of this api, in unspecified order.
+ { # Method represents a method of an api.
+ "name": "A String", # The simple name of this method.
+ "requestStreaming": True or False, # If true, the request is streamed.
+ "responseTypeUrl": "A String", # The URL of the output message type.
+ "requestTypeUrl": "A String", # A URL of the input message type.
+ "responseStreaming": True or False, # If true, the response is streamed.
+ "syntax": "A String", # The source syntax of this method.
+ "options": [ # Any metadata attached to the method.
+ { # A protocol buffer option, which can be attached to a message, field,
+ # enumeration, etc.
+ "name": "A String", # The option's name. For example, `"java_package"`.
+ "value": { # The option's value. For example, `"com.google.protobuf"`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ },
+ ],
+ },
+ ],
+ "sourceContext": { # `SourceContext` represents information about the source of a # Source context for the protocol buffer service represented by this
+ # message.
+ # protobuf element, like the file in which it is defined.
+ "fileName": "A String", # The path-qualified name of the .proto file that contained the associated
+ # protobuf element. For example: `"google/protobuf/source_context.proto"`.
+ },
+ "mixins": [ # Included APIs. See Mixin.
+ { # Declares an API to be included in this API. The including API must
+ # redeclare all the methods from the included API, but documentation
+ # and options are inherited as follows:
+ #
+ # - If after comment and whitespace stripping, the documentation
+ # string of the redeclared method is empty, it will be inherited
+ # from the original method.
+ #
+ # - Each annotation belonging to the service config (http,
+ # visibility) which is not set in the redeclared method will be
+ # inherited.
+ #
+ # - If an http annotation is inherited, the path pattern will be
+ # modified as follows. Any version prefix will be replaced by the
+ # version of the including API plus the root path if specified.
+ #
+ # Example of a simple mixin:
+ #
+ # package google.acl.v1;
+ # service AccessControl {
+ # // Get the underlying ACL object.
+ # rpc GetAcl(GetAclRequest) returns (Acl) {
+ # option (google.api.http).get = "/v1/{resource=**}:getAcl";
+ # }
+ # }
+ #
+ # package google.storage.v2;
+ # service Storage {
+ # // rpc GetAcl(GetAclRequest) returns (Acl);
+ #
+ # // Get a data record.
+ # rpc GetData(GetDataRequest) returns (Data) {
+ # option (google.api.http).get = "/v2/{resource=**}";
+ # }
+ # }
+ #
+ # Example of a mixin configuration:
+ #
+ # apis:
+ # - name: google.storage.v2.Storage
+ # mixins:
+ # - name: google.acl.v1.AccessControl
+ #
+ # The mixin construct implies that all methods in `AccessControl` are
+ # also declared with same name and request/response types in
+ # `Storage`. A documentation generator or annotation processor will
+ # see the effective `Storage.GetAcl` method after inherting
+ # documentation and annotations as follows:
+ #
+ # service Storage {
+ # // Get the underlying ACL object.
+ # rpc GetAcl(GetAclRequest) returns (Acl) {
+ # option (google.api.http).get = "/v2/{resource=**}:getAcl";
+ # }
+ # ...
+ # }
+ #
+ # Note how the version in the path pattern changed from `v1` to `v2`.
+ #
+ # If the `root` field in the mixin is specified, it should be a
+ # relative path under which inherited HTTP paths are placed. Example:
+ #
+ # apis:
+ # - name: google.storage.v2.Storage
+ # mixins:
+ # - name: google.acl.v1.AccessControl
+ # root: acls
+ #
+ # This implies the following inherited HTTP annotation:
+ #
+ # service Storage {
+ # // Get the underlying ACL object.
+ # rpc GetAcl(GetAclRequest) returns (Acl) {
+ # option (google.api.http).get = "/v2/acls/{resource=**}:getAcl";
+ # }
+ # ...
+ # }
+ "root": "A String", # If non-empty specifies a path under which inherited HTTP paths
+ # are rooted.
+ "name": "A String", # The fully qualified name of the API which is included.
+ },
+ ],
+ "syntax": "A String", # The source syntax of the service.
+ "version": "A String", # A version string for this api. If specified, must have the form
+ # `major-version.minor-version`, as in `1.10`. If the minor version
+ # is omitted, it defaults to zero. If the entire version field is
+ # empty, the major version is derived from the package name, as
+ # outlined below. If the field is not empty, the version in the
+ # package name will be verified to be consistent with what is
+ # provided here.
+ #
+ # The versioning schema uses [semantic
+ # versioning](http://semver.org) where the major version number
+ # indicates a breaking change and the minor version an additive,
+ # non-breaking change. Both version numbers are signals to users
+ # what to expect from different versions, and should be carefully
+ # chosen based on the product plan.
+ #
+ # The major version is also reflected in the package name of the
+ # API, which must end in `v<major-version>`, as in
+ # `google.feature.v1`. For major versions 0 and 1, the suffix can
+ # be omitted. Zero major versions must only be used for
+ # experimental, none-GA apis.
+ "options": [ # Any metadata attached to the API.
+ { # A protocol buffer option, which can be attached to a message, field,
+ # enumeration, etc.
+ "name": "A String", # The option's name. For example, `"java_package"`.
+ "value": { # The option's value. For example, `"com.google.protobuf"`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ },
+ ],
+ "name": "A String", # The fully qualified name of this api, including package name
+ # followed by the api's simple name.
+ },
+ ],
+ "customError": { # Customize service error responses. For example, list any service # Custom error configuration.
+ # specific protobuf types that can appear in error detail lists of
+ # error responses.
+ #
+ # Example:
+ #
+ # custom_error:
+ # types:
+ # - google.foo.v1.CustomError
+ # - google.foo.v1.AnotherError
+ "rules": [ # The list of custom error rules that apply to individual API messages.
+ #
+ # **NOTE:** All service configuration rules follow "last one wins" order.
+ { # A custom error rule.
+ "isErrorType": True or False, # Mark this message as possible payload in error response. Otherwise,
+ # objects of this type will be filtered when they appear in error payload.
+ "selector": "A String", # Selects messages to which this rule applies.
+ #
+ # Refer to selector for syntax details.
+ },
+ ],
+ "types": [ # The list of custom error detail types, e.g. 'google.foo.v1.CustomError'.
+ "A String",
+ ],
+ },
+ "visibility": { # `Visibility` defines restrictions for the visibility of service # API visibility configuration.
+ # elements. Restrictions are specified using visibility labels
+ # (e.g., TRUSTED_TESTER) that are elsewhere linked to users and projects.
+ #
+ # Users and projects can have access to more than one visibility label. The
+ # effective visibility for multiple labels is the union of each label's
+ # elements, plus any unrestricted elements.
+ #
+ # If an element and its parents have no restrictions, visibility is
+ # unconditionally granted.
+ #
+ # Example:
+ #
+ # visibility:
+ # rules:
+ # - selector: google.calendar.Calendar.EnhancedSearch
+ # restriction: TRUSTED_TESTER
+ # - selector: google.calendar.Calendar.Delegate
+ # restriction: GOOGLE_INTERNAL
+ #
+ # Here, all methods are publicly visible except for the restricted methods
+ # EnhancedSearch and Delegate.
+ "rules": [ # 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.
+ "restriction": "A String", # Lists the visibility labels for this rule. Any of the listed labels grants
+ # visibility to the element.
+ #
+ # 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: GOOGLE_INTERNAL, TRUSTED_TESTER
+ #
+ # Removing GOOGLE_INTERNAL from this restriction will break clients that
+ # rely on this method and only had access to it through GOOGLE_INTERNAL.
+ "selector": "A String", # Selects methods, messages, fields, enums, etc. to which this rule applies.
+ #
+ # Refer to selector for syntax details.
+ },
+ ],
+ },
+ "metrics": [ # Defines the metrics used by this service.
+ { # Defines a metric type and its schema.
+ "displayName": "A String", # A concise name for the metric, which can be displayed in user interfaces.
+ # Use sentence case without an ending period, for example "Request count".
+ "description": "A String", # A detailed description of the metric, which can be used in documentation.
+ "metricKind": "A String", # Whether the metric records instantaneous values, changes to a value, etc.
+ "valueType": "A String", # Whether the measurement is an integer, a floating-point number, etc.
+ "labels": [ # The set of labels that can be used to describe a specific instance of this
+ # metric type. For example, the
+ # `compute.googleapis.com/instance/network/received_bytes_count` metric type
+ # has a label, `loadbalanced`, that specifies whether the traffic was
+ # received through a load balanced IP address.
+ { # A description of a label.
+ "valueType": "A String", # The type of data that can be assigned to the label.
+ "description": "A String", # A human-readable description for the label.
+ "key": "A String", # The label key.
+ },
+ ],
+ "type": "A String", # The metric type including a DNS name prefix, for example
+ # `"compute.googleapis.com/instance/cpu/utilization"`. Metric types
+ # should use a natural hierarchical grouping such as the following:
+ #
+ # compute.googleapis.com/instance/cpu/utilization
+ # compute.googleapis.com/instance/disk/read_ops_count
+ # compute.googleapis.com/instance/network/received_bytes_count
+ #
+ # Note that if the metric type changes, the monitoring data will be
+ # discontinued, and anything depends on it will break, such as monitoring
+ # dashboards, alerting rules and quota limits. Therefore, once a metric has
+ # been published, its type should be immutable.
+ "unit": "A String", # 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 includes the dimensionless unit `1`, such as `1/s`.
+ #
+ # 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 '}'.
+ "name": "A String", # Resource name. The format of the name may vary between different
+ # implementations. For examples:
+ #
+ # projects/{project_id}/metricDescriptors/{type=**}
+ # metricDescriptors/{type=**}
+ },
+ ],
+ "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
+ { # Enum type definition.
+ "sourceContext": { # `SourceContext` represents information about the source of a # The source context.
+ # protobuf element, like the file in which it is defined.
+ "fileName": "A String", # The path-qualified name of the .proto file that contained the associated
+ # protobuf element. For example: `"google/protobuf/source_context.proto"`.
+ },
+ "enumvalue": [ # Enum value definitions.
+ { # Enum value definition.
+ "number": 42, # Enum value number.
+ "options": [ # Protocol buffer options.
+ { # A protocol buffer option, which can be attached to a message, field,
+ # enumeration, etc.
+ "name": "A String", # The option's name. For example, `"java_package"`.
+ "value": { # The option's value. For example, `"com.google.protobuf"`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ },
+ ],
+ "name": "A String", # Enum value name.
+ },
+ ],
+ "options": [ # Protocol buffer options.
+ { # A protocol buffer option, which can be attached to a message, field,
+ # enumeration, etc.
+ "name": "A String", # The option's name. For example, `"java_package"`.
+ "value": { # The option's value. For example, `"com.google.protobuf"`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ },
+ ],
+ "name": "A String", # Enum type name.
+ "syntax": "A String", # The source syntax.
+ },
+ ],
+ "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
+ { # A protocol buffer message type.
+ "oneofs": [ # The list of types appearing in `oneof` definitions in this type.
+ "A String",
+ ],
+ "name": "A String", # The fully qualified message name.
+ "sourceContext": { # `SourceContext` represents information about the source of a # The source context.
+ # protobuf element, like the file in which it is defined.
+ "fileName": "A String", # The path-qualified name of the .proto file that contained the associated
+ # protobuf element. For example: `"google/protobuf/source_context.proto"`.
+ },
+ "syntax": "A String", # The source syntax.
+ "fields": [ # The list of fields.
+ { # A single field of a message type.
+ "kind": "A String", # The field type.
+ "oneofIndex": 42, # The index of the field type in `Type.oneofs`, for message or enumeration
+ # types. The first type has index 1; zero means the type is not in the list.
+ "typeUrl": "A String", # The field type URL, without the scheme, for message or enumeration
+ # types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`.
+ "name": "A String", # The field name.
+ "defaultValue": "A String", # The string value of the default value of this field. Proto2 syntax only.
+ "jsonName": "A String", # The field JSON name.
+ "number": 42, # The field number.
+ "cardinality": "A String", # The field cardinality.
+ "options": [ # The protocol buffer options.
+ { # A protocol buffer option, which can be attached to a message, field,
+ # enumeration, etc.
+ "name": "A String", # The option's name. For example, `"java_package"`.
+ "value": { # The option's value. For example, `"com.google.protobuf"`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ },
+ ],
+ "packed": True or False, # Whether to use alternative packed wire representation.
+ },
+ ],
+ "options": [ # The protocol buffer options.
+ { # A protocol buffer option, which can be attached to a message, field,
+ # enumeration, etc.
+ "name": "A String", # The option's name. For example, `"java_package"`.
+ "value": { # The option's value. For example, `"com.google.protobuf"`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ },
+ ],
+ },
+ ],
+ "logging": { # 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 `library.googleapis.com/activity_history` log is
+ # sent to both the producer and consumer projects, whereas
+ # the `library.googleapis.com/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: library.googleapis.com/activity_history
+ # labels:
+ # - key: /customer_id
+ # - name: library.googleapis.com/purchase_history
+ # logging:
+ # producer_destinations:
+ # - monitored_resource: library.googleapis.com/branch
+ # logs:
+ # - library.googleapis.com/activity_history
+ # - library.googleapis.com/purchase_history
+ # consumer_destinations:
+ # - monitored_resource: library.googleapis.com/branch
+ # logs:
+ # - library.googleapis.com/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.
+ { # Configuration of a specific logging destination (the producer project
+ # or the consumer project).
+ "monitoredResource": "A String", # The monitored resource type. The type must be defined in
+ # Service.monitored_resources section.
+ "logs": [ # Names of the logs to be sent to this destination. Each name must
+ # be defined in the Service.logs section.
+ "A String",
+ ],
+ },
+ ],
+ "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.
+ { # Configuration of a specific logging destination (the producer project
+ # or the consumer project).
+ "monitoredResource": "A String", # The monitored resource type. The type must be defined in
+ # Service.monitored_resources section.
+ "logs": [ # Names of the logs to be sent to this destination. Each name must
+ # be defined in the Service.logs section.
+ "A String",
+ ],
+ },
+ ],
+ },
+ "name": "A String", # The DNS address at which this service is available,
+ # e.g. `calendar.googleapis.com`.
+ "documentation": { # `Documentation` provides the information for describing a service. # Additional API documentation.
+ #
+ # 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>
+ # Comments can be made conditional using a visibility label. The below
+ # text will be only rendered if the `BETA` label is available:
+ # <pre><code>(--BETA: comment for BETA users --)</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.
+ "rules": [ # A list of documentation rules that apply to individual API elements.
+ #
+ # **NOTE:** All service configuration rules follow "last one wins" order.
+ { # A documentation rule provides information about individual API elements.
+ "description": "A String", # Description of the selected API(s).
+ "deprecationDescription": "A String", # Deprecation description of the selected element(s). It can be provided if an
+ # element is marked as `deprecated`.
+ "selector": "A String", # 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". To
+ # specify a default for all applicable elements, the whole pattern "*"
+ # is used.
+ },
+ ],
+ "overview": "A String", # 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.
+ "summary": "A String", # A short summary of what the service does. Can only be provided by
+ # plain text.
+ "pages": [ # The top level pages for the documentation set.
+ { # Represents a documentation page. A page can contain subpages to represent
+ # nested documentation set structure.
+ "content": "A String", # 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.
+ # Object with schema name: Page
+ ],
+ "name": "A String", # 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`.
+ },
+ ],
+ "documentationRootUrl": "A String", # The URL to the root of documentation.
+ },
+ "systemTypes": [ # A list of all proto message types included in this API service.
+ # It serves similar purpose as [google.api.Service.types], except that
+ # these types are not needed by user-defined APIs. Therefore, they will not
+ # show up in the generated discovery doc. This field should only be used
+ # to define system APIs in ESF.
+ { # A protocol buffer message type.
+ "oneofs": [ # The list of types appearing in `oneof` definitions in this type.
+ "A String",
+ ],
+ "name": "A String", # The fully qualified message name.
+ "sourceContext": { # `SourceContext` represents information about the source of a # The source context.
+ # protobuf element, like the file in which it is defined.
+ "fileName": "A String", # The path-qualified name of the .proto file that contained the associated
+ # protobuf element. For example: `"google/protobuf/source_context.proto"`.
+ },
+ "syntax": "A String", # The source syntax.
+ "fields": [ # The list of fields.
+ { # A single field of a message type.
+ "kind": "A String", # The field type.
+ "oneofIndex": 42, # The index of the field type in `Type.oneofs`, for message or enumeration
+ # types. The first type has index 1; zero means the type is not in the list.
+ "typeUrl": "A String", # The field type URL, without the scheme, for message or enumeration
+ # types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`.
+ "name": "A String", # The field name.
+ "defaultValue": "A String", # The string value of the default value of this field. Proto2 syntax only.
+ "jsonName": "A String", # The field JSON name.
+ "number": 42, # The field number.
+ "cardinality": "A String", # The field cardinality.
+ "options": [ # The protocol buffer options.
+ { # A protocol buffer option, which can be attached to a message, field,
+ # enumeration, etc.
+ "name": "A String", # The option's name. For example, `"java_package"`.
+ "value": { # The option's value. For example, `"com.google.protobuf"`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ },
+ ],
+ "packed": True or False, # Whether to use alternative packed wire representation.
+ },
+ ],
+ "options": [ # The protocol buffer options.
+ { # A protocol buffer option, which can be attached to a message, field,
+ # enumeration, etc.
+ "name": "A String", # The option's name. For example, `"java_package"`.
+ "value": { # The option's value. For example, `"com.google.protobuf"`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ },
+ ],
+ },
+ ],
+ "context": { # `Context` defines which contexts an API requests. # Context configuration.
+ #
+ # 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`.
+ "rules": [ # 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.
+ "provided": [ # A list of full type names of provided contexts.
+ "A String",
+ ],
+ "requested": [ # A list of full type names of requested contexts.
+ "A String",
+ ],
+ "selector": "A String", # Selects the methods to which this rule applies.
+ #
+ # Refer to selector for syntax details.
+ },
+ ],
+ },
+ },
+ ],
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
+ <pre>Retrieves the next page of results.
+
+Args:
+ previous_request: The request for the previous page. (required)
+ previous_response: The response from the request for the previous page. (required)
+
+Returns:
+ A request object that you can call 'execute()' on to request the next
+ page. Returns None if there are no more items in the collection.
+ </pre>
+</div>
+
+<div class="method">
+ <code class="details" id="submit">submit(serviceName=None, body, x__xgafv=None)</code>
+ <pre>Creates a new service configuration (version) for a managed service based
+on
+user-supplied configuration source files (for example: OpenAPI
+Specification). This method stores the source configurations as well as the
+generated service configuration. To rollout the service configuration to
+other services,
+please call CreateServiceRollout.
+
+Operation<response: SubmitConfigSourceResponse>
+
+Args:
+ serviceName: string, The name of the service. See the [overview](/service-management/overview)
+for naming requirements. For example: `example.googleapis.com`. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # Request message for SubmitConfigSource method.
+ "validateOnly": True or False, # Optional. If set, this will result in the generation of a
+ # `google.api.Service` configuration based on the `ConfigSource` provided,
+ # but the generated config and the sources will NOT be persisted.
+ "configSource": { # Represents a source file which is used to generate the service configuration # The source configuration for the service.
+ # defined by `google.api.Service`.
+ "files": [ # Set of source configuration files that are used to generate a service
+ # configuration (`google.api.Service`).
+ { # Generic specification of a source configuration file
+ "fileContents": "A String", # The bytes that constitute the file.
+ "fileType": "A String", # The type of configuration file this represents.
+ "filePath": "A String", # The file name of the configuration file (full or relative path).
+ },
+ ],
+ "id": "A String", # 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.
+ },
+ }
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a
+ # network API call.
+ "metadata": { # Service-specific metadata associated with the operation. It typically
+ # contains progress information and common metadata such as create time.
+ # Some services might not provide such metadata. Any method that returns a
+ # long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "done": True or False, # If the value is `false`, it means the operation is still in progress.
+ # If true, the operation is completed, and either `error` or `response` is
+ # available.
+ "response": { # The normal response of the operation in case of success. If the original
+ # method returns no data on success, such as `Delete`, the response is
+ # `google.protobuf.Empty`. If the original method is standard
+ # `Get`/`Create`/`Update`, the response should be the resource. For other
+ # methods, the response should have the type `XxxResponse`, where `Xxx`
+ # is the original method name. For example, if the original method name
+ # is `TakeSnapshot()`, the inferred response type is
+ # `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that
+ # originally returns it. If you use the default HTTP mapping, the
+ # `name` should have the format of `operations/some/unique/name`.
+ "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure.
+ # programming environments, including REST APIs and RPC APIs. It is used by
+ # [gRPC](https://github.com/grpc). The error model is designed to be:
+ #
+ # - Simple to use and understand for most users
+ # - Flexible enough to meet unexpected needs
+ #
+ # # Overview
+ #
+ # The `Status` message contains three pieces of data: error code, error message,
+ # and error details. The error code should be an enum value of
+ # google.rpc.Code, but it may accept additional error codes if needed. The
+ # error message should be a developer-facing English message that helps
+ # developers *understand* and *resolve* the error. If a localized user-facing
+ # error message is needed, put the localized message in the error details or
+ # localize it in the client. The optional error details may contain arbitrary
+ # information about the error. There is a predefined set of error detail types
+ # in the package `google.rpc` which can be used for common error conditions.
+ #
+ # # Language mapping
+ #
+ # The `Status` message is the logical representation of the error model, but it
+ # is not necessarily the actual wire format. When the `Status` message is
+ # exposed in different client libraries and different wire protocols, it can be
+ # mapped differently. For example, it will likely be mapped to some exceptions
+ # in Java, but more likely mapped to some error codes in C.
+ #
+ # # Other uses
+ #
+ # The error model and the `Status` message can be used in a variety of
+ # environments, either with or without APIs, to provide a
+ # consistent developer experience across different environments.
+ #
+ # Example uses of this error model include:
+ #
+ # - Partial errors. If a service needs to return partial errors to the client,
+ # it may embed the `Status` in the normal response to indicate the partial
+ # errors.
+ #
+ # - Workflow errors. A typical workflow has multiple steps. Each step may
+ # have a `Status` message for error reporting purpose.
+ #
+ # - Batch operations. If a client uses batch request and batch response, the
+ # `Status` message should be used directly inside batch response, one for
+ # each error sub-response.
+ #
+ # - Asynchronous operations. If an API call embeds asynchronous operation
+ # results in its response, the status of those operations should be
+ # represented directly using the `Status` message.
+ #
+ # - Logging. If some API errors are stored in logs, the message `Status` could
+ # be used directly after any stripping needed for security/privacy reasons.
+ "message": "A String", # 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 field, or localized by the client.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There will be a
+ # common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file