pSrSSKJr 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"GS+GS,\R5r"GS-GS.\R5r"GS/GS0\R5r"GS1GS2\R5r"GS3GS4\R5r"GS5GS6\R5r"GS7GS8\R5r"GS9GS:\R5r"GS;GS<\R5r\GRL"\GS=GS>5 \GRN"\GRPGS?GS@5 \GRN"\GRPGSAGSB5 GgC(DzGenerated message classes for servicemanagement version v1. Google Service Management allows service producers to publish their services on Google Cloud Platform so that they can be discovered and used by service consumers. )absolute_import)messages)encoding) extra_typesservicemanagementc<\rSrSrSr\R "S5rSrg)Advicea Generated advice about this change, used for providing more information about how a change will affect the existing service. Fields: description: Useful description for why this advice was applied and what actions should be taken to mitigate any implied risks. N) __name__ __module__ __qualname____firstlineno____doc__ _messages StringField description__static_attributes__r _lib/googlecloudsdk/generated_clients/apis/servicemanagement/v1/servicemanagement_v1_messages.pyr r s%%a(+rr cf\rSrSrSr"SS\R 5r\R"S5r \R"SSSS 9r \R"S S SS 9r \R"S 5r \R"S SSS 9r\R"SS5r\R "SS5r\R"S5rSrg)Apia Api 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. New usages of this message as an alternative to ServiceDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information. Enums: SyntaxValueValuesEnum: The source syntax of the service. Fields: edition: The source edition string, only valid when syntax is SYNTAX_EDITIONS. 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.SyntaxValueValuesEnumLzThe source syntax of the service. Values: SYNTAX_PROTO2: Syntax `proto2`. SYNTAX_PROTO3: Syntax `proto3`. SYNTAX_EDITIONS: Syntax `editions`. rr r N r rrrr SYNTAX_PROTO2 SYNTAX_PROTO3SYNTAX_EDITIONSrr rrSyntaxValueValuesEnumrLMMOrr#r MethodrTrepeatedMixinOption SourceContextr N)r rrrrrEnumr#redition MessageFieldmethodsmixinsnameoptions sourceContext EnumFieldsyntaxversionrr rrrrs*X inn   ! !! $'  " "8Q >'  ! !'1t <&   q !$  " "8Q >'((!<-   6 :&  ! !! $'rrc\rSrSrSr\R "S5"SS\R55r \R"S5r \R"SS5r Srg ) AspectbaAspect represents Generic aspect. It is used to configure an aspect without making direct changes to service.proto Messages: SpecValue: Content of the configuration. The underlying schema should be defined by Aspect owners as protobuf message under `google/api/configaspects/proto`. Fields: kind: The type of this aspect configuration. spec: Content of the configuration. The underlying schema should be defined by Aspect owners as protobuf message under `google/api/configaspects/proto`. additionalPropertiescf\rSrSrSr"SS\R 5r\R"SSSS9r Sr g ) Aspect.SpecValueraContent of the configuration. The underlying schema should be defined by Aspect owners as protobuf message under `google/api/configaspects/proto`. Messages: AdditionalProperty: An additional property for a SpecValue object. Fields: additionalProperties: Properties of the object. cb\rSrSrSr\R "S5r\R"SS5r Sr g)#Aspect.SpecValue.AdditionalPropertyzAn additional property for a SpecValue object. Fields: key: Name of the additional property. value: A extra_types.JsonValue attribute. r extra_types.JsonValuerr N r rrrrrrkeyr3valuerr rrAdditionalPropertyrD,   ! !! $c$$%  y~~ ))!d;/    8! <'rrVc\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 r rr)r*r, JwtLocationr.Tr&r N)r rrrrrr audiencesauthorizationUrlidissuerjwksUrir3 jwtLocationsrr rrrfrfso-^##A&)**1-Q"   #&  ! !! $''' q4H,rrfc`\rSrSrSr\R "S5r\R "S5rSr g)AuthRequirementia 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 r rr N) r rrrrrrri providerIdrr rrrprps)*##A&)$$Q'*rrpc`\rSrSrSr\R "SSSS9r\R "SSSS9rS r g ) Authenticationi!a`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. rfr Tr&AuthenticationRulerr N) r rrrrrr3 providersrulesrr rrrsrs!s2 $$^QF)  !5q4 H%rrsc\rSrSrSr\R "S5r\R"SS5r \R"SSSS 9r \R"S 5r S r g ) rti6aAuthentication 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. r OAuthRequirementsrrpr)Tr&r*r N)r rrrrr BooleanFieldallowWithoutCredentialr3oauth requirementsrselectorrr rrrtrt6sR %11!4  !4a 8%''(91tL,  " "1 %(rrtc<\rSrSrSr\R "SSSS9rSrg) BackendiLz`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. BackendRuler Tr&r N r rrrrrr3rvrr rrrrLs  D A%rrc&\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"S5r\R,"SS5r\R0"SS5r\R"S5r\R"S5rSrg)riWa A backend rule provides configuration for an individual API element. Enums: PathTranslationValueValuesEnum: no-lint 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. loadBalancingPolicy: The load balancing policy used for connection to the application backend. Defined as an arbitrary string to accomondate custom load balancing policies supported by the underlying channel, but suggest most users use one of the standard policies, such as the default, "RoundRobin". 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: no-lint 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.PathTranslationValueValuesEnumia?no-lint 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 rr rr N) r rrrrPATH_TRANSLATION_UNSPECIFIEDCONSTANT_ADDRESSAPPEND_PATH_TO_ADDRESSrr rrPathTranslationValueValuesEnumrs8$% 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. r rrr NrGr rrrJrs+   ! !! $c$$]A6errJr Tr&r NrLr rrOverridesByRequestProtocolValuers2  7Y.. 7%112FTXYrrr rr)r*r,r.r/r0 r N)r rrrrrr1rrrPrMrraddress FloatFielddeadlinery disableAuth jwtAudienceloadBalancingPolicy minDeadlineoperationDeadliner3overridesByRequestProtocolr9pathTranslationprotocolr}rr rrrrWs2hy~~B !!"89Z (9(9Z:Z2  ! !! $'  ! !! $(&&q)+%%a(+!--a0$$Q'+**1-(556WYZ[''(H!L/  " "2 &(  " "2 &(rrcd\rSrSrSr\R "SS5r\R "SS5rSr g) BatchingConfigProtoiz`BatchingConfigProto` defines the batching configuration for an API method. Fields: batchDescriptor: The request and response fields used in batching. thresholds: The thresholds which trigger a batched request to be sent. BatchingDescriptorProtor BatchingSettingsProtorr N) r rrrrrr3batchDescriptor thresholdsrr rrrrs/**+DaH/%%&=qA*rrc\rSrSrSr\R "S5r\R "SSS9r\R "S5r Sr g ) ria`BatchingDescriptorProto` specifies the fields of the request message to be used for batching, and, optionally, the fields of the response message to be used for demultiplexing. Fields: batchedField: The repeated field in the request message to be aggregated by batching. discriminatorFields: A list of the fields in the request message. Two requests will be batched together only if the values of every field specified in `request_discriminator_fields` is equal between the two requests. subresponseField: Optional. When present, indicates the field in the response message to be used to demultiplex the response into multiple response messages, in correspondence with the multiple request messages originally batched together. r rTr&r)r N) r rrrrrr batchedFielddiscriminatorFieldssubresponseFieldrr rrrrs="&&q),!--a$?**1-rrc"\rSrSrSr"SS\R 5r\R"S5r \R"S\RRS9r \R"S\RRS9r\R"S \RRS9r\R"S \RRS9r\R""SS 5r\R"S \RRS9r\R"S 5rSrg)ria`BatchingSettingsProto` specifies a set of batching thresholds, each of which acts as a trigger to send a batch of messages as a request. At least one threshold must be positive nonzero. Enums: FlowControlLimitExceededBehaviorValueValuesEnum: The behavior to take when the flow control limit is exceeded. Fields: delayThreshold: The duration after which a batch should be sent, starting from the addition of the first message to that batch. elementCountLimit: The maximum number of elements collected in a batch that could be accepted by server. elementCountThreshold: The number of elements of a field collected into a batch which, if exceeded, causes the batch to be sent. flowControlByteLimit: The maximum size of data allowed by flow control. flowControlElementLimit: The maximum number of elements allowed by flow control. flowControlLimitExceededBehavior: The behavior to take when the flow control limit is exceeded. requestByteLimit: The maximum size of the request that could be accepted by server. requestByteThreshold: The aggregated size of the batched field which, if exceeded, causes the batch to be sent. This size is computed by aggregating the sizes of the request field to be batched, not of the entire request message. c(\rSrSrSrSrSrSrSrSr g) EBatchingSettingsProto.FlowControlLimitExceededBehaviorValueValuesEnumiaThe behavior to take when the flow control limit is exceeded. Values: UNSET_BEHAVIOR: Default behavior, system-defined. THROW_EXCEPTION: Stop operation, raise error. BLOCK: Pause operation until limit clears. IGNORE: Continue operation, disregard limit. rr rr)r N) r rrrrUNSET_BEHAVIORTHROW_EXCEPTIONBLOCKIGNORErr rr/FlowControlLimitExceededBehaviorValueValuesEnumrsNO E Frrr rvariantr)r*r,r.r/r0r N)r rrrrrr1rrdelayThreshold IntegerFieldVariantINT32elementCountLimitelementCountThresholdflowControlByteLimitflowControlElementLimitr9 flowControlLimitExceededBehaviorrequestByteLimitrequestByteThresholdrr rrrrs8   ((+.,,Q 8I8I8O8OP#00IO>O>U>UV%.%8%89jlm%n"++Ay7H7H7N7NO"//2rrc<\rSrSrSr\R "SSSS9rSrg) Billingi-aFBilling 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. BillingDestinationr Tr&r N) r rrrrrr3consumerDestinationsrr rrrr-s 0#//0DaRVWrrc^\rSrSrSr\R "SSS9r\R "S5rSr g) riIaiConfiguration 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. r Tr&rr N r rrrrrrmetricsmonitoredResourcerr rrrrI,  ! !!d 3'++A.rrc\rSrSrSr\R "SS5r\R"SSS9r \R"S5r S r g ) BindingiXatAssociates `members`, or principals, with a `role`. Fields: condition: The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource- policies). members: Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other- app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how- to/kubernetes-service-accounts). For example, `my- project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locatio ns/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.goog leapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.co m/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{ attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePo ols/{pool_id}/*`: All identities in a workforce identity pool. * `princi pal://iam.googleapis.com/projects/{project_number}/locations/global/work loadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.c om/projects/{project_number}/locations/global/workloadIdentityPools/{poo l_id}/group/{group_id}`: A workload identity pool group. * `principalSet ://iam.googleapis.com/projects/{project_number}/locations/global/workloa dIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * ` principalSet://iam.googleapis.com/projects/{project_number}/locations/gl obal/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other- app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.google apis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attr ibute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workfo rcePools/my-pool-id/subject/my-subject-attribute-value`. role: Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles). Exprr rTr&r)r N) r rrrrrr3 conditionrmembersrolerr rrrrXs?Ob$$VQ/)  ! !!d 3'   q !$rrc<\rSrSrSr\R "SSSS9rSrg) ChangeReportiaChange report associated with a particular service configuration. It contains a list of ConfigChanges based on the comparison between two service configurations. Fields: configChanges: List of changes between two service configurations. The changes will be alphabetically sorted based on the identifier of each change. A ConfigChange identifier is a dot separated path to the configuration. Example: visibility.rules[selector='LibraryService.CreateBook'].restriction ConfigChanger Tr&r N) r rrrrrr3 configChangesrr rrrrs ((TJ-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.LaunchStageValueValuesEnumiaLaunch 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. rr rr)r*r,r.r/r Nr rrrrLAUNCH_STAGE_UNSPECIFIED UNIMPLEMENTED PRELAUNCH EARLY_ACCESSALPHABETAGA DEPRECATEDrr rrLaunchStageValueValuesEnumr3!D !MIL E D BJrr CppSettingsr DotnetSettingsr GoSettingsr) JavaSettingsr*r, NodeSettingsr. PhpSettingsr/PythonSettingsr0r RubySettingsrrr N)r rrrrrr1rr3 cppSettingsdotnetSettings goSettings javaSettingsr9 launchStage nodeSettings phpSettingspythonSettingsryrestNumericEnums rubySettingsrr;rr rrrrs.*9>>*X&&}a8+))*:A>.%%lA6*'':,##$@!D+'':,&&}a8+))*:A>.++A.'';,  ! !" %'rrc\rSrSrSr"SS\R 5r\R"SSSS9r \R"S5r \R"S S 5r S rg ) CommonLanguageSettingsiaRequired 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 selectiveGapicGeneration: Configuration for which RPCs should be generated in the GAPIC client. c$\rSrSrSrSrSrSrSrg);CommonLanguageSettings.DestinationsValueListEntryValuesEnumiaDestinationsValueListEntryValuesEnum 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. rr rr N) r rrrr&CLIENT_LIBRARY_DESTINATION_UNSPECIFIEDGITHUBPACKAGE_MANAGERrr rr$DestinationsValueListEntryValuesEnumrs ./* FOrrr Tr&rSelectiveGapicGenerationr)r N)r rrrrrr1rr9 destinationsrreferenceDocsUrir3selectiveGapicGenerationrr rrrrsU  Y^^ $$%KQY]^,**1-&334NPQRrrcT\rSrSrSr\R "S5"SS\R55r \R "S5"SS\R55r \R"SS S S 9r \R"SS 5r \R"S 5r\R"SS5rSrg)CompositeOperationMetadatai3aWMetadata for composite operations. Messages: OriginalRequestValue: Original request that triggered this operation. ResponseFieldMasksValue: Defines which part of the response a child operation will contribute. Each key of the map is the name of a child operation. Each value is a field mask that identifies what that child operation contributes to the response, for example, "quota_settings", "visibility_settings", etc. Fields: childOperations: The child operations. The details of the asynchronous child operations are stored in a separate row and not in this metadata. Only the operation name is stored here. originalRequest: Original request that triggered this operation. persisted: Indicates whether the requested state change has been persisted. Once this field is set, it is guaranteed to propagate to all backends eventually, but it may not be visible immediately. Clients that are not concerned with waiting on propagation can stop polling the operation once the persisted field is set responseFieldMasks: Defines which part of the response a child operation will contribute. Each key of the map is the name of a child operation. Each value is a field mask that identifies what that child operation contributes to the response, for example, "quota_settings", "visibility_settings", etc. r?cf\rSrSrSr"SS\R 5r\R"SSSS9r Sr g ) /CompositeOperationMetadata.OriginalRequestValueiOzOriginal request that triggered this operation. Messages: AdditionalProperty: An additional property for a OriginalRequestValue object. Fields: additionalProperties: Properties of the object. Contains field @type with type URL. cb\rSrSrSr\R "S5r\R"SS5r Sr g)BCompositeOperationMetadata.OriginalRequestValue.AdditionalPropertyi\zAn additional property for a OriginalRequestValue object. Fields: key: Name of the additional property. value: A extra_types.JsonValue attribute. r rFrr NrGr rrrJr\rKrrJr Tr&r NrLr rrOriginalRequestValuerOrOrrcf\rSrSrSr"SS\R 5r\R"SSSS9r Sr g ) 2CompositeOperationMetadata.ResponseFieldMasksValueiiaDefines which part of the response a child operation will contribute. Each key of the map is the name of a child operation. Each value is a field mask that identifies what that child operation contributes to the response, for example, "quota_settings", "visibility_settings", etc. Messages: AdditionalProperty: An additional property for a ResponseFieldMasksValue object. Fields: additionalProperties: Additional properties of type ResponseFieldMasksValue c`\rSrSrSr\R "S5r\R "S5rSr g)ECompositeOperationMetadata.ResponseFieldMasksValue.AdditionalPropertyiyzAn additional property for a ResponseFieldMasksValue object. Fields: key: Name of the additional property. value: A string attribute. r rr N r rrrrrrrHrIrr rrrJry)   ! !! $c##A&errJr Tr&r NrLr rrResponseFieldMasksValueri2  'Y.. '%112FTXYrr Operationr Tr&rr)r*r N)r rrrrrrPrrMrrr3childOperationsoriginalRequestry persistedresponseFieldMasksrr rrrr3s6 !!"89ZY..Z:Z2 !!"89Z 1 1Z:Z8**;DI/**+A1E/$$Q') --.GKrrc\rSrSrSr"SS\R 5r\R"SSSS9r \R"SS 5r \R"S 5r \R"S 5r\R"S 5rS rg)riapOutput generated from semantically comparing two versions of a service configuration. Includes detailed information about a field that have changed with applicable advice about potential consequences for the change, such as backwards-incompatibility. Enums: ChangeTypeValueValuesEnum: The type for this change, either ADDED, REMOVED, or MODIFIED. Fields: advices: Collection of advice provided for this change, useful for determining the possible impact of this change. changeType: The type for this change, either ADDED, REMOVED, or MODIFIED. element: Object hierarchy path to the change, with levels separated by a '.' character. For repeated fields, an applicable unique identifier field is used for the index (usually selector, name, or id). For maps, the term 'key' is used. If the field has no unique identifier, the numeric index is used. Examples: - visibility.rules[selector=="google.Li braryService.ListBooks"].restriction - quota.metric_rules[selector=="google"].metric_costs[key=="reads"].value - logging.producer_destinations[0] newValue: Value of the changed object in the new Service configuration, in JSON format. This field will not be populated if ChangeType == REMOVED. oldValue: Value of the changed object in the old Service configuration, in JSON format. This field will not be populated if ChangeType == ADDED. c(\rSrSrSrSrSrSrSrSr g) &ConfigChange.ChangeTypeValueValuesEnumiaThe type for this change, either ADDED, REMOVED, or MODIFIED. Values: CHANGE_TYPE_UNSPECIFIED: No value was provided. ADDED: The changed object exists in the 'new' service configuration, but not in the 'old' service configuration. REMOVED: The changed object exists in the 'old' service configuration, but not in the 'new' service configuration. MODIFIED: The changed object exists in both service configurations, but its value is different. rr rr)r N) r rrrrCHANGE_TYPE_UNSPECIFIEDADDEDREMOVEDMODIFIEDrr rrChangeTypeValueValuesEnumrs   EGHrrr r Tr&rr)r*r,r N)r rrrrrr1rr3advicesr9 changeTyperelementnewValueoldValuerr rrrrsp6).."  " "8Q >'""#>B*  ! !! $'  " "1 %(  " "1 %(rrc\rSrSrSr"SS\R 5r\R"S5r \R"S5r \R"SS5r Srg ) ConfigFileiaNGeneric specification of a source configuration file Enums: FileTypeValueValuesEnum: The type of configuration file this represents. Fields: fileContents: The bytes that constitute the file. filePath: The file name of the configuration file (full or relative path). fileType: The type of configuration file this represents. c0\rSrSrSrSrSrSrSrSr Sr S r g ) "ConfigFile.FileTypeValueValuesEnumiaThe type of configuration file this represents. Values: FILE_TYPE_UNSPECIFIED: Unknown file type. SERVICE_CONFIG_YAML: YAML-specification of service. OPEN_API_JSON: OpenAPI specification, serialized in JSON. OPEN_API_YAML: OpenAPI specification, serialized in YAML. FILE_DESCRIPTOR_SET_PROTO: FileDescriptorSet, generated by protoc. To generate, use protoc with imports and source info included. For an example test.proto file, the following command would put the value in a new file named out.pb. $protoc --include_imports --include_source_info test.proto -o out.pb PROTO_FILE: Uncompiled Proto file. Used for storage and display purposes only, currently server-side compilation is not supported. Should match the inputs to 'protoc' command used to generated FILE_DESCRIPTOR_SET_PROTO. A file of this type can only be included if at least one file of type FILE_DESCRIPTOR_SET_PROTO is included. rr rr)r*r,r N) r rrrrFILE_TYPE_UNSPECIFIEDSERVICE_CONFIG_YAML OPEN_API_JSON OPEN_API_YAMLFILE_DESCRIPTOR_SET_PROTO PROTO_FILErr rrFileTypeValueValuesEnumrs*$MM !Jrr&r rr)r N)r rrrrrr1r& BytesField fileContentsrfilePathr9fileTyperr rrrrsL  4%%a(,  " "1 %(  !:A >(rrc<\rSrSrSr\R "S5rSrg) ConfigRefizRepresents a service configuration with its name and id. Fields: name: Resource name of a service config. It must have the following format: "services/{service name}/configs/{config id}". r r N) r rrrrrrr6rr rrr,r,s   q !$rr,c`\rSrSrSr\R "SSSS9r\R"S5r Sr g ) ConfigSourceiaRepresents a source file which is used to generate the service configuration defined by `google.api.Service`. Fields: files: Set of source configuration files that are used to generate a service configuration (`google.api.Service`). id: A unique ID for a specific instance of this message, typically assigned by the client for tracking purpose. If empty, the server may choose to generate one instead. rr Tr&rr N) r rrrrrr3filesrrkrr rrr.r.s-   q4 @%Q"rr.c<\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. ContextRuler Tr&r Nrr rrr1r1s(  D A%rr1c\rSrSrSr\R "SSS9r\R "SSS9r\R "SSS9r \R "SSS9r \R "S 5r S r g ) r2iaA 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. It is used to support propagating HTTP headers and ETags from the response extension. requested: A list of full type names of requested contexts, only the requested context will be made available to the backend. selector: Selects the methods to which this rule applies. Refer to selector for syntax details. r Tr&rr)r*r,r N) r rrrrrrallowedRequestExtensionsallowedResponseExtensionsprovided requestedr}rr rrr2r2sc '221tD'33AE  " "1t 4(##A5)  " "1 %(rr2c`\rSrSrSr\R "S5r\R"SSSS9r Sr g ) Controli6aSelects 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 features (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 MethodPolicyrTr&r N) r rrrrrr environmentr3methodPoliciesrr rrr9r96s- %%a(+)).!dK.rr9c>\rSrSrSr\R "SS5rSrg)riFzESettings for C++ client libraries. Fields: common: Some settings. rr r N r rrrrrr3commonrr rrrrF  ! !":A >&rrc^\rSrSrSr\R "SSSS9r\R"SSS9r Sr g ) CustomErroriPaCustomize 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'. CustomErrorRuler Tr&rr N) r rrrrrr3rvrtypesrr rrrBrBPs0   !2A E%   D 1%rrBc`\rSrSrSr\R "S5r\R"S5r Sr g)rCiba%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. r rr N) r rrrrrry isErrorTyperr}rr rrrCrCbs)&&q)+  " "1 %(rrCc`\rSrSrSr\R "S5r\R "S5rSr g)CustomHttpPatterniqzA 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. r rr N) r rrrrrrrQpathrr rrrHrHqs)   q !$   q !$rrHc\rSrSrSr\R "S5r\R"SS5r \R "S5r Sr g) CustomerSettingsi}aSettings that control how a customer (organization or folder) uses a service. Fields: customerId: ID for the customer that consumes the service (see above). Customer id is always in the format of a Gaia id. quotaSettings: Settings that control how much or how fast the service can be used by the consumer projects under the organization or folder collectively. serviceName: The name of the service. See the `ServiceManager` overview for naming requirements. r QuotaSettingsrr)r N) r rrrrrr customerIdr3 quotaSettings serviceNamerr rrrKrK}s; $$Q'*((!<-%%a(+rrKc\rSrSrSrSrg)DeleteServiceStrategyizStrategy used to delete a service. This strategy is a placeholder only used by the system generated rollout to delete a service. r Nr rrrrrr rrrQrQsrrQc\rSrSrSr"SS\R 5r\R"SS5r \R"S5r \R"S5r Sr g ) Diagnosticia0Represents a diagnostic message (error or warning) Enums: KindValueValuesEnum: The kind of diagnostic information provided. Fields: kind: The kind of diagnostic information provided. location: File name and line number of the error or warning. message: Message describing the error or warning. c \rSrSrSrSrSrSrg)Diagnostic.KindValueValuesEnumizjThe kind of diagnostic information provided. Values: WARNING: Warnings and errors ERROR: Only errors rr r N)r rrrrWARNINGERRORrr rrKindValueValuesEnumrVs G ErrYr rr)r N)r rrrrrr1rYr9rQrlocationmessagerr rrrTrTsL INN   2A 6$  " "1 %(  ! !! $'rrTc8\rSrSrSr\R "S5r\R "S5r\R "S5r \R"SSSS 9r \R"S S SS 9r \R"SS SS 9r \R "S 5r\R "S5rSrg) Documentationiaq `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: additionalIamInfo: Optional information about the IAM configuration. This is typically used to link to documentation about a product's IAM roles and permissions. 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 the boilerplate content. 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`. r rr)Pager*Tr&DocumentationRuler,r.r/r0r N)r rrrrrradditionalIamInfodocumentationRootUrloverviewr3pagesrvsectionOverridesserviceRootUrlsummaryrr rrr]r]s6p ++A."..q1  " "1 %(  T :%  !4a$ G%++FAE((+.  ! !! $'rr]c\rSrSrSr\R "S5r\R "S5r\R "S5r \R "S5r Sr g) r_iaTA 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. 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. r rr)r*r N) r rrrrrrdeprecationDescriptionrdisableReplacementWordsr}rr rrr_r_sK(%003%%a(+%11!4  " "1 %(rr_c\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.RenamedResourcesValuei3aMap 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.AdditionalPropertyiCzAn additional property for a RenamedResourcesValue object. Fields: key: Name of the additional property. value: A string attribute. r rr Nrr rrrJrnCrrrJr Tr&r NrLr rrRenamedResourcesValuerl3r rrocf\rSrSrSr"SS\R 5r\R"SSSS9r Sr g ) #DotnetSettings.RenamedServicesValueiPaMap 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.AdditionalPropertyi^An additional property for a RenamedServicesValue object. Fields: key: Name of the additional property. value: A string attribute. r rr Nrr rrrJrs^rrrJr Tr&r NrLr rrRenamedServicesValuerqPs2  'Y.. '%112FTXYrrurr rTr&r)r*r,r.r N)r rrrrrrPrrMrorur3r?rforcedNamespaceAliaseshandwrittenSignaturesignoredResourcesrenamedResourcesrenamedServicesrr rrrrs D !!"89Zi//Z:Z8 !!"89ZY..Z:Z4  ! !":A >&$00TB#//DA**1t<++,CQG**+A1E/rrc\rSrSrSr"SS\R 5r\R"SS5r \R"SS5r \R"SS S S 9r S r g )EffectiveQuotaGroupisa@An effective quota group contains both the metadata for a quota group as derived from the service config, and the effective limits in that group as calculated from producer and consumer overrides together with service defaults. Enums: BillingInteractionValueValuesEnum: Fields: baseGroup: The service configuration for this quota group, minus the quota limits, which are replaced by the effective limits below. billingInteraction: A BillingInteractionValueValuesEnum attribute. quotas: The usage and limit information for each limit within this quota group. c(\rSrSrSrSrSrSrSrSr g) 5EffectiveQuotaGroup.BillingInteractionValueValuesEnumiaBillingInteractionValueValuesEnum enum type. Values: BILLING_INTERACTION_UNSPECIFIED: The interaction between this quota group and the project billing status is unspecified. NONBILLABLE_ONLY: This quota group is enforced only when the consumer project is not billable. BILLABLE_ONLY: This quota group is enforced only when the consumer project is billable. ANY_BILLING_STATUS: This quota group is enforced regardless of the consumer project's billing status. rr rr)r N) r rrrrBILLING_INTERACTION_UNSPECIFIEDNONBILLABLE_ONLY BILLABLE_ONLYANY_BILLING_STATUSrr rr!BillingInteractionValueValuesEnumr~s  '(#Mrr QuotaGroupr r QuotaInfor)Tr&r N)r rrrrrr1rr3 baseGroupr9billingInteractionquotasrr rrr|r|ssT )..$$$\15) **+NPQR  ! !+q4 @&rr|c\rSrSrSr\R "SS5r\R"S5r \R"S5r \R"S5r Sr g ) EffectiveQuotaLimitiaAn effective quota limit contains the metadata for a quota limit as derived from the service config, together with fields that describe the effective limit value and what overrides can be applied to it. Fields: baseLimit: The service's configuration for this quota limit. effectiveLimit: The effective limit value, based on the stored producer and consumer overrides and the service defaults. key: The key used to identify this limit when applying overrides. The consumer_overrides and producer_overrides maps are keyed by strings of the form "QuotaGroupName/QuotaLimitName". maxConsumerOverrideAllowed: The maximum override value that a consumer may specify. QuotaLimitr rr)r*r N)r rrrrrr3 baseLimitreffectiveLimitrrHmaxConsumerOverrideAllowedrr rrrrsL $$\15)))!,.a #(55a8rrc\rSrSrSr\R "S5r\R"SS5r \R"SS5r \R"SSS S 9r S r g ) EffectiveQuotaLimit2iaSAn effective quota limit contains the metadata for a quota limit as derived from the service config, together with fields that describe the effective limit value and what overrides can be applied to it. This is used only for quota limits that are grouped by metrics instead of quota groups. Fields: allowAdminOverrides: whether admin overrides are allowed on this limit. Admin overrides are allowed if this limit is an organization level one, or if this limit is a project level one and there is an identical organizational limit. baseLimit: The service's configuration for this quota limit. defaultLimit: The default quota limit based on the consumer's reputation and billing status. Region and zone default limits are kept. quotaBuckets: Effective quota limit, maximum override allowed, and usage for each quota bucket. r rrr) QuotaBucketr*Tr&r N) r rrrrrryallowAdminOverridesr3r defaultLimit quotaBucketsrr rrrrsR""..q1$$\15)'' a8,'' q4H,rrc\rSrSrSr\R "S5"SS\R55r \R"SS5r \R"SS5r S r g ) EffectiveQuotasForMetriciaEffective quotas for a metric. It contains both the metadata for the metric as defined in the service config, and the effective limits for quota limits defined on the metric as calculated from service default, producer and consumer overrides, and adjusted by the reputation tier of the user. This is used only for quota limits that are grouped by metrics instead of quota groups. Messages: EffectiveLimitsValue: Effective limit values for all quota limits defined on the metric. The keys of the map are the name of the quota limits. Fields: effectiveLimits: Effective limit values for all quota limits defined on the metric. The keys of the map are the name of the quota limits. metric: The metric descriptor in service config. r?cf\rSrSrSr"SS\R 5r\R"SSSS9r Sr g ) -EffectiveQuotasForMetric.EffectiveLimitsValueia,Effective limit values for all quota limits defined on the metric. The keys of the map are the name of the quota limits. Messages: AdditionalProperty: An additional property for a EffectiveLimitsValue object. Fields: additionalProperties: Additional properties of type EffectiveLimitsValue cb\rSrSrSr\R "S5r\R"SS5r Sr g)@EffectiveQuotasForMetric.EffectiveLimitsValue.AdditionalPropertyizAn additional property for a EffectiveLimitsValue object. Fields: key: Name of the additional property. value: A EffectiveQuotaLimit2 attribute. r rrr NrGr rrrJrs,   ! !! $c$$%;Q?errJr Tr&r NrLr rrEffectiveLimitsValuers4  @Y.. @%112FTXYrrr MetricDescriptorrr N)r rrrrrrPrrMrr3effectiveLimitsmetricrr rrrrs_" !!"89ZY..Z:Z2**+A1E/  ! !"4a 8&rrc<\rSrSrSr\R "S5rSrg)EnableServiceRequestiaTRequest message for EnableService method. Fields: consumerId: Required. The identity of consumer resource which service enablement will be applied to. The Google Service Management implementation accepts the following forms: - "project:" Note: this is made compatible with google.api.servicecontrol.v1.Operation.consumer_id. r r N) r rrrrrr consumerIdrr rrrrs$$Q'*rrc\rSrSrSrSrg)EnableServiceResponseiz+Operation payload for EnableService method.r NrRr rrrrs4rrc\rSrSrSr\R "SSS9r\R"S5r \R "S5r \R "S5r S r g ) Endpointi a`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: Aliases for this endpoint, these will be served by the same UrlMap as the parent endpoint, and will be provisioned in the GCP stack for the Regional Endpoints. 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". r Tr&rr)r*r N) r rrrrrraliasesry allowCorsr6targetrr rrrr sK<  ! !!d 3'$$Q')   q !$   #&rrc\rSrSrSr"SS\R 5r\R"S5r \R"SSSS 9r \R"S 5r \R"S S SS 9r \R"S S5r\R"SS5rSrg)r1i/akEnum type definition. New usages of this message as an alternative to EnumDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information. 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.SyntaxValueValuesEnumiCThe source syntax. Values: SYNTAX_PROTO2: Syntax `proto2`. SYNTAX_PROTO3: Syntax `proto3`. SYNTAX_EDITIONS: Syntax `editions`. rr rr Nrr rrr#rCr$rr#r EnumValuerTr&r)r+r*r-r,r.r N)r rrrrrr1r#rr2r3 enumvaluer6r7r8r9r:rr rrr1r1/s& inn   ! !! $'$$[!dC)   q !$  " "8Q >'((!<-   6 :&rr1c\rSrSrSr\R "S5r\R"S\RRS9r \R"SSSS 9r S rg ) riWaEnum value definition. New usages of this message as an alternative to EnumValueDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information. Fields: name: Enum value name. number: Enum value number. options: Protocol buffer options. r rrr+r)Tr&r N)r rrrrrrr6rrrnumberr3r7rr rrrrWsK    q !$  ! !!Y->->-D-D E&  " "8Q >'rrc\rSrSrSr\R "S5r\R "S5r\R "S5r Sr g)ExperimentalFeaturesiiaExperimental features to be included during client library generation. These fields will be deprecated once the feature graduates and is enabled by default. Fields: protobufPythonicTypesEnabled: Enables generation of protobuf code using new types that are more Pythonic which are included in `protobuf>=5.29.x`. This feature will be enabled by default 1 month after launching the feature in preview packages. restAsyncIoEnabled: Enables generation of asynchronous REST clients if `rest` transport is enabled. By default, asynchronous REST clients will not be generated. This feature will be enabled by default 1 month after launching the feature in preview packages. unversionedPackageDisabled: Disables generation of an unversioned Python package for this client library. This means that the module names will need to be versioned in import statements. For example `import google.cloud.library_v2` instead of `import google.cloud.library`. r rr)r N) r rrrrrryprotobufPythonicTypesEnabledrestAsyncIoEnabledunversionedPackageDisabledrr rrrris<&"+!7!7!: --a0(55a8rrc\rSrSrSr\R "S5r\R "S5r\R "S5r \R "S5r Sr g) riaqRepresents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. Fields: description: Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. expression: Textual representation of an expression in Common Expression Language syntax. location: Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. title: Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. r rr)r*r N) r rrrrrrr expressionrZtitlerr rrrrsI:%%a(+$$Q'*  " "1 %(    "%rrc$\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)FieldiaLA single field of a message type. New usages of this message as an alternative to FieldDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information. 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. rr rr)r N) r rrrrCARDINALITY_UNKNOWNCARDINALITY_OPTIONALCARDINALITY_REQUIREDCARDINALITY_REPEATEDrr rrCardinalityValueValuesEnumrs!rrcd\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. rr rr)r*r,r.r/r0rrr 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 rrrYrsh.LKJJKJLLIKJLJKIMMKKrrYr rr)r*r,r.rr/r+r0Tr&rrr N)r rrrrrr1rrYr9 cardinalityr defaultValuejsonNamerQr6rrrr oneofIndexr3r7rypackedtypeUrlrr rrrrs8 9>> *INN*X##$@!D+&&q),  " "1 %(   2A 6$   q !$  ! !!Y->->-D-D E&%%a1B1B1H1HI*  " "8Q >'  ! !! $&  ! !" %'rrc\rSrSrSr\R "S5r\R "S5r\R "S5r Sr g) FieldPolicyi aGoogle 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". r rr)r N) r rrrrrrresourcePermission resourceTyper}rr rrrr s:,!,,Q/&&q),  " "1 %(rrc`\rSrSrSr\R "S5r\R "S5rSr g)FlowErrorDetailsi%zEncapsulation of flow-specific error details for debugging. Used as a details field on an error Status, not intended for external use. Fields: exceptionType: The type of exception (as a class name). flowStepId: The step that failed. r rr N) r rrrrrr exceptionType flowStepIdrr rrrr%s)''*-$$Q'*rrc \rSrSrSr\R "S5"SS\R55r \R "S5"SS\R55r \R"SS5r \R"SS 5r S rg ) GenerateConfigReportRequesti2aaRequest message for GenerateConfigReport method. Messages: NewConfigValue: Required. Service configuration for which we want to generate the report. For this version of API, the supported types are google.api.servicemanagement.v1.ConfigRef, google.api.servicemanagement.v1.ConfigSource, and google.api.Service OldConfigValue: Optional. Service configuration against which the comparison will be done. For this version of API, the supported types are google.api.servicemanagement.v1.ConfigRef, google.api.servicemanagement.v1.ConfigSource, and google.api.Service Fields: newConfig: Required. Service configuration for which we want to generate the report. For this version of API, the supported types are google.api.servicemanagement.v1.ConfigRef, google.api.servicemanagement.v1.ConfigSource, and google.api.Service oldConfig: Optional. Service configuration against which the comparison will be done. For this version of API, the supported types are google.api.servicemanagement.v1.ConfigRef, google.api.servicemanagement.v1.ConfigSource, and google.api.Service r?cf\rSrSrSr"SS\R 5r\R"SSSS9r Sr g ) *GenerateConfigReportRequest.NewConfigValueiJaRequired. Service configuration for which we want to generate the report. For this version of API, the supported types are google.api.servicemanagement.v1.ConfigRef, google.api.servicemanagement.v1.ConfigSource, and google.api.Service Messages: AdditionalProperty: An additional property for a NewConfigValue object. Fields: additionalProperties: Properties of the object. Contains field @type with type URL. cb\rSrSrSr\R "S5r\R"SS5r Sr g)=GenerateConfigReportRequest.NewConfigValue.AdditionalPropertyiYzAn additional property for a NewConfigValue object. Fields: key: Name of the additional property. value: A extra_types.JsonValue attribute. r rFrr NrGr rrrJrYrKrrJr Tr&r NrLr rrNewConfigValuerJ4  AY.. A%112FTXYrrcf\rSrSrSr"SS\R 5r\R"SSSS9r Sr g ) *GenerateConfigReportRequest.OldConfigValueifaOptional. Service configuration against which the comparison will be done. For this version of API, the supported types are google.api.servicemanagement.v1.ConfigRef, google.api.servicemanagement.v1.ConfigSource, and google.api.Service Messages: AdditionalProperty: An additional property for a OldConfigValue object. Fields: additionalProperties: Properties of the object. Contains field @type with type URL. cb\rSrSrSr\R "S5r\R"SS5r Sr g)=GenerateConfigReportRequest.OldConfigValue.AdditionalPropertyiuzAn additional property for a OldConfigValue object. Fields: key: Name of the additional property. value: A extra_types.JsonValue attribute. r rFrr NrGr rrrJrurKrrJr Tr&r NrLr rrOldConfigValuerfrrrr rr N)r rrrrrrPrrMrrr3 newConfig oldConfigrr rrrr2s. !!"89Zy((Z:Z6 !!"89Zy((Z:Z6$$%5q9)$$%5q9)rrc\rSrSrSr\R "SSSS9r\R "SSSS9r\R"S 5r \R"S 5r S r g ) GenerateConfigReportResponseiaResponse message for GenerateConfigReport method. Fields: changeReports: list of ChangeReport, each corresponding to comparison between two service configurations. diagnostics: Errors / Linter warnings associated with the service definition this report belongs to. id: ID of the service configuration this report belongs to. serviceName: Name of the service this report belongs to. rr Tr&rTrr)r*r N) r rrrrrr3 changeReports diagnosticsrrkrOrr rrrrsQ ((TJ-&&|QF+Q"%%a(+rrc>\rSrSrSr\R "SS5rSrg)GetIamPolicyRequestizRequest message for `GetIamPolicy` method. Fields: options: OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`. GetPolicyOptionsr r N) r rrrrrr3r7rr rrrrs  " "#5q 9'rrcb\rSrSrSr\R "S\RRS9r Sr g)ria]Encapsulates settings provided to GetIamPolicy. Fields: requestedPolicyVersion: Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource- policies). r rr N) r rrrrrrrrrequestedPolicyVersionrr rrrrs("%11!Y=N=N=T=TUrrc\rSrSrSr\R "S5"SS\R55r \R"SS5r \R"SS5r S r g ) riajSettings for Go client libraries. Messages: RenamedServicesValue: Map of service names to renamed services. Keys are the package relative service names and values are the name to be used for the service client and call options. Example: publishing: go_settings: renamed_services: Publisher: TopicAdmin Fields: common: Some settings. renamedServices: Map of service names to renamed services. Keys are the package relative service names and values are the name to be used for the service client and call options. Example: publishing: go_settings: renamed_services: Publisher: TopicAdmin r?cf\rSrSrSr"SS\R 5r\R"SSSS9r Sr g ) GoSettings.RenamedServicesValueiaMap of service names to renamed services. Keys are the package relative service names and values are the name to be used for the service client and call options. Example: publishing: go_settings: renamed_services: Publisher: TopicAdmin Messages: AdditionalProperty: An additional property for a RenamedServicesValue object. Fields: additionalProperties: Additional properties of type RenamedServicesValue c`\rSrSrSr\R "S5r\R "S5rSr g)2GoSettings.RenamedServicesValue.AdditionalPropertyirtr rr Nrr rrrJrrrrJr Tr&r NrLr rrrurs2  'Y.. '%112FTXYrrurr rr N)r rrrrrrPrrMrur3r?rzrr rrrrs_  !!"89ZY..Z:Z6  ! !":A >&**+A1E/rrc`\rSrSrSr\R "S5r\R"SSSS9r Sr g ) HttpiaDefines 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. r HttpRulerTr&r N) r rrrrrryfullyDecodeReservedExpansionr3rvrr rrr r s. "+!7!7!:  Q >%rr c\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)r ia,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: `GET /v1/messages/123456` - gRPC: `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: `GET /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: `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: `PATCH /v1/messages/123456 { "text": "Hi!" }` - gRPC: `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: `PATCH /v1/messages/123456 { "text": "Hi!" }` - gRPC: `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: `GET /v1/messages/123456` - gRPC: `GetMessage(message_id: "123456")` - HTTP: `GET /v1/users/me/messages/123456` - gRPC: `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. The following example selects a gRPC method and applies an `HttpRule` to it: http: rules: - 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. r Tr&rrHr)r*r,r.r/r0rrr N)r rrrrrr3additionalBindingsrbodycustomdeletegetpatchpostput responseBodyr}rr rrr r scJ!--j!dK   q !$  ! !"5q 9&   #&a #    "%   q !$a #&&q),  " "2 &(rr c\rSrSrSr\R "S5"SS\R55r \R"SS5r \R"S5r \R"SS 5rS rg ) riawSettings 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: library_settings: 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.ServiceClassNamesValueiaConfigure 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.AdditionalPropertyizAn additional property for a ServiceClassNamesValue object. Fields: key: Name of the additional property. value: A string attribute. r rr Nrr rrrJrrrrJr Tr&r NrLr rrServiceClassNamesValuers2$ 'Y.. '%112FTXYrrrr rr)r N)r rrrrrrPrrMrr3r?rlibraryPackageserviceClassNamesrr rrrrsq> !!"89Zy00Z:Z@  ! !":A >&((+.,,-EqIrrc\rSrSrSr\R "S5r\R "S5r\R "S5r \R "S5r Sr g) rhiaSpecifies 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. r rr)r*r N) r rrrrrrcookieheaderquery valuePrefixrr rrrhrhsI    #&   #&    "%%%a(+rrhc\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.ValueTypeValueValuesEnumi zThe 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. rr rr N) r rrrrSTRINGBOOLINT64rr rrValueTypeValueValuesEnumr' sF D Err+r rr)r N)r rrrrrr1r+rrrHr9 valueTyperr rrr%r% sL   %%a(+a #!!"'++A.((+.,,Q/))!,/   6 :&rr%c`\rSrSrSr\R "SSSS9r\R"S5r Sr g ) r:i 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 . rr Tr&rr N) r rrrrrr3requestPoliciesrr}rr rrr:r: s- **=!dK/  " "1 %(rr:c\rSrSrSr\R "SSS9r\R"SS5r \R"SS 5r \R "S 5r S r g ) MethodSettingsi aDescribes the generator configuration for a method. Fields: autoPopulatedFields: List of top-level fields of the request message, that should be automatically populated by the client libraries based on their (google.api.field_info).format. Currently supported format: UUID4. Example of a YAML configuration: publishing: method_settings: - selector: google.example.v1.ExampleService.CreateExample auto_populated_fields: - request_id batching: Batching configuration for an API method in client libraries. Example of a YAML configuration: publishing: method_settings: - selector: google.example.v1.ExampleService.BatchCreateExample batching: element_count_threshold: 1000 request_byte_threshold: 100000000 delay_threshold_millis: 10 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: 60s # 1 minute poll_delay_multiplier: 1.5 max_poll_delay: 360s # 6 minutes total_poll_timeout: 54000s # 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. Example: publishing: method_settings: - selector: google.storage.control.v2.StorageControl.CreateFolder # method settings for CreateFolder... r Tr&rrrJr)r*r N) r rrrrrrautoPopulatedFieldsr3batching longRunningr}rr rrr`r` sQ8"--a$?  # #$91 =(&&}a8+  " "1 %(rr`c(\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. rr rr)r*r,r.r/r Nrr rrrrf rrrc(\rSrSrSrSrSrSrSrSr g) *MetricDescriptor.MetricKindValueValuesEnumi 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. rr rr)r N) r rrrrMETRIC_KIND_UNSPECIFIEDGAUGEDELTA CUMULATIVErr rrMetricKindValueValuesEnumrh s   E EJrrmc4\rSrSrSrSrSrSrSrSr Sr S r S r g ) )MetricDescriptor.ValueTypeValueValuesEnumi 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. rr rr)r*r,r.r N) r rrrrVALUE_TYPE_UNSPECIFIEDr)r*DOUBLEr( DISTRIBUTIONMONEYrr rrr+ro s- D E F FL Err+r rr%r)Tr&r*MetricDescriptorMetadatar,r.r/r0rrrr N)r rrrrrr1rrmr+rrr@r3rAr9rmetadata metricKindmonitoredResourceTypesr6typeunitr,rr rrrr? sbH*9>>*X)..&0%%a(+%%a(+  ! !"3Q F&##$@!D+  # #$> B(""#>B*$00TB   q !$   q !$   r "$!!"