Classes
Class containing functions used to build the Agent header.
Represents an exception thrown during an RPC.
Provides basic array helper methods.
BidiStream is the response object from a gRPC bidirectional streaming API call.
Contains information necessary to manage a network request.
ClientStream is the response object from a gRPC client streaming API call.
The CredentialsWrapper object provides a wrapper around a FetchAuthTokenInterface.
A collection of elements retrieved using one or more API calls. The
collection will attempt to retrieve a fixed number of elements, and
will make API calls until that fixed number is reached, or there
are no more elements to retrieve.
Container class for Protobuf label constants. See FieldDescriptorProto.Label in
https://github.com/google/protobuf/blob/master/src/google/protobuf/descriptor.proto
Container class for Protobuf type constants. See FieldDescriptorProto.Type in
https://github.com/google/protobuf/blob/master/src/google/protobuf/descriptor.proto
Common functions used to work with various clients.
Provides helper methods for gRPC support.
Service Description: Manages long-running operations with an API service.
{@inheritdoc}
Middleware which adds a CredentialsWrapper object to the call options.
Middleware to add fixed headers to an API call.
Middleware which wraps the response in an OperationResponse object.
Middleware which filters the $options array.
Middleware which wraps the response in an PagedListResponses object.
Middleware which transforms $response into [$response, $metadata]
Middleware that adds retry functionality.
Response object from a long running API method.
A Page object wraps an API list method response and provides methods
to retrieve additional pages using the page token.
Holds the description information used for page streaming.
Response object for paged results from a list API method
Represents a path template.
Builds a PSR-7 request from a set of request information.
Encapsulates request params header metadata.
Represents an absolute resource template, meaning that it will always contain a leading slash,
and may contain a trailing verb (":").
Collection of methods for parsing Segments.
Represents a relative resource template, meaning that it will never contain a leading slash or
trailing verb (":").
Represents a resource template that may or may not contain a leading slash, and if a leading
slash is present may contain a trailing verb (":"). (Note that a trailing verb without a
leading slash is not permitted).
Represents a segment in a resource template. This is used internally by RelativeResourceTemplate,
but is not intended for public use and may change without notice.
The RetrySettings class is used to configure retrying and timeouts for RPCs.
Collection of methods to help with serialization of protobuf objects
ServerStream is the response object from a gRPC server streaming API call.
Provides helper methods for service address handling.
The MockBidiStreamingCall class is used to mock out the \Grpc\BidiStreamingCall class
(https://github.com/grpc/grpc/blob/master/src/php/lib/Grpc/BidiStreamingCall.php)
The MockClientStreamingCall class is used to mock out the \Grpc\ClientStreamingCall class
(https://github.com/grpc/grpc/blob/master/src/php/lib/Grpc/ClientStreamingCall.php)
Generated from protobuf message
google.apicore.testing.MockRequest
Generated from protobuf message
google.apicore.testing.MockRequestBody
Generated from protobuf message
google.apicore.testing.MockResponse
The MockServerStreamingCall class is used to mock out the \Grpc\ServerStreamingCall class
(https://github.com/grpc/grpc/blob/master/src/php/lib/Grpc/ServerStreamingCall.php)
The MockStubTrait is used by generated mock stub classes which extent \Grpc\BaseStub
(https://github.com/grpc/grpc/blob/master/src/php/lib/Grpc/BaseStub.php)
It provides functionality to add responses, get received calls, and overrides the _simpleRequest
method so that the elements of $responses are returned instead of making a call to the API.
The MockUnaryCall class is used to mock out the \Grpc\UnaryCall class
(https://github.com/grpc/grpc/blob/master/src/php/lib/Grpc/UnaryCall.php)
Class ReceivedRequest used to hold the function name and request object of a call
make to a mock gRPC stub.
A transport that sends protobuf over HTTP 1.1 that can be used when full gRPC support
is not available.
A gRPC based transport implementation.
Class ForwardingCall wraps a \Grpc\AbstractCall.
Class ForwardingUnaryCall wraps a \Grpc\UnaryCall.
Temporary class to support an interceptor-like interface until gRPC interceptor support is
available.
A trait for shared functionality between transports that support only unary RPCs using simple
HTTP requests.
A REST based transport implementation.
Provides a light wrapper around often used URI related functions.
ValidationException represents a local error (i.e. not during an RPC call).
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.
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 and,
optionally, a histogram representing the distribution of those values across
a specified set of histogram buckets.
A Distribution may optionally contain a histogram of the values in the
population. The histogram is given in
bucket_counts as counts of values
that fall into one of a sequence of non-overlapping buckets. The sequence
of buckets is described by bucket_options.
A set of buckets with arbitrary widths.
Specify a 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.
Specify a 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.
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_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.
Value types that can be used as label values.
LabelDescriptor_ValueType
deprecated
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.
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.
The kind of measurement. It describes how the data is reported.
The value type of a metric.
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.
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.
Common audit log format for Google Cloud Platform API operations.
Authentication information for the operation.
Authorization information for the operation.
Metadata about the request.
An alias to a repo revision.
The type of an Alias.
AliasContext_Kind
deprecated
This class is deprecated. Use Google\Cloud\DevTools\Source\V1\AliasContext\Kind instead.
A CloudRepoSourceContext denotes a particular revision in a cloud
repo (a repo hosted by the Google Cloud Platform).
A CloudWorkspaceId is a unique identifier for a cloud workspace.
A CloudWorkspaceSourceContext denotes a workspace at a particular snapshot.
An ExtendedSourceContext is a SourceContext combined with additional
details describing the context.
A SourceContext referring to a Gerrit project.
A GitSourceContext denotes a particular revision in a third party Git
repository (e.g. GitHub).
Selects a repo using a Google Cloud Platform project ID
(e.g. winged-cargo-31) and a repo name within that project.
A unique identifier for a cloud repo.
A SourceContext is a reference to a tree of files. A SourceContext together
with a path point to a unique revision of a single file or directory.
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.
API Overview
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.
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.
Audit log information specific to Cloud IAM. This message is serialized
as an
Any type in the ServiceData message of an
AuditLog message.
The request message for [Operations.CancelOperation][google.longrunning.Operations.CancelOperation].
The request message for [Operations.DeleteOperation][google.longrunning.Operations.DeleteOperation].
The request message for [Operations.GetOperation][google.longrunning.Operations.GetOperation].
The request message for [Operations.ListOperations][google.longrunning.Operations.ListOperations].
The response message for [Operations.ListOperations][google.longrunning.Operations.ListOperations].
This resource represents a long-running operation that is the result of a
network API call.
Manages long-running operations with an API service.
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 Google APIs.
Describes additional debugging info.
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. The error model is designed to be:
- Simple to use and understand for most users
- Flexible enough to meet unexpected needs
Overview
The Status message contains three pieces of data: error code, error message,
and error details. The error code should be an enum value of
[google.rpc.Code][google.rpc.Code], but it may accept additional error codes if needed. The
error message should be a developer-facing English message that helps
developers understand and resolve the error. If a localized user-facing
error message is needed, put the localized message in the error details or
localize it in the client. The optional error details may contain arbitrary
information about the error. There is a predefined set of error detail types
in the package google.rpc that can be used for common error conditions.
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. Here are some examples:
Example (Java):
import com.google.type.Color;
// .
Represents a whole calendar date, e.g. date of birth. The time of day and
time zone are either specified elsewhere or are not significant. The date
is relative to the Proleptic Gregorian Calendar. The day may be 0 to
represent a year and month where the day is not significant, e.g. credit card
expiration date. The year may be 0 to represent a month and day independent
of year, e.g. anniversary date. Related types are [google.type.TimeOfDay][google.type.TimeOfDay]
and
google.protobuf.Timestamp.
Represents a day of week.
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.
Represents an amount of money with its currency type.
Represents a postal address, e.g. for postal delivery or payments addresses.
Represents a time of day. The date and time zone are either not significant
or are specified elsewhere. An API may chose to allow leap seconds. Related
types are [google.type.Date][google.type.Date] and
google.protobuf.Timestamp.