Default request referring to version v1 of the Service Usage API. This contains the host and root path used as a starting point for constructing service requests.

View your data across Google Cloud Platform services

View and manage your data across Google Cloud Platform services

Manage your Google API service configuration

Represents the entirety of the methods and resources available for the Service Usage API service.

Whether the measurement is an integer, a floating-point number, etc. Some combinations of `metric_kind` and `value_type` might not be supported.

Define a parameter's name and location. The parameter may be passed as either an HTTP header or a URL query parameter, and if both are passed the behavior is implementation-dependent.

See: systemParameter smart constructor.

Creates a value of SystemParameter with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• spHTTPHeader
• spURLQueryParameter
• spName

Define the HTTP header name to use for the parameter. It is case insensitive.

Define the URL query parameter name to use for the parameter. It is case sensitive.

Define the name of the parameter, such as "api_key" . It is case sensitive.

An object that describes the schema of a MonitoredResource object using a type name and a set of labels. For example, the monitored resource descriptor for Google Compute Engine VM instances has a type of `"gce_instance"` and specifies the use of the labels `"instance_id"` and `"zone"` to identify particular VM instances. Different APIs can support different monitored resource types. APIs generally provide a `list` method that returns the monitored resource descriptors used by the API.

See: monitoredResourceDescriptor smart constructor.

Creates a value of MonitoredResourceDescriptor with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• mrdName
• mrdDisplayName
• mrdLabels
• mrdType
• mrdDescription

Optional. The resource name of the monitored resource descriptor: `"projects/{project_id}/monitoredResourceDescriptors/{type}"` where {type} is the value of the `type` field in this object and {project_id} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format `"monitoredResourceDescriptors/{type}"`.

Optional. A concise name for the monitored resource type that might be displayed in user interfaces. It should be a Title Cased Noun Phrase, without any article or other determiners. For example, `"Google Cloud SQL Database"`.

Required. A set of labels used to describe instances of this monitored resource type. For example, an individual Google Cloud SQL database is identified by values for the labels `"database_id"` and `"zone"`.

Required. The monitored resource type. For example, the type `"cloudsql_database"` represents databases in Google Cloud SQL. The maximum length of this value is 256 characters.

Optional. A detailed description of the monitored resource type that might be used in documentation.

`Service` is the root object of Google service configuration schema. It describes basic information about a service, such as the name and the title, and delegates other aspects to sub-sections. Each sub-section is either a proto message or a repeated proto message that configures a specific aspect, such as auth. See each proto message definition for details. Example: type: google.api.Service config_version: 3 name: calendar.googleapis.com title: Google Calendar API apis: - name: google.calendar.v3.Calendar authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: "*" requirements: provider_id: google_calendar_auth

See: googleAPIService smart constructor.

Creates a value of GoogleAPIService with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• gasControl
• gasMetrics
• gasContext
• gasAuthentication
• gasAPIs
• gasTypes
• gasSystemTypes
• gasExperimental
• gasMonitoredResources
• gasBackend
• gasMonitoring
• gasName
• gasSystemParameters
• gasLogs
• gasDocumentation
• gasId
• gasUsage
• gasEndpoints
• gasEnums
• gasConfigVersion
• gasHTTP
• gasTitle
• gasProducerProjectId
• gasSourceInfo
• gasBilling
• gasCustomError
• gasLogging
• gasQuota

Configuration for the service control plane.

Defines the metrics used by this service.

Context configuration.

Auth configuration.

A list of API interfaces exported by this service. Only the `name` field of the google.protobuf.Api needs to be provided by the configuration author, as the remaining fields will be derived from the IDL during the normalization process. It is an error to specify an API interface here which cannot be resolved against the associated IDL files.

A list of all proto message types included in this API service. Types referenced directly or indirectly by the `apis` are automatically included. Messages which are not referenced but shall be included, such as types used by the `google.protobuf.Any` type, should be listed here by name. Example: types: - name: google.protobuf.Int32

A list of all proto message types included in this API service. It serves similar purpose as [google.api.Service.types], except that these types are not needed by user-defined APIs. Therefore, they will not show up in the generated discovery doc. This field should only be used to define system APIs in ESF.

Experimental configuration.

Defines the monitored resources used by this service. This is required by the Service.monitoring and Service.logging configurations.

API backend configuration.

Monitoring configuration.

The service name, which is a DNS-like logical identifier for the service, such as `calendar.googleapis.com`. The service name typically goes through DNS verification to make sure the owner of the service also owns the DNS name.

System parameter configuration.

Defines the logs used by this service.

Additional API documentation.

A unique ID for a specific instance of this message, typically assigned by the client for tracking purpose. If empty, the server may choose to generate one instead. Must be no longer than 60 characters.

Configuration controlling usage of this service.

Configuration for network endpoints. If this is empty, then an endpoint with the same name as the service is automatically generated to service all defined APIs.

A list of all enum types included in this API service. Enums referenced directly or indirectly by the `apis` are automatically included. Enums which are not referenced but shall be included should be listed here by name. Example: enums: - name: google.someapi.v1.SomeEnum

The semantic version of the service configuration. The config version affects the interpretation of the service configuration. For example, certain features are enabled by default for certain config versions. The latest config version is `3`.

HTTP configuration.

The product title for this service.

The Google project that owns this service.

Output only. The source information for this configuration if available.

Billing configuration.

Custom error configuration.

Logging configuration.

Quota configuration.

A documentation rule provides information about individual API elements.

See: documentationRule smart constructor.

Creates a value of DocumentationRule with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• drSelector
• drDeprecationDescription
• drDescription

The selector is a comma-separated list of patterns. Each pattern is a qualified name of the element which may end in "*", indicating a wildcard. Wildcards are only allowed at the end and for a whole component of the qualified name, i.e. "foo.*" is ok, but not "foo.b*" or "foo.*.bar". To specify a default for all applicable elements, the whole pattern "*" is used.

Deprecation description of the selected element(s). It can be provided if an element is marked as `deprecated`.

Description of the selected API(s).

The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons.

See: status smart constructor.

Creates a value of Status with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• sDetails
• sCode
• sMessage

A list of messages that carry the error details. There is a common set of message types for APIs to use.

The status code, which should be an enum value of google.rpc.Code.

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.

See: operationSchema smart constructor.

Creates a value of OperationSchema with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• osAddtional

Properties of the object. Contains field 'type with type URL.

Whether or not the service has been enabled for use by the consumer.

Configuration of a specific billing destination (Currently only support bill against consumer project).

See: billingDestination smart constructor.

Creates a value of BillingDestination with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• bdMetrics
• bdMonitoredResource

Names of the metrics to report to this billing destination. Each name must be defined in Service.metrics section.

The monitored resource type. The type must be defined in Service.monitored_resources section.

Selects and configures the service controller used by the service. The service controller handles features like abuse, quota, billing, logging, monitoring, etc.

See: control smart constructor.

Creates a value of Control with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• cEnvironment

The service control environment to use. If empty, no control plane feature (like quota and billing) will be enabled.

User-defined authentication requirements, including support for JSON Web Token (JWT).

See: authRequirement smart constructor.

Creates a value of AuthRequirement with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• arProviderId
• arAudiences

id from authentication provider. Example: provider_id: bookstore_auth

NOTE: This will be deprecated soon, once AuthProvider.audiences is implemented and accepted in all the runtime components. The list of JWT audiences. 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

Response message for the `ListServices` method.

See: listServicesResponse smart constructor.