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.
Backend defines the backend configuration for a service.
A backend rule provides configuration for an individual API element.
Path Translation specifies how to combine the backend address with the
request path in order to produce the appropriate forwarding URL for the
request.
BackendRule_PathTranslation
deprecated
This class is deprecated. Use Google\Api\BackendRule\PathTranslation instead.
Billing related configuration of the service.
Configuration of a specific billing destination (Currently only support
bill against consumer project).
Billing_BillingDestination
deprecated
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. It
optionally contains a histogram representing the distribution of those values
across a set of buckets.
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.
Specifies a set of buckets with arbitrary widths.
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.
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.
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.
The range of the population values.
Distribution_BucketOptions
deprecated
This class is deprecated. Use Google\Api\Distribution\BucketOptions instead.
Distribution_BucketOptions_Explicit
deprecated
This class is deprecated. Use Google\Api\Distribution\BucketOptions\Explicit instead.
Distribution_BucketOptions_Exponential
deprecated
This class is deprecated. Use Google\Api\Distribution\BucketOptions\Exponential instead.
Distribution_BucketOptions_Linear
deprecated
This class is deprecated. Use Google\Api\Distribution\BucketOptions\Linear instead.
Distribution_Exemplar
deprecated
This class is deprecated. Use Google\Api\Distribution\Exemplar 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.
Request message for the Check method.
Response message for the Check method.
A CEL expression which has been successfully type checked.
Represents a primitive literal.
Represents a declaration of a named value or function.
Function declaration specifies one or more overloads which indicate the
function's parameter types and return type, and may optionally specify a
function definition in terms of CEL expressions.
An overload indicates a function's parameter types and return type, and
may optionally include a function body described in terms of [Expr][google.api.expr.v1alpha1.Expr]
values.
Identifier declaration which specifies its type and optional
Expr value.
Decl_FunctionDecl
deprecated
This class is deprecated. Use Google\Api\Expr\V1alpha1\Decl\FunctionDecl instead.
Decl_FunctionDecl_Overload
deprecated
This class is deprecated. Use Google\Api\Expr\V1alpha1\Decl\FunctionDecl\Overload instead.
Decl_IdentDecl
deprecated
This class is deprecated. Use Google\Api\Expr\V1alpha1\Decl\IdentDecl instead.
An enum value.
A set of errors.
Request message for the Eval method.
Response message for the Eval method.
The state of an evaluation.
A single evalution result.
EvalState_Result
deprecated
This class is deprecated. Use Google\Api\Expr\V1alpha1\EvalState\Result instead.
Values of intermediate expressions produced when evaluating expression.
ID and value index of one step.
Explain_ExprStep
deprecated
This class is deprecated. Use Google\Api\Expr\V1alpha1\Explain\ExprStep instead.
An abstract representation of a common expression.
The value of an evaluated expression.
A call expression, including calls to predefined functions and operators.
A comprehension expression applied to a list or map.
A list creation expression.
A map or message creation expression.
Represents an entry.
An identifier expression. e.g.
request.
A field selection expression. e.g.
request.auth.
Expr_Call
deprecated
This class is deprecated. Use Google\Api\Expr\V1alpha1\Expr\Call instead.
Expr_Comprehension
deprecated
This class is deprecated. Use Google\Api\Expr\V1alpha1\Expr\Comprehension instead.
Expr_CreateList
deprecated
This class is deprecated. Use Google\Api\Expr\V1alpha1\Expr\CreateList instead.
Expr_CreateStruct
deprecated
This class is deprecated. Use Google\Api\Expr\V1alpha1\Expr\CreateStruct instead.
Expr_CreateStruct_Entry
deprecated
This class is deprecated. Use Google\Api\Expr\V1alpha1\Expr\CreateStruct\Entry instead.
Expr_Ident
deprecated
This class is deprecated. Use Google\Api\Expr\V1alpha1\Expr\Ident instead.
Expr_Select
deprecated
This class is deprecated. Use Google\Api\Expr\V1alpha1\Expr\Select instead.
Warnings or errors in service execution are represented by
[google.rpc.Status][google.rpc.Status] messages, with the following message
in the details field.
Severities of issues.
IssueDetails_Severity
deprecated
This class is deprecated. Use Google\Api\Expr\V1alpha1\IssueDetails\Severity instead.
A list.
A map.
An entry in the map.
MapValue_Entry
deprecated
This class is deprecated. Use Google\Api\Expr\V1alpha1\MapValue\Entry instead.
Request message for the Parse method.
Response message for the Parse method.
An expression together with source information as returned by the parser.
Describes a resolved reference to a declaration.
Source information collected at parse time.
A specific position in source.
Represents a CEL type.
Application defined abstract type.
Function type with result and arg types.
List type with typed elements, e.g.
list<example.proto.MyMessage>.
Map type with parameterized key and value types, e.g.
map<string, int>.
CEL primitive types.
Well-known protobuf types treated with first-class support in CEL.
Type_AbstractType
deprecated
This class is deprecated. Use Google\Api\Expr\V1alpha1\Type\AbstractType instead.
Type_FunctionType
deprecated
This class is deprecated. Use Google\Api\Expr\V1alpha1\Type\FunctionType instead.
Type_ListType
deprecated
This class is deprecated. Use Google\Api\Expr\V1alpha1\Type\ListType instead.
Type_MapType
deprecated
This class is deprecated. Use Google\Api\Expr\V1alpha1\Type\MapType instead.
Type_PrimitiveType
deprecated
This class is deprecated. Use Google\Api\Expr\V1alpha1\Type\PrimitiveType instead.
Type_WellKnownType
deprecated
This class is deprecated. Use Google\Api\Expr\V1alpha1\Type\WellKnownType instead.
A set of expressions for which the value is unknown.
Represents a CEL value.
A declaration.
The declared type of a variable.
An enum value.
A set of errors.
The state of an evaluation.
A single evaluation result.
EvalState_Result
deprecated
This class is deprecated. Use Google\Api\Expr\V1beta1\EvalState\Result instead.
An abstract representation of a common expression.
The value of an evaluated expression.
A call expression, including calls to predefined functions and operators.
A comprehension expression applied to a list or map.
A list creation expression.
A map or message creation expression.
Represents an entry.
An identifier expression. e.g.
request.
A field selection expression. e.g.
request.auth.
Expr_Call
deprecated
This class is deprecated. Use Google\Api\Expr\V1beta1\Expr\Call instead.
Expr_Comprehension
deprecated
This class is deprecated. Use Google\Api\Expr\V1beta1\Expr\Comprehension instead.
Expr_CreateList
deprecated
This class is deprecated. Use Google\Api\Expr\V1beta1\Expr\CreateList instead.
Expr_CreateStruct
deprecated
This class is deprecated. Use Google\Api\Expr\V1beta1\Expr\CreateStruct instead.
Expr_CreateStruct_Entry
deprecated
This class is deprecated. Use Google\Api\Expr\V1beta1\Expr\CreateStruct\Entry instead.
Expr_Ident
deprecated
This class is deprecated. Use Google\Api\Expr\V1beta1\Expr\Ident instead.
Expr_Select
deprecated
This class is deprecated. Use Google\Api\Expr\V1beta1\Expr\Select instead.
A function declaration.
A reference to an expression id.
An identifier declaration.
A list.
Represents a primitive literal.
A map.
An entry in the map.
MapValue_Entry
deprecated
This class is deprecated. Use Google\Api\Expr\V1beta1\MapValue\Entry instead.
An expression together with source information as returned by the parser.
Source information collected at parse time.
A specific position in source.
A set of expressions for which the value is unknown.
Represents a CEL value.
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).
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.
Value types that can be used as label values.
LabelDescriptor_ValueType
deprecated
This class is deprecated. Use Google\Api\LabelDescriptor\ValueType instead.
The launch stage as defined by Google Cloud Platform
Launch Stages.
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.
Configuration of a specific logging destination (the producer project
or the consumer project).
Logging_LoggingDestination
deprecated
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.
Additional annotations that can be used to guide the usage of a metric.
The kind of measurement. It describes how the data is reported.
The value type of a metric.
MetricDescriptor_MetricDescriptorMetadata
deprecated
This class is deprecated. Use Google\Api\MetricDescriptor\MetricDescriptorMetadata instead.
MetricDescriptor_MetricKind
deprecated
This class is deprecated. Use Google\Api\MetricDescriptor\MetricKind instead.
MetricDescriptor_ValueType
deprecated
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.
Configuration of a specific monitoring destination (the producer project
or the consumer project).
Monitoring_MonitoringDestination
deprecated
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.
Supported data type of the property values
Property_PropertyType
deprecated
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.
A simple descriptor of a resource type.
A description of the historical or future-looking state of the
resource pattern.
ResourceDescriptor_History
deprecated
This class is deprecated. Use Google\Api\ResourceDescriptor\History instead.
Defines a proto annotation that describes a string field that refers to
an API resource.
A projection from an input message to the GRPC or REST header.
Specifies the routing information that should be sent along with the request
in the form of routing header.
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.
One delta entry for AuditConfig. Each individual change (only one
exempted_member in each entry) to a AuditConfig will be a separate entry.
The type of action performed on an audit configuration in a policy.
AuditConfigDelta_Action
deprecated
This class is deprecated. Use Google\Cloud\Iam\V1\AuditConfigDelta\Action instead.
Associates
members with a role.
One delta entry for Binding. Each individual change (only one member in each
entry) to a binding will be a separate entry.
The type of action performed on a Binding in a policy.
BindingDelta_Action
deprecated
This class is deprecated. Use Google\Cloud\Iam\V1\BindingDelta\Action instead.
Request message for
GetIamPolicy method.
Encapsulates settings provided to GetIamPolicy.
Defines an Identity and Access Management (IAM) policy. It is used to
specify access control policies for Cloud Platform resources.
The difference delta between two policies.
Request message for
SetIamPolicy method.
Request message for
TestIamPermissions method.
Response message for
TestIamPermissions method.
The request message for [Locations.GetLocation][google.cloud.location.Locations.GetLocation].
The request message for [Locations.ListLocations][google.cloud.location.Locations.ListLocations].
The response message for [Locations.ListLocations][google.cloud.location.Locations.ListLocations].
A resource that represents Google Cloud Platform location.
A common proto for logging HTTP requests. Only contains semantics
defined by the HTTP specification. Product-specific logging
information MUST be defined in a separate message.
The severity of the event described in a log entry, expressed as one of the
standard severity levels listed below. For your reference, the levels are
assigned the listed numeric values. The effect of using numeric values other
than those listed is undefined.
An enum to be used to mark the essential (for polling) fields in an
API-specific Operation object. A custom Operation object may contain many
different fields, but only few of them are essential to conduct a successful
polling process.
Audit log information specific to Cloud IAM. This message is serialized
as an
Any type in the ServiceData message of an
AuditLog message.
Describes violations in a client request. This error type focuses on the
syntactic aspects of the request.
A message type used to describe a single bad request field.
BadRequest_FieldViolation
deprecated
This class is deprecated. Use Google\Rpc\BadRequest\FieldViolation instead.
The canonical error codes for gRPC APIs.
Describes additional debugging info.
Describes the cause of the error with structured details.
Provides links to documentation or for performing an out of band action.
Describes a URL link.
Help_Link
deprecated
This class is deprecated. Use Google\Rpc\Help\Link instead.
Provides a localized error message that is safe to return to the user
which can be attached to an RPC error.
Describes what preconditions have failed.
A message type used to describe a single precondition failure.
PreconditionFailure_Violation
deprecated
This class is deprecated. Use Google\Rpc\PreconditionFailure\Violation instead.
Describes how a quota check failed.
A message type used to describe a single quota violation. For example, a
daily quota or a custom quota that was exceeded.
QuotaFailure_Violation
deprecated
This class is deprecated. Use Google\Rpc\QuotaFailure\Violation instead.
Contains metadata about the request that clients can attach when filing a bug
or providing other forms of feedback.
Describes the resource that is being accessed.
Describes when the clients can retry a failed request. Clients could ignore
the recommendation here or retry when this information is missing from error
responses.
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.
A
CalendarPeriod represents the abstract concept of a time period that has
a canonical start. Grammatically, "the start of the current
CalendarPeriod." All calendar times begin at midnight UTC.
Represents a color in the RGBA color space. This representation is designed
for simplicity of conversion to/from color representations in various
languages over compactness; for example, the fields of this representation
can be trivially provided to the constructor of "java.awt.Color" in Java; it
can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
method in iOS; and, with just a little work, it can be easily formatted into
a CSS "rgba()" string in JavaScript, as well.
Represents a whole or partial calendar date, e.g. a birthday. The time of day
and time zone are either specified elsewhere or are not significant. The date
is relative to the Proleptic Gregorian Calendar. This can represent:
* A full date, with non-zero year, month and day values
* A month and day value, with a zero year, e.g. an anniversary
* A year on its own, with zero month and day values
* A year and month value, with a zero day, e.g. a credit card expiration date
Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and
google.protobuf.Timestamp.
Represents civil time in one of a few possible ways:
* When utc_offset is set and time_zone is unset: a civil time on a calendar
day with a particular offset from UTC.
Represents a day of week.
A representation of a decimal value, such as 2.5. Clients may convert values
into language-native decimal formats, such as Java's [BigDecimal][] or
Python's [decimal.Decimal][].
Represents an expression text. Example:
title: "User account presence"
description: "Determines whether the request has a user account"
expression: "size(request.user) > 0"
Represents a fraction in terms of a numerator divided by a denominator.
Represents a time interval, encoded as a Timestamp start (inclusive) and a
Timestamp end (exclusive).
An object representing a latitude/longitude pair. This is expressed as a pair
of doubles representing degrees latitude and degrees longitude. Unless
specified otherwise, this must conform to the
WGS84
standard. Values must be within normalized ranges.
Localized variant of a text in a particular language.
Represents an amount of money with its currency type.
Represents a month in the Gregorian calendar.
An object representing a phone number, suitable as an API wire format.
An object representing a short code, which is a phone number that is
typically much shorter than regular phone numbers and can be used to
address messages in MMS and SMS systems, as well as for abbreviated dialing
(e.g. "Text 611 to see how many minutes you have remaining on your plan.").
Represents a postal address, e.g. for postal delivery or payments addresses.
A quaternion is defined as the quotient of two directed lines in a
three-dimensional space or equivalently as the quotient of two Euclidean
vectors (https://en.wikipedia.org/wiki/Quaternion).
Represents a time of day. The date and time zone are either not significant
or are specified elsewhere. An API may choose to allow leap seconds. Related
types are [google.type.Date][google.type.Date] and
google.protobuf.Timestamp.
Represents a time zone from the
IANA Time Zone Database.