api library

The Google Cloud client for the Service Config API.

Lets you define and config your API service.

Classes

Advice: Generated advice about this change, used for providing more information about how a change will affect the existing service.
Authentication: Authentication defines the authentication configuration for API methods provided by an API service.
AuthenticationRule: Authentication rules for the service.
AuthProvider: Configuration for an authentication provider, including support for JSON Web Token (JWT).
AuthRequirement: User-defined authentication requirements, including support for JSON Web Token (JWT).
Backend: Backend defines the backend configuration for a service.
BackendRule: A backend rule provides configuration for an individual API element.
BackendRule_PathTranslation: Path Translation specifies how to combine the backend address with the request path in order to produce the appropriate forwarding URL for the request.
Billing: Billing related configuration of the service.
Billing_BillingDestination: Configuration of a specific billing destination (Currently only support bill against consumer project).
ChangeType: Classifies set of possible modifications to an object in the service configuration.
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.
ClientLibrarySettings: Details about how and where to publish client libraries.
CommonLanguageSettings: Required information for every language.
ConfigChange: Output generated from semantically comparing two versions of a service configuration.
Context: Context defines which contexts an API requests.
ContextRule: A context rule provides information about the context for an individual API element.
Control: Selects and configures the service controller used by the service.
CppSettings: Settings for C++ client libraries.
CustomHttpPattern: A custom pattern is used for defining custom HTTP verb.
Distribution: Distribution contains summary statistics for a population of values. It optionally contains a histogram representing the distribution of those values across a set of buckets.
Distribution_BucketOptions: BucketOptions describes the bucket boundaries used to create a histogram for the distribution. The buckets can be in a linear sequence, an exponential sequence, or each bucket can be specified explicitly. BucketOptions does not include the number of values in each bucket.
Distribution_BucketOptions_Explicit: Specifies a set of buckets with arbitrary widths.
Distribution_BucketOptions_Exponential: Specifies an exponential sequence of buckets that have a width that is proportional to the value of the lower bound. Each bucket represents a constant relative uncertainty on a specific value in the bucket.
Distribution_BucketOptions_Linear: Specifies a linear sequence of buckets that all have the same width (except overflow and underflow). Each bucket represents a constant absolute uncertainty on the specific value in the bucket.
Distribution_Exemplar: Exemplars are example points that may be used to annotate aggregated distribution values. They are metadata that gives information about a particular value added to a Distribution bucket, such as a trace ID that was active when a value was added. They may contain further information, such as a example values and timestamps, origin, etc.
Distribution_Range: The range of the population values.
Documentation: Documentation provides the information for describing a service.
DocumentationRule: A documentation rule provides information about individual API elements.
DotnetSettings: Settings for Dotnet client libraries.
Endpoint: 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.
ErrorReason: Defines the supported values for google.rpc.ErrorInfo.reason for the googleapis.com error domain. This error domain is reserved for Service Infrastructure. For each error info of this domain, the metadata key "service" refers to the logical identifier of an API service, such as "pubsub.googleapis.com". The "consumer" refers to the entity that consumes an API Service. It typically is a Google project that owns the client application or the server resource, such as "projects/123". Other metadata keys are specific to each error reason. For more information, see the definition of the specific error reason.
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.
FieldInfo: Rich semantic information of an API field beyond basic typing.
FieldInfo_Format: The standard format of a field value. The supported formats are all backed by either an RFC defined by the IETF or a Google-defined AIP.
FieldPolicy: Google API Policy Annotation
GoSettings: Settings for Go client libraries.
Http: 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.
HttpBody: 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: gRPC Transcoding
JavaSettings: Settings for Java client libraries.
JwtLocation: Specifies a location to extract JWT from an API request.
LabelDescriptor: A description of a label.
LabelDescriptor_ValueType: Value types that can be used as label values.
LaunchStage: The launch stage as defined by Google Cloud Platform Launch Stages.
LogDescriptor: A description of a log type. Example in YAML format:
Logging: Logging configuration of the service.
Logging_LoggingDestination: Configuration of a specific logging destination (the producer project or the consumer project).
MethodPolicy: Defines policies applying to an RPC method.
MethodSettings: Describes the generator configuration for a method.
MethodSettings_LongRunning: Describes settings to use when generating API methods that use the long-running operation pattern. All default values below are from those used in the client library generators (e.g. Java).
Metric: A specific metric, identified by specifying values for all of the labels of a google.api.MetricDescriptor.
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.
MetricDescriptor_MetricDescriptorMetadata: Additional annotations that can be used to guide the usage of a metric.
MetricDescriptor_MetricDescriptorMetadata_TimeSeriesResourceHierarchyLevel: The resource hierarchy level of the timeseries data of a metric.
MetricDescriptor_MetricKind: The kind of measurement. It describes how the data is reported. For information on setting the start time and end time based on the MetricKind, see TimeInterval.
MetricDescriptor_ValueType: The value type of a metric.
MetricRule: Bind API methods to metrics. Binding a method to a metric causes that metric's configured quota behaviors to apply to the method call.
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 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 for "gce_instance" has labels "project_id", "instance_id" and "zone":
MonitoredResourceDescriptor: 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.
MonitoredResourceMetadata: Auxiliary metadata for a MonitoredResource object. 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.
Monitoring: Monitoring configuration of the service.
Monitoring_MonitoringDestination: Configuration of a specific monitoring destination (the producer project or the consumer project).
NodeSettings: Settings for Node client libraries.
OauthRequirements: 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.
Page: Represents a documentation page. A page can contain subpages to represent nested documentation set structure.
PhpSettings: Settings for Php client libraries.
ProjectProperties: 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. This descriptor defines which properties are allowed to be set on a project.
Property: Defines project properties.
Property_PropertyType: Supported data type of the property values
Publishing: This message configures the settings for publishing Google Cloud Client libraries generated from the service config.
PythonSettings: Settings for Python client libraries.
PythonSettings_ExperimentalFeatures: Experimental features to be included during client library generation. These fields will be deprecated once the feature graduates and is enabled by default.
Quota: Quota configuration helps to achieve fairness and budgeting in service usage.
QuotaLimit: 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.
ResourceDescriptor: A simple descriptor of a resource type.
ResourceDescriptor_History: A description of the historical or future-looking state of the resource pattern.
ResourceDescriptor_Style: A flag representing a specific style that a resource claims to conform to.
ResourceReference: Defines a proto annotation that describes a string field that refers to an API resource.
RoutingParameter: A projection from an input message to the GRPC or REST header.
RoutingRule: Specifies the routing information that should be sent along with the request in the form of routing header. NOTE: All service configuration rules follow the "last one wins" order.
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.
Service: Service is the root object of Google API service configuration (service config). It describes the basic information about a logical service, such as the service name and the user-facing 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. For more information, see each proto message definition.
SourceInfo: Source information used to create a Service Config
SystemParameter: 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.
SystemParameterRule: Define a system parameter rule mapping system parameter definitions to methods.
SystemParameters: System parameter configuration
TypeReference: A reference to a message type, for use in FieldInfo.
Usage: Configuration controlling usage of a service.
UsageRule: Usage configuration rules for the service.
Visibility: Visibility restricts service consumer's access to service elements, such as whether an application can call a visibility-restricted method. The restriction is expressed by applying visibility labels on service elements. The visibility labels are elsewhere linked to service consumers.
VisibilityRule: A visibility rule provides visibility configuration for an individual API element.

api library

Classes

google_cloud_api package

api library