Namespaces

Classes

Generated advice about this change, used for providing more information about how a change will affect the existing service.
Configuration for an anthentication 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.
Configuration of authorization.
Backend defines the backend configuration for a service.
A backend rule provides configuration for an individual API element.
Billing related configuration of the service.
This class is deprecated. Use Google\Api\Billing\BillingDestination instead.
Classifies set of possible modifications to an object in the service configuration.
Output generated from semantically comparing two versions of a service configuration.
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.
A custom pattern is used for defining custom HTTP verb.
Distribution contains summary statistics for a population of values and, optionally, a histogram representing the distribution of those values across a specified set of histogram buckets.
This class is deprecated. Use Google\Api\Distribution\BucketOptions instead.
This class is deprecated. Use Google\Api\Distribution\BucketOptions\Explicit instead.
This class is deprecated. Use Google\Api\Distribution\BucketOptions\Exponential instead.
This class is deprecated. Use Google\Api\Distribution\BucketOptions\Linear instead.
Distribution_Range deprecated
This class is deprecated. Use Google\Api\Distribution\Range instead.
Documentation provides the information for describing a service.
A documentation rule provides information about individual API elements.
Endpoint describes a network endpoint that serves a set of APIs.
Experimental service configuration. These configuration options can only be used by whitelisted users.
Defines the HTTP configuration for an API service. It contains a list of [HttpRule][google.api.HttpRule], each specifying the mapping of an RPC method to one or more HTTP REST API methods.
Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page.
HttpRule defines the mapping of an RPC method to one or more HTTP REST API methods. The mapping specifies how different portions of the RPC request message are mapped to URL path, URL query parameters, and HTTP request body. The mapping is typically specified as an google.api.http annotation on the RPC method, see "google/api/annotations.proto" for details.
A description of a label.
This class is deprecated. Use Google\Api\LabelDescriptor\ValueType instead.
A description of a log type. Example in YAML format: - name: library.googleapis.com/activity_history description: The history of borrowing and returning library items.
Logging configuration of the service.
This class is deprecated. Use Google\Api\Logging\LoggingDestination instead.
A specific metric, identified by specifying values for all of the labels of a [MetricDescriptor][google.api.MetricDescriptor].
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.
This class is deprecated. Use Google\Api\MetricDescriptor\MetricKind instead.
This class is deprecated. Use Google\Api\MetricDescriptor\ValueType instead.
Bind API methods to metrics. Binding a method to a metric causes that metric's configured quota, billing, and monitoring behaviors to apply to the method call.
An object representing a resource that can be used for monitoring, logging, billing, or other purposes. Examples include virtual machine instances, databases, and storage devices such as disks. The type field identifies a [MonitoredResourceDescriptor][google.api.MonitoredResourceDescriptor] object that describes the resource's schema. Information in the labels field identifies the actual resource and its attributes according to the schema. For example, a particular Compute Engine VM instance could be represented by the following object, because the [MonitoredResourceDescriptor][google.api.MonitoredResourceDescriptor] for "gce_instance" has labels "instance_id" and "zone": { "type": "gce_instance", "labels": { "instance_id": "12345678901234", "zone": "us-central1-a" }}
An object that describes the schema of a [MonitoredResource][google.api.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.
Auxiliary metadata for a [MonitoredResource][google.api.MonitoredResource] object.
Monitoring configuration of the service.
This class is deprecated. Use Google\Api\Monitoring\MonitoringDestination instead.
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.
Represents a documentation page. A page can contain subpages to represent nested documentation set structure.
A descriptor for defining project properties for a service. One service may have many consumer projects, and the service may want to behave differently depending on some properties on the project. For example, a project may be associated with a school, or a business, or a government agency, a business type property on the project may affect how a service responds to the client.
Defines project properties.
This class is deprecated. Use Google\Api\Property\PropertyType instead.
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 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.
Source information used to create a Service Config
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.

Configuration controlling usage of a service.
Usage configuration rules for the service.