^>SrSSKJr SSKJr SSKJr SSKJr Sr "SS\R5r "S S \R5r "S S \R5r "S S\R5r"SS\R5r"SS\R5r"SS\R5r"SS\R5r"SS\R5r"SS\R5r"SS\R5r"SS\R5r"SS \R5r"S!S"\R5r"S#S$\R5r"S%S&\R5r"S'S(\R5r"S)S*\R5r"S+S,\R5r"S-S.\R5r"S/S0\R5r"S1S2\R5r "S3S4\R5r!"S5S6\R5r""S7S8\R5r#"S9S:\R5r$"S;S<\R5r%"S=S>\R5r&"S?S@\R5r'"SASB\R5r("SCSD\R5r)"SESF\R5r*"SGSH\R5r+"SISJ\R5r,"SKSL\R5r-"SMSN\R5r."SOSP\R5r/"SQSR\R5r0"SSST\R5r1"SUSV\R5r2"SWSX\R5r3"SYSZ\R5r4"S[S\\R5r5"S]S^\R5r6"S_S`\R5r7"SaSb\R5r8"ScSd\R5r9"SeSf\R5r:"SgSh\R5r;"SiSj\R5r<"SkSl\R5r="SmSn\R5r>"SoSp\R5r?"SqSr\R5r@"SsSt\R5rA"SuSv\R5rB"SwSx\R5rC"SySz\R5rD"S{S|\R5rE"S}S~\R5rF"SS\R5rG"SS\R5rH"SS\R5rI"SS\R5rJ"SS\R5rK"SS\R5rL"SS\R5rM"SS\R5rN"SS\R5rO"SS\R5rP"SS\R5rQ"SS\R5rR"SS\R5rS"SS\R5rT"SS\R5rU"SS\R5rV"SS\R5rW"SS\R5rX"SS\R5rY"SS\R5rZ"SS\R5r["SS\R5r\"SS\R5r]"SS\R5r^"SS\R5r_"SS\R5r`"SS\R5ra"SS\R5rb"SS\R5rc"SS\R5rd"SS\R5re"SS\R5rf"SS\R5rg"SS\R5rh"SS\R5ri"SS\R5rj"SS\R5rk"SS\R5rl"SS\R5rm"SS\R5rn"SS\R5ro"SS\R5rp"SS\R5rq"SS\R5rr"SS\R5rs"SS\R5rt"SS\R5ru"SS\R5rv"SS\R5rw"SS\R5rx"SS\R5ry"SS\R5rz"SS\R5r{"SS\R5r|"SS\R5r}"SS\R5r~"SS\R5r"SS\R5r"SS\R5r"SS\R5r"SS\R5r"SS\R5r"SS\R5r"SS\R5r"SGS\R5r"GSGS\R5r"GSGS\R5r"GSGS\R5r"GSGS\R5r"GS GS \R5r"GS GS \R5r"GS GS\R5r"GSGS\R5r"GSGS\R5r"GSGS\R5r"GSGS\R5r"GSGS\R5r"GSGS\R5r"GSGS\R5r"GSGS\R5r"GSGS \R5r"GS!GS"\R5r"GS#GS$\R5r"GS%GS&\R5r"GS'GS(\R5r"GS)GS*\R5r\GR:"\GS+GS,5 \GR<"\GR>GS-GS.5 \GR<"\GR>GS/GS05 Gg1(2zGenerated message classes for serviceusage version v2alpha. Enables services that service consumers want to use on Google Cloud Platform, lists the available or enabled services, or disables services that service consumers no longer use. )absolute_import)messages)encoding) extra_types serviceusagec\rSrSrSrSrg)AddEnableRulesMetadataz)Metadata for the `AddEnableRules` method.N__name__ __module__ __qualname____firstlineno____doc____static_attributes__r _lib/googlecloudsdk/generated_clients/apis/serviceusage/v2alpha/serviceusage_v2alpha_messages.pyr r s2rr c^\rSrSrSr\R "SSS9r\R "S5rSr g) AddEnableRulesResponsea@The response message of `AddEnableRules` method. Fields: addedValues: The values added to the parent consumer policy. parent: The parent consumer policy. It can be `projects/12345/consumerPolicies/default`, or `folders/12345/consumerPolicies/default`, or `organizations/12345/consumerPolicies/default`. Trepeatedr N) r rrrr _messages StringField addedValuesparentrr rrrrs+%%a$7+   #&rrcF\rSrSrSr\R "S5"SS\R55r \R"S5r \R"SS5r \R"S5r\R"S 5r\R "S 5r\R"S 5rS rg )AdminQuotaPolicy&aQuota policy created by quota administrator. Messages: DimensionsValue: If this map is nonempty, then this policy applies only to specific values for dimensions defined in the limit unit. For example, a policy on a limit with the unit `1/{project}/{region}` could contain an entry with the key `region` and the value `us-east-1`; the policy is only applied to quota consumed in that region. This map has the following restrictions: * If `region` appears as a key, its value must be a valid Cloud region. * If `zone` appears as a key, its value must be a valid Cloud zone. * Keys other than `region` or `zone` are not valid. Fields: container: The cloud resource container at which the quota policy is created. The format is `{container_type}/{container_number}` dimensions: If this map is nonempty, then this policy applies only to specific values for dimensions defined in the limit unit. For example, a policy on a limit with the unit `1/{project}/{region}` could contain an entry with the key `region` and the value `us-east-1`; the policy is only applied to quota consumed in that region. This map has the following restrictions: * If `region` appears as a key, its value must be a valid Cloud region. * If `zone` appears as a key, its value must be a valid Cloud zone. * Keys other than `region` or `zone` are not valid. metric: The name of the metric to which this policy applies. An example name would be: `compute.googleapis.com/cpus` name: The resource name of the policy. This name is generated by the server when the policy is created. Example names would be: `organization s/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googl eapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminQuotaPolicies/4a3f2c1d` policyValue: The quota policy value. Can be any nonnegative integer, or -1 (unlimited quota). unit: The limit unit of the limit to which this policy applies. An example unit would be: `1/{project}/{region}` Note that `{project}` and `{region}` are not placeholders in this example; the literal characters `{` and `}` occur in the string. additionalPropertiescf\rSrSrSr"SS\R 5r\R"SSSS9r Sr g ) AdminQuotaPolicy.DimensionsValueMaIf this map is nonempty, then this policy applies only to specific values for dimensions defined in the limit unit. For example, a policy on a limit with the unit `1/{project}/{region}` could contain an entry with the key `region` and the value `us-east-1`; the policy is only applied to quota consumed in that region. This map has the following restrictions: * If `region` appears as a key, its value must be a valid Cloud region. * If `zone` appears as a key, its value must be a valid Cloud zone. * Keys other than `region` or `zone` are not valid. Messages: AdditionalProperty: An additional property for a DimensionsValue object. Fields: additionalProperties: Additional properties of type DimensionsValue c`\rSrSrSr\R "S5r\R "S5rSr g)3AdminQuotaPolicy.DimensionsValue.AdditionalProperty_An additional property for a DimensionsValue object. Fields: key: Name of the additional property. value: A string attribute. rrr N r rrrrrrkeyvaluerr rrAdditionalPropertyr(_)   ! !! $c##A&err.rTrr N r rrrrrMessager. MessageFieldr#rr rrDimensionsValuer%Ms2 'Y.. '%112FTXYrr3rrr N)r rrrrrMapUnrecognizedFieldsrr1r3r containerr2 dimensionsmetricname IntegerField policyValueunitrr rrr!r!&s$L !!"89Z ))Z:Z<##A&)%%&7;*   #&   q !$&&q)+   q !$rr!c`\rSrSrSr\R "S5r\R "S5rSr g) AncestorGrouptzA service ancestor group for which the service is a descendant. Fields: groupName: Output only. The name of the ancestor group. parent: Output only. The parent service which this ancestor contains. rrr N) r rrrrrr groupNamerrr rrrArAts)##A&)   #&rrAcB\rSrSrSr"SS\R 5r\R"SSSS9r \R"S S SS9r \R"S 5r \R"S S SS9r \R"SS5r\R"SS5r\R"S5rSrg)ApiaApi is a light-weight descriptor for an API Interface. Interfaces are also described as "protocol buffer services" in some contexts, such as by the "service" keyword in a .proto file, but they are different from API Services, which represent a concrete implementation of an interface as opposed to simply a description of methods and bindings. They are also sometimes simply referred to as "APIs" in other contexts, such as the name of this message itself. See https://cloud.google.com/apis/design/glossary for detailed terminology. Enums: SyntaxValueValuesEnum: The source syntax of the service. Fields: methods: The methods of this interface, in unspecified order. mixins: Included interfaces. See Mixin. name: The fully qualified name of this interface, including package name followed by the interface's simple name. options: Any metadata attached to the interface. sourceContext: Source context for the protocol buffer service represented by this message. syntax: The source syntax of the service. version: A version string for this interface. 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 interface, which must end in `v`, 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, non-GA interfaces. c$\rSrSrSrSrSrSrSrg)Api.SyntaxValueValuesEnumzThe source syntax of the service. Values: SYNTAX_PROTO2: Syntax `proto2`. SYNTAX_PROTO3: Syntax `proto3`. SYNTAX_EDITIONS: Syntax `editions`. rrrr N r rrrr SYNTAX_PROTO2 SYNTAX_PROTO3SYNTAX_EDITIONSrr rrSyntaxValueValuesEnumrHMMOrrNMethodrTrMixinrr4Optionr5 SourceContextr6r7r N)r rrrrrEnumrNr2methodsmixinsrr<options sourceContext EnumFieldsyntaxversionrr rrrErEs$L inn   " "8Q >'  ! !'1t <&   q !$  " "8Q >'((!<-   6 :&  ! !! $'rrEc\rSrSrSr\R "S5r\R "S5r\R "S5r \R "S5r \R "S5r \R"SS S S 9r S rg ) AuthProvidera Configuration for an authentication provider, including support for [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json- web-token-32). Fields: audiences: The list of JWT [audiences](https://tools.ietf.org/html/draft- ietf-oauth-json-web-token-32#section-4.1.3). that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, JWTs with audiences: - "https://[service.name]/[google.protobuf.Api.name]" - "https://[service.name]/" will be accepted. For example, if no audiences are in the setting, LibraryService API will accept JWTs with the following audiences: - https://library- example.googleapis.com/google.example.library.v1.LibraryService - https://library-example.googleapis.com/ Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com authorizationUrl: Redirect URL if JWT token is required but not present or is expired. Implement authorizationUrl of securityDefinitions in OpenAPI spec. id: The unique identifier of the auth provider. It will be referred to by `AuthRequirement.provider_id`. Example: "bookstore_auth". issuer: Identifies the principal that issued the JWT. See https://tools.ietf.org/html/draft-ietf-oauth-json-web- token-32#section-4.1.1 Usually a URL or an email address. Example: https://securetoken.google.com Example: 1234567-compute@developer.gserviceaccount.com jwksUri: URL of the provider's public key set to validate signature of the JWT. See [OpenID Discovery](https://openid.net/specs/openid-connect- discovery-1_0.html#ProviderMetadata). Optional if the key set document: - can be retrieved from [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html) of the issuer. - can be inferred from the email domain of the issuer (e.g. a Google service account). Example: https://www.googleapis.com/oauth2/v1/certs jwtLocations: Defines the locations to extract the JWT. For now it is only used by the Cloud Endpoints to store the OpenAPI extension [x-google- jwt-locations] (https://cloud.google.com/endpoints/docs/openapi/openapi- extensions#x-google-jwt-locations) JWT locations can be one of HTTP headers, URL query parameters or cookies. The rule is that the first match wins. If not specified, default to use following 3 locations: 1) Authorization: Bearer 2) x-goog-iap-jwt-assertion 3) access_token query parameter Default locations can be specified as followings: jwt_locations: - header: Authorization value_prefix: "Bearer " - header: x-goog-iap-jwt-assertion - query: access_token rrr4r5r6 JwtLocationr7Trr N)r rrrrrr audiencesauthorizationUrlidissuerjwksUrir2 jwtLocationsrr rrr^r^so-^##A&)**1-Q"   #&  ! !! $''' q4H,rr^c`\rSrSrSr\R "S5r\R "S5rSr g)AuthRequirementa User-defined authentication requirements, including support for [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web- token-32). Fields: audiences: NOTE: This will be deprecated soon, once AuthProvider.audiences is implemented and accepted in all the runtime components. The list of JWT [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web- token-32#section-4.1.3). that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, only JWTs with audience "https://Service_name/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 providerId: id from authentication provider. Example: provider_id: bookstore_auth rrr N) r rrrrrrra providerIdrr rrrhrhs)*##A&)$$Q'*rrhc`\rSrSrSr\R "SSSS9r\R "SSSS9rS r g ) Authenticationia`Authentication` defines the authentication configuration for API methods provided by an API service. Example: name: calendar.googleapis.com authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: "*" requirements: provider_id: google_calendar_auth - selector: google.calendar.Delegate oauth: canonical_scopes: https://www.googleapis.com/auth/calendar.read Fields: providers: Defines a set of authentication providers that a service supports. rules: A list of authentication rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order. r^rTrAuthenticationRulerr N) r rrrrrr2 providersrulesrr rrrlrls2 $$^QF)  !5q4 H%rrlc\rSrSrSr\R "S5r\R"SS5r \R"SSSS 9r \R"S 5r S r g ) rmi#aAuthentication 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. Fields: allowWithoutCredential: If true, the service accepts API keys without any other credential. This flag only applies to HTTP and gRPC requests. oauth: The requirements for OAuth credentials. requirements: Requirements for additional authentication providers. selector: Selects the methods to which this rule applies. Refer to selector for syntax details. rOAuthRequirementsrrhr4Trr5r N)r rrrrr BooleanFieldallowWithoutCredentialr2oauth requirementsrselectorrr rrrmrm#sR %11!4  !4a 8%''(91tL,  " "1 %(rrmc<\rSrSrSr\R "SSSS9rSrg) Backendi9z`Backend` defines the backend configuration for a service. Fields: rules: A list of API backend rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order. BackendRulerTrr N r rrrrrr2rorr rrrxrx9s  D A%rrxc\rSrSrSr"SS\R 5r\R"S5"SS\R55r \R"S5r \R"S 5r\R "S 5r\R"S 5r\R"S 5r\R"S 5r\R*"SS5r\R."SS5r\R"S5r\R"S5rSrg)ryiDa A backend rule provides configuration for an individual API element. Enums: PathTranslationValueValuesEnum: Messages: OverridesByRequestProtocolValue: The map between request protocol and the backend address. Fields: address: The address of the API backend. The scheme is used to determine the backend protocol and security. The following schemes are accepted: SCHEME PROTOCOL SECURITY http:// HTTP None https:// HTTP TLS grpc:// gRPC None grpcs:// gRPC TLS It is recommended to explicitly include a scheme. Leaving out the scheme may cause constrasting behaviors across platforms. If the port is unspecified, the default is: - 80 for schemes without TLS - 443 for schemes with TLS For HTTP backends, use protocol to specify the protocol version. deadline: The number of seconds to wait for a response from a request. The default varies based on the request protocol and deployment environment. disableAuth: When disable_auth is true, a JWT ID token won't be generated and the original "Authorization" HTTP header will be preserved. If the header is used to carry the original token and is expected by the backend, this field must be set to true to preserve the header. jwtAudience: The JWT audience is used when generating a JWT ID token for the backend. This ID token will be added in the HTTP "authorization" header, and sent to the backend. minDeadline: Deprecated, do not use. operationDeadline: The number of seconds to wait for the completion of a long running operation. The default is no deadline. overridesByRequestProtocol: The map between request protocol and the backend address. pathTranslation: A PathTranslationValueValuesEnum attribute. protocol: The protocol used for sending a request to the backend. The supported values are "http/1.1" and "h2". The default value is inferred from the scheme in the address field: SCHEME PROTOCOL http:// http/1.1 https:// http/1.1 grpc:// h2 grpcs:// h2 For secure HTTP backends (https://) that support HTTP/2, set this field to "h2" for improved performance. Configuring this field to non-default values is only supported for secure HTTP backends. This field will be ignored for all other backends. See https://www.iana.org/assignments/tls-extensiontype- values/tls-extensiontype-values.xhtml#alpn-protocol-ids for more details on the supported values. selector: Selects the methods to which this rule applies. Refer to selector for syntax details. c$\rSrSrSrSrSrSrSrg)*BackendRule.PathTranslationValueValuesEnumitaaPathTranslationValueValuesEnum enum type. Values: PATH_TRANSLATION_UNSPECIFIED: CONSTANT_ADDRESS: Use the backend address as-is, with no modification to the path. If the URL pattern contains variables, the variable names and values will be appended to the query string. If a query string parameter and a URL pattern variable have the same name, this may result in duplicate keys in the query string. # Examples Given the following operation config: Method path: /api/company/{cid}/user/{uid} Backend address: https://example.cloudfunctions.net/getUser Requests to the following request paths will call the backend at the translated path: Request path: /api/company/widgetworks/user/johndoe Translated: https://example.cloudfunctions.net/getUser?cid=widgetworks&uid=johndoe Request path: /api/company/widgetworks/user/johndoe?timezone=EST Translated: https://example.cloudfunctions.net/getUser?timezone=EST&ci d=widgetworks&uid=johndoe APPEND_PATH_TO_ADDRESS: The request path will be appended to the backend address. # Examples Given the following operation config: Method path: /api/company/{cid}/user/{uid} Backend address: https://example.appspot.com Requests to the following request paths will call the backend at the translated path: Request path: /api/company/widgetworks/user/johndoe Translated: https://example.appspot.com/api/company/widgetworks/user/johndoe Request path: /api/company/widgetworks/user/johndoe?timezone=EST Translated: https://example.appspot.com/api/company/widgetworks/user/j ohndoe?timezone=EST rrrr N) r rrrrPATH_TRANSLATION_UNSPECIFIEDCONSTANT_ADDRESSAPPEND_PATH_TO_ADDRESSrr rrPathTranslationValueValuesEnumr}ts8$% rrr#cf\rSrSrSr"SS\R 5r\R"SSSS9r Sr g ) +BackendRule.OverridesByRequestProtocolValueiaThe map between request protocol and the backend address. Messages: AdditionalProperty: An additional property for a OverridesByRequestProtocolValue object. Fields: additionalProperties: Additional properties of type OverridesByRequestProtocolValue cb\rSrSrSr\R "S5r\R"SS5r Sr g)>BackendRule.OverridesByRequestProtocolValue.AdditionalPropertyizAn additional property for a OverridesByRequestProtocolValue object. Fields: key: Name of the additional property. value: A BackendRule attribute. rryrr N r rrrrrrr,r2r-rr rrr.rs+   ! !! $c$$]A6err.rTrr Nr0r rrOverridesByRequestProtocolValuers2  7Y.. 7%112FTXYrrrrr4r5r6r7rT r N)r rrrrrrUrrr8r1rraddress FloatFielddeadlinerr disableAuth jwtAudience minDeadlineoperationDeadliner2overridesByRequestProtocolrZpathTranslationprotocolrvrr rrryryDs-^y~~B !!"89Z (9(9Z:Z2  ! !! $'  ! !! $(&&q)+%%a(+$$Q'+**1-(556WYZ[''(H!L/  " "1 %(  " "2 &(rryc<\rSrSrSr\R "SSSS9rSrg) !BatchCreateAdminOverridesResponseizfResponse message for BatchCreateAdminOverrides Fields: overrides: The overrides that were created. QuotaOverriderTrr N r rrrrrr2 overridesrr rrrr $$_a$G)rrc<\rSrSrSr\R "SSSS9rSrg) $BatchCreateConsumerOverridesResponseiziResponse message for BatchCreateConsumerOverrides Fields: overrides: The overrides that were created. rrTrr Nrr rrrrrrrc`\rSrSrSr\R "SSSS9r\R "SSSS9rS r g ) BatchEnableServicesResponseiaResponse message for the `BatchEnableServices` method. This response message is assigned to the `response` field of the returned Operation when that operation is done. Fields: failures: If allow_partial_success is true, and one or more services could not be enabled, this field contains the details about each failure. services: The new state of the services after enabling. EnableFailurerTrGoogleApiServiceusageV1Servicerr N) r rrrrrr2failuresservicesrr rrrrs3 # #OQ F(  # #$DaRV W(rrc<\rSrSrSr\R "SSSS9rSrg) BatchGetServicesResponseizvThe response message of the `BatchGetServices` method. Fields: services: The details about the requested services. ServiceStaterTrr N) r rrrrrr2rrr rrrrs  # #NA E(rrc<\rSrSrSr\R "SSSS9rSrg) BillingiaFBilling related configuration of the service. The following example shows how to configure monitored resources and metrics for billing, `consumer_destinations` is the only supported destination and the monitored resources need at least one label key `cloud.googleapis.com/location` to indicate the location of the billing usage, using different monitored resources between monitoring and billing is recommended so they can be evolved independently: monitored_resources: - type: library.googleapis.com/billing_branch labels: - key: cloud.googleapis.com/location description: | Predefined label to support billing location restriction. - key: city description: | Custom label to define the city where the library branch is located in. - key: name description: Custom label to define the name of the library branch. metrics: - name: library.googleapis.com/book/borrowed_count metric_kind: DELTA value_type: INT64 unit: "1" billing: consumer_destinations: - monitored_resource: library.googleapis.com/billing_branch metrics: - library.googleapis.com/book/borrowed_count Fields: consumerDestinations: Billing configurations for sending metrics to the consumer project. There can be multiple consumer destinations per service, each one must have a different monitored resource type. A metric can be used in at most one consumer destination. BillingDestinationrTrr N) r rrrrrr2consumerDestinationsrr rrrrs 0#//0DaRVWrrc^\rSrSrSr\R "SSS9r\R "S5rSr g) riaiConfiguration of a specific billing destination (Currently only support bill against consumer project). Fields: metrics: Names of the metrics to report to this billing destination. Each name must be defined in Service.metrics section. monitoredResource: The monitored resource type. The type must be defined in Service.monitored_resources section. rTrrr N r rrrrrrmetricsmonitoredResourcerr rrrr,  ! !!d 3'++A.rrcb\rSrSrSr\R "S5r\R"SS5r Sr g)CategoryServiceizA service that belongs to a category and its metadata. Fields: parent: The parent category to which this service belongs. service: Output only. The service included by this category. rServicerr N) r rrrrrrrr2servicerr rrrrs+   #&  " "9a 0'rrc\rSrSrSr"SS\R 5r\R"SS5r \R"SS5r \R"S S 5r \R"S S 5r \R"SS 5r\R"SS5r\R"SS5r\R"SS5r\R$"S5r\R"SS5r\R*"S5rSrg)ClientLibrarySettingsiaDetails about how and where to publish client libraries. Enums: LaunchStageValueValuesEnum: Launch stage of this version of the API. Fields: cppSettings: Settings for C++ client libraries. dotnetSettings: Settings for .NET client libraries. goSettings: Settings for Go client libraries. javaSettings: Settings for legacy Java features, supported in the Service YAML. launchStage: Launch stage of this version of the API. nodeSettings: Settings for Node client libraries. phpSettings: Settings for PHP client libraries. pythonSettings: Settings for Python client libraries. restNumericEnums: When using transport=rest, the client request will encode enums as numbers rather than strings. rubySettings: Settings for Ruby client libraries. version: Version of the API to apply these settings to. This is the full protobuf package for the API, ending in the version element. Examples: "google.cloud.speech.v1" and "google.spanner.admin.database.v1". c8\rSrSrSrSrSrSrSrSr Sr S r S r S r g ) 0ClientLibrarySettings.LaunchStageValueValuesEnumi7aLaunch stage of this version of the API. Values: LAUNCH_STAGE_UNSPECIFIED: Do not use this default value. UNIMPLEMENTED: The feature is not yet implemented. Users can not use it. PRELAUNCH: Prelaunch features are hidden from users and are only visible internally. EARLY_ACCESS: Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released. ALPHA: Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects allowlisted. Alpha releases don't have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases. BETA: Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases. GA: GA features are open to all developers and are considered stable and fully qualified for production use. DEPRECATED: Deprecated features are scheduled to be shut down and removed. For more information, see the "Deprecation Policy" section of our [Terms of Service](https://cloud.google.com/terms/) and the [Google Cloud Platform Subject to the Deprecation Policy](https://cloud.google.com/terms/deprecation) documentation. rrrr4r5r6r7rTr Nr rrrrLAUNCH_STAGE_UNSPECIFIED UNIMPLEMENTED PRELAUNCH EARLY_ACCESSALPHABETAGA DEPRECATEDrr rrLaunchStageValueValuesEnumr73!D !MIL E D BJrr CppSettingsrDotnetSettingsr GoSettingsr4 JavaSettingsr5r6 NodeSettingsr7 PhpSettingsrTPythonSettingsrr RubySettingsr r N)r rrrrrrUrr2 cppSettingsdotnetSettings goSettings javaSettingsrZ launchStage nodeSettings phpSettingspythonSettingsrrrestNumericEnums rubySettingsrr\rr rrrrs.*9>>*X&&}a8+))*:A>.%%lA6*'':,##$@!D+'':,&&}a8+))*:A>.++A.'';,  ! !" %'rrc\rSrSrSr"SS\R 5r\R"SSSS9r \R"S5r S r g ) CommonLanguageSettingsipaVRequired information for every language. Enums: DestinationsValueListEntryValuesEnum: Fields: destinations: The destination where API teams want this client library to be published. referenceDocsUri: Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest c$\rSrSrSrSrSrSrSrg);CommonLanguageSettings.DestinationsValueListEntryValuesEnumi}aDestinationsValueListEntryValuesEnum enum type. Values: CLIENT_LIBRARY_DESTINATION_UNSPECIFIED: Client libraries will neither be generated nor published to package managers. GITHUB: Generate the client library in a repo under github.com/googleapis, but don't publish it to package managers. PACKAGE_MANAGER: Publish the library to package managers like nuget.org and npmjs.com. rrrr N) r rrrr&CLIENT_LIBRARY_DESTINATION_UNSPECIFIEDGITHUBPACKAGE_MANAGERrr rr$DestinationsValueListEntryValuesEnumr}s ./* FOrrrTrrr N) r rrrrrrUrrZ destinationsrreferenceDocsUrirr rrrrps@  Y^^ $$%KQY]^,**1-rrc"\rSrSrSr\R "S5"SS\R55r \R"SS5r \R"SSS S 9r \R"S 5r\R"S 5r\R"S 5rSrg)ConsumerPolicyiaConsumer Policy is a set of rules that define what services or service groups can be used for a cloud resource hierarchy. Messages: AnnotationsValue: Optional. Annotations is an unstructured key-value map stored with a policy that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. [AIP-128](https://google.aip.dev/128#annotations) Fields: annotations: Optional. Annotations is an unstructured key-value map stored with a policy that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. [AIP-128](https://google.aip.dev/128#annotations) enableRules: Enable rules define usable services and service groups. etag: An opaque tag indicating the current version of the policy, used for concurrency control. name: Output only. The resource name of the policy. We only allow consumer policy name as `default` for now: `projects/12345/consumerPolicies/default`, `folders/12345/consumerPolicies/default`, `organizations/12345/consumerPolicies/default`. updateTime: The last-modified time. r#cf\rSrSrSr"SS\R 5r\R"SSSS9r Sr g ) ConsumerPolicy.AnnotationsValueiOptional. Annotations is an unstructured key-value map stored with a policy that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. [AIP-128](https://google.aip.dev/128#annotations) Messages: AdditionalProperty: An additional property for a AnnotationsValue object. Fields: additionalProperties: Additional properties of type AnnotationsValue c`\rSrSrSr\R "S5r\R "S5rSr g)2ConsumerPolicy.AnnotationsValue.AdditionalPropertyiAn additional property for a AnnotationsValue object. Fields: key: Name of the additional property. value: A string attribute. rrr Nr+r rrr.rr/rr.rTrr Nr0r rrAnnotationsValuer2  'Y.. '%112FTXYrrr EnableRulerTrr4r5r6r N)r rrrrrr8rr1rr2 annotations enableRulesretagr< updateTimerr rrrrs4 !!"89Z**Z:Z6&&'91=+&&|QF+   q !$   q !$$$Q'*rrc<\rSrSrSr\R "SSSS9rSrg) ContextiaN`Context` defines which contexts an API requests. Example: context: rules: - selector: "*" requested: - google.rpc.context.ProjectContext - google.rpc.context.OriginContext The above specifies that all methods in the API request `google.rpc.context.ProjectContext` and `google.rpc.context.OriginContext`. Available context types are defined in package `google.rpc.context`. This also provides mechanism to allowlist any protobuf message extension that can be sent in grpc metadata using "x-goog- ext--bin" and "x-goog-ext--jspb" format. For example, list any service specific protobuf types that can appear in grpc metadata as follows in your yaml file: Example: context: rules: - selector: "google.example.library.v1.LibraryService.CreateBook" allowed_request_extensions: - google.foo.v1.NewExtension allowed_response_extensions: - google.foo.v1.NewExtension You can also specify extension ID instead of fully qualified extension name here. Fields: rules: A list of RPC context rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order. ContextRulerTrr Nrzr rrrrs(  D A%rrc\rSrSrSr\R "SSS9r\R "SSS9r\R "SSS9r \R "SSS9r \R "S 5r S r g ) ria[A context rule provides information about the context for an individual API element. Fields: allowedRequestExtensions: A list of full type names or extension IDs of extensions allowed in grpc side channel from client to backend. allowedResponseExtensions: A list of full type names or extension IDs of extensions allowed in grpc side channel from backend to client. provided: A list of full type names of provided contexts. requested: A list of full type names of requested contexts. selector: Selects the methods to which this rule applies. Refer to selector for syntax details. rTrrr4r5r6r N) r rrrrrrallowedRequestExtensionsallowedResponseExtensionsprovided requestedrvrr rrrrsc '221tD'33AE  " "1t 4(##A5)  " "1 %(rrc`\rSrSrSr\R "S5r\R"SSSS9r Sr g ) ControliaSelects and configures the service controller used by the service. Example: control: environment: servicecontrol.googleapis.com Fields: environment: The service controller environment to use. If empty, no control plane feature (like quota and billing) will be enabled. The recommended value for most services is servicecontrol.googleapis.com methodPolicies: Defines policies applying to the API methods of the service. r MethodPolicyrTrr N) r rrrrrr environmentr2methodPoliciesrr rrrrs- %%a(+)).!dK.rrc>\rSrSrSr\R "SS5rSrg)ri zESettings for C++ client libraries. Fields: common: Some settings. rrr N r rrrrrr2commonrr rrrr   ! !":A >&rrc\rSrSrSrSrg)CreateAdminQuotaPolicyMetadataizMetadata message that provides information such as progress, partial failures, and similar information on each GetOperation call of LRO returned by CreateAdminQuotaPolicy. r Nr r rrrrrrc^\rSrSrSr\R "SSSS9r\R"SSS9r Sr g ) CustomErroriaCustomize service error responses. For example, list any service 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 Fields: rules: The list of custom error rules that apply to individual API messages. **NOTE:** All service configuration rules follow "last one wins" order. types: The list of custom error detail types, e.g. 'google.foo.v1.CustomError'. CustomErrorRulerTrrr N) r rrrrrr2rortypesrr rrrrs0   !2A E%   D 1%rrc`\rSrSrSr\R "S5r\R"S5r Sr g)ri0a%A custom error rule. Fields: isErrorType: Mark this message as possible payload in error response. Otherwise, objects of this type will be filtered when they appear in error payload. selector: Selects messages to which this rule applies. Refer to selector for syntax details. rrr N) r rrrrrrr isErrorTyperrvrr rrrr0s)&&q)+  " "1 %(rrc`\rSrSrSr\R "S5r\R "S5rSr g)CustomHttpPatterni?zA custom pattern is used for defining custom HTTP verb. Fields: kind: The name of this custom HTTP verb. path: The path matched by this custom verb. rrr N) r rrrrrrkindpathrr rrr r ?s)   q !$   q !$rr c\rSrSrSrSrg)DeleteAdminQuotaPolicyMetadataiKzMetadata message that provides information such as progress, partial failures, and similar information on each GetOperation call of LRO returned by DeleteAdminQuotaPolicy. r Nr r rrr r Krrr c`\rSrSrSr\R "S5r\R "S5rSr g)DescendantServiceiSaA service group descendant that belongs to a certain service group directly or to one of its included groups. Fields: parent: Output only. The parent group to which this descendant belongs. serviceName: Output only. The name of the descendant service. rrr N) r rrrrrrr serviceNamerr rrrrSs)   #&%%a(+rrc>\rSrSrSr\R "SS5rSrg)DisableServiceResponsei`zResponse message for the `DisableService` method. This response message is assigned to the `response` field of the returned Operation when that operation is done. Fields: service: The new state of the service after disabling. rrr N r rrrrrr2rrr rrrr`  " "#CQ G'rrc\rSrSrSr\R "S5r\R "S5r\R"SSSS9r \R"S S SS9r \R"SS SS9r \R "S 5r \R "S 5rSrg) Documentationila `Documentation` provides the information for describing a service. Example: 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: > ... 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: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) 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: (== include path/to/file ==) 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: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation. Fields: documentationRootUrl: The URL to the root of documentation. overview: Declares a single overview page. For example: documentation: summary: ... overview: (== include overview.md ==) This is a shortcut for the following declaration (using pages style): documentation: summary: ... pages: - name: Overview content: (== include overview.md ==) Note: you cannot specify both `overview` field and `pages` field. pages: The top level pages for the documentation set. rules: A list of documentation rules that apply to individual API elements. **NOTE:** All service configuration rules follow "last one wins" order. sectionOverrides: Specifies section and content to override boilerplate content provided by go/api-docgen. Currently overrides following sections: 1. rest.service.client_libraries serviceRootUrl: Specifies the service root url if the default one (the service name from the yaml file) is not suitable. This can be seen in any fully specified service urls as well as sections that show a base that other urls are relative to. summary: A short description of what the service does. The summary must be plain text. It becomes the overview of the service displayed in Google Cloud Console. NOTE: This field is equivalent to the standard field `description`. rrPager4TrDocumentationRuler5r6r7rTr N)r rrrrrrdocumentationRootUrloverviewr2pagesrosectionOverridesserviceRootUrlsummaryrr rrrrls3j#..q1  " "1 %(  T :%  !4a$ G%++FAE((+.  ! !! $'rrc\rSrSrSr\R "S5r\R "S5r\R "S5r \R "S5r Sr g) riaiA documentation rule provides information about individual API elements. Fields: deprecationDescription: Deprecation description of the selected element(s). It can be provided if an element is marked as `deprecated`. description: Description of the selected proto element (e.g. a message, a method, a 'service' definition, or a field). Defaults to leading & trailing comments taken from the proto source definition of the proto element. disableReplacementWords: String of comma or space separated case-sensitive words for which method/field name replacement will be disabled by go/api-docgen. selector: The selector is a comma-separated list of patterns for any element such as a method, a field, an enum value. Each pattern is a qualified name of the element which may end in "*", indicating a wildcard. Wildcards are only allowed at the end and for a whole component of the qualified name, i.e. "foo.*" is ok, but not "foo.b*" or "foo.*.bar". A wildcard will match one or more components. To specify a default for all applicable elements, the whole pattern "*" is used. rrr4r5r N) r rrrrrrdeprecationDescription descriptiondisableReplacementWordsrvrr rrrrsK*%003%%a(+%11!4  " "1 %(rrc\rSrSrSr\R "S5"SS\R55r \R "S5"SS\R55r \R"SS 5r \R"S S S 9r\R"S S S 9r\R"SS S 9r\R"SS5r\R"SS5rSrg)riaSettings for Dotnet client libraries. Messages: RenamedResourcesValue: Map from full resource types to the effective short name for the resource. This is used when otherwise resource named from different services would cause naming collisions. Example entry: "datalabeling.googleapis.com/Dataset": "DataLabelingDataset" RenamedServicesValue: Map from original service names to renamed versions. This is used when the default generated types would cause a naming conflict. (Neither name is fully-qualified.) Example: Subscriber to SubscriberServiceApi. Fields: common: Some settings. forcedNamespaceAliases: Namespaces which must be aliased in snippets due to a known (but non-generator-predictable) naming collision handwrittenSignatures: Method signatures (in the form "service.method(signature)") which are provided separately, so shouldn't be generated. Snippets *calling* these methods are still generated, however. ignoredResources: List of full resource types to ignore during generation. This is typically used for API-specific Location resources, which should be handled by the generator as if they were actually the common Location resources. Example entry: "documentai.googleapis.com/Location" renamedResources: Map from full resource types to the effective short name for the resource. This is used when otherwise resource named from different services would cause naming collisions. Example entry: "datalabeling.googleapis.com/Dataset": "DataLabelingDataset" renamedServices: Map from original service names to renamed versions. This is used when the default generated types would cause a naming conflict. (Neither name is fully-qualified.) Example: Subscriber to SubscriberServiceApi. r#cf\rSrSrSr"SS\R 5r\R"SSSS9r Sr g ) $DotnetSettings.RenamedResourcesValueiaMap from full resource types to the effective short name for the resource. This is used when otherwise resource named from different services would cause naming collisions. Example entry: "datalabeling.googleapis.com/Dataset": "DataLabelingDataset" Messages: AdditionalProperty: An additional property for a RenamedResourcesValue object. Fields: additionalProperties: Additional properties of type RenamedResourcesValue c`\rSrSrSr\R "S5r\R "S5rSr g)7DotnetSettings.RenamedResourcesValue.AdditionalPropertyizAn additional property for a RenamedResourcesValue object. Fields: key: Name of the additional property. value: A string attribute. rrr Nr+r rrr.r'r/rr.rTrr Nr0r rrRenamedResourcesValuer%s2  'Y.. '%112FTXYrr(cf\rSrSrSr"SS\R 5r\R"SSSS9r Sr g ) #DotnetSettings.RenamedServicesValueiaMap from original service names to renamed versions. This is used when the default generated types would cause a naming conflict. (Neither name is fully-qualified.) Example: Subscriber to SubscriberServiceApi. Messages: AdditionalProperty: An additional property for a RenamedServicesValue object. Fields: additionalProperties: Additional properties of type RenamedServicesValue c`\rSrSrSr\R "S5r\R "S5rSr g)6DotnetSettings.RenamedServicesValue.AdditionalPropertyizAn additional property for a RenamedServicesValue object. Fields: key: Name of the additional property. value: A string attribute. rrr Nr+r rrr.r,r/rr.rTrr Nr0r rrRenamedServicesValuer*s2  'Y.. '%112FTXYrr-rrrTrr4r5r6r7r N)r rrrrrr8rr1r(r-r2rrforcedNamespaceAliaseshandwrittenSignaturesignoredResourcesrenamedResourcesrenamedServicesrr rrrrs D !!"89Zi//Z:Z8 !!"89ZY..Z:Z4  ! !":A >&$00TB#//DA**1t<++,CQG**+A1E/rrc\rSrSrSr\R "SSSS9r\R "SSSS9r\R"S 5r \R"S 5r S r g ) EffectivePolicyi*aEffective Policy is a singleton read-only resource modeling the collapsed policies and metadata effective at a particular point in the hierarchy. Fields: enableRuleMetadata: Output only. Metadata about enable rules in the same order as the `enable_rules` objects. enableRules: Output only. Aggregated `EnableRule` objects grouped by any associated conditions. Conditions are not supported in `alpha` and there will be exactly one rule present. name: Output only. The name of the effective policy. Format: `projects/100/effectivePolicy`, `folders/101/effectivePolicy`, `organizations/102/effectivePolicy`. updateTime: Output only. The time the policy was last updated. RuleSourcerTr&GoogleApiServiceusageV2alphaEnableRulerr4r5r N) r rrrrrr2enableRuleMetadatarrr<rrr rrr4r4*sU !--lAM&&'OQR]ab+   q !$$$Q'*rr4c\rSrSrSrSrg)EmptyiAaA generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } r Nr r rrr9r9Asrr9c`\rSrSrSr\R "S5r\R "S5rSr g)riJzProvides error messages for the failing services. Fields: errorMessage: An error message describing why the service could not be enabled. serviceId: The service id of a service that could not be enabled. rrr N) r rrrrrr errorMessage serviceIdrr rrrrJs)&&q),##A&)rrc\rSrSrSr"SS\R 5r\R"SS5r \R"SSS9r \R"S SS9r \R"S SS9r S rg ) riWaThe consumer policy rule that defines usable services and service groups. Enums: EnableTypeValueValuesEnum: Client and resource project enable type. Fields: enableType: Client and resource project enable type. groups: DEPRECATED: Please use field `values`. Service group should have prefix `groups/`. The names of the service groups that are enabled (Not Implemented). Example: `groups/googleServices`. services: DEPRECATED: Please use field `values`. Service should have prefix `services/`. The names of the services that are enabled. Example: `storage.googleapis.com`. values: The names of the services or service groups that are enabled. Example: `services/storage.googleapis.com`, `groups/googleServices`, `groups/allServices`. c(\rSrSrSrSrSrSrSrSr g) $EnableRule.EnableTypeValueValuesEnumikaClient and resource project enable type. Values: ENABLE_TYPE_UNSPECIFIED: Unspecified enable type, which means enabled as both client and resource project. CLIENT: Enable all clients under the CRM node specified by `ConsumerPolicy.name` to use the listed services. A client can be an API key, an OAuth client, or a service account. RESOURCE: Enable resources in the list services to be created and used under the CRM node specified by the `ConsumerPolicy.name`. V1_COMPATIBLE: Activation made by Service Usage v1 API. This will be how consumers differentiate between policy changes made by v1 and v2 clients and understand what is actually possible based on those different policies. rrrr4r N) r rrrrENABLE_TYPE_UNSPECIFIEDCLIENTRESOURCE V1_COMPATIBLErr rrEnableTypeValueValuesEnumr?ks  FHMrrDrrTrr4r5r N)r rrrrrrUrDrZ enableTypergroupsrvaluesrr rrrrWsb&)..*""#>B*  T 2&  " "1t 4(  T 2&rrc>\rSrSrSr\R "SS5rSrg)EnableServiceResponseizResponse message for the `EnableService` method. This response message is assigned to the `response` field of the returned Operation when that operation is done. Fields: service: The new state of the service after enabling. rrr Nrr rrrIrIrrrIc\rSrSrSr\R "SSS9r\R"S5r \R "S5r \R "S5r S r g ) Endpointia;`Endpoint` describes a network address of a service that serves a set of APIs. It is commonly known as a service endpoint. A service may expose any number of service endpoints, and all service endpoints share the same service definition, such as quota limits and monitoring metrics. Example: type: google.api.Service name: library-example.googleapis.com endpoints: # Declares network address `https://library-example.googleapis.com` # for service `library-example.googleapis.com`. The `https` scheme # is implicit for all service endpoints. Other schemes may be # supported in the future. - name: library-example.googleapis.com allow_cors: false - name: content- staging-library-example.googleapis.com # Allows HTTP OPTIONS calls to be passed to the API frontend, for it # to decide whether the subsequent cross- origin request is allowed # to proceed. allow_cors: true Fields: aliases: Unimplemented. Dot not use. DEPRECATED: This field is no longer supported. Instead of using aliases, please specify multiple google.api.Endpoint for each of the intended aliases. Additional names that this endpoint will be hosted on. allowCors: Allowing [CORS](https://en.wikipedia.org/wiki/Cross- origin_resource_sharing), aka cross-domain traffic, would allow the backends served from this endpoint to receive and respond to HTTP OPTIONS requests. The response will be used by the browser to determine whether the subsequent cross-origin request is allowed to proceed. name: The canonical name of this endpoint. target: The specification of an Internet routable address of API frontend that will handle requests to this [API Endpoint](https://cloud.google.com/apis/design/glossary). It should be either a valid IPv4 address or a fully-qualified domain name. For example, "8.8.8.8" or "myservice.appspot.com". rTrrr4r5r N) r rrrrrraliasesrr allowCorsr<targetrr rrrKrKsK>  ! !!d 3'$$Q')   q !$   #&rrKc\rSrSrSr"SS\R 5r\R"S5r \R"SSSS 9r \R"S 5r \R"S S SS 9r \R"S S5r\R"SS5rSrg)rUiaKEnum type definition. Enums: SyntaxValueValuesEnum: The source syntax. Fields: edition: The source edition string, only valid when syntax is SYNTAX_EDITIONS. enumvalue: Enum value definitions. name: Enum type name. options: Protocol buffer options. sourceContext: The source context. syntax: The source syntax. c$\rSrSrSrSrSrSrSrg)Enum.SyntaxValueValuesEnumiThe source syntax. Values: SYNTAX_PROTO2: Syntax `proto2`. SYNTAX_PROTO3: Syntax `proto3`. SYNTAX_EDITIONS: Syntax `editions`. rrrr NrJr rrrNrQrOrrNr EnumValuerTrr4rRr5rSr6r7r N)r rrrrrrUrNreditionr2 enumvaluer<rXrYrZr[rr rrrUrUs  inn   ! !! $'$$[!dC)   q !$  " "8Q >'((!<-   6 :&rrUc\rSrSrSr\R "S5r\R"S\RRS9r \R"SSSS 9r S rg ) rSizzEnum value definition. Fields: name: Enum value name. number: Enum value number. options: Protocol buffer options. rrvariantrRr4Trr N)r rrrrrrr<r=VariantINT32numberr2rXrr rrrSrSsK   q !$  ! !!Y->->-D-D E&  " "8Q >'rrSc$\rSrSrSr"SS\R 5r"SS\R 5r\R"SS5r \R"S5r \R"S 5r \R"SS 5r\R"S 5r\R "S \R"R$S 9r\R "S\R"R$S 9r\R*"SSSS9r\R."S5r\R"S5rSrg)Fieldia+A single field of a message type. Enums: CardinalityValueValuesEnum: The field cardinality. KindValueValuesEnum: The field type. Fields: cardinality: The field cardinality. defaultValue: The string value of the default value of this field. Proto2 syntax only. jsonName: The field JSON name. kind: The field type. name: The field name. number: The field number. oneofIndex: 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. options: The protocol buffer options. packed: Whether to use alternative packed wire representation. typeUrl: The field type URL, without the scheme, for message or enumeration types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`. c(\rSrSrSrSrSrSrSrSr g) Field.CardinalityValueValuesEnumizThe field cardinality. Values: CARDINALITY_UNKNOWN: For fields with unknown cardinality. CARDINALITY_OPTIONAL: For optional fields. CARDINALITY_REQUIRED: For required fields. Proto2 syntax only. CARDINALITY_REPEATED: For repeated fields. rrrr4r N) r rrrrCARDINALITY_UNKNOWNCARDINALITY_OPTIONALCARDINALITY_REQUIREDCARDINALITY_REPEATEDrr rrCardinalityValueValuesEnumr_s!rrdcd\rSrSrSrSrSrSrSrSr Sr S r S r S r S rS rSrSrSrSrSrSrSrSrSrg)Field.KindValueValuesEnumiaThe field type. Values: TYPE_UNKNOWN: Field type unknown. TYPE_DOUBLE: Field type double. TYPE_FLOAT: Field type float. TYPE_INT64: Field type int64. TYPE_UINT64: Field type uint64. TYPE_INT32: Field type int32. TYPE_FIXED64: Field type fixed64. TYPE_FIXED32: Field type fixed32. TYPE_BOOL: Field type bool. TYPE_STRING: Field type string. TYPE_GROUP: Field type group. Proto2 syntax only, and deprecated. TYPE_MESSAGE: Field type message. TYPE_BYTES: Field type bytes. TYPE_UINT32: Field type uint32. TYPE_ENUM: Field type enum. TYPE_SFIXED32: Field type sfixed32. TYPE_SFIXED64: Field type sfixed64. TYPE_SINT32: Field type sint32. TYPE_SINT64: Field type sint64. rrrr4r5r6r7rTrrrr r N)r rrrr TYPE_UNKNOWN TYPE_DOUBLE TYPE_FLOAT TYPE_INT64 TYPE_UINT64 TYPE_INT32 TYPE_FIXED64 TYPE_FIXED32 TYPE_BOOL TYPE_STRING TYPE_GROUP TYPE_MESSAGE TYPE_BYTES TYPE_UINT32 TYPE_ENUM TYPE_SFIXED32 TYPE_SFIXED64 TYPE_SINT32 TYPE_SINT64rr rrKindValueValuesEnumrfsh.LKJJKJLLIKJLJKIMMKKrrrrr4r5r6r7rWrTrRrTrrrr N)r rrrrrrUrdrrZ cardinalityr defaultValuejsonNamer r<r=rYrZr[ oneofIndexr2rXrrpackedtypeUrlrr rrr]r]s0 9>> *INN*X##$@!D+&&q),  " "1 %(   2A 6$   q !$  ! !!Y->->-D-D E&%%a1B1B1H1HI*  " "8Q >'  ! !! $&  ! !" %'rr]c\rSrSrSr\R "S5r\R "S5r\R "S5r Sr g) FieldPolicyiIaGoogle API Policy Annotation This message defines a simple API policy annotation that can be used to annotate API request and response message fields with applicable policies. One field may have multiple applicable policies that must all be satisfied before a request can be processed. This policy annotation is used to generate the overall policy that will be used for automatic runtime policy enforcement and documentation generation. Fields: resourcePermission: Specifies the required permission(s) for the resource referred to by the field. It requires the field contains a valid resource reference, and the request must pass the permission checks to proceed. For example, "resourcemanager.projects.get". resourceType: Specifies the resource type for the resource referred to by the field. selector: Selects one or more request or response message fields to apply this `FieldPolicy`. When a `FieldPolicy` is used in proto annotation, the selector must be left as empty. The service config generator will automatically fill the correct value. When a `FieldPolicy` is used in service config, the selector must be a comma-separated string with valid request or response field paths, such as "foo.bar" or "foo.bar,foo.baz". rrr4r N) r rrrrrrresourcePermission resourceTypervrr rrrrIs:,!,,Q/&&q),  " "1 %(rrc\rSrSrSrSrg)GetServiceIdentityMetadataiez-Metadata for the `GetServiceIdentity` method.r Nr r rrrres6rrc\rSrSrSr"SS\R 5r\R"SS5r \R"SS5r Sr g ) GetServiceIdentityResponseiiuResponse message for getting service identity. Enums: StateValueValuesEnum: Service identity state. Fields: identity: Service identity that service producer can use to access consumer resources. If exists is true, it contains email and unique_id. If exists is false, it contains pre-constructed email and empty unique_id. state: Service identity state. c \rSrSrSrSrSrSrg)/GetServiceIdentityResponse.StateValueValuesEnumiwService identity state. Values: IDENTITY_STATE_UNSPECIFIED: Default service identity state. This value is used if the state is omitted. ACTIVE: Service identity has been created and can be used. rrr Nr rrrrIDENTITY_STATE_UNSPECIFIEDACTIVErr rrStateValueValuesEnumrw"# FrrServiceIdentityrrr N r rrrrrrUrr2identityrZstaterr rrrris?  Y^^  # #$5q 9(   4a 8%rrc>\rSrSrSr\R "SS5rSrg)rizDSettings for Go client libraries. Fields: common: Some settings. rrr Nrr rrrrrrrcL\rSrSrSr\R "SSSS9r\R "SS5r\R "S S 5r \R "S S 5r \R"S \RRS9r\R "SS5r\R "SS5r\R "SS5r\R "SS5r\R "SSSS9r\R "SSSS9r\R "SS5r\R,"S5r\R "SS5r\R "S S!SS9r\R "S"S#SS9r\R "S$S%SS9r\R "S&S'5r\R,"S(5r\R,"S)5r\R "S*S+5r\R "S,S-5r \R "S.S/5r!\R "S0S15r"\R "S2S3SS9r#\R,"S45r$\R "S2S5SS9r%\R "S6S75r&S8r'g9):GoogleApiServiceiaW`Service` is the root object of Google API service configuration (service config). It describes the basic information about a logical service, such as the service name and the user-facing title, and delegates other aspects to sub-sections. Each sub-section is either a proto message or a repeated proto message that configures a specific aspect, such as auth. For more information, see each proto message definition. Example: type: google.api.Service name: calendar.googleapis.com title: Google Calendar API apis: - name: google.calendar.v3.Calendar visibility: rules: - selector: "google.calendar.v3.*" restriction: PREVIEW backend: rules: - selector: "google.calendar.v3.*" address: calendar.example.com authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: "*" requirements: provider_id: google_calendar_auth Fields: 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. authentication: Auth configuration. backend: API backend configuration. billing: Billing configuration. configVersion: Obsolete. Do not use. This field has no semantic meaning. The service config compiler always sets this field to `3`. context: Context configuration. control: Configuration for the service control plane. customError: Custom error configuration. documentation: Additional API documentation. endpoints: Configuration for network endpoints. If this is empty, then an endpoint with the same name as the service is automatically generated to service all defined APIs. 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 by the configuration author. Example: enums: - name: google.someapi.v1.SomeEnum http: HTTP configuration. id: A unique ID for a specific instance of this message, typically assigned by the client for tracking purpose. Must be no longer than 63 characters and only lower case letters, digits, '.', '_' and '-' are allowed. If empty, the server may choose to generate one instead. logging: Logging configuration. logs: Defines the logs used by this service. metrics: Defines the metrics used by this service. monitoredResources: Defines the monitored resources used by this service. This is required by the Service.monitoring and Service.logging configurations. monitoring: Monitoring configuration. name: The service name, which is a DNS-like logical identifier for the service, such as `calendar.googleapis.com`. The service name typically goes through DNS verification to make sure the owner of the service also owns the DNS name. producerProjectId: The Google project that owns this service. publishing: Settings for [Google Cloud Client libraries](https://cloud.google.com/apis/docs/cloud-client-libraries) generated from APIs defined as protocol buffers. quota: Quota configuration. sourceInfo: Output only. The source information for this configuration if available. systemParameters: System parameter configuration. 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. title: The product title for this service, it is the name displayed in Google Cloud Console. 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 by the configuration author. Example: types: - name: google.protobuf.Int32 usage: Configuration controlling usage of this service. rErTrrlrrxr4rr5r6rWrr7rrTrrrrrKrrUrHttprgrhLoggingri LogDescriptorrjMetricDescriptorrkMonitoredResourceDescriptorrl Monitoringrmr  PublishingQuota SourceInforSystemParametersTypeUsager N)(r rrrrrr2apisauthenticationbackendbillingr=rYUINT32 configVersioncontextcontrol customError documentation endpointsenumshttprrclogginglogsrmonitoredResources monitoringr<producerProjectId publishingquota sourceInfosystemParameters systemTypestitlerusagerr rrrrsM^   q4 8$))*:A>.  " "9a 0'  " "9a 0'((I4E4E4L4LM-  " "9a 0'  " "9a 0'&&}a8+((!<-$$ZdC)  d ;%    +$R "  " "9b 1'   d C$  " "#5rD I' --.KRZ^_%%lB7*   r "$++B/%%lB7*  " -%%%lB7*++,>C&&vrDA+    #%  d ;%  " -%rrc:\rSrSrSr\R "SSS9rSrg)(GoogleApiServiceusageV1OperationMetadataiThe operation metadata returned for the batchend services operation. Fields: resourceNames: The full name of the resources that this operation is directly associated with. rTrr N r rrrrrr resourceNamesrr rrrr''D9-rrc\rSrSrSr"SS\R 5r\R"SS5r \R"S5r \R"S5r \R"SS 5rS rg ) ri aA service that is available for use by the consumer. Enums: StateValueValuesEnum: Whether or not the service has been enabled for use by the consumer. Fields: config: The service configuration of the available service. Some fields may be filtered out of the configuration in responses to the `ListServices` method. These fields are present only in responses to the `GetService` method. name: The resource name of the consumer and service. A valid name would be: - projects/123/services/serviceusage.googleapis.com parent: The resource name of the consumer. A valid name would be: - projects/123 state: Whether or not the service has been enabled for use by the consumer. c$\rSrSrSrSrSrSrSrg)3GoogleApiServiceusageV1Service.StateValueValuesEnumiaWhether or not the service has been enabled for use by the consumer. Values: STATE_UNSPECIFIED: The default value, which indicates that the enabled state of the service is unspecified or not meaningful. Currently, all consumers other than projects (such as folders and organizations) are always in this state. DISABLED: The service cannot be used by this consumer. It has either been explicitly disabled, or has never been enabled. ENABLED: The service has been explicitly enabled for use by this consumer. rrrr N) r rrrrSTATE_UNSPECIFIEDDISABLEDENABLEDrr rrrrs HGrr$GoogleApiServiceusageV1ServiceConfigrrr4r5r N)r rrrrrrUrr2configrr<rrZrrr rrrr s_&Y^^"  ! !"H! L&   q !$   #&   4a 8%rrc\rSrSrSr\R "SSSS9r\R "SS5r\R "S S 5r \R "S S SS9r \R "S SSS9r \R "SS5r \R"S5r\R "SS5r\R"S5r\R "SS5rSrg)ri4aThe configuration of the service. Fields: apis: A list of API interfaces exported by this service. Contains only the names, versions, and method names of the interfaces. authentication: Auth configuration. Contains only the OAuth rules. documentation: Additional API documentation. Contains only the summary and the documentation URL. endpoints: Configuration for network endpoints. Contains only the names and aliases of the endpoints. monitoredResources: Defines the monitored resources used by this service. This is required by the Service.monitoring and Service.logging configurations. monitoring: Monitoring configuration. This should not include the 'producer_destinations' field. name: The DNS address at which this service is available. An example DNS address would be: `calendar.googleapis.com`. quota: Quota configuration. title: The product title for this service. usage: Configuration controlling usage of this service. rErTrrlrrr4rKr5rr6rr7rTrrrrrr N)r rrrrrr2rrrrrrrr<rrrrr rrrr4s,   q4 8$))*:A>.((!<-$$ZTB) --.KQY]^%%lA6*   q !$  ! ,%    "%  " -%rrc\rSrSrSr"SS\R 5r\R"SS5r \R"SS5r Sr g ) 6GoogleApiServiceusageV1beta1GetServiceIdentityResponseiWrc \rSrSrSrSrSrSrg)KGoogleApiServiceusageV1beta1GetServiceIdentityResponse.StateValueValuesEnumierrrr Nrr rrrrerrr+GoogleApiServiceusageV1beta1ServiceIdentityrrr Nrr rrrrWs@  Y^^  # #$QST U(   4a 8%rrc`\rSrSrSr\R "S5r\R "S5rSr g)ritService identity for a service. This is the identity that service producer should use to access consumer resources. Fields: email: The email address of the service account that a service producer would use to access consumer resources. uniqueId: The unique and stable id of the service account. https://cloud.g oogle.com/iam/reference/rest/v1/projects.serviceAccounts#ServiceAccount rrr N r rrrrrremailuniqueIdrr rrrrt)    "%  " "1 %(rrc\rSrSrSr\R "S5r\R"SSSS9r \R "S5r S r g ) GoogleApiServiceusageV2alphaApiizAPI details for APIs exposed by a Service. Fields: name: The name of the API. operations: The operations this API exposes. version: The version of the API. r%GoogleApiServiceusageV2alphaOperationrTrr4r N) r rrrrrrr<r2 operationsr\rr rrrrs?   q !$%%&Mq[_`*  ! !! $'rrcF\rSrSrSr\R "S5"SS\R55r \R"SS5r \R"S5r \R"SS S S 9r\R"S 5r\R"S 5r\R"S5rSrg)*GoogleApiServiceusageV2alphaConsumerPolicyiaConsumer Policy is a set of rules that define what services or service groups can be used for a cloud resource hierarchy. Messages: AnnotationsValue: Optional. Annotations is an unstructured key-value map stored with a policy that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. [AIP-128](https://google.aip.dev/128#annotations) Fields: annotations: Optional. Annotations is an unstructured key-value map stored with a policy that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. [AIP-128](https://google.aip.dev/128#annotations) createTime: Output only. The time the policy was created. For singleton policies, this is the first touch of the policy. enableRules: Enable rules define usable services, groups, and categories. There can currently be at most one `EnableRule`. This restriction will be lifted in later releases. etag: Output only. An opaque tag indicating the current version of the policy, used for concurrency control. name: Output only. The resource name of the policy. Only the `default` policy is supported: `projects/12345/consumerPolicies/default`, `folders/12345/consumerPolicies/default`, `organizations/12345/consumerPolicies/default`. updateTime: Output only. The time the policy was last updated. r#cf\rSrSrSr"SS\R 5r\R"SSSS9r Sr g ) ;GoogleApiServiceusageV2alphaConsumerPolicy.AnnotationsValueirc`\rSrSrSr\R "S5r\R "S5rSr g)NGoogleApiServiceusageV2alphaConsumerPolicy.AnnotationsValue.AdditionalPropertyirrrr Nr+r rrr.rr/rr.rTrr Nr0r rrrrrrrrrr6r4Trr5r6r7r N)r rrrrrr8rr1rr2rr createTimerrr<rrr rrrrs: !!"89Z**Z:Z6&&'91=+$$Q'*&&'OQR]ab+   q !$   q !$$$Q'*rrc`\rSrSrSr\R "S5r\R "S5rSr g))GoogleApiServiceusageV2alphaDocumentationiaBProvides more detailed information about a service, such as tutorials and pricing information. Fields: learnmoreUrl: Provides a URL where service consumers can learn more about the product. pricingUrl: Provides a link to pricing information for the service, such as https://cloud.google.com/bigquery/pricing. rrr N) r rrrrrr learnmoreUrl pricingUrlrr rrrrs)&&q),$$Q'*rrc~\rSrSrSr\R "SSS9r\R "SSS9r\R "SSS9r Sr g ) r6iaThe consumer policy rule that defines enabled services, groups, and categories. Fields: categories: The names of the categories that are enabled. Example: `categories/googleServices`. groups: The names of the service groups that are enabled. Example: `services/container.googleapis.com/groups/dependencies`. services: The names of the services that are enabled. Example: `services/storage.googleapis.com`. rTrrr4r N) r rrrrrr categoriesrFrrr rrr6r6s? $$Q6*  T 2&  " "1t 4(rr6c\rSrSrSr\R "S5r\R "S5r\R "S5r Sr g)!GoogleApiServiceusageV2alphaGroupizInformation about the group. Fields: description: The detailed description of the group. displayName: The display name of the group. name: The resource name of the group. rrr4r N) r rrrrrrr! displayNamer<rr rrrrs9%%a(+%%a(+   q !$rrc\rSrSrSr\R "S5r\R "S5r\R "S5r Sr g)riaA GoogleApiServiceusageV2alphaOperation object. Fields: name: Name of the operation. requestMessageType: The type to use when sending requests. For example, `CreateBookRequest`. responseMessageType: The type that will be sent with responses. For example, `Book`. rrr4r N) r rrrrrrr<requestMessageTyperesponseMessageTyperr rrrrs;   q !$ ,,Q/!--a0rrc\rSrSrSrSrg)8GoogleApiServiceusageV2alphaUpdateConsumerPolicyMetadatai/Metadata for the `UpdateConsumerPolicy` method.r Nr r rrrr8rrc\rSrSrSr\R "SS5r\R"S5r \R "SS5r Sr g ) GroupStateia!Information about the state of a group with respect to a consumer resource. Fields: group: Output only. The group referenced by this state. name: Output only. The resource name of the group state. state: Output only. The state of this group with respect to the consumer parent. rrrStater4r N) r rrrrrr2grouprr<rrr rrrrs>  !Da H%   q !$  ! ,%rrc`\rSrSrSr\R "S5r\R"SSSS9r Sr g ) ri&aDefines the HTTP configuration for an API service. It contains a list of HttpRule, each specifying the mapping of an RPC method to one or more HTTP REST API methods. Fields: fullyDecodeReservedExpansion: When set to true, URL path parameters will be fully URI-decoded except in cases of single segment matches in reserved expansion, where "%2F" will be left encoded. The default behavior is to not decode RFC 6570 reserved characters in multi segment matches. rules: A list of HTTP configuration rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order. rHttpRulerTrr N) r rrrrrrrfullyDecodeReservedExpansionr2rorr rrrr&s. "+!7!7!:  Q >%rrc\rSrSrSr\R "SSSS9r\R"S5r \R "SS5r \R"S 5r \R"S 5r \R"S 5r \R"S 5r\R"S 5r\R"S5r\R"S5rSrg)ri:a=,# gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non- repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/{name=messages/*}" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an HTTP REST to gRPC mapping as below: HTTP | gRPC -----|----- `GET /v1/messages/123456` | `GetMessage(name: "messages/123456")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:"/v1/messages/{message_id}" }; } } message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: HTTP | gRPC -----|----- `GET /v1/messages/123456?revision=2&sub.subfield=foo` | `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: "foo"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A¶m=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: "message" }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: HTTP | gRPC -----|----- `PATCH /v1/messages/123456 { "text": "Hi!" }` | `UpdateMessage(message_id: "123456" message { text: "Hi!" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: "*" }; } } message Message { string message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is enabled: HTTP | gRPC -----|----- `PATCH /v1/messages/123456 { "text": "Hi!" }` | `UpdateMessage(message_id: "123456" text: "Hi!")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/messages/{message_id}" additional_bindings { get: "/v1/users/{user_id}/messages/{message_id}" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC mappings: HTTP | gRPC -----|----- `GET /v1/messages/123456` | `GetMessage(message_id: "123456")` `GET /v1/users/me/messages/123456` | `GetMessage(user_id: "me" message_id: "123456")` ## Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is "*", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. ### Path template syntax Template = "/" Segments [ Verb ] ; Segments = Segment { "/" Segment } ; Segment = "*" | "**" | LITERAL | Variable ; Variable = "{" FieldPath [ "=" Segments ] "}" ; FieldPath = IDENT { "." IDENT } ; Verb = ":" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `"{var}"` or `"{var=*}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a variable contains multiple path segments, such as `"{var=foo/*}"` or `"{var=**}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except "%2F" and "%2f" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var}`. ## Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. Example: http: rules: # Selects a gRPC method and applies HttpRule to it. - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id}/{sub.subfield} ## Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol- buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading "/" character. The reason is that the most common use case "{var}" does not capture the leading "/" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature. Fields: 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). body: The name of the request field whose value is mapped to the HTTP request body, or `*` for mapping all request fields not captured by the path pattern to the HTTP body, or omitted for not having any HTTP request body. NOTE: the referred field must be present at the top-level of the request message type. custom: The custom pattern is used for specifying an HTTP method that is not included in the `pattern` field, such as HEAD, or "*" to leave the HTTP method unspecified for this rule. The wild-card rule is useful for services that provide content to Web (HTML) clients. delete: Maps to HTTP DELETE. Used for deleting a resource. get: Maps to HTTP GET. Used for listing and getting information about resources. patch: Maps to HTTP PATCH. Used for updating a resource. post: Maps to HTTP POST. Used for creating a resource or performing an action. put: Maps to HTTP PUT. Used for replacing a resource. responseBody: Optional. The name of the response field whose value is mapped to the HTTP response body. When omitted, the entire response message will be used as the HTTP response body. NOTE: The referred field must be present at the top-level of the response message type. selector: Selects a method to which this rule applies. Refer to selector for syntax details. rTrrr r4r5r6r7rTrrrr N)r rrrrrr2additionalBindingsrbodycustomdeletegetpatchpostput responseBodyrvrr rrrr:scJ!--j!dK   q !$  ! !"5q 9&   #&a #    "%   q !$a #&&q),  " "2 &(rrc\rSrSrSrSrg)ImportAdminOverridesMetadataizMetadata message that provides information such as progress, partial failures, and similar information on each GetOperation call of LRO returned by ImportAdminOverrides. r Nr r rrrrrrrc<\rSrSrSr\R "SSSS9rSrg) ImportAdminOverridesResponseizxResponse message for ImportAdminOverrides Fields: overrides: The overrides that were created from the imported data. rrTrr Nrr rrrrrrrc\rSrSrSrSrg) ImportAdminQuotaPoliciesMetadataizMetadata message that provides information such as progress, partial failures, and similar information on each GetOperation call of LRO returned by ImportAdminQuotaPolicies. r Nr r rrrrrrrc<\rSrSrSr\R "SSSS9rSrg) ImportAdminQuotaPoliciesResponseizzResponse message for ImportAdminQuotaPolicies Fields: policies: The policies that were created from the imported data. r!rTrr N) r rrrrrr2policiesrr rrrrs  # #$6D I(rrc\rSrSrSrSrg)ImportConsumerOverridesMetadataizMetadata message that provides information such as progress, partial failures, and similar information on each GetOperation call of LRO returned by ImportConsumerOverrides. r Nr r rrrrrrrc<\rSrSrSr\R "SSSS9rSrg) ImportConsumerOverridesResponseiz{Response message for ImportConsumerOverrides Fields: overrides: The overrides that were created from the imported data. rrTrr Nrr rrrrrrrc\rSrSrSr\R "S5"SS\R55r \R"SS5r \R"S5r \R"SS 5rS rg ) ri"aaSettings for Java client libraries. Messages: ServiceClassNamesValue: Configure the Java class name to use instead of the service's for its corresponding generated GAPIC client. Keys are fully-qualified service names as they appear in the protobuf (including the full the language_settings.java.interface_names" field in gapic.yaml. API teams should otherwise use the service name as it appears in the protobuf. Example of a YAML configuration:: publishing: java_settings: service_class_names: - google.pubsub.v1.Publisher: TopicAdmin - google.pubsub.v1.Subscriber: SubscriptionAdmin Fields: common: Some settings. libraryPackage: The package name to use in Java. Clobbers the java_package option set in the protobuf. This should be used **only** by APIs who have already set the language_settings.java.package_name" field in gapic.yaml. API teams should use the protobuf java_package option where possible. Example of a YAML configuration:: publishing: java_settings: library_package: com.google.cloud.pubsub.v1 serviceClassNames: Configure the Java class name to use instead of the service's for its corresponding generated GAPIC client. Keys are fully- qualified service names as they appear in the protobuf (including the full the language_settings.java.interface_names" field in gapic.yaml. API teams should otherwise use the service name as it appears in the protobuf. Example of a YAML configuration:: publishing: java_settings: service_class_names: - google.pubsub.v1.Publisher: TopicAdmin - google.pubsub.v1.Subscriber: SubscriptionAdmin r#cf\rSrSrSr"SS\R 5r\R"SSSS9r Sr g ) #JavaSettings.ServiceClassNamesValueiAaConfigure the Java class name to use instead of the service's for its corresponding generated GAPIC client. Keys are fully-qualified service names as they appear in the protobuf (including the full the language_settings.java.interface_names" field in gapic.yaml. API teams should otherwise use the service name as it appears in the protobuf. Example of a YAML configuration:: publishing: java_settings: service_class_names: - google.pubsub.v1.Publisher: TopicAdmin - google.pubsub.v1.Subscriber: SubscriptionAdmin Messages: AdditionalProperty: An additional property for a ServiceClassNamesValue object. Fields: additionalProperties: Additional properties of type ServiceClassNamesValue c`\rSrSrSr\R "S5r\R "S5rSr g)6JavaSettings.ServiceClassNamesValue.AdditionalPropertyiUzAn additional property for a ServiceClassNamesValue object. Fields: key: Name of the additional property. value: A string attribute. rrr Nr+r rrr.r$Ur/rr.rTrr Nr0r rrServiceClassNamesValuer"As2$ 'Y.. '%112FTXYrr%rrrr4r N)r rrrrrr8rr1r%r2rrlibraryPackageserviceClassNamesrr rrrr"sq< !!"89Zy00Z:Z@  ! !":A >&((+.,,-EqIrrc\rSrSrSr\R "S5r\R "S5r\R "S5r \R "S5r Sr g) r`igaSpecifies a location to extract JWT from an API request. Fields: cookie: Specifies cookie name to extract JWT token. header: Specifies HTTP header name to extract JWT token. query: Specifies URL query parameter name to extract JWT token. valuePrefix: The value prefix. The value format is "value_prefix{token}" Only applies to "in" header type. Must be empty for "in" query type. If not empty, the header value has to match (case sensitive) this prefix. If not matched, JWT will not be extracted. If matched, JWT will be extracted after the prefix is removed. For example, for "Authorization: Bearer {JWT}", value_prefix="Bearer " with a space at the end. rrr4r5r N) r rrrrrrcookieheaderquery valuePrefixrr rrr`r`gsI    #&   #&    "%%%a(+rr`c\rSrSrSr"SS\R 5r\R"S5r \R"S5r \R"SS5r Sr g ) LabelDescriptori|aA description of a label. Enums: ValueTypeValueValuesEnum: The type of data that can be assigned to the label. Fields: description: A human-readable description for the label. key: The label key. valueType: The type of data that can be assigned to the label. c$\rSrSrSrSrSrSrSrg)(LabelDescriptor.ValueTypeValueValuesEnumizThe type of data that can be assigned to the label. Values: STRING: A variable-length string. This is the default. BOOL: Boolean; true or false. INT64: A 64-bit signed integer. rrrr N) r rrrrSTRINGBOOLINT64rr rrValueTypeValueValuesEnumr0sF D Err4rrr4r N)r rrrrrrUr4rr!r,rZ valueTyperr rrr.r.|sL   %%a(+a #!!"r>s.''*-  # #$7T J(rr>c`\rSrSrSr\R "SSSS9r\R"S5r Sr g ) ListGroupMembersResponseiaThe response message of the `ListGroupMembers` method. Fields: memberStates: The member states exposed by the parent group. nextPageToken: A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. MemberStaterTrrr N) r rrrrrr2 memberStatesrr9rr rrr@r@s-'' q4H,''*-rr@c`\rSrSrSr\R "S5r\R"SSSS9r Sr g ) ListOperationsResponseizThe response message for Operations.ListOperations. Fields: nextPageToken: The standard List next-page token. operations: A list of operations that matches the specified filter in the request. r OperationrTrr N) r rrrrrrr9r2rrr rrrDrDs-''*-%%k1tD*rrDc`\rSrSrSr\R "SSSS9r\R"S5r Sr g ) ListServiceApisResponseiaThe response message of the `ListServiceApis` method. Fields: apis: The apis exposed by the parent service. nextPageToken: A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. rrTrrr N) r rrrrrr2rrr9rr rrrGrGs.    A1t T$''*-rrGc`\rSrSrSr\R "SSSS9r\R"S5r Sr g ) ListServiceGroupsResponseiaThe response message of the `ListServiceGroups` method. Fields: groups: The group states exposed by the parent service. nextPageToken: A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. rrTrrr Nr8r rrrIrIs-  ! !,D A&''*-rrIc\rSrSrSr\R "S5r\R "S5r\R"SSSS9r \R "S 5r S r g ) riaA 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 Fields: description: A human-readable description of this log. This information appears in the documentation and can contain details. displayName: The human-readable name for this log. This information appears on the user interface and should be concise. 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. name: The name of the log. It must be less than 512 characters long and can include the following characters: upper- and lower-case alphanumeric characters [A-Za-z0-9], and punctuation characters including slash, underscore, hyphen, period [/_-.]. rrr.r4Trr5r N) r rrrrrrr!rr2labelsr<rr rrrrsN&%%a(+%%a(+  ! !"3Q F&   q !$rrc`\rSrSrSr\R "SSSS9r\R "SSSS9rSr g ) ri a5Logging configuration of the service. The following example shows how to configure logs to be sent to the producer and consumer projects. In the example, the `activity_history` log is sent to both the producer and consumer projects, whereas the `purchase_history` log is only sent to the producer project. monitored_resources: - type: library.googleapis.com/branch labels: - key: /city description: The city where the library branch is located in. - key: /name description: The name of the branch. logs: - name: activity_history labels: - key: /customer_id - name: purchase_history logging: producer_destinations: - monitored_resource: library.googleapis.com/branch logs: - activity_history - purchase_history consumer_destinations: - monitored_resource: library.googleapis.com/branch logs: - activity_history Fields: 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. 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. LoggingDestinationrTrrr N r rrrrrr2rproducerDestinationsrr rrrr s70#//0DaRVW"//0DaRVWrrc^\rSrSrSr\R "SSS9r\R "S5rSr g) rMi- aConfiguration of a specific logging destination (the producer project or the consumer project). Fields: logs: Names of the logs to be sent to this destination. Each name must be defined in the Service.logs section. If the log name is not a domain scoped name, it will be automatically prefixed with the service name followed by "/". monitoredResource: The monitored resource type. The type must be defined in the Service.monitored_resources section. rTrrr N) r rrrrrrrrrr rrrMrM- s,    q4 0$++A.rrMc\rSrSrSr\R "S5r\R "S5r\R"S\RRS9r \R "S5r Srg ) LongRunningi> a.Describes settings to use when generating API methods that use the long- running operation pattern. All default values below are from those used in the client library generators (e.g. [Java](https://github.com/googleapis/gapic-generator-java/blob/04c2faa191a9b 5a10b92392fe8482279c4404803/src/main/java/com/google/api/generator/gapic/com poser/common/RetrySettingsComposer.java)). Fields: initialPollDelay: Initial delay after which the first poll request will be made. Default value: 5 seconds. maxPollDelay: Maximum time between two subsequent poll requests. Default value: 45 seconds. pollDelayMultiplier: Multiplier to gradually increase delay between subsequent polls until it reaches max_poll_delay. Default value: 1.5. totalPollTimeout: Total polling timeout. Default value: 5 minutes. rrr4rWr5r N)r rrrrrrinitialPollDelay maxPollDelayrrYFLOATpollDelayMultipliertotalPollTimeoutrr rrrRrR> sZ"**1-&&q),!,,Q 8I8I8O8OP**1-rrRc\rSrSrSr\R "S5r\R "S5r\R "S5r \R "S5r Sr g) MemberiV aYA service group member that belongs to a certain service group. It can be a service group or a single service. Fields: groupName: A string attribute. parent: The parent group to which this member belongs. reason: Information on why the member is a part of this group. Provided by the service owner. serviceName: A string attribute. rrr4r5r N) r rrrrrrrCrreasonrrr rrrYrYV sI ##A&)   #&   #&%%a(+rrYcb\rSrSrSr\R "SS5r\R"S5r Sr g)rAih zInformation about the member state with respect to a particular consumer. Fields: member: Output only. The member referenced by this state. name: Output only. The resource name of the member state. rYrrr N) r rrrrrr2memberrr<rr rrrArAh s+  ! !(A .&   q !$rrAc@\rSrSrSr"SS\R 5r\R"S5r \R"SSSS 9r \R"S 5r \R"S 5r\R"S 5r\R"S 5r\R""SS5rSrg)rPiu aMethod represents a method of an API interface. Enums: SyntaxValueValuesEnum: The source syntax of this method. Fields: name: The simple name of this method. options: Any metadata attached to the method. requestStreaming: If true, the request is streamed. requestTypeUrl: A URL of the input message type. responseStreaming: If true, the response is streamed. responseTypeUrl: The URL of the output message type. syntax: The source syntax of this method. c$\rSrSrSrSrSrSrSrg)Method.SyntaxValueValuesEnumi zThe source syntax of this method. Values: SYNTAX_PROTO2: Syntax `proto2`. SYNTAX_PROTO3: Syntax `proto3`. SYNTAX_EDITIONS: Syntax `editions`. rrrr NrJr rrrNr_ rOrrNrrRrTrr4r5r6r7rTr N)r rrrrrrUrNrr<r2rXrrrequestStreamingrequestTypeUrlresponseStreamingresponseTypeUrlrZr[rr rrrPrPu s  inn    q !$  " "8Q >'++A.((+.,,Q/))!,/   6 :&rrPc`\rSrSrSr\R "SSSS9r\R"S5r Sr g ) ri aDefines policies applying to an RPC method. Fields: requestPolicies: Policies that are applicable to the request message. selector: Selects a method to which these policies should be enforced, for example, "google.pubsub.v1.Subscriber.CreateSubscription". Refer to selector for syntax details. NOTE: This field must not be set in the proto annotation. It will be automatically filled by the service config compiler . rrTrrr N) r rrrrrr2requestPoliciesrrvrr rrrr s- **=!dK/  " "1 %(rrcb\rSrSrSr\R "SS5r\R"S5r Sr g)MethodSettingsi aDescribes the generator configuration for a method. Fields: longRunning: Describes settings to use for long-running operations when generating API methods for RPCs. Complements RPCs that use the annotations in google/longrunning/operations.proto. Example of a YAML configuration:: publishing: method_settings: - selector: google.cloud.speech.v2.Speech.BatchRecognize long_running: initial_poll_delay: seconds: 60 # 1 minute poll_delay_multiplier: 1.5 max_poll_delay: seconds: 360 # 6 minutes total_poll_timeout: seconds: 54000 # 90 minutes selector: The fully qualified name of the method, for which the options below apply. This is used to find the method to apply the options. rRrrr N) r rrrrrr2 longRunningrrvrr rrrgrg s+ &&}a8+  " "1 %(rrgc(\rSrSrSr"SS\R 5r"SS\R 5r"SS\R 5r \R"S 5r \R"S 5r \R"S S S S9r\R"SS5r\R"SS5r\R"SS5r\R"SS S9r\R"S5r\R"S5r\R"S5r\R"SS5rSrg)ri aDefines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type's existing data unusable. Enums: LaunchStageValueValuesEnum: Optional. The launch stage of the metric definition. MetricKindValueValuesEnum: Whether the metric records instantaneous values, changes to a value, etc. Some combinations of `metric_kind` and `value_type` might not be supported. ValueTypeValueValuesEnum: Whether the measurement is an integer, a floating-point number, etc. Some combinations of `metric_kind` and `value_type` might not be supported. Fields: description: A detailed description of the metric, which can be used in documentation. displayName: A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example "Request count". This field is optional but it is recommended to be set for any metrics associated with user-visible concepts, such as Quota. labels: The set of labels that can be used to describe a specific instance of this metric type. For example, the `appengine.googleapis.com/http/server/response_latencies` metric type has a label for the HTTP response code, `response_code`, so you can look at latencies for successful responses or just for responses that failed. launchStage: Optional. The launch stage of the metric definition. metadata: Optional. Metadata which can be used to guide usage of the metric. metricKind: Whether the metric records instantaneous values, changes to a value, etc. Some combinations of `metric_kind` and `value_type` might not be supported. monitoredResourceTypes: Read-only. If present, then a time series, which is identified partially by a metric type and a MonitoredResourceDescriptor, that is associated with this metric type can only be associated with one of the monitored resource types listed here. name: The resource name of the metric descriptor. type: The metric type, including its DNS name prefix. The type is not URL- encoded. All user-defined metric types have the DNS name `custom.googleapis.com` or `external.googleapis.com`. Metric types should use a natural hierarchical grouping. For example: "custom.googleapis.com/invoice/paid/amount" "external.googleapis.com/prometheus/up" "appengine.googleapis.com/http/server/response_latencies" unit: The units in which the metric value is reported. It is only applicable if the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The `unit` defines the representation of the stored metric values. Different systems might scale the values to be more easily displayed (so a value of `0.02kBy` _might_ be displayed as `20By`, and a value of `3523kBy` _might_ be displayed as `3.5MBy`). However, if the `unit` is `kBy`, then the value of the metric is always in thousands of bytes, no matter how it might be displayed. If you want a custom metric to record the exact number of CPU-seconds used by a job, you can create an `INT64 CUMULATIVE` metric whose `unit` is `s{CPU}` (or equivalently `1s{CPU}` or just `s`). If the job uses 12,005 CPU-seconds, then the value is written as `12005`. Alternatively, if you want a custom metric to record data in a more granular way, you can create a `DOUBLE CUMULATIVE` metric whose `unit` is `ks{CPU}`, and then write the value `12.005` (which is `12005/1000`), or use `Kis{CPU}` and write `11.723` (which is `12005/1024`). The supported units are a subset of [The Unified Code for Units of Measure](https://unitsofmeasure.org/ucum.html) standard: **Basic units (UNIT)** * `bit` bit * `By` byte * `s` second * `min` minute * `h` hour * `d` day * `1` dimensionless **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^12) * `P` peta (10^15) * `E` exa (10^18) * `Z` zetta (10^21) * `Y` yotta (10^24) * `m` milli (10^-3) * `u` micro (10^-6) * `n` nano (10^-9) * `p` pico (10^-12) * `f` femto (10^-15) * `a` atto (10^-18) * `z` zepto (10^-21) * `y` yocto (10^-24) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these connectors: * `/` division or ratio (as an infix operator). For examples, `kBy/{email}` or `MiBy/10ms` (although you should almost never have `/s` in a metric `unit`; rates should always be computed at query time from the underlying cumulative or delta value). * `.` multiplication or composition (as an infix operator). For examples, `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; Annotation = "{" NAME "}" ; Notes: * `Annotation` is just a comment if it follows a `UNIT`. If the annotation is used alone, then the unit is equivalent to `1`. For examples, `{request}/s == 1/s`, `By{transmitted}/s == By/s`. * `NAME` is a sequence of non-blank printable ASCII characters not containing `{` or `}`. * `1` represents a unitary [dimensionless unit](https://en.wikipedia.org/wiki/Dimensionless_quantity) of 1, such as in `1/s`. It is typically used when none of the basic units are appropriate. For example, "new users per day" can be represented as `1/d` or `{new-users}/d` (and a metric value `5` would mean "5 new users). Alternatively, "thousands of page views per day" would be represented as `1000/d` or `k1/d` or `k{page_views}/d` (and a metric value of `5.3` would mean "5300 page views per day"). * `%` represents dimensionless value of 1/100, and annotates values giving a percentage (so the metric values are typically in the range of 0..100, and a metric value `3` means "3 percent"). * `10^2.%` indicates a metric contains a ratio, typically in the range 0..1, that will be multiplied by 100 and displayed as a percentage (so a metric value `0.03` means "3 percent"). valueType: Whether the measurement is an integer, a floating-point number, etc. Some combinations of `metric_kind` and `value_type` might not be supported. c8\rSrSrSrSrSrSrSrSr Sr S r S r S r g ) +MetricDescriptor.LaunchStageValueValuesEnumi# aOptional. The launch stage of the metric definition. Values: LAUNCH_STAGE_UNSPECIFIED: Do not use this default value. UNIMPLEMENTED: The feature is not yet implemented. Users can not use it. PRELAUNCH: Prelaunch features are hidden from users and are only visible internally. EARLY_ACCESS: Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released. ALPHA: Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects allowlisted. Alpha releases don't have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases. BETA: Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases. GA: GA features are open to all developers and are considered stable and fully qualified for production use. DEPRECATED: Deprecated features are scheduled to be shut down and removed. For more information, see the "Deprecation Policy" section of our [Terms of Service](https://cloud.google.com/terms/) and the [Google Cloud Platform Subject to the Deprecation Policy](https://cloud.google.com/terms/deprecation) documentation. rrrr4r5r6r7rTr Nrr rrrrk# rrrc(\rSrSrSrSrSrSrSrSr g) *MetricDescriptor.MetricKindValueValuesEnumiO aPWhether the metric records instantaneous values, changes to a value, etc. Some combinations of `metric_kind` and `value_type` might not be supported. Values: METRIC_KIND_UNSPECIFIED: Do not use this default value. GAUGE: An instantaneous measurement of a value. DELTA: The change in a value during a time interval. CUMULATIVE: A value accumulated over a time interval. Cumulative measurements in a time series should have the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points. rrrr4r N) r rrrrMETRIC_KIND_UNSPECIFIEDGAUGEDELTA CUMULATIVErr rrMetricKindValueValuesEnumrmO s   E EJrrrc4\rSrSrSrSrSrSrSrSr Sr S r S r g ) )MetricDescriptor.ValueTypeValueValuesEnumib a]Whether the measurement is an integer, a floating-point number, etc. Some combinations of `metric_kind` and `value_type` might not be supported. Values: VALUE_TYPE_UNSPECIFIED: Do not use this default value. BOOL: The value is a boolean. This value type can be used only if the metric kind is `GAUGE`. INT64: The value is a signed 64-bit integer. DOUBLE: The value is a double precision floating point number. STRING: The value is a text string. This value type can be used only if the metric kind is `GAUGE`. DISTRIBUTION: The value is a `Distribution`. MONEY: The value is money. rrrr4r5r6r7r N) r rrrrVALUE_TYPE_UNSPECIFIEDr2r3DOUBLEr1 DISTRIBUTIONMONEYrr rrr4rtb s- D E F FL Err4rrr.r4Trr5MetricDescriptorMetadatar6r7rTrrrrr N)r rrrrrrUrrrr4rr!rr2rKrZrmetadata metricKindmonitoredResourceTypesr<typer?r5rr rrrr sbH*9>>*X)..&0%%a(+%%a(+  ! !"3Q F&##$@!D+  # #$> B(""#>B*$00TB   q !$   q !$   r "$!!"