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.
Defines the billing status requirements for operations.
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.
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 a 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 APIs. The mapping determines what portions of the request
message are populated from the path, query parameters, or body of
the HTTP request. The mapping is typically specified as an
google.api.http annotation, see "google/api/annotations.proto"
for details.
A description of a label.
Value types that can be used as label values.
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).
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.
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.
Monitoring configuration of the service.
Configuration of a specific monitoring destination (the producer project
or the consumer project).
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
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.
The entity analysis request message.
The entity analysis response message.
The entity-level sentiment analysis request message.
The entity-level sentiment analysis response message.
The sentiment analysis request message.
The sentiment analysis response message.
The syntax analysis request message.
The syntax analysis response message.
The request message for the text annotation API, which can perform multiple
analysis types (sentiment, entities, and syntax) in one call.
All available features for sentiment, syntax, and semantic analysis.
The text annotations response message.
Represents dependency parse tree information for a token.
The parse label enum for the token.
##########################################################
Represents the input to API methods.
The document types enum.
Represents the text encoding that the caller uses to process the output.
Represents a phrase in the text that is a known entity, such as
a person, an organization, or location. The API associates information, such
as salience and mentions, with entities.
Represents a mention for an entity in the text. Currently, proper noun
mentions are supported.
The supported types of mentions.
The type of the entity.
Provides text analysis operations such as sentiment analysis and entity
recognition.
Represents part of speech information for a token.
The characteristic of a verb that expresses time flow during an event.
The grammatical function performed by a noun or pronoun in a phrase,
clause, or sentence. In some languages, other parts of speech, such as
adjective and determiner, take case inflection in agreement with the noun.
Depending on the language, Form can be categorizing different forms of
verbs, adjectives, adverbs, etc. For example, categorizing inflected
endings of verbs and adjectives or distinguishing between short and long
forms of adjectives and participles
Gender classes of nouns reflected in the behaviour of associated words.
The grammatical feature of verbs, used for showing modality and attitude.
Count distinctions.
The distinction between the speaker, second person, third person, etc.
This category shows if the token is part of a proper name.
Reciprocal features of a pronoun.
The part of speech tags enum.
Time reference.
The relationship between the action that a verb expresses and the
participants identified by its arguments.
Represents a sentence in the input document.
Represents the feeling associated with the entire text or entities in
the text.
Represents an output piece of text.
Represents the smallest syntactic building block of the text.
Describes the progress of a long-running
LongRunningRecognize call. It is
included in the metadata field of the Operation returned by the
GetOperation call of the google::longrunning::Operations service.
The top-level message sent by the client for the
LongRunningRecognize
method.
The only message returned to the client by the
LongRunningRecognize method.
Contains audio data in the encoding specified in the
RecognitionConfig.
Provides information to the recognizer that specifies how to process the
request.
Audio encoding of the data sent in the audio message. All encodings support
only 1 channel (mono) audio. Only
FLAC includes a header that describes
the bytes of audio that follow the header. The other encodings are raw
audio bytes with no header.
The top-level message sent by the client for the
Recognize method.
The only message returned to the client by the
Recognize method. It
contains the result as zero or more sequential SpeechRecognitionResult
messages.
Provides "hints" to the speech recognizer to favor specific words and phrases
in the results.
Service that implements Google Cloud Speech API.
Alternative hypotheses (a.k.a. n-best list).
A speech recognition result corresponding to a portion of the audio.
Provides information to the recognizer that specifies how to process the
request.
A streaming speech recognition result corresponding to a portion of the audio
that is currently being processed.
The top-level message sent by the client for the
StreamingRecognize method.
StreamingRecognizeResponse is the only message returned to the client by
StreamingRecognize. A series of one or more StreamingRecognizeResponse
messages are streamed back to the client.
Indicates the type of speech event.
Describes the progress of a long-running
AsyncRecognize call. It is
included in the metadata field of the Operation returned by the
GetOperation call of the google::longrunning::Operations service.
The top-level message sent by the client for the
AsyncRecognize method.
The only message returned to the client by
AsyncRecognize. It contains the
result as zero or more sequential SpeechRecognitionResult messages. It is
included in the result.response field of the Operation returned by the
GetOperation call of the google::longrunning::Operations service.
Contains audio data in the encoding specified in the
RecognitionConfig.
Provides information to the recognizer that specifies how to process the
request.
Audio encoding of the data sent in the audio message. All encodings support
only 1 channel (mono) audio. Only
FLAC includes a header that describes
the bytes of audio that follow the header. The other encodings are raw
audio bytes with no header.
Provides "hints" to the speech recognizer to favor specific words and phrases
in the results.
Service that implements Google Cloud Speech API.
Alternative hypotheses (a.k.a. n-best list).
A speech recognition result corresponding to a portion of the audio.
Provides information to the recognizer that specifies how to process the
request.
A streaming speech recognition result corresponding to a portion of the audio
that is currently being processed.
The top-level message sent by the client for the
StreamingRecognize method.
StreamingRecognizeResponse is the only message returned to the client by
StreamingRecognize. A series of one or more StreamingRecognizeResponse
messages are streamed back to the client.
Indicates the type of endpointer event.
The top-level message sent by the client for the
SyncRecognize method.
The only message returned to the client by
SyncRecognize. It
contains the result as zero or more sequential SpeechRecognitionResult
messages.
Video annotation progress. Included in the
metadata
field of the Operation returned by the GetOperation
call of the google::longrunning::Operations service.
Video annotation request.
Video annotation response. Included in the
response
field of the Operation returned by the GetOperation
call of the google::longrunning::Operations service.
Bounding box.
Face annotation.
Face location.
Video annotation feature.
Label annotation.
Label detection mode.
Label level (scope).
Label location.
Bucketized representation of likelihood.
Safe search annotation (based on per-frame visual signals only).
Annotation progress for a single video.
Annotation results for a single video.
Video context and/or feature-specific parameters.
Service that implements Google Cloud Video Intelligence API.
Video segment.
Request for performing Google Cloud Vision API tasks over a user-provided
image, with user-requested features.
Response to an image annotation request.
Multiple image annotation requests are batched into a single service call.
Response to a batch image annotation request.
Logical element on the page.
Type of a block (text, image etc) as identified by OCR.
A bounding polygon for the detected image annotation.
Color information consists of RGB channels, score, and the fraction of
the image that the color occupies in the image.
Single crop hint that is used to generate a new crop when serving an image.
Set of crop hints that are used to generate new crops when serving images.
Parameters for crop hints annotation request.
Set of dominant colors and their corresponding scores.
Set of detected entity features.
A face annotation object contains the results of face detection.
A face-specific landmark (for example, a face feature).
Face landmark (feature) type.
Users describe the type of Google Cloud Vision API tasks to perform over
images by using Features. Each Feature indicates a type of image
detection task to perform. Features encode the Cloud Vision API
vertical to operate on and the number of top-scoring results to return.
Type of image feature.
Client image to perform Google Cloud Vision API tasks over.
Service that performs Google Cloud Vision API detection tasks over client
images, such as face, landmark, logo, label, and text detection. The
ImageAnnotator service returns detected entities from the images.
Image context and/or feature-specific parameters.
Stores image properties, such as dominant colors.
External image source (Google Cloud Storage image location).
Rectangle determined by min and max
LatLng pairs.
A bucketized representation of likelihood, which is intended to give clients
highly stable results across model upgrades.
Detected entity location information.
Detected page from OCR.
Structural unit of text representing a number of words in certain order.
A 3D position in the image, used primarily for Face detection landmarks.
A
Property consists of a user-supplied name/value pair.
Set of features pertaining to the image, computed by computer vision
methods over safe-search verticals (for example, adult, spoof, medical,
violence).
A single symbol representation.
TextAnnotation contains a structured representation of OCR extracted text.
Detected start or end of a structural component.
Enum to denote the type of break found. New line, space etc.
Detected language for a structural component.
Additional information detected on the structural component.
A vertex represents a 2D point in the image.
Relevant information for the image from the Internet.
Entity deduced from similar images on the Internet.
Metadata for online images.
Metadata for web pages.
A word representation.
Deletes all events in the project.
Response message for deleting error events.
A description of the context in which an error occurred.
An error event which is returned by the Error Reporting system.
Description of a group of similar error events.
A sorting order of error groups.
Service for retrieving and updating individual error groups.
Data extracted for a specific group based on certain filter criteria,
such as a given time period and/or service filter.
An API for retrieving and managing error statistics as well as data for
individual events.
A request to return an individual group.
HTTP request data that is related to a reported error.
Specifies a set of error events to return.
Contains a set of requested error events.
Specifies a set of
ErrorGroupStats to return.
Contains a set of requested error group stats.
Requests might be rejected or the resulting timed count durations might be
adjusted for lower durations.
The supported time ranges.
A request for reporting an individual error event.
Response for reporting an individual error event.
An API for reporting error events.
An error event which is reported to the Error Reporting system.
Describes a running service that sends errors.
Specifies criteria for filtering a subset of service contexts.
Indicates a location in the source code of the service for which
errors are reported.
The number of errors in a given time period.
Specifies how the time periods of error group counts are aligned.
Information related to tracking the progress on resolving the error.
A request to replace the existing data for the given group.
The request message for the
GetTrace method.
The request message for the
ListTraces method. All fields are required
unless specified.
Type of data returned for traces in the list.
The response message for the
ListTraces method.
The request message for the
PatchTraces method.
A trace describes how long it takes for an application to perform an
operation. It consists of a set of spans, each of which represent a single
timed event within the operation.
This file describes an API for collecting and viewing traces and spans
within a trace. A Trace is a collection of spans corresponding to a single
operation or set of operations for an application. A span is an individual
timed event which forms a node of the trace tree. Spans for a single trace
may span multiple services.
A span represents a single timed event within a trace. Spans can be nested
and form a trace tree. Often, a trace contains a root span that describes the
end-to-end latency of an operation and, optionally, one or more subspans for
its suboperations. Spans do not need to be contiguous. There may be gaps
between spans in a trace.
Type of span. Can be used to specify additional relationships between spans
in addition to a parent/child relationship.
List of new or updated traces.
Encapsulates the custom GAPIC header information.
Creates a function wrapper that provides extra functionalities such as retry and bundling.
Holds the parameters used for exponential backoff logic.
BidiStream is the response object from a gRPC bidirectional streaming API call.
Encapsulates the call settings for an API call.
ClientStream is the response object from a gRPC client streaming API call.
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.
Holds constants necessary for interacting with gRPC.
A class that manages credentials for an API object using the Google Auth library
This class represents a segment in a path template.
Service Description: Manages long-running operations with an API service.
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
Holds the parameters for retry and timeout logic with exponential backoff. Actual
implementation of the logic is elsewhere.
Collection of methods to help with serialization of protobuf objects
ServerStream is the response object from a gRPC server streaming API call.
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)
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.
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.
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.
Service for configuring sinks used to export log entries outside of
Stackdriver Logging.
The parameters to CreateLogMetric.
The parameters to
CreateSink.
The parameters to DeleteLogMetric.
The parameters to DeleteLog.
The parameters to
DeleteSink.
The parameters to GetLogMetric.
The parameters to
GetSink.
The parameters to
ListLogEntries.
Result returned from
ListLogEntries.
The parameters to ListLogMetrics.
Result returned from ListLogMetrics.
The parameters to ListLogs.
Result returned from ListLogs.
The parameters to ListMonitoredResourceDescriptors
Result returned from ListMonitoredResourceDescriptors.
The parameters to
ListSinks.
Result returned from
ListSinks.
An individual entry in a log.
Additional information about a potentially long-running operation with which
a log entry is associated.
Additional information about the source code location that produced the log
entry.
Describes a logs-based metric. The value of the metric is the
number of log entries that match a logs filter in a given time interval.
Stackdriver Logging API version.
Describes a sink used to export log entries to one of the following
destinations in any project: a Cloud Storage bucket, a BigQuery dataset, or a
Cloud Pub/Sub topic. A logs filter controls which log entries are
exported. The sink must be created within a project, organization, billing
account, or folder.
Available log entry formats. Log entries can be written to Stackdriver
Logging in either format and can be exported in either format.
Service for ingesting and querying logs.
Service for configuring logs-based metrics.
The parameters to UpdateLogMetric.
The parameters to
UpdateSink.
Error details for WriteLogEntries with partial success.
The parameters to WriteLogEntries.
Result returned from WriteLogEntries.
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 how to combine multiple time series to provide different views of
the data. Aggregation consists of an alignment step on individual time
series (
per_series_aligner) followed by an optional reduction of the data
across different time series (cross_series_reducer). For more details, see
Aggregation.
The Aligner describes how to bring the data points in a single
time series into temporal alignment.
A Reducer describes how to aggregate data points from multiple
time series into a single time series.
The
CreateGroup request.
The
CreateMetricDescriptor request.
Describes the result of a failed request to write data to a time series.
The
CreateTimeSeries request.
The
DeleteGroup request. You can only delete a group if it has no children.
The
DeleteMetricDescriptor request.
The
GetGroup request.
The
GetMetricDescriptor request.
The
GetMonitoredResourceDescriptor request.
The description of a dynamic collection of monitored resources. Each group
has a filter that is matched against monitored resources and their associated
metadata. If a group's filter matches an available monitored resource, then
that resource is a member of that group. Groups can contain any number of
monitored resources, and each monitored resource can be a member of any
number of groups.
The Group API lets you inspect and manage your
groups.
The
ListGroupMembers request.
The
ListGroupMembers response.
The
ListGroup request.
The
ListGroups response.
The
ListMetricDescriptors request.
The
ListMetricDescriptors response.
The
ListMonitoredResourceDescriptors request.
The
ListMonitoredResourcDescriptors response.
The
ListTimeSeries request.
Controls which fields are returned by
ListTimeSeries.
The
ListTimeSeries response.
Manages metric descriptors, monitored resource descriptors, and
time series data.
A single data point in a time series.
A time interval extending just after a start time through an end time.
A collection of data points that describes the time-varying values
of a metric. A time series is identified by a combination of a
fully-specified monitored resource and a fully-specified metric.
A single strongly-typed value.
The
UpdateGroup request.
Any contains an arbitrary serialized protocol buffer message along with a
URL that describes the type of the serialized message.
Api is a light-weight descriptor for a protocol buffer service.
Wrapper message for
bool.
Wrapper message for
bytes.
Wrapper message for
double.
A Duration represents a signed, fixed-length span of time represented
as a count of seconds and fractions of seconds at nanosecond
resolution. It is independent of any calendar and concepts like "day"
or "month". It is related to Timestamp in that the difference between
two Timestamp values is a Duration and it can be added or subtracted
from a Timestamp. Range is approximately +-10,000 years.
Enum type definition.
Enum value definition.
A single field of a message type.
FieldMask represents a set of symbolic field paths, for example:
paths: "f.a"
paths: "f.b.d"
Here f represents a field in some root message, a and b
fields in the message found in f, and d a field found in the
message in f.b.
Whether a field is optional, required, or repeated.
Basic field types.
Wrapper message for
float.
A generic empty message that you can re-use to avoid defining duplicated
empty messages in your APIs. A typical example is to use it as the request
or the response type of an API method. For instance:
service Foo {
rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
}
The JSON representation for
Empty is empty JSON object {}.
Wrapper message for
int32.
Wrapper message for
int64.
ListValue is a wrapper around a repeated field of values.
Method represents a method of an api.
Declares an API to be included in this API. The including API must
redeclare all the methods from the included API, but documentation
and options are inherited as follows:
- If after comment and whitespace stripping, the documentation
string of the redeclared method is empty, it will be inherited
from the original method.
NullValue is a singleton enumeration to represent the null value for the
Value type union.
A protocol buffer option, which can be attached to a message, field,
enumeration, etc.
SourceContext represents information about the source of a
protobuf element, like the file in which it is defined.
Wrapper message for
string.
Struct represents a structured data value, consisting of fields
which map to dynamically typed values. In some languages, Struct
might be supported by a native representation. For example, in
scripting languages like JS a struct is represented as an
object. The details of that representation are described together
with the proto support for the language.
The syntax in which a protocol buffer element is defined.
A Timestamp represents a point in time independent of any time zone
or calendar, represented as seconds and fractions of seconds at
nanosecond resolution in UTC Epoch time. It is encoded using the
Proleptic Gregorian Calendar which extends the Gregorian calendar
backwards to year one. It is encoded assuming all minutes are 60
seconds long, i.e. leap seconds are "smeared" so that no leap second
table is needed for interpretation. Range is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z.
A protocol buffer message type.
Wrapper message for
uint32.
Wrapper message for
uint64.
Value represents a dynamically typed value which can be either
null, a number, a string, a boolean, a recursive struct value, or a
list of values. A producer of value is expected to set one of that
variants, absence of any variant indicates an error.
Request for the Acknowledge method.
Request for the
CreateSnapshot method.
Request for the
DeleteSnapshot method.
Request for the DeleteSubscription method.
Request for the
DeleteTopic method.
Request for the GetSubscription method.
Request for the GetTopic method.
Request for the
ListSnapshots method.
Response for the
ListSnapshots method.
Request for the
ListSubscriptions method.
Response for the
ListSubscriptions method.
Request for the
ListTopicSubscriptions method.
Response for the
ListTopicSubscriptions method.
Request for the
ListTopics method.
Response for the
ListTopics method.
Request for the ModifyAckDeadline method.
Request for the ModifyPushConfig method.
Request for the Publish method.
Response for the
Publish method.
The service that an application uses to manipulate topics, and to send
messages to a topic.
A message data and its attributes. The message payload must not be empty;
it must contain either a non-empty data field, or at least one attribute.
Request for the
Pull method.
Response for the
Pull method.
Configuration for a push delivery endpoint.
A message and its corresponding acknowledgment ID.
Request for the
Seek method.
Protobuf type
Google\Pubsub\V1\SeekResponse
A snapshot resource.
Request for the
StreamingPull streaming RPC method. This request is used to
establish the initial stream as well as to stream acknowledgements and ack
deadline modifications from the client to the server.
Response for the
StreamingPull method. This response is used to stream
messages from the server to the client.
The service that an application uses to manipulate subscriptions and to
consume messages from a subscription via the
Pull method.
A subscription resource.
A topic resource.
Request for the UpdateSubscription method.
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.
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.
Provides a localized error message that is safe to return to the user
which can be attached to an RPC error.
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.
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 which can be used for common error conditions.
Metadata type for the operation returned by
[CreateDatabase][google.spanner.admin.database.v1.DatabaseAdmin.CreateDatabase].
The request for [CreateDatabase][google.spanner.admin.database.v1.DatabaseAdmin.CreateDatabase].
A Cloud Spanner database.
Cloud Spanner Database Admin API
Indicates the current state of the database.
The request for [DropDatabase][google.spanner.admin.database.v1.DatabaseAdmin.DropDatabase].
The request for [GetDatabaseDdl][google.spanner.admin.database.v1.DatabaseAdmin.GetDatabaseDdl].
The response for [GetDatabaseDdl][google.spanner.admin.database.v1.DatabaseAdmin.GetDatabaseDdl].
The request for [GetDatabase][google.spanner.admin.database.v1.DatabaseAdmin.GetDatabase].
The request for [ListDatabases][google.spanner.admin.database.v1.DatabaseAdmin.ListDatabases].
The response for [ListDatabases][google.spanner.admin.database.v1.DatabaseAdmin.ListDatabases].
Metadata type for the operation returned by
[UpdateDatabaseDdl][google.spanner.admin.database.v1.DatabaseAdmin.UpdateDatabaseDdl].
Enqueues the given DDL statements to be applied, in order but not
necessarily all at once, to the database schema at some point (or
points) in the future. The server checks that the statements
are executable (syntactically valid, name tables that exist, etc.)
before enqueueing them, but they may still fail upon
later execution (e.g., if a statement from another batch of
statements is applied first and it conflicts in some way, or if
there is some data-related problem like a
NULL value in a column to
which NOT NULL would be added). If a statement fails, all
subsequent statements in the batch are automatically cancelled.
Metadata type for the operation returned by
[CreateInstance][google.spanner.admin.instance.v1.InstanceAdmin.CreateInstance].
The request for [CreateInstance][google.spanner.admin.instance.v1.InstanceAdmin.CreateInstance].
The request for [DeleteInstance][google.spanner.admin.instance.v1.InstanceAdmin.DeleteInstance].
The request for
[GetInstanceConfigRequest][google.spanner.admin.instance.v1.InstanceAdmin.GetInstanceConfig].
The request for [GetInstance][google.spanner.admin.instance.v1.InstanceAdmin.GetInstance].
An isolated set of Cloud Spanner resources on which databases can be hosted.
Cloud Spanner Instance Admin API
A possible configuration for a Cloud Spanner instance. Configurations
define the geographic placement of nodes and their replication.
Indicates the current state of the instance.
The request for [ListInstanceConfigs][google.spanner.admin.instance.v1.InstanceAdmin.ListInstanceConfigs].
The response for [ListInstanceConfigs][google.spanner.admin.instance.v1.InstanceAdmin.ListInstanceConfigs].
The request for [ListInstances][google.spanner.admin.instance.v1.InstanceAdmin.ListInstances].
The response for [ListInstances][google.spanner.admin.instance.v1.InstanceAdmin.ListInstances].
Metadata type for the operation returned by
[UpdateInstance][google.spanner.admin.instance.v1.InstanceAdmin.UpdateInstance].
The request for [UpdateInstance][google.spanner.admin.instance.v1.InstanceAdmin.UpdateInstance].
The request for [BeginTransaction][google.spanner.v1.Spanner.BeginTransaction].
The request for [Commit][google.spanner.v1.Spanner.Commit].
The response for [Commit][google.spanner.v1.Spanner.Commit].
The request for [CreateSession][google.spanner.v1.Spanner.CreateSession].
The request for [DeleteSession][google.spanner.v1.Spanner.DeleteSession].
The request for [ExecuteSql][google.spanner.v1.Spanner.ExecuteSql] and
[ExecuteStreamingSql][google.spanner.v1.Spanner.ExecuteStreamingSql].
Mode in which the query must be processed.
The request for [GetSession][google.spanner.v1.Spanner.GetSession].
KeyRange represents a range of rows in a table or index.
KeySet defines a collection of Cloud Spanner keys and/or key ranges. All
the keys are expected to be in the same table or index. The keys need
not be sorted in any particular way.
A modification to one or more Cloud Spanner rows. Mutations can be
applied to a Cloud Spanner database by sending them in a
[Commit][google.spanner.v1.Spanner.Commit] call.
Arguments to [delete][google.spanner.v1.Mutation.delete] operations.
Arguments to [insert][google.spanner.v1.Mutation.insert], [update][google.spanner.v1.Mutation.update], [insert_or_update][google.spanner.v1.Mutation.insert_or_update], and
[replace][google.spanner.v1.Mutation.replace] operations.
Partial results from a streaming read or SQL query. Streaming reads and
SQL queries better tolerate large result sets, large rows, and large
values, but are a little trickier to consume.
Node information for nodes appearing in a [QueryPlan.plan_nodes][google.spanner.v1.QueryPlan.plan_nodes].
Metadata associated with a parent-child relationship appearing in a
[PlanNode][google.spanner.v1.PlanNode].
The kind of [PlanNode][google.spanner.v1.PlanNode]. Distinguishes between the two different kinds of
nodes that can appear in a query plan.
Condensed representation of a node and its subtree. Only present for
SCALAR [PlanNode(s)][google.spanner.v1.PlanNode].
Contains an ordered list of nodes appearing in the query plan.
The request for [Read][google.spanner.v1.Spanner.Read] and
[StreamingRead][google.spanner.v1.Spanner.StreamingRead].
Results from [Read][google.spanner.v1.Spanner.Read] or
[ExecuteSql][google.spanner.v1.Spanner.ExecuteSql].
Metadata about a [ResultSet][google.spanner.v1.ResultSet] or [PartialResultSet][google.spanner.v1.PartialResultSet].
Additional statistics about a [ResultSet][google.spanner.v1.ResultSet] or [PartialResultSet][google.spanner.v1.PartialResultSet].
The request for [Rollback][google.spanner.v1.Spanner.Rollback].
A session in the Cloud Spanner API.
Cloud Spanner API
StructType defines the fields of a [STRUCT][google.spanner.v1.TypeCode.STRUCT] type.
Message representing a single field of a struct.
A transaction.
Transactions
Each session can have at most one active transaction at a time. After the active transaction is completed, the session can immediately be re-used for the next transaction. It is not necessary to create a new session for each transaction.
Options for read-only transactions.
Options for read-write transactions.
This message is used to select the transaction in which a
[Read][google.spanner.v1.Spanner.Read] or
[ExecuteSql][google.spanner.v1.Spanner.ExecuteSql] call runs.
Type indicates the type of a Cloud Spanner value, as might be stored in a
table cell or returned from an SQL query.
TypeCode is used as part of [Type][google.spanner.v1.Type] to
indicate the type of a Cloud Spanner value.
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.