Module api

Modules

http_rule

Nested message and enum types in HttpRule.

label_descriptor

Nested message and enum types in LabelDescriptor.

method_settings

Nested message and enum types in MethodSettings.

python_settings

Nested message and enum types in PythonSettings.

resource_descriptor

Nested message and enum types in ResourceDescriptor.

Structs

ClientLibrarySettings

Details about how and where to publish client libraries.

CommonLanguageSettings

Required information for every language.

CppSettings

Settings for C++ client libraries.

CustomHttpPattern

A custom pattern is used for defining custom HTTP verb.

DotnetSettings

Settings for Dotnet client libraries.

GoSettings

Settings for Go client libraries.

Http

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.

HttpRule

gRPC Transcoding

JavaSettings

Settings for Java client libraries.

LabelDescriptor

A description of a label.

MethodSettings

Describes the generator configuration for a method.

MonitoredResource

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 "project_id", "instance_id" and "zone":

MonitoredResourceDescriptor

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.

MonitoredResourceMetadata

Auxiliary metadata for a [MonitoredResource][google.api.MonitoredResource] object. [MonitoredResource][google.api.MonitoredResource] objects contain the minimum set of information to uniquely identify a monitored resource instance. There is some other useful auxiliary metadata. Monitoring and Logging use an ingestion pipeline to extract metadata for cloud resources of all types, and store the metadata in this message.

NodeSettings

Settings for Node client libraries.

PhpSettings

Settings for Php client libraries.

Publishing

This message configures the settings for publishing Google Cloud Client libraries generated from the service config.

PythonSettings

Settings for Python client libraries.

ResourceDescriptor

A simple descriptor of a resource type.

ResourceReference

Defines a proto annotation that describes a string field that refers to an API resource.

RubySettings

Settings for Ruby client libraries.

SelectiveGapicGeneration

This message is used to configure the generation of a subset of the RPCs in a service for client libraries.

Enums

ClientLibraryDestination

To where should client libraries be published?

ClientLibraryOrganization

The organization for which the client libraries are being published. Affects the url where generated docs are published, etc.

FieldBehavior

An indicator of the behavior of a given field (for example, that a field is required in requests, or given as output but ignored as input). This does not change the behavior in protocol buffers itself; it only denotes the behavior and may affect how API tooling handles the field.

LaunchStage

The launch stage as defined by Google Cloud Platform Launch Stages.