google_api_service_usage v0.6.0 API Reference

Modules

API calls for all endpoints tagged Operations.

API calls for all endpoints tagged Services.

Handle Tesla connections for GoogleApi.ServiceUsage.V1.

Api is a light-weight descriptor for an API Interface.

Configuration for an authentication provider, including support for JSON Web Token (JWT).

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

Authentication defines the authentication configuration for an API.

Authentication rules for the service.

Backend defines the backend configuration for a service.

A backend rule provides configuration for an individual API element.

Response message for BatchCreateAdminOverrides

Response message for BatchCreateConsumerOverrides

Request message for the BatchEnableServices method.

Response message for the BatchEnableServices method. This response message is assigned to the response field of the returned Operation when that operation is done.

Billing related configuration of the service.

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

The request message for Operations.CancelOperation.

Context defines which contexts an API requests.

A context rule provides information about the context for an individual API element.

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

Customize service error responses. For example, list any service specific protobuf types that can appear in error detail lists of error responses.

A custom pattern is used for defining custom HTTP verb.

Request message for the DisableService method.

Response message for the DisableService method. This response message is assigned to the response field of the returned Operation when that operation is done.

Documentation provides the information for describing a service.

A documentation rule provides information about individual API elements.

A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance

Provides error messages for the failing services.

Request message for the EnableService method.

Response message for the EnableService method. This response message is assigned to the response field of the returned Operation when that operation is done.

Endpoint describes a network endpoint that serves a set of APIs. A service may expose any number of endpoints, and all endpoints share the same service configuration, such as quota configuration and monitoring configuration.

Enum type definition.

A single field of a message type.

Response message for getting service identity.

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.

The per-product per-project service identity for a service.

The operation metadata returned for the batchend services operation.

A service that is available for use by the consumer.

Service identity for a service. This is the identity that service producer should use to access consumer resources.

Defines 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.

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, Cloud Endpoints, gRPC Gateway, and Envoy proxy support this feature and use it for large scale production services.

Specifies a location to extract JWT from an API request.

The response message for Operations.ListOperations.

Response message for the ListServices method.

A description of a log type. Example in YAML format

Logging configuration of the service.

Configuration of a specific logging destination (the producer project or the consumer project).

Method represents a method of an API interface.

Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type's existing data unusable.

Additional annotations that can be used to guide the usage of a metric.

Bind API methods to metrics. Binding a method to a metric causes that metric's configured quota behaviors to apply to the method call.

Declares an API Interface to be included in this interface. The including interface must redeclare all the methods from the included interface, but documentation and options are inherited as follows

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.

Monitoring configuration of the service.

Configuration of a specific monitoring destination (the producer project or the consumer project).

OAuth scopes are a way to define data and permissions on data. For example, there are scopes defined for "Read-only access to Google Calendar" and "Access to Cloud Platform". Users can consent to a scope for an application, giving it permission to access that data on their behalf.

This resource represents a long-running operation that is the result of a network API call.

The operation metadata returned for the batchend services operation.

A protocol buffer option, which can be attached to a message, field, enumeration, etc.

Represents a documentation page. A page can contain subpages to represent nested documentation set structure.

Quota configuration helps to achieve fairness and budgeting in service usage.

QuotaLimit defines a specific limit that applies over a specified duration for a limit type. There can be at most one limit for a duration and limit type combination defined within a QuotaGroup.

Service identity for a service. This is the identity that service producer should use to access consumer resources.

SourceContext represents information about the source of a protobuf element, like the file in which it is defined.

Source information used to create a Service Config

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. Each Status message contains three pieces of data: error code, error message, and error details.

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.

Define a system parameter rule mapping system parameter definitions to methods.

System parameter configuration

A system parameter is a special kind of parameter defined by the API system, not by an individual API. It is typically mapped to an HTTP header and/or a URL query parameter. This configuration specifies which methods change the names of the system parameters.

A protocol buffer message type.

Configuration controlling usage of a service.

Usage configuration rules for the service.