Index
A
- Advice — Class in namespace Google\Api
- Generated advice about this change, used for providing more information about how a change will affect the existing service.
- AuthProvider — Class in namespace Google\Api
- Configuration for an anthentication provider, including support for JSON Web Token (JWT).
- AuthRequirement — Class in namespace Google\Api
- User-defined authentication requirements, including support for JSON Web Token (JWT).
- Authentication — Class in namespace Google\Api
Authentication
defines the authentication configuration for an API.- AuthenticationRule — Class in namespace Google\Api
- Authentication rules for the service.
- AuthorizationConfig — Class in namespace Google\Api
- Configuration of authorization.
- AuditLog — Class in namespace Google\Cloud\Audit
- Common audit log format for Google Cloud Platform API operations.
- AuthenticationInfo — Class in namespace Google\Cloud\Audit
- Authentication information for the operation.
- AuthorizationInfo — Class in namespace Google\Cloud\Audit
- Authorization information for the operation.
- AnalyzeEntitiesRequest — Class in namespace Google\Cloud\Language\V1beta2
- The entity analysis request message.
- AnalyzeEntitiesResponse — Class in namespace Google\Cloud\Language\V1beta2
- The entity analysis response message.
- AnalyzeEntitySentimentRequest — Class in namespace Google\Cloud\Language\V1beta2
- The entity-level sentiment analysis request message.
- AnalyzeEntitySentimentResponse — Class in namespace Google\Cloud\Language\V1beta2
- The entity-level sentiment analysis response message.
- AnalyzeSentimentRequest — Class in namespace Google\Cloud\Language\V1beta2
- The sentiment analysis request message.
- AnalyzeSentimentResponse — Class in namespace Google\Cloud\Language\V1beta2
- The sentiment analysis response message.
- AnalyzeSyntaxRequest — Class in namespace Google\Cloud\Language\V1beta2
- The syntax analysis request message.
- AnalyzeSyntaxResponse — Class in namespace Google\Cloud\Language\V1beta2
- The syntax analysis response message.
- AnnotateTextRequest — Class in namespace Google\Cloud\Language\V1beta2
- The request message for the text annotation API, which can perform multiple analysis types (sentiment, entities, and syntax) in one call.
- AnnotateTextRequest_Features — Class in namespace Google\Cloud\Language\V1beta2
- All available features for sentiment, syntax, and semantic analysis.
- AnnotateTextResponse — Class in namespace Google\Cloud\Language\V1beta2
- The text annotations response message.
- LanguageServiceGrpcClient::AnalyzeSentiment() — Method in class LanguageServiceGrpcClient
- Analyzes the sentiment of the provided text.
- LanguageServiceGrpcClient::AnalyzeEntities() — Method in class LanguageServiceGrpcClient
- Finds named entities (currently proper names and common nouns) in the text along with entity types, salience, mentions for each entity, and other properties.
- LanguageServiceGrpcClient::AnalyzeEntitySentiment() — Method in class LanguageServiceGrpcClient
- Finds entities, similar to [AnalyzeEntities][google.cloud.language.v1beta2.LanguageService.AnalyzeEntities] in the text and analyzes sentiment associated with each entity and its mentions.
- LanguageServiceGrpcClient::AnalyzeSyntax() — Method in class LanguageServiceGrpcClient
- Analyzes the syntax of the text and provides sentence boundaries and tokenization along with part of speech tags, dependency trees, and other properties.
- LanguageServiceGrpcClient::AnnotateText() — Method in class LanguageServiceGrpcClient
- A convenience method that provides all syntax, sentiment, and entity features in one call.
- $RecognitionAudio — Property in class RecognitionAudio
- AsyncRecognizeMetadata — Class in namespace Google\Cloud\Speech\V1beta1
- Describes the progress of a long-running
AsyncRecognize
call. It is included in themetadata
field of theOperation
returned by theGetOperation
call of thegoogle::longrunning::Operations
service. - AsyncRecognizeRequest — Class in namespace Google\Cloud\Speech\V1beta1
- The top-level message sent by the client for the
AsyncRecognize
method. - AsyncRecognizeResponse — Class in namespace Google\Cloud\Speech\V1beta1
- The only message returned to the client by
AsyncRecognize
. It contains the result as zero or more sequentialSpeechRecognitionResult
messages. It is included in theresult.response
field of theOperation
returned by theGetOperation
call of thegoogle::longrunning::Operations
service. - $RecognitionAudio — Property in class RecognitionAudio
- SpeechGrpcClient::AsyncRecognize() — Method in class SpeechGrpcClient
- Performs asynchronous speech recognition: receive results via the
[google.longrunning.Operations]
(/speech/reference/rest/v1beta1/operations#Operation)
interface. Returns either an
Operation.error
or anOperation.response
which contains anAsyncRecognizeResponse
message. - AnnotateVideoProgress — Class in namespace Google\Cloud\Videointelligence\V1beta1
- Video annotation progress. Included in the
metadata
field of theOperation
returned by theGetOperation
call of thegoogle::longrunning::Operations
service. - AnnotateVideoRequest — Class in namespace Google\Cloud\Videointelligence\V1beta1
- Video annotation request.
- AnnotateVideoResponse — Class in namespace Google\Cloud\Videointelligence\V1beta1
- Video annotation response. Included in the
response
field of theOperation
returned by theGetOperation
call of thegoogle::longrunning::Operations
service. - VideoIntelligenceServiceGrpcClient::AnnotateVideo() — Method in class VideoIntelligenceServiceGrpcClient
- Performs asynchronous video annotation. Progress and results can be
retrieved through the
google.longrunning.Operations
interface. - AnnotateImageRequest — Class in namespace Google\Cloud\Vision\V1
- Request for performing Google Cloud Vision API tasks over a user-provided image, with user-requested features.
- AnnotateImageResponse — Class in namespace Google\Cloud\Vision\V1
- Response to an image annotation request.
- AgentHeaderDescriptor — Class in namespace Google\GAX
- Encapsulates the custom GAPIC header information.
- ApiCallable — Class in namespace Google\GAX
- Creates a function wrapper that provides extra functionalities such as retry and bundling.
- ApiException — Class in namespace Google\GAX
- $Parser — Property in class Parser
- $ParserAction — Property in class ParserAction
- $ParserCachedAction — Property in class ParserCachedAction
- $ParserState — Property in class ParserState
- ParserSymbol::addAction() — Method in class ParserSymbol
- GeneratedTest::assertRepeatedFieldEquals() — Method in class GeneratedTest
- MockStubTrait::addResponse() — Method in class MockStubTrait
- Add a response object, and an optional status, to the list of responses to be returned via _simpleRequest.
- Aggregation — Class in namespace Google\Monitoring\V3
- 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. - Aggregation_Aligner — Class in namespace Google\Monitoring\V3
- The Aligner describes how to bring the data points in a single time series into temporal alignment.
- Aggregation_Reducer — Class in namespace Google\Monitoring\V3
- A Reducer describes how to aggregate data points from multiple time series into a single time series.
- Any — Class in namespace Google\Protobuf
Any
contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.- Api — Class in namespace Google\Protobuf
- Api is a light-weight descriptor for a protocol buffer service.
- AcknowledgeRequest — Class in namespace Google\Pubsub\V1
- Request for the Acknowledge method.
- SubscriberGrpcClient::Acknowledge() — Method in class SubscriberGrpcClient
- Acknowledges the messages associated with the
ack_ids
in theAcknowledgeRequest
. The Pub/Sub system can remove the relevant messages from the subscription.
B
- Backend — Class in namespace Google\Api
Backend
defines the backend configuration for a service.- BackendRule — Class in namespace Google\Api
- A backend rule provides configuration for an individual API element.
- Billing — Class in namespace Google\Api
- Billing related configuration of the service.
- BillingStatusRule — Class in namespace Google\Api
- Defines the billing status requirements for operations.
- BoundingBox — Class in namespace Google\Cloud\Videointelligence\V1beta1
- Bounding box.
- BatchAnnotateImagesRequest — Class in namespace Google\Cloud\Vision\V1
- Multiple image annotation requests are batched into a single service call.
- BatchAnnotateImagesResponse — Class in namespace Google\Cloud\Vision\V1
- Response to a batch image annotation request.
- Block — Class in namespace Google\Cloud\Vision\V1
- Logical element on the page.
- Block_BlockType — Class in namespace Google\Cloud\Vision\V1
- Type of a block (text, image etc) as identified by OCR.
- BoundingPoly — Class in namespace Google\Cloud\Vision\V1
- A bounding polygon for the detected image annotation.
- ImageAnnotatorGrpcClient::BatchAnnotateImages() — Method in class ImageAnnotatorGrpcClient
- Run image detection and annotation for a batch of images.
- BackoffSettings — Class in namespace Google\GAX
- Holds the parameters used for exponential backoff logic.
- BidiStream — Class in namespace Google\GAX
- BidiStream is the response object from a gRPC bidirectional streaming API call.
- Parser::begin() — Method in class Parser
- Binding — Class in namespace Google\Iam\V1
- Associates
members
with arole
. - BindingDelta — Class in namespace Google\Iam\V1
- One delta entry for Binding. Each individual change (only one member in each entry) to a binding will be a separate entry.
- BindingDelta_Action — Class in namespace Google\Iam\V1
- The type of action performed on a Binding in a policy.
- BoolValue — Class in namespace Google\Protobuf
- Wrapper message for
bool
. - BytesValue — Class in namespace Google\Protobuf
- Wrapper message for
bytes
. - BadRequest — Class in namespace Google\Rpc
- Describes violations in a client request. This error type focuses on the syntactic aspects of the request.
- BadRequest_FieldViolation — Class in namespace Google\Rpc
- A message type used to describe a single bad request field.
- BeginTransactionRequest — Class in namespace Google\Spanner\V1
- The request for [BeginTransaction][google.spanner.v1.Spanner.BeginTransaction].
- SpannerGrpcClient::BeginTransaction() — Method in class SpannerGrpcClient
- Begins a new transaction. This step can often be skipped: [Read][google.spanner.v1.Spanner.Read], [ExecuteSql][google.spanner.v1.Spanner.ExecuteSql] and [Commit][google.spanner.v1.Spanner.Commit] can begin a new transaction as a side-effect.
C
- ChangeType — Class in namespace Google\Api
- Classifies set of possible modifications to an object in the service configuration.
- ConfigChange — Class in namespace Google\Api
- Output generated from semantically comparing two versions of a service configuration.
- Context — Class in namespace Google\Api
Context
defines which contexts an API requests.- ContextRule — Class in namespace Google\Api
- A context rule provides information about the context for an individual API element.
- Control — Class in namespace Google\Api
- Selects and configures the service controller used by the service. The service controller handles features like abuse, quota, billing, logging, monitoring, etc.
- CustomHttpPattern — Class in namespace Google\Api
- A custom pattern is used for defining custom HTTP verb.
- ColorInfo — Class in namespace Google\Cloud\Vision\V1
- Color information consists of RGB channels, score, and the fraction of the image that the color occupies in the image.
- CropHint — Class in namespace Google\Cloud\Vision\V1
- Single crop hint that is used to generate a new crop when serving an image.
- CropHintsAnnotation — Class in namespace Google\Cloud\Vision\V1
- Set of crop hints that are used to generate new crops when serving images.
- CropHintsParams — Class in namespace Google\Cloud\Vision\V1
- Parameters for crop hints annotation request.
- ApiCallable::callWithoutRequest() — Method in class ApiCallable
- ApiCallable::createApiCall() — Method in class ApiCallable
- ApiException::createFromStdClass() — Method in class ApiException
- BidiStream::createApiCall() — Method in class BidiStream
- BidiStream::closeWrite() — Method in class BidiStream
- Inform the server that no more requests will be written. The write() function cannot be called after closeWrite() is called.
- BidiStream::closeWriteAndReadAll() — Method in class BidiStream
- Call closeWrite(), and read all responses from the server, until the streaming call is completed. Throws an ApiException if the streaming call failed.
- CallSettings — Class in namespace Google\GAX
- Encapsulates the call settings for an API call.
- ClientStream — Class in namespace Google\GAX
- ClientStream is the response object from a gRPC client streaming API call.
- ClientStream::createApiCall() — Method in class ClientStream
- GrpcCredentialsHelper::createCallCredentialsCallback() — Method in class GrpcCredentialsHelper
- Creates the callback function to be passed to gRPC for providing the credentials for a call.
- GrpcCredentialsHelper::createStub() — Method in class GrpcCredentialsHelper
- Creates a gRPC client stub.
- GrpcCredentialsHelper::createSslChannelCredentials() — Method in class GrpcCredentialsHelper
- Construct ssl channel credentials. This exists to allow overriding in unit tests.
- $Parser — Property in class Parser
- $Parser — Property in class Parser
- $Parser — Property in class Parser
- Parser::currentRules() — Method in class Parser
- OperationsClient::cancelOperation() — Method in class OperationsClient
- Starts asynchronous cancellation on a long-running operation. The server
makes a best effort to cancel the operation, but success is not
guaranteed. If the server doesn't support this method, it returns
google.rpc.Code.UNIMPLEMENTED
. Clients can use [Operations.GetOperation][google.longrunning.Operations.GetOperation] or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an [Operation.error][google.longrunning.Operation.error] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding toCode.CANCELLED
. - OperationsClient::close() — Method in class OperationsClient
- Initiates an orderly shutdown in which preexisting calls continue but new calls are immediately cancelled.
- OperationResponse::cancel() — Method in class OperationResponse
- Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it will throw an ApiException with code \google\rpc\Code::UNIMPLEMENTED. Clients can continue to use reload and pollUntilComplete methods to check whether the cancellation succeeded or whether the operation completed despite cancellation.
- PageStreamingDescriptor::createFromFields() — Method in class PageStreamingDescriptor
- PathTemplate::count() — Method in class PathTemplate
- ServerStream::createApiCall() — Method in class ServerStream
- $MockStatus — Property in class MockStatus
- ConfigServiceV2GrpcClient — Class in namespace Google\Logging\V2
- Service for configuring sinks used to export log entries outside of Stackdriver Logging.
- ConfigServiceV2GrpcClient::CreateSink() — Method in class ConfigServiceV2GrpcClient
- Creates a sink that exports specified log entries to a destination. The
export of newly-ingested log entries begins immediately, unless the current
time is outside the sink's start and end times or the sink's
writer_identity
is not permitted to write to the destination. A sink can export log entries only from the resource owning the sink. - CreateLogMetricRequest — Class in namespace Google\Logging\V2
- The parameters to CreateLogMetric.
- CreateSinkRequest — Class in namespace Google\Logging\V2
- The parameters to
CreateSink
. - MetricsServiceV2GrpcClient::CreateLogMetric() — Method in class MetricsServiceV2GrpcClient
- Creates a logs-based metric.
- CancelOperationRequest — Class in namespace Google\Longrunning
- The request message for [Operations.CancelOperation][google.longrunning.Operations.CancelOperation].
- OperationsGrpcClient::CancelOperation() — Method in class OperationsGrpcClient
- Starts asynchronous cancellation on a long-running operation. The server
makes a best effort to cancel the operation, but success is not
guaranteed. If the server doesn't support this method, it returns
google.rpc.Code.UNIMPLEMENTED
. Clients can use [Operations.GetOperation][google.longrunning.Operations.GetOperation] or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an [Operation.error][google.longrunning.Operation.error] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding toCode.CANCELLED
. - CreateGroupRequest — Class in namespace Google\Monitoring\V3
- The
CreateGroup
request. - CreateMetricDescriptorRequest — Class in namespace Google\Monitoring\V3
- The
CreateMetricDescriptor
request. - CreateTimeSeriesError — Class in namespace Google\Monitoring\V3
- Describes the result of a failed request to write data to a time series.
- CreateTimeSeriesRequest — Class in namespace Google\Monitoring\V3
- The
CreateTimeSeries
request. - GroupServiceGrpcClient::CreateGroup() — Method in class GroupServiceGrpcClient
- Creates a new group.
- MetricServiceGrpcClient::CreateMetricDescriptor() — Method in class MetricServiceGrpcClient
- Creates a new metric descriptor.
- MetricServiceGrpcClient::CreateTimeSeries() — Method in class MetricServiceGrpcClient
- Creates or adds data to one or more time series.
- CreateSnapshotRequest — Class in namespace Google\Pubsub\V1
- Request for the
CreateSnapshot
method. - PublisherGrpcClient::CreateTopic() — Method in class PublisherGrpcClient
- Creates the given topic with the given name.
- SubscriberGrpcClient::CreateSubscription() — Method in class SubscriberGrpcClient
- Creates a subscription to a given topic.
- SubscriberGrpcClient::CreateSnapshot() — Method in class SubscriberGrpcClient
- Creates a snapshot from the requested subscription.
- Code — Class in namespace Google\Rpc
- The canonical error codes for Google APIs.
- CreateDatabaseMetadata — Class in namespace Google\Spanner\Admin\Database\V1
- Metadata type for the operation returned by [CreateDatabase][google.spanner.admin.database.v1.DatabaseAdmin.CreateDatabase].
- CreateDatabaseRequest — Class in namespace Google\Spanner\Admin\Database\V1
- The request for [CreateDatabase][google.spanner.admin.database.v1.DatabaseAdmin.CreateDatabase].
- DatabaseAdminGrpcClient::CreateDatabase() — Method in class DatabaseAdminGrpcClient
- Creates a new Cloud Spanner database and starts to prepare it for serving.
- CreateInstanceMetadata — Class in namespace Google\Spanner\Admin\Instance\V1
- Metadata type for the operation returned by [CreateInstance][google.spanner.admin.instance.v1.InstanceAdmin.CreateInstance].
- CreateInstanceRequest — Class in namespace Google\Spanner\Admin\Instance\V1
- The request for [CreateInstance][google.spanner.admin.instance.v1.InstanceAdmin.CreateInstance].
- InstanceAdminGrpcClient::CreateInstance() — Method in class InstanceAdminGrpcClient
- Creates an instance and begins preparing it to begin serving. The
returned [long-running operation][google.longrunning.Operation]
can be used to track the progress of preparing the new
instance. The instance name is assigned by the caller. If the
named instance already exists,
CreateInstance
returnsALREADY_EXISTS
. - CommitRequest — Class in namespace Google\Spanner\V1
- The request for [Commit][google.spanner.v1.Spanner.Commit].
- CommitResponse — Class in namespace Google\Spanner\V1
- The response for [Commit][google.spanner.v1.Spanner.Commit].
- CreateSessionRequest — Class in namespace Google\Spanner\V1
- The request for [CreateSession][google.spanner.v1.Spanner.CreateSession].
- SpannerGrpcClient::CreateSession() — Method in class SpannerGrpcClient
- Creates a new session. A session can be used to perform transactions that read and/or modify data in a Cloud Spanner database.
- SpannerGrpcClient::Commit() — Method in class SpannerGrpcClient
- Commits a transaction. The request includes the mutations to be applied to rows in the database.
- Color — Class in namespace Google\Type
- 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; // .
D
- Distribution — Class in namespace Google\Api
- 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.
- Distribution_BucketOptions — Class in namespace Google\Api
- 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 bybucket_options
. - Distribution_BucketOptions_Explicit — Class in namespace Google\Api
- A set of buckets with arbitrary widths.
- Distribution_BucketOptions_Exponential — Class in namespace Google\Api
- 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.
- Distribution_BucketOptions_Linear — Class in namespace Google\Api
- 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.
- Distribution_Range — Class in namespace Google\Api
- The range of the population values.
- Documentation — Class in namespace Google\Api
Documentation
provides the information for describing a service.- DocumentationRule — Class in namespace Google\Api
- A documentation rule provides information about individual API elements.
- DependencyEdge — Class in namespace Google\Cloud\Language\V1beta2
- Represents dependency parse tree information for a token.
- DependencyEdge_Label — Class in namespace Google\Cloud\Language\V1beta2
- The parse label enum for the token.
- Document — Class in namespace Google\Cloud\Language\V1beta2
##########################################################
Represents the input to API methods.
- Document_Type — Class in namespace Google\Cloud\Language\V1beta2
- The document types enum.
- DominantColorsAnnotation — Class in namespace Google\Cloud\Vision\V1
- Set of dominant colors and their corresponding scores.
- DeleteEventsRequest — Class in namespace Google\Devtools\Clouderrorreporting\V1beta1
- Deletes all events in the project.
- DeleteEventsResponse — Class in namespace Google\Devtools\Clouderrorreporting\V1beta1
- Response message for deleting error events.
- ErrorStatsServiceGrpcClient::DeleteEvents() — Method in class ErrorStatsServiceGrpcClient
- Deletes all error events of a given project.
- $Parser — Property in class Parser
- $Parser — Property in class Parser
- $Parser — Property in class Parser
- OperationsClient::deleteOperation() — Method in class OperationsClient
- Deletes a long-running operation. This method indicates that the client is
no longer interested in the operation result. It does not cancel the
operation. If the server doesn't support this method, it returns
google.rpc.Code.UNIMPLEMENTED
. - OperationResponse::delete() — Method in class OperationResponse
- Delete the long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation.
- Serializer::decodeMessage() — Method in class Serializer
- Serializer::decodeMetadata() — Method in class Serializer
- Decode metadata received from gRPC status object
- $MockStatus — Property in class MockStatus
- SerializationTrait::deserializeMessage() — Method in class SerializationTrait
- ConfigServiceV2GrpcClient::DeleteSink() — Method in class ConfigServiceV2GrpcClient
- Deletes a sink. If the sink has a unique
writer_identity
, then that service account is also deleted. - DeleteLogMetricRequest — Class in namespace Google\Logging\V2
- The parameters to DeleteLogMetric.
- DeleteLogRequest — Class in namespace Google\Logging\V2
- The parameters to DeleteLog.
- DeleteSinkRequest — Class in namespace Google\Logging\V2
- The parameters to
DeleteSink
. - LoggingServiceV2GrpcClient::DeleteLog() — Method in class LoggingServiceV2GrpcClient
- Deletes all the log entries in a log.
- MetricsServiceV2GrpcClient::DeleteLogMetric() — Method in class MetricsServiceV2GrpcClient
- Deletes a logs-based metric.
- DeleteOperationRequest — Class in namespace Google\Longrunning
- The request message for [Operations.DeleteOperation][google.longrunning.Operations.DeleteOperation].
- OperationsGrpcClient::DeleteOperation() — Method in class OperationsGrpcClient
- Deletes a long-running operation. This method indicates that the client is
no longer interested in the operation result. It does not cancel the
operation. If the server doesn't support this method, it returns
google.rpc.Code.UNIMPLEMENTED
. - DeleteGroupRequest — Class in namespace Google\Monitoring\V3
- The
DeleteGroup
request. You can only delete a group if it has no children. - DeleteMetricDescriptorRequest — Class in namespace Google\Monitoring\V3
- The
DeleteMetricDescriptor
request. - GroupServiceGrpcClient::DeleteGroup() — Method in class GroupServiceGrpcClient
- Deletes an existing group.
- MetricServiceGrpcClient::DeleteMetricDescriptor() — Method in class MetricServiceGrpcClient
- Deletes a metric descriptor. Only user-created custom metrics can be deleted.
- DoubleValue — Class in namespace Google\Protobuf
- Wrapper message for
double
. - Duration — Class in namespace Google\Protobuf
- 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.
- DeleteSnapshotRequest — Class in namespace Google\Pubsub\V1
- Request for the
DeleteSnapshot
method. - DeleteSubscriptionRequest — Class in namespace Google\Pubsub\V1
- Request for the DeleteSubscription method.
- DeleteTopicRequest — Class in namespace Google\Pubsub\V1
- Request for the
DeleteTopic
method. - PublisherGrpcClient::DeleteTopic() — Method in class PublisherGrpcClient
- Deletes the topic with the given name. Returns
NOT_FOUND
if the topic does not exist. After a topic is deleted, a new topic may be created with the same name; this is an entirely new topic with none of the old configuration or subscriptions. Existing subscriptions to this topic are not deleted, but theirtopic
field is set to_deleted-topic_
. - SubscriberGrpcClient::DeleteSubscription() — Method in class SubscriberGrpcClient
- Deletes an existing subscription. All messages retained in the subscription
are immediately dropped. Calls to
Pull
after deletion will returnNOT_FOUND
. After a subscription is deleted, a new one may be created with the same name, but the new one has no association with the old subscription or its topic unless the same topic is specified. - SubscriberGrpcClient::DeleteSnapshot() — Method in class SubscriberGrpcClient
- Removes an existing snapshot. All messages retained in the snapshot are immediately dropped. After a snapshot is deleted, a new one may be created with the same name, but the new one has no association with the old snapshot or its subscription, unless the same subscription is specified.
- DebugInfo — Class in namespace Google\Rpc
- Describes additional debugging info.
- Database — Class in namespace Google\Spanner\Admin\Database\V1
- A Cloud Spanner database.
- DatabaseAdminGrpcClient — Class in namespace Google\Spanner\Admin\Database\V1
- Cloud Spanner Database Admin API
- DatabaseAdminGrpcClient::DropDatabase() — Method in class DatabaseAdminGrpcClient
- Drops (aka deletes) a Cloud Spanner database.
- Database_State — Class in namespace Google\Spanner\Admin\Database\V1
- Indicates the current state of the database.
- DropDatabaseRequest — Class in namespace Google\Spanner\Admin\Database\V1
- The request for [DropDatabase][google.spanner.admin.database.v1.DatabaseAdmin.DropDatabase].
- DeleteInstanceRequest — Class in namespace Google\Spanner\Admin\Instance\V1
- The request for [DeleteInstance][google.spanner.admin.instance.v1.InstanceAdmin.DeleteInstance].
- InstanceAdminGrpcClient::DeleteInstance() — Method in class InstanceAdminGrpcClient
- Deletes an instance.
- DeleteSessionRequest — Class in namespace Google\Spanner\V1
- The request for [DeleteSession][google.spanner.v1.Spanner.DeleteSession].
- SpannerGrpcClient::DeleteSession() — Method in class SpannerGrpcClient
- Ends a session, releasing server resources associated with it.
- Date — Class in namespace Google\Type
- 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
. - DayOfWeek — Class in namespace Google\Type
- Represents a day of week.
E
- Endpoint — Class in namespace Google\Api
Endpoint
describes a network endpoint that serves a set of APIs.- Experimental — Class in namespace Google\Api
- Experimental service configuration. These configuration options can only be used by whitelisted users.
- EncodingType — Class in namespace Google\Cloud\Language\V1beta2
- Represents the text encoding that the caller uses to process the output.
- Entity — Class in namespace Google\Cloud\Language\V1beta2
- 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.
- EntityMention — Class in namespace Google\Cloud\Language\V1beta2
- Represents a mention for an entity in the text. Currently, proper noun mentions are supported.
- EntityMention_Type — Class in namespace Google\Cloud\Language\V1beta2
- The supported types of mentions.
- Entity_Type — Class in namespace Google\Cloud\Language\V1beta2
- The type of the entity.
- EntityAnnotation — Class in namespace Google\Cloud\Vision\V1
- Set of detected entity features.
- ErrorContext — Class in namespace Google\Devtools\Clouderrorreporting\V1beta1
- A description of the context in which an error occurred.
- ErrorEvent — Class in namespace Google\Devtools\Clouderrorreporting\V1beta1
- An error event which is returned by the Error Reporting system.
- ErrorGroup — Class in namespace Google\Devtools\Clouderrorreporting\V1beta1
- Description of a group of similar error events.
- ErrorGroupOrder — Class in namespace Google\Devtools\Clouderrorreporting\V1beta1
- A sorting order of error groups.
- ErrorGroupServiceGrpcClient — Class in namespace Google\Devtools\Clouderrorreporting\V1beta1
- Service for retrieving and updating individual error groups.
- ErrorGroupStats — Class in namespace Google\Devtools\Clouderrorreporting\V1beta1
- Data extracted for a specific group based on certain filter criteria, such as a given time period and/or service filter.
- ErrorStatsServiceGrpcClient — Class in namespace Google\Devtools\Clouderrorreporting\V1beta1
- An API for retrieving and managing error statistics as well as data for individual events.
- $Parser — Property in class Parser
- $ParserError — Property in class ParserError
- PagedListResponse::expandToFixedSizeCollection() — Method in class PagedListResponse
- Returns a collection of elements with a fixed size set by the collectionSize parameter. The collection will only contain fewer than collectionSize elements if there are no more pages to be retrieved from the server.
- Serializer::encodeMessage() — Method in class Serializer
- Enum — Class in namespace Google\Protobuf
- Enum type definition.
- EnumValue — Class in namespace Google\Protobuf
- Enum value definition.
- ExecuteSqlRequest — Class in namespace Google\Spanner\V1
- The request for [ExecuteSql][google.spanner.v1.Spanner.ExecuteSql] and [ExecuteStreamingSql][google.spanner.v1.Spanner.ExecuteStreamingSql].
- ExecuteSqlRequest_QueryMode — Class in namespace Google\Spanner\V1
- Mode in which the query must be processed.
- $KeyRange — Property in class KeyRange
- SpannerGrpcClient::ExecuteSql() — Method in class SpannerGrpcClient
- Executes an SQL query, returning all rows in a single reply. This
method cannot be used to return a result set larger than 10 MiB;
if the query yields more data than that, the query fails with
a
FAILED_PRECONDITION
error. - SpannerGrpcClient::ExecuteStreamingSql() — Method in class SpannerGrpcClient
- Like [ExecuteSql][google.spanner.v1.Spanner.ExecuteSql], except returns the result set as a stream. Unlike [ExecuteSql][google.spanner.v1.Spanner.ExecuteSql], there is no limit on the size of the returned result set. However, no individual row in the result set can exceed 100 MiB, and no column value can exceed 10 MiB.
F
- FaceAnnotation — Class in namespace Google\Cloud\Videointelligence\V1beta1
- Face annotation.
- FaceLocation — Class in namespace Google\Cloud\Videointelligence\V1beta1
- Face location.
- Feature — Class in namespace Google\Cloud\Videointelligence\V1beta1
- Video annotation feature.
- FaceAnnotation — Class in namespace Google\Cloud\Vision\V1
- A face annotation object contains the results of face detection.
- FaceAnnotation_Landmark — Class in namespace Google\Cloud\Vision\V1
- A face-specific landmark (for example, a face feature).
- FaceAnnotation_Landmark_Type — Class in namespace Google\Cloud\Vision\V1
- Face landmark (feature) type.
- Feature — Class in namespace Google\Cloud\Vision\V1
- 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.
- Feature_Type — Class in namespace Google\Cloud\Vision\V1
- Type of image feature.
- BackoffSettings::fromSnakeCase() — Method in class BackoffSettings
- Constructs an instance from snake-case parameters.
- FixedSizeCollection — Class in namespace Google\GAX
- 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.
- $Parser — Property in class Parser
- $ParserLocation — Property in class ParserLocation
- $ParserLocation — Property in class ParserLocation
- $ListGroupsRequest — Property in class ListGroupsRequest
- Field — Class in namespace Google\Protobuf
- A single field of a message type.
- FieldMask — Class in namespace Google\Protobuf
FieldMask
represents a set of symbolic field paths, for example: paths: "f.a" paths: "f.b.d" Heref
represents a field in some root message,a
andb
fields in the message found inf
, andd
a field found in the message inf.b
.- Field_Cardinality — Class in namespace Google\Protobuf
- Whether a field is optional, required, or repeated.
- Field_Kind — Class in namespace Google\Protobuf
- Basic field types.
- FloatValue — Class in namespace Google\Protobuf
- Wrapper message for
float
.
G
- Advice::getDescription() — Method in class Advice
- Useful description for why this advice was applied and what actions should be taken to mitigate any implied risks.
- AuthProvider::getId() — Method in class AuthProvider
- The unique identifier of the auth provider. It will be referred to by
AuthRequirement.provider_id
. - AuthProvider::getIssuer() — Method in class AuthProvider
- Identifies the principal that issued the JWT. See https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 Usually a URL or an email address.
- AuthProvider::getJwksUri() — Method in class AuthProvider
- URL of the provider's public key set to validate signature of the JWT. See OpenID Discovery.
- AuthProvider::getAudiences() — Method in class AuthProvider
- The list of JWT audiences.
- AuthRequirement::getProviderId() — Method in class AuthRequirement
- [id][google.api.AuthProvider.id] from authentication provider.
- AuthRequirement::getAudiences() — Method in class AuthRequirement
- NOTE: This will be deprecated soon, once AuthProvider.audiences is implemented and accepted in all the runtime components.
- Authentication::getRules() — Method in class Authentication
- A list of authentication rules that apply to individual API methods.
- Authentication::getProviders() — Method in class Authentication
- Defines a set of authentication providers that a service supports.
- AuthenticationRule::getSelector() — Method in class AuthenticationRule
- Selects the methods to which this rule applies.
- AuthenticationRule::getOauth() — Method in class AuthenticationRule
- The requirements for OAuth credentials.
- AuthenticationRule::getAllowWithoutCredential() — Method in class AuthenticationRule
- Whether to allow requests without a credential. The credential can be an OAuth token, Google cookies (first-party auth) or EndUserCreds.
- AuthenticationRule::getRequirements() — Method in class AuthenticationRule
- Requirements for additional authentication providers.
- AuthorizationConfig::getProvider() — Method in class AuthorizationConfig
- The name of the authorization provider, such as firebaserules.googleapis.com.
- Backend::getRules() — Method in class Backend
- A list of API backend rules that apply to individual API methods.
- BackendRule::getSelector() — Method in class BackendRule
- Selects the methods to which this rule applies.
- BackendRule::getAddress() — Method in class BackendRule
- The address of the API backend.
- BackendRule::getDeadline() — Method in class BackendRule
- The number of seconds to wait for a response from a request. The default depends on the deployment context.
- Billing::getMetrics() — Method in class Billing
- Names of the metrics to report to billing. Each name must be defined in [Service.metrics][google.api.Service.metrics] section.
- Billing::getRules() — Method in class Billing
- A list of billing status rules for configuring billing status check.
- BillingStatusRule::getSelector() — Method in class BillingStatusRule
- Selects the operation names to which this rule applies.
- BillingStatusRule::getAllowedStatuses() — Method in class BillingStatusRule
- Allowed billing statuses. The billing status check passes if the actual billing status matches any of the provided values here.
- ConfigChange::getElement() — Method in class ConfigChange
- Object hierarchy path to the change, with levels separated by a '.' character. For repeated fields, an applicable unique identifier field is used for the index (usually selector, name, or id). For maps, the term 'key' is used. If the field has no unique identifier, the numeric index is used.
- ConfigChange::getOldValue() — Method in class ConfigChange
- Value of the changed object in the old Service configuration, in JSON format. This field will not be populated if ChangeType == ADDED.
- ConfigChange::getNewValue() — Method in class ConfigChange
- Value of the changed object in the new Service configuration, in JSON format. This field will not be populated if ChangeType == REMOVED.
- ConfigChange::getChangeType() — Method in class ConfigChange
- The type for this change, either ADDED, REMOVED, or MODIFIED.
- ConfigChange::getAdvices() — Method in class ConfigChange
- Collection of advice provided for this change, useful for determining the possible impact of this change.
- Context::getRules() — Method in class Context
- A list of RPC context rules that apply to individual API methods.
- ContextRule::getSelector() — Method in class ContextRule
- Selects the methods to which this rule applies.
- ContextRule::getRequested() — Method in class ContextRule
- A list of full type names of requested contexts.
- ContextRule::getProvided() — Method in class ContextRule
- A list of full type names of provided contexts.
- Control::getEnvironment() — Method in class Control
- The service control environment to use. If empty, no control plane feature (like quota and billing) will be enabled.
- CustomHttpPattern::getKind() — Method in class CustomHttpPattern
- The name of this custom HTTP verb.
- CustomHttpPattern::getPath() — Method in class CustomHttpPattern
- The path matched by this custom verb.
- Distribution::getCount() — Method in class Distribution
- The number of values in the population. Must be non-negative.
- Distribution::getMean() — Method in class Distribution
- The arithmetic mean of the values in the population. If
count
is zero then this field must be zero. - Distribution::getSumOfSquaredDeviation() — Method in class Distribution
- The sum of squared deviations from the mean of the values in the population. For values x_i this is: Sum[i=1.
- Distribution::getRange() — Method in class Distribution
- If specified, contains the range of the population values. The field
must not be present if the
count
is zero. - Distribution::getBucketOptions() — Method in class Distribution
- Defines the histogram bucket boundaries.
- Distribution::getBucketCounts() — Method in class Distribution
- If
bucket_options
is given, then the sum of the values inbucket_counts
must equal the value incount
. Ifbucket_options
is not given, nobucket_counts
fields may be given. - Distribution_BucketOptions::getLinearBuckets() — Method in class Distribution_BucketOptions
- The linear bucket.
- Distribution_BucketOptions::getExponentialBuckets() — Method in class Distribution_BucketOptions
- The exponential buckets.
- Distribution_BucketOptions::getExplicitBuckets() — Method in class Distribution_BucketOptions
- The explicit buckets.
- Distribution_BucketOptions::getOptions() — Method in class Distribution_BucketOptions
- Distribution_BucketOptions_Explicit::getBounds() — Method in class Distribution_BucketOptions_Explicit
- The values must be monotonically increasing.
- Distribution_BucketOptions_Exponential::getNumFiniteBuckets() — Method in class Distribution_BucketOptions_Exponential
- Must be greater than 0.
- Distribution_BucketOptions_Exponential::getGrowthFactor() — Method in class Distribution_BucketOptions_Exponential
- Must be greater than 1.
- Distribution_BucketOptions_Exponential::getScale() — Method in class Distribution_BucketOptions_Exponential
- Must be greater than 0.
- Distribution_BucketOptions_Linear::getNumFiniteBuckets() — Method in class Distribution_BucketOptions_Linear
- Must be greater than 0.
- Distribution_BucketOptions_Linear::getWidth() — Method in class Distribution_BucketOptions_Linear
- Must be greater than 0.
- Distribution_BucketOptions_Linear::getOffset() — Method in class Distribution_BucketOptions_Linear
- Lower bound of the first bucket.
- Distribution_Range::getMin() — Method in class Distribution_Range
- The minimum of the population values.
- Distribution_Range::getMax() — Method in class Distribution_Range
- The maximum of the population values.
- Documentation::getSummary() — Method in class Documentation
- A short summary of what the service does. Can only be provided by plain text.
- Documentation::getPages() — Method in class Documentation
- The top level pages for the documentation set.
- Documentation::getRules() — Method in class Documentation
- A list of documentation rules that apply to individual API elements.
- Documentation::getDocumentationRootUrl() — Method in class Documentation
- The URL to the root of documentation.
- Documentation::getOverview() — Method in class Documentation
- Declares a single overview page. For example:
<
pre>
documentation: summary: .
- DocumentationRule::getSelector() — Method in class DocumentationRule
- The selector is a comma-separated list of patterns. Each pattern is a qualified name of the element which may end in "*", indicating a wildcard.
- DocumentationRule::getDescription() — Method in class DocumentationRule
- Description of the selected API(s).
- DocumentationRule::getDeprecationDescription() — Method in class DocumentationRule
- Deprecation description of the selected element(s). It can be provided if an
element is marked as
deprecated
. - Endpoint::getName() — Method in class Endpoint
- The canonical name of this endpoint.
- Endpoint::getAliases() — Method in class Endpoint
- DEPRECATED: This field is no longer supported. Instead of using aliases, please specify multiple [google.api.Endpoint][google.api.Endpoint] for each of the intented alias.
- Endpoint::getApis() — Method in class Endpoint
- The list of APIs served by this endpoint.
- Endpoint::getFeatures() — Method in class Endpoint
- The list of features enabled on this endpoint.
- Endpoint::getTarget() — Method in class Endpoint
- The specification of an Internet routable address of API frontend that will handle requests to this API Endpoint.
- Endpoint::getAllowCors() — Method in class Endpoint
- Allowing CORS, aka cross-domain traffic, would allow the backends served from this endpoint to receive and respond to HTTP OPTIONS requests. The response will be used by the browser to determine whether the subsequent cross-origin request is allowed to proceed.
- Experimental::getAuthorization() — Method in class Experimental
- Authorization configuration.
- Http::getRules() — Method in class Http
- A list of HTTP configuration rules that apply to individual API methods.
- HttpBody::getContentType() — Method in class HttpBody
- The HTTP Content-Type string representing the content type of the body.
- HttpBody::getData() — Method in class HttpBody
- HTTP body binary data.
- HttpRule::getSelector() — Method in class HttpRule
- Selects methods to which this rule applies.
- HttpRule::getGet() — Method in class HttpRule
- Used for listing and getting information about resources.
- HttpRule::getPut() — Method in class HttpRule
- Used for updating a resource.
- HttpRule::getPost() — Method in class HttpRule
- Used for creating a resource.
- HttpRule::getDelete() — Method in class HttpRule
- Used for deleting a resource.
- HttpRule::getPatch() — Method in class HttpRule
- Used for updating a resource.
- HttpRule::getCustom() — Method in class HttpRule
- Custom pattern is used for defining custom verbs.
- HttpRule::getBody() — Method in class HttpRule
- The name of the request field whose value is mapped to the HTTP body, or
*
for mapping all fields not captured by the path pattern to the HTTP body. NOTE: the referred field must not be a repeated field and must be present at the top-level of request message type. - HttpRule::getAdditionalBindings() — Method in class HttpRule
- Additional HTTP bindings for the selector. Nested bindings must
not contain an
additional_bindings
field themselves (that is, the nesting may only be one level deep). - HttpRule::getPattern() — Method in class HttpRule
- LabelDescriptor::getKey() — Method in class LabelDescriptor
- The label key.
- LabelDescriptor::getValueType() — Method in class LabelDescriptor
- The type of data that can be assigned to the label.
- LabelDescriptor::getDescription() — Method in class LabelDescriptor
- A human-readable description for the label.
- LogDescriptor::getName() — Method in class LogDescriptor
- The name of the log. It must be less than 512 characters long and can include the following characters: upper- and lower-case alphanumeric characters [A-Za-z0-9], and punctuation characters including slash, underscore, hyphen, period [/_-.].
- LogDescriptor::getLabels() — Method in class LogDescriptor
- The set of labels that are available to describe a specific log entry.
- LogDescriptor::getDescription() — Method in class LogDescriptor
- A human-readable description of this log. This information appears in the documentation and can contain details.
- LogDescriptor::getDisplayName() — Method in class LogDescriptor
- The human-readable name for this log. This information appears on the user interface and should be concise.
- Logging::getProducerDestinations() — Method in class Logging
- Logging configurations for sending logs to the producer project.
- Logging::getConsumerDestinations() — Method in class Logging
- Logging configurations for sending logs to the consumer project.
- Logging_LoggingDestination::getMonitoredResource() — Method in class Logging_LoggingDestination
- The monitored resource type. The type must be defined in the [Service.monitored_resources][google.api.Service.monitored_resources] section.
- Logging_LoggingDestination::getLogs() — Method in class Logging_LoggingDestination
- Names of the logs to be sent to this destination. Each name must be defined in the [Service.logs][google.api.Service.logs] section. If the log name is not a domain scoped name, it will be automatically prefixed with the service name followed by "/".
- Metric::getType() — Method in class Metric
- An existing metric type, see [google.api.MetricDescriptor][google.api.MetricDescriptor].
- Metric::getLabels() — Method in class Metric
- The set of label values that uniquely identify this metric. All
labels listed in the
MetricDescriptor
must be assigned values. - MetricDescriptor::getName() — Method in class MetricDescriptor
- The resource name of the metric descriptor. Depending on the
implementation, the name typically includes: (1) the parent resource name
that defines the scope of the metric type or of its data; and (2) the
metric's URL-encoded type, which also appears in the
type
field of this descriptor. For example, following is the resource name of a custom metric within the GCP projectmy-project-id
: "projects/my-project-id/metricDescriptors/custom.googleapis.com%2Finvoice%2Fpaid%2Famount" - MetricDescriptor::getType() — Method in class MetricDescriptor
- The metric type, including its DNS name prefix. The type is not
URL-encoded. All user-defined custom metric types have the DNS name
custom.googleapis.com
. Metric types should use a natural hierarchical grouping. For example: "custom.googleapis.com/invoice/paid/amount" "appengine.googleapis.com/http/server/response_latencies" - MetricDescriptor::getLabels() — Method in class MetricDescriptor
- The set of labels that can be used to describe a specific
instance of this metric type. For example, the
appengine.googleapis.com/http/server/response_latencies
metric type has a label for the HTTP response code,response_code
, so you can look at latencies for successful responses or just for responses that failed. - MetricDescriptor::getMetricKind() — Method in class MetricDescriptor
- Whether the metric records instantaneous values, changes to a value, etc.
- MetricDescriptor::getValueType() — Method in class MetricDescriptor
- Whether the measurement is an integer, a floating-point number, etc.
- MetricDescriptor::getUnit() — Method in class MetricDescriptor
- The unit in which the metric value is reported. It is only applicable
if the
value_type
isINT64
,DOUBLE
, orDISTRIBUTION
. The supported units are a subset of The Unified Code for Units of Measure standard: Basic units (UNIT) *bit
bit *By
byte *s
second *min
minute *h
hour *d
day Prefixes (PREFIX) *k
kilo (103) *M
mega (106) *G
giga (109) *T
tera (1012) *P
peta (1015) *E
exa (1018) *Z
zetta (1021) *Y
yotta (1024) *m
milli (10-3) *u
micro (10-6) *n
nano (10-9) *p
pico (10-12) *f
femto (10-15) *a
atto (10-18) *z
zepto (10-21) *y
yocto (10-24) *Ki
kibi (210) *Mi
mebi (220) *Gi
gibi (230) *Ti
tebi (240) Grammar The grammar includes the dimensionless unit1
, such as1/s
. - MetricDescriptor::getDescription() — Method in class MetricDescriptor
- A detailed description of the metric, which can be used in documentation.
- MetricDescriptor::getDisplayName() — Method in class MetricDescriptor
- A concise name for the metric, which can be displayed in user interfaces.
- MetricRule::getSelector() — Method in class MetricRule
- Selects the methods to which this rule applies.
- MetricRule::getMetricCosts() — Method in class MetricRule
- Metrics to update when the selected methods are called, and the associated cost applied to each metric.
- MonitoredResource::getType() — Method in class MonitoredResource
- Required. The monitored resource type. This field must match
the
type
field of a [MonitoredResourceDescriptor][google.api.MonitoredResourceDescriptor] object. For example, the type of a Cloud SQL database is"cloudsql_database"
. - MonitoredResource::getLabels() — Method in class MonitoredResource
- Required. Values for all of the labels listed in the associated monitored
resource descriptor. For example, Cloud SQL databases use the labels
"database_id"
and"zone"
. - MonitoredResourceDescriptor::getName() — Method in class MonitoredResourceDescriptor
- Optional. The resource name of the monitored resource descriptor:
"projects/{project_id}/monitoredResourceDescriptors/{type}"
where {type} is the value of thetype
field in this object and {project_id} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format"monitoredResourceDescriptors/{type}"
. - MonitoredResourceDescriptor::getType() — Method in class MonitoredResourceDescriptor
- Required. The monitored resource type. For example, the type
"cloudsql_database"
represents databases in Google Cloud SQL. - MonitoredResourceDescriptor::getDisplayName() — Method in class MonitoredResourceDescriptor
- Optional. A concise name for the monitored resource type that might be
displayed in user interfaces. It should be a Title Cased Noun Phrase,
without any article or other determiners. For example,
"Google Cloud SQL Database"
. - MonitoredResourceDescriptor::getDescription() — Method in class MonitoredResourceDescriptor
- Optional. A detailed description of the monitored resource type that might be used in documentation.
- MonitoredResourceDescriptor::getLabels() — Method in class MonitoredResourceDescriptor
- Required. A set of labels used to describe instances of this monitored
resource type. For example, an individual Google Cloud SQL database is
identified by values for the labels
"database_id"
and"zone"
. - Monitoring::getProducerDestinations() — Method in class Monitoring
- Monitoring configurations for sending metrics to the producer project.
- Monitoring::getConsumerDestinations() — Method in class Monitoring
- Monitoring configurations for sending metrics to the consumer project.
- Monitoring_MonitoringDestination::getMonitoredResource() — Method in class Monitoring_MonitoringDestination
- The monitored resource type. The type must be defined in [Service.monitored_resources][google.api.Service.monitored_resources] section.
- Monitoring_MonitoringDestination::getMetrics() — Method in class Monitoring_MonitoringDestination
- Names of the metrics to report to this monitoring destination.
- OAuthRequirements::getCanonicalScopes() — Method in class OAuthRequirements
- The list of publicly documented OAuth scopes that are allowed access. An OAuth token containing any of these scopes will be accepted.
- Page::getName() — Method in class Page
- The name of the page. It will be used as an identity of the page to
generate URI of the page, text of the link to this page in navigation,
etc. The full page name (start from the root page name to this page
concatenated with
.
) can be used as reference to the page in your documentation. For example:pages: - name: Tutorial content: (== include tutorial.md ==) subpages: - name: Java content: (== include tutorial_java.md ==)
You can reference
Java
page using Markdown reference link syntax:[Java][Tutorial.Java]
. - Page::getContent() — Method in class Page
- The Markdown content of the page. You can use
(== include {path} ==)
to include content from a Markdown file. - Page::getSubpages() — Method in class Page
- Subpages of this page. The order of subpages specified here will be honored in the generated docset.
- ProjectProperties::getProperties() — Method in class ProjectProperties
- List of per consumer project-specific properties.
- Property::getName() — Method in class Property
- The name of the property (a.k.a key).
- Property::getType() — Method in class Property
- The type of this property.
- Property::getDescription() — Method in class Property
- The description of the property
- Quota::getLimits() — Method in class Quota
- List of
QuotaLimit
definitions for the service. - Quota::getMetricRules() — Method in class Quota
- List of
MetricRule
definitions, each one mapping a selected method to one or more metrics. - QuotaLimit::getName() — Method in class QuotaLimit
- Name of the quota limit. The name is used to refer to the limit when overriding the default limit on per-consumer basis.
- QuotaLimit::getDescription() — Method in class QuotaLimit
- Optional. User-visible, extended description for this quota limit.
- QuotaLimit::getDefaultLimit() — Method in class QuotaLimit
- Default number of tokens that can be consumed during the specified duration. This is the number of tokens assigned when a client application developer activates the service for his/her project.
- QuotaLimit::getMaxLimit() — Method in class QuotaLimit
- Maximum number of tokens that can be consumed during the specified duration. Client application developers can override the default limit up to this maximum. If specified, this value cannot be set to a value less than the default limit. If not specified, it is set to the default limit.
- QuotaLimit::getFreeTier() — Method in class QuotaLimit
- Free tier value displayed in the Developers Console for this limit.
- QuotaLimit::getDuration() — Method in class QuotaLimit
- Duration of this limit in textual notation. Example: "100s", "24h", "1d".
- QuotaLimit::getMetric() — Method in class QuotaLimit
- The name of the metric this quota limit applies to. The quota limits with the same metric will be checked together during runtime. The metric must be defined within the service config.
- QuotaLimit::getUnit() — Method in class QuotaLimit
- Specify the unit of the quota limit. It uses the same syntax as [Metric.unit][]. The supported unit kinds are determined by the quota backend system.
- QuotaLimit::getValues() — Method in class QuotaLimit
- Tiered limit values. Also allows for regional or zone overrides for these values if "/{region}" or "/{zone}" is specified in the unit field.
- QuotaLimit::getDisplayName() — Method in class QuotaLimit
- User-visible display name for this limit.
- Service::getConfigVersion() — Method in class Service
- The version of the service configuration. The config version may
influence interpretation of the configuration, for example, to
determine defaults. This is documented together with applicable
options. The current default for the config version itself is
3
. - Service::getName() — Method in class Service
- The DNS address at which this service is available,
e.g.
calendar.googleapis.com
. - Service::getId() — Method in class Service
- A unique ID for a specific instance of this message, typically assigned by the client for tracking purpose. If empty, the server may choose to generate one instead.
- Service::getTitle() — Method in class Service
- The product title associated with this service.
- Service::getProducerProjectId() — Method in class Service
- The id of the Google developer project that owns the service.
- Service::getApis() — Method in class Service
- A list of API interfaces exported by this service. Only the
name
field of the [google.protobuf.Api][google.protobuf.Api] needs to be provided by the configuration author, as the remaining fields will be derived from the IDL during the normalization process. It is an error to specify an API interface here which cannot be resolved against the associated IDL files. - Service::getTypes() — Method in class Service
- A list of all proto message types included in this API service.
- Service::getEnums() — Method in class Service
- A list of all enum types included in this API service. Enums
referenced directly or indirectly by the
apis
are automatically included. Enums which are not referenced but shall be included should be listed here by name. Example: enums: - name: google.someapi.v1.SomeEnum - Service::getDocumentation() — Method in class Service
- Additional API documentation.
- Service::getBackend() — Method in class Service
- API backend configuration.
- Service::getHttp() — Method in class Service
- HTTP configuration.
- Service::getQuota() — Method in class Service
- Quota configuration.
- Service::getAuthentication() — Method in class Service
- Auth configuration.
- Service::getContext() — Method in class Service
- Context configuration.
- Service::getUsage() — Method in class Service
- Configuration controlling usage of this service.
- Service::getEndpoints() — Method in class Service
- Configuration for network endpoints. If this is empty, then an endpoint with the same name as the service is automatically generated to service all defined APIs.
- Service::getControl() — Method in class Service
- Configuration for the service control plane.
- Service::getLogs() — Method in class Service
- Defines the logs used by this service.
- Service::getMetrics() — Method in class Service
- Defines the metrics used by this service.
- Service::getMonitoredResources() — Method in class Service
- Defines the monitored resources used by this service. This is required by the [Service.monitoring][google.api.Service.monitoring] and [Service.logging][google.api.Service.logging] configurations.
- Service::getLogging() — Method in class Service
- Logging configuration.
- Service::getMonitoring() — Method in class Service
- Monitoring configuration.
- Service::getSystemParameters() — Method in class Service
- System parameter configuration.
- Service::getSourceInfo() — Method in class Service
- Output only. The source information for this configuration if available.
- Service::getExperimental() — Method in class Service
- Experimental configuration.
- SourceInfo::getSourceFiles() — Method in class SourceInfo
- All files used during config generation.
- SystemParameter::getName() — Method in class SystemParameter
- Define the name of the parameter, such as "api_key" . It is case sensitive.
- SystemParameter::getHttpHeader() — Method in class SystemParameter
- Define the HTTP header name to use for the parameter. It is case insensitive.
- SystemParameter::getUrlQueryParameter() — Method in class SystemParameter
- Define the URL query parameter name to use for the parameter. It is case sensitive.
- SystemParameterRule::getSelector() — Method in class SystemParameterRule
- Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs.
- SystemParameterRule::getParameters() — Method in class SystemParameterRule
- Define parameters. Multiple names may be defined for a parameter.
- SystemParameters::getRules() — Method in class SystemParameters
- Define system parameters.
- Usage::getRequirements() — Method in class Usage
- Requirements that must be satisfied before a consumer project can use the
service. Each requirement is of the form <service.name>/
; for example 'serviceusage.googleapis.com/billing-enabled'. - Usage::getRules() — Method in class Usage
- A list of usage rules that apply to individual API methods.
- Usage::getProducerNotificationChannel() — Method in class Usage
- The full resource name of a channel used for sending notifications to the service producer.
- UsageRule::getSelector() — Method in class UsageRule
- Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs.
- UsageRule::getAllowUnregisteredCalls() — Method in class UsageRule
- True, if the method allows unregistered calls; false otherwise.
- UsageRule::getSkipServiceControl() — Method in class UsageRule
- True, if the method should skip service control. If so, no control plane feature (like quota and billing) will be enabled.
- AuditLog::getServiceName() — Method in class AuditLog
- The name of the API service performing the operation. For example,
"datastore.googleapis.com"
. - AuditLog::getMethodName() — Method in class AuditLog
- The name of the service method or operation.
- AuditLog::getResourceName() — Method in class AuditLog
- The resource or collection that is the target of the operation.
- AuditLog::getNumResponseItems() — Method in class AuditLog
- The number of items returned from a List or Query API method, if applicable.
- AuditLog::getStatus() — Method in class AuditLog
- The status of the overall operation.
- AuditLog::getAuthenticationInfo() — Method in class AuditLog
- Authentication information.
- AuditLog::getAuthorizationInfo() — Method in class AuditLog
- Authorization information. If there are multiple resources or permissions involved, then there is one AuthorizationInfo element for each {resource, permission} tuple.
- AuditLog::getRequestMetadata() — Method in class AuditLog
- Metadata about the operation.
- AuditLog::getRequest() — Method in class AuditLog
- The operation request. This may not include all request parameters, such as those that are too large, privacy-sensitive, or duplicated elsewhere in the log record.
- AuditLog::getResponse() — Method in class AuditLog
- The operation response. This may not include all response elements, such as those that are too large, privacy-sensitive, or duplicated elsewhere in the log record.
- AuditLog::getServiceData() — Method in class AuditLog
- Other service-specific data about the request, response, and other activities.
- AuthenticationInfo::getPrincipalEmail() — Method in class AuthenticationInfo
- The email address of the authenticated user making the request.
- AuthorizationInfo::getResource() — Method in class AuthorizationInfo
- The resource being accessed, as a REST-style string. For example: bigquery.googlapis.com/projects/PROJECTID/datasets/DATASETID
- AuthorizationInfo::getPermission() — Method in class AuthorizationInfo
- The required IAM permission.
- AuthorizationInfo::getGranted() — Method in class AuthorizationInfo
- Whether or not authorization for
resource
andpermission
was granted. - RequestMetadata::getCallerIp() — Method in class RequestMetadata
- The IP address of the caller.
- RequestMetadata::getCallerSuppliedUserAgent() — Method in class RequestMetadata
- The user agent of the caller.
- AnalyzeEntitiesRequest::getDocument() — Method in class AnalyzeEntitiesRequest
- Input document.
- AnalyzeEntitiesRequest::getEncodingType() — Method in class AnalyzeEntitiesRequest
- The encoding type used by the API to calculate offsets.
- AnalyzeEntitiesResponse::getEntities() — Method in class AnalyzeEntitiesResponse
- The recognized entities in the input document.
- AnalyzeEntitiesResponse::getLanguage() — Method in class AnalyzeEntitiesResponse
- The language of the text, which will be the same as the language specified in the request or, if not specified, the automatically-detected language.
- AnalyzeEntitySentimentRequest::getDocument() — Method in class AnalyzeEntitySentimentRequest
- Input document.
- AnalyzeEntitySentimentRequest::getEncodingType() — Method in class AnalyzeEntitySentimentRequest
- The encoding type used by the API to calculate offsets.
- AnalyzeEntitySentimentResponse::getEntities() — Method in class AnalyzeEntitySentimentResponse
- The recognized entities in the input document with associated sentiments.
- AnalyzeEntitySentimentResponse::getLanguage() — Method in class AnalyzeEntitySentimentResponse
- The language of the text, which will be the same as the language specified in the request or, if not specified, the automatically-detected language.
- AnalyzeSentimentRequest::getDocument() — Method in class AnalyzeSentimentRequest
- Input document.
- AnalyzeSentimentRequest::getEncodingType() — Method in class AnalyzeSentimentRequest
- The encoding type used by the API to calculate sentence offsets for the sentence sentiment.
- AnalyzeSentimentResponse::getDocumentSentiment() — Method in class AnalyzeSentimentResponse
- The overall sentiment of the input document.
- AnalyzeSentimentResponse::getLanguage() — Method in class AnalyzeSentimentResponse
- The language of the text, which will be the same as the language specified in the request or, if not specified, the automatically-detected language.
- AnalyzeSentimentResponse::getSentences() — Method in class AnalyzeSentimentResponse
- The sentiment for all the sentences in the document.
- AnalyzeSyntaxRequest::getDocument() — Method in class AnalyzeSyntaxRequest
- Input document.
- AnalyzeSyntaxRequest::getEncodingType() — Method in class AnalyzeSyntaxRequest
- The encoding type used by the API to calculate offsets.
- AnalyzeSyntaxResponse::getSentences() — Method in class AnalyzeSyntaxResponse
- Sentences in the input document.
- AnalyzeSyntaxResponse::getTokens() — Method in class AnalyzeSyntaxResponse
- Tokens, along with their syntactic information, in the input document.
- AnalyzeSyntaxResponse::getLanguage() — Method in class AnalyzeSyntaxResponse
- The language of the text, which will be the same as the language specified in the request or, if not specified, the automatically-detected language.
- AnnotateTextRequest::getDocument() — Method in class AnnotateTextRequest
- Input document.
- AnnotateTextRequest::getFeatures() — Method in class AnnotateTextRequest
- The enabled features.
- AnnotateTextRequest::getEncodingType() — Method in class AnnotateTextRequest
- The encoding type used by the API to calculate offsets.
- AnnotateTextRequest_Features::getExtractSyntax() — Method in class AnnotateTextRequest_Features
- Extract syntax information.
- AnnotateTextRequest_Features::getExtractEntities() — Method in class AnnotateTextRequest_Features
- Extract entities.
- AnnotateTextRequest_Features::getExtractDocumentSentiment() — Method in class AnnotateTextRequest_Features
- Extract document-level sentiment.
- AnnotateTextRequest_Features::getExtractEntitySentiment() — Method in class AnnotateTextRequest_Features
- Extract entities and their associated sentiment.
- AnnotateTextResponse::getSentences() — Method in class AnnotateTextResponse
- Sentences in the input document. Populated if the user enables [AnnotateTextRequest.Features.extract_syntax][google.cloud.language.v1beta2.AnnotateTextRequest.Features.extract_syntax].
- AnnotateTextResponse::getTokens() — Method in class AnnotateTextResponse
- Tokens, along with their syntactic information, in the input document.
- AnnotateTextResponse::getEntities() — Method in class AnnotateTextResponse
- Entities, along with their semantic information, in the input document.
- AnnotateTextResponse::getDocumentSentiment() — Method in class AnnotateTextResponse
- The overall sentiment for the document. Populated if the user enables [AnnotateTextRequest.Features.extract_document_sentiment][google.cloud.language.v1beta2.AnnotateTextRequest.Features.extract_document_sentiment].
- AnnotateTextResponse::getLanguage() — Method in class AnnotateTextResponse
- The language of the text, which will be the same as the language specified in the request or, if not specified, the automatically-detected language.
- DependencyEdge::getHeadTokenIndex() — Method in class DependencyEdge
- Represents the head of this token in the dependency tree.
- DependencyEdge::getLabel() — Method in class DependencyEdge
- The parse label for the token.
- Document::getType() — Method in class Document
- Required. If the type is not set or is
TYPE_UNSPECIFIED
, returns anINVALID_ARGUMENT
error. - Document::getContent() — Method in class Document
- The content of the input in string format.
- Document::getGcsContentUri() — Method in class Document
- The Google Cloud Storage URI where the file content is located.
- Document::getLanguage() — Method in class Document
- The language of the document (if not specified, the language is
automatically detected). Both ISO and BCP-47 language codes are
accepted.
Language Support lists currently supported languages for each API method. - Document::getSource() — Method in class Document
- Entity::getName() — Method in class Entity
- The representative name for the entity.
- Entity::getType() — Method in class Entity
- The entity type.
- Entity::getMetadata() — Method in class Entity
- Metadata associated with the entity.
- Entity::getSalience() — Method in class Entity
- The salience score associated with the entity in the [0, 1.0] range.
- Entity::getMentions() — Method in class Entity
- The mentions of this entity in the input document. The API currently supports proper noun mentions.
- Entity::getSentiment() — Method in class Entity
- For calls to [AnalyzeEntitySentiment][] or if [AnnotateTextRequest.Features.extract_entity_sentiment][google.cloud.language.v1beta2.AnnotateTextRequest.Features.extract_entity_sentiment] is set to true, this field will contain the aggregate sentiment expressed for this entity in the provided document.
- EntityMention::getText() — Method in class EntityMention
- The mention text.
- EntityMention::getType() — Method in class EntityMention
- The type of the entity mention.
- EntityMention::getSentiment() — Method in class EntityMention
- For calls to [AnalyzeEntitySentiment][] or if [AnnotateTextRequest.Features.extract_entity_sentiment][google.cloud.language.v1beta2.AnnotateTextRequest.Features.extract_entity_sentiment] is set to true, this field will contain the sentiment expressed for this mention of the entity in the provided document.
- PartOfSpeech::getTag() — Method in class PartOfSpeech
- The part of speech tag.
- PartOfSpeech::getAspect() — Method in class PartOfSpeech
- The grammatical aspect.
- PartOfSpeech::getCase() — Method in class PartOfSpeech
- The grammatical case.
- PartOfSpeech::getForm() — Method in class PartOfSpeech
- The grammatical form.
- PartOfSpeech::getGender() — Method in class PartOfSpeech
- The grammatical gender.
- PartOfSpeech::getMood() — Method in class PartOfSpeech
- The grammatical mood.
- PartOfSpeech::getNumber() — Method in class PartOfSpeech
- The grammatical number.
- PartOfSpeech::getPerson() — Method in class PartOfSpeech
- The grammatical person.
- PartOfSpeech::getProper() — Method in class PartOfSpeech
- The grammatical properness.
- PartOfSpeech::getReciprocity() — Method in class PartOfSpeech
- The grammatical reciprocity.
- PartOfSpeech::getTense() — Method in class PartOfSpeech
- The grammatical tense.
- PartOfSpeech::getVoice() — Method in class PartOfSpeech
- The grammatical voice.
- Sentence::getText() — Method in class Sentence
- The sentence text.
- Sentence::getSentiment() — Method in class Sentence
- For calls to [AnalyzeSentiment][] or if [AnnotateTextRequest.Features.extract_document_sentiment][google.cloud.language.v1beta2.AnnotateTextRequest.Features.extract_document_sentiment] is set to true, this field will contain the sentiment for the sentence.
- Sentiment::getMagnitude() — Method in class Sentiment
- A non-negative number in the [0, +inf) range, which represents the absolute magnitude of sentiment regardless of score (positive or negative).
- Sentiment::getScore() — Method in class Sentiment
- Sentiment score between -1.0 (negative sentiment) and 1.0 (positive sentiment).
- TextSpan::getContent() — Method in class TextSpan
- The content of the output text.
- TextSpan::getBeginOffset() — Method in class TextSpan
- The API calculates the beginning offset of the content in the original document according to the [EncodingType][google.cloud.language.v1beta2.EncodingType] specified in the API request.
- Token::getText() — Method in class Token
- The token text.
- Token::getPartOfSpeech() — Method in class Token
- Parts of speech tag for this token.
- Token::getDependencyEdge() — Method in class Token
- Dependency tree parse for this token.
- Token::getLemma() — Method in class Token
- Lemma of the token.
- LongRunningRecognizeMetadata::getProgressPercent() — Method in class LongRunningRecognizeMetadata
- Approximate percentage of audio processed thus far. Guaranteed to be 100 when the audio is fully processed and the results are available.
- LongRunningRecognizeMetadata::getStartTime() — Method in class LongRunningRecognizeMetadata
- Time when the request was received.
- LongRunningRecognizeMetadata::getLastUpdateTime() — Method in class LongRunningRecognizeMetadata
- Time of the most recent processing update.
- LongRunningRecognizeRequest::getConfig() — Method in class LongRunningRecognizeRequest
- Required Provides information to the recognizer that specifies how to process the request.
- LongRunningRecognizeRequest::getAudio() — Method in class LongRunningRecognizeRequest
- Required The audio data to be recognized.
- LongRunningRecognizeResponse::getResults() — Method in class LongRunningRecognizeResponse
- Output-only Sequential list of transcription results corresponding to sequential portions of audio.
- RecognitionAudio::getContent() — Method in class RecognitionAudio
- The audio data bytes encoded as specified in
RecognitionConfig
. Note: as with all bytes fields, protobuffers use a pure binary representation, whereas JSON representations use base64. - RecognitionAudio::getUri() — Method in class RecognitionAudio
- URI that points to a file that contains audio data bytes as specified in
RecognitionConfig
. Currently, only Google Cloud Storage URIs are supported, which must be specified in the following format:gs://bucket_name/object_name
(other URI formats return [google.rpc.Code.INVALID_ARGUMENT][]). For more information, see Request URIs. - RecognitionAudio::getAudioSource() — Method in class RecognitionAudio
- RecognitionConfig::getEncoding() — Method in class RecognitionConfig
- Required Encoding of audio data sent in all
RecognitionAudio
messages. - RecognitionConfig::getSampleRateHertz() — Method in class RecognitionConfig
- Required Sample rate in Hertz of the audio data sent in all
RecognitionAudio
messages. Valid values are: 8000-48000. - RecognitionConfig::getLanguageCode() — Method in class RecognitionConfig
- Required The language of the supplied audio as a BCP-47 language tag.
- RecognitionConfig::getMaxAlternatives() — Method in class RecognitionConfig
- Optional Maximum number of recognition hypotheses to be returned.
- RecognitionConfig::getProfanityFilter() — Method in class RecognitionConfig
- Optional If set to
true
, the server will attempt to filter out profanities, replacing all but the initial character in each filtered word with asterisks, e.g. "f***". If set tofalse
or omitted, profanities won't be filtered out. - RecognitionConfig::getSpeechContexts() — Method in class RecognitionConfig
- Optional A means to provide context to assist the speech recognition.
- RecognizeRequest::getConfig() — Method in class RecognizeRequest
- Required Provides information to the recognizer that specifies how to process the request.
- RecognizeRequest::getAudio() — Method in class RecognizeRequest
- Required The audio data to be recognized.
- RecognizeResponse::getResults() — Method in class RecognizeResponse
- Output-only Sequential list of transcription results corresponding to sequential portions of audio.
- SpeechContext::getPhrases() — Method in class SpeechContext
- Optional A list of strings containing words and phrases "hints" so that the speech recognition is more likely to recognize them. This can be used to improve the accuracy for specific words and phrases, for example, if specific commands are typically spoken by the user. This can also be used to add additional words to the vocabulary of the recognizer. See usage limits.
- SpeechRecognitionAlternative::getTranscript() — Method in class SpeechRecognitionAlternative
- Output-only Transcript text representing the words that the user spoke.
- SpeechRecognitionAlternative::getConfidence() — Method in class SpeechRecognitionAlternative
- Output-only The confidence estimate between 0.0 and 1.0. A higher number
indicates an estimated greater likelihood that the recognized words are
correct. This field is typically provided only for the top hypothesis, and
only for
is_final=true
results. Clients should not rely on theconfidence
field as it is not guaranteed to be accurate, or even set, in any of the results. - SpeechRecognitionResult::getAlternatives() — Method in class SpeechRecognitionResult
- Output-only May contain one or more recognition hypotheses (up to the
maximum specified in
max_alternatives
). - StreamingRecognitionConfig::getConfig() — Method in class StreamingRecognitionConfig
- Required Provides information to the recognizer that specifies how to process the request.
- StreamingRecognitionConfig::getSingleUtterance() — Method in class StreamingRecognitionConfig
- Optional If
false
or omitted, the recognizer will perform continuous recognition (continuing to wait for and process audio even if the user pauses speaking) until the client closes the input stream (gRPC API) or until the maximum time limit has been reached. May return multipleStreamingRecognitionResult
s with theis_final
flag set totrue
. - StreamingRecognitionConfig::getInterimResults() — Method in class StreamingRecognitionConfig
- Optional If
true
, interim results (tentative hypotheses) may be returned as they become available (these interim results are indicated with theis_final=false
flag). - StreamingRecognitionResult::getAlternatives() — Method in class StreamingRecognitionResult
- Output-only May contain one or more recognition hypotheses (up to the
maximum specified in
max_alternatives
). - StreamingRecognitionResult::getIsFinal() — Method in class StreamingRecognitionResult
- Output-only If
false
, thisStreamingRecognitionResult
represents an interim result that may change. Iftrue
, this is the final time the speech service will return this particularStreamingRecognitionResult
, the recognizer will not return any further hypotheses for this portion of the transcript and corresponding audio. - StreamingRecognitionResult::getStability() — Method in class StreamingRecognitionResult
- Output-only An estimate of the likelihood that the recognizer will not change its guess about this interim result. Values range from 0.0 (completely unstable) to 1.0 (completely stable).
- StreamingRecognizeRequest::getStreamingConfig() — Method in class StreamingRecognizeRequest
- Provides information to the recognizer that specifies how to process the
request. The first
StreamingRecognizeRequest
message must contain astreaming_config
message. - StreamingRecognizeRequest::getAudioContent() — Method in class StreamingRecognizeRequest
- The audio data to be recognized. Sequential chunks of audio data are sent
in sequential
StreamingRecognizeRequest
messages. The firstStreamingRecognizeRequest
message must not containaudio_content
data and all subsequentStreamingRecognizeRequest
messages must containaudio_content
data. The audio bytes must be encoded as specified inRecognitionConfig
. Note: as with all bytes fields, protobuffers use a pure binary representation (not base64). See audio limits. - StreamingRecognizeRequest::getStreamingRequest() — Method in class StreamingRecognizeRequest
- StreamingRecognizeResponse::getError() — Method in class StreamingRecognizeResponse
- Output-only If set, returns a [google.rpc.Status][] message that specifies the error for the operation.
- StreamingRecognizeResponse::getResults() — Method in class StreamingRecognizeResponse
- Output-only This repeated list contains zero or more results that correspond to consecutive portions of the audio currently being processed.
- StreamingRecognizeResponse::getSpeechEventType() — Method in class StreamingRecognizeResponse
- Output-only Indicates the type of speech event.
- AsyncRecognizeMetadata::getProgressPercent() — Method in class AsyncRecognizeMetadata
- Approximate percentage of audio processed thus far. Guaranteed to be 100 when the audio is fully processed and the results are available.
- AsyncRecognizeMetadata::getStartTime() — Method in class AsyncRecognizeMetadata
- Time when the request was received.
- AsyncRecognizeMetadata::getLastUpdateTime() — Method in class AsyncRecognizeMetadata
- Time of the most recent processing update.
- AsyncRecognizeRequest::getConfig() — Method in class AsyncRecognizeRequest
- Required Provides information to the recognizer that specifies how to process the request.
- AsyncRecognizeRequest::getAudio() — Method in class AsyncRecognizeRequest
- Required The audio data to be recognized.
- AsyncRecognizeResponse::getResults() — Method in class AsyncRecognizeResponse
- Output-only Sequential list of transcription results corresponding to sequential portions of audio.
- RecognitionAudio::getContent() — Method in class RecognitionAudio
- The audio data bytes encoded as specified in
RecognitionConfig
. Note: as with all bytes fields, protobuffers use a pure binary representation, whereas JSON representations use base64. - RecognitionAudio::getUri() — Method in class RecognitionAudio
- URI that points to a file that contains audio data bytes as specified in
RecognitionConfig
. Currently, only Google Cloud Storage URIs are supported, which must be specified in the following format:gs://bucket_name/object_name
(other URI formats return [google.rpc.Code.INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT]). For more information, see Request URIs. - RecognitionAudio::getAudioSource() — Method in class RecognitionAudio
- RecognitionConfig::getEncoding() — Method in class RecognitionConfig
- Required Encoding of audio data sent in all
RecognitionAudio
messages. - RecognitionConfig::getSampleRate() — Method in class RecognitionConfig
- Required Sample rate in Hertz of the audio data sent in all
RecognitionAudio
messages. Valid values are: 8000-48000. - RecognitionConfig::getLanguageCode() — Method in class RecognitionConfig
- Optional The language of the supplied audio as a BCP-47 language tag.
- RecognitionConfig::getMaxAlternatives() — Method in class RecognitionConfig
- Optional Maximum number of recognition hypotheses to be returned.
- RecognitionConfig::getProfanityFilter() — Method in class RecognitionConfig
- Optional If set to
true
, the server will attempt to filter out profanities, replacing all but the initial character in each filtered word with asterisks, e.g. "f***". If set tofalse
or omitted, profanities won't be filtered out. - RecognitionConfig::getSpeechContext() — Method in class RecognitionConfig
- Optional A means to provide context to assist the speech recognition.
- SpeechContext::getPhrases() — Method in class SpeechContext
- Optional A list of strings containing words and phrases "hints" so that the speech recognition is more likely to recognize them. This can be used to improve the accuracy for specific words and phrases, for example, if specific commands are typically spoken by the user. This can also be used to add additional words to the vocabulary of the recognizer. See usage limits.
- SpeechRecognitionAlternative::getTranscript() — Method in class SpeechRecognitionAlternative
- Output-only Transcript text representing the words that the user spoke.
- SpeechRecognitionAlternative::getConfidence() — Method in class SpeechRecognitionAlternative
- Output-only The confidence estimate between 0.0 and 1.0. A higher number
indicates an estimated greater likelihood that the recognized words are
correct. This field is typically provided only for the top hypothesis, and
only for
is_final=true
results. Clients should not rely on theconfidence
field as it is not guaranteed to be accurate, or even set, in any of the results. - SpeechRecognitionResult::getAlternatives() — Method in class SpeechRecognitionResult
- Output-only May contain one or more recognition hypotheses (up to the
maximum specified in
max_alternatives
). - StreamingRecognitionConfig::getConfig() — Method in class StreamingRecognitionConfig
- Required Provides information to the recognizer that specifies how to process the request.
- StreamingRecognitionConfig::getSingleUtterance() — Method in class StreamingRecognitionConfig
- Optional If
false
or omitted, the recognizer will perform continuous recognition (continuing to wait for and process audio even if the user pauses speaking) until the client closes the input stream (gRPC API) or until the maximum time limit has been reached. May return multipleStreamingRecognitionResult
s with theis_final
flag set totrue
. - StreamingRecognitionConfig::getInterimResults() — Method in class StreamingRecognitionConfig
- Optional If
true
, interim results (tentative hypotheses) may be returned as they become available (these interim results are indicated with theis_final=false
flag). - StreamingRecognitionResult::getAlternatives() — Method in class StreamingRecognitionResult
- Output-only May contain one or more recognition hypotheses (up to the
maximum specified in
max_alternatives
). - StreamingRecognitionResult::getIsFinal() — Method in class StreamingRecognitionResult
- Output-only If
false
, thisStreamingRecognitionResult
represents an interim result that may change. Iftrue
, this is the final time the speech service will return this particularStreamingRecognitionResult
, the recognizer will not return any further hypotheses for this portion of the transcript and corresponding audio. - StreamingRecognitionResult::getStability() — Method in class StreamingRecognitionResult
- Output-only An estimate of the likelihood that the recognizer will not change its guess about this interim result. Values range from 0.0 (completely unstable) to 1.0 (completely stable).
- StreamingRecognizeRequest::getStreamingConfig() — Method in class StreamingRecognizeRequest
- Provides information to the recognizer that specifies how to process the
request. The first
StreamingRecognizeRequest
message must contain astreaming_config
message. - StreamingRecognizeRequest::getAudioContent() — Method in class StreamingRecognizeRequest
- The audio data to be recognized. Sequential chunks of audio data are sent
in sequential
StreamingRecognizeRequest
messages. The firstStreamingRecognizeRequest
message must not containaudio_content
data and all subsequentStreamingRecognizeRequest
messages must containaudio_content
data. The audio bytes must be encoded as specified inRecognitionConfig
. Note: as with all bytes fields, protobuffers use a pure binary representation (not base64). See audio limits. - StreamingRecognizeRequest::getStreamingRequest() — Method in class StreamingRecognizeRequest
- StreamingRecognizeResponse::getError() — Method in class StreamingRecognizeResponse
- Output-only If set, returns a [google.rpc.Status][google.rpc.Status] message that specifies the error for the operation.
- StreamingRecognizeResponse::getResults() — Method in class StreamingRecognizeResponse
- Output-only This repeated list contains zero or more results that correspond to consecutive portions of the audio currently being processed.
- StreamingRecognizeResponse::getResultIndex() — Method in class StreamingRecognizeResponse
- Output-only Indicates the lowest index in the
results
array that has changed. The repeatedStreamingRecognitionResult
results overwrite past results at this index and higher. - StreamingRecognizeResponse::getEndpointerType() — Method in class StreamingRecognizeResponse
- Output-only Indicates the type of endpointer event.
- SyncRecognizeRequest::getConfig() — Method in class SyncRecognizeRequest
- Required Provides information to the recognizer that specifies how to process the request.
- SyncRecognizeRequest::getAudio() — Method in class SyncRecognizeRequest
- Required The audio data to be recognized.
- SyncRecognizeResponse::getResults() — Method in class SyncRecognizeResponse
- Output-only Sequential list of transcription results corresponding to sequential portions of audio.
- AnnotateVideoProgress::getAnnotationProgress() — Method in class AnnotateVideoProgress
- Progress metadata for all videos specified in
AnnotateVideoRequest
. - AnnotateVideoRequest::getInputUri() — Method in class AnnotateVideoRequest
- Input video location. Currently, only
Google Cloud Storage URIs are
supported, which must be specified in the following format:
gs://bucket-id/object-id
(other URI formats return [google.rpc.Code.INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT]). For more information, see Request URIs. - AnnotateVideoRequest::getInputContent() — Method in class AnnotateVideoRequest
- The video data bytes. Encoding: base64. If unset, the input video(s)
should be specified via
input_uri
. If set,input_uri
should be unset. - AnnotateVideoRequest::getFeatures() — Method in class AnnotateVideoRequest
- Requested video annotation features.
- AnnotateVideoRequest::getVideoContext() — Method in class AnnotateVideoRequest
- Additional video context and/or feature-specific parameters.
- AnnotateVideoRequest::getOutputUri() — Method in class AnnotateVideoRequest
- Optional location where the output (in JSON format) should be stored.
- AnnotateVideoRequest::getLocationId() — Method in class AnnotateVideoRequest
- Optional cloud region where annotation should take place. Supported cloud
regions:
us-east1
,us-west1
,europe-west1
,asia-east1
. If no region is specified, a region will be determined based on video file location. - AnnotateVideoResponse::getAnnotationResults() — Method in class AnnotateVideoResponse
- Annotation results for all videos specified in
AnnotateVideoRequest
. - BoundingBox::getLeft() — Method in class BoundingBox
- Left X coordinate.
- BoundingBox::getRight() — Method in class BoundingBox
- Right X coordinate.
- BoundingBox::getBottom() — Method in class BoundingBox
- Bottom Y coordinate.
- BoundingBox::getTop() — Method in class BoundingBox
- Top Y coordinate.
- FaceAnnotation::getThumbnail() — Method in class FaceAnnotation
- Thumbnail of a representative face view (in JPEG format). Encoding: base64.
- FaceAnnotation::getSegments() — Method in class FaceAnnotation
- All locations where a face was detected.
- FaceAnnotation::getLocations() — Method in class FaceAnnotation
- Face locations at one frame per second.
- FaceLocation::getBoundingBox() — Method in class FaceLocation
- Bounding box in a frame.
- FaceLocation::getTimeOffset() — Method in class FaceLocation
- Video time offset in microseconds.
- LabelAnnotation::getDescription() — Method in class LabelAnnotation
- Textual description, e.g.
Fixed-gear bicycle
. - LabelAnnotation::getLanguageCode() — Method in class LabelAnnotation
- Language code for
description
in BCP-47 format. - LabelAnnotation::getLocations() — Method in class LabelAnnotation
- Where the label was detected and with what confidence.
- LabelLocation::getSegment() — Method in class LabelLocation
- Video segment. Set to [-1, -1] for video-level labels.
- LabelLocation::getConfidence() — Method in class LabelLocation
- Confidence that the label is accurate. Range: [0, 1].
- LabelLocation::getLevel() — Method in class LabelLocation
- Label level.
- SafeSearchAnnotation::getAdult() — Method in class SafeSearchAnnotation
- Likelihood of adult content.
- SafeSearchAnnotation::getSpoof() — Method in class SafeSearchAnnotation
- Likelihood that an obvious modification was made to the original version to make it appear funny or offensive.
- SafeSearchAnnotation::getMedical() — Method in class SafeSearchAnnotation
- Likelihood of medical content.
- SafeSearchAnnotation::getViolent() — Method in class SafeSearchAnnotation
- Likelihood of violent content.
- SafeSearchAnnotation::getRacy() — Method in class SafeSearchAnnotation
- Likelihood of racy content.
- SafeSearchAnnotation::getTimeOffset() — Method in class SafeSearchAnnotation
- Video time offset in microseconds.
- VideoAnnotationProgress::getInputUri() — Method in class VideoAnnotationProgress
- Video file location in Google Cloud Storage.
- VideoAnnotationProgress::getProgressPercent() — Method in class VideoAnnotationProgress
- Approximate percentage processed thus far.
- VideoAnnotationProgress::getStartTime() — Method in class VideoAnnotationProgress
- Time when the request was received.
- VideoAnnotationProgress::getUpdateTime() — Method in class VideoAnnotationProgress
- Time of the most recent update.
- VideoAnnotationResults::getInputUri() — Method in class VideoAnnotationResults
- Video file location in Google Cloud Storage.
- VideoAnnotationResults::getLabelAnnotations() — Method in class VideoAnnotationResults
- Label annotations. There is exactly one element for each unique label.
- VideoAnnotationResults::getFaceAnnotations() — Method in class VideoAnnotationResults
- Face annotations. There is exactly one element for each unique face.
- VideoAnnotationResults::getShotAnnotations() — Method in class VideoAnnotationResults
- Shot annotations. Each shot is represented as a video segment.
- VideoAnnotationResults::getSafeSearchAnnotations() — Method in class VideoAnnotationResults
- Safe search annotations.
- VideoAnnotationResults::getError() — Method in class VideoAnnotationResults
- If set, indicates an error. Note that for a single
AnnotateVideoRequest
some videos may succeed and some may fail. - VideoContext::getSegments() — Method in class VideoContext
- Video segments to annotate. The segments may overlap and are not required to be contiguous or span the whole video. If unspecified, each video is treated as a single segment.
- VideoContext::getLabelDetectionMode() — Method in class VideoContext
- If label detection has been requested, what labels should be detected
in addition to video-level labels or segment-level labels. If unspecified,
defaults to
SHOT_MODE
. - VideoContext::getStationaryCamera() — Method in class VideoContext
- Whether the video has been shot from a stationary (i.e. non-moving) camera.
- VideoContext::getLabelDetectionModel() — Method in class VideoContext
- Model to use for label detection.
- VideoContext::getFaceDetectionModel() — Method in class VideoContext
- Model to use for face detection.
- VideoContext::getShotChangeDetectionModel() — Method in class VideoContext
- Model to use for shot change detection.
- VideoContext::getSafeSearchDetectionModel() — Method in class VideoContext
- Model to use for safe search detection.
- VideoSegment::getStartTimeOffset() — Method in class VideoSegment
- Start offset in microseconds (inclusive). Unset means 0.
- VideoSegment::getEndTimeOffset() — Method in class VideoSegment
- End offset in microseconds (inclusive). Unset means 0.
- AnnotateImageRequest::getImage() — Method in class AnnotateImageRequest
- The image to be processed.
- AnnotateImageRequest::getFeatures() — Method in class AnnotateImageRequest
- Requested features.
- AnnotateImageRequest::getImageContext() — Method in class AnnotateImageRequest
- Additional context that may accompany the image.
- AnnotateImageResponse::getFaceAnnotations() — Method in class AnnotateImageResponse
- If present, face detection has completed successfully.
- AnnotateImageResponse::getLandmarkAnnotations() — Method in class AnnotateImageResponse
- If present, landmark detection has completed successfully.
- AnnotateImageResponse::getLogoAnnotations() — Method in class AnnotateImageResponse
- If present, logo detection has completed successfully.
- AnnotateImageResponse::getLabelAnnotations() — Method in class AnnotateImageResponse
- If present, label detection has completed successfully.
- AnnotateImageResponse::getTextAnnotations() — Method in class AnnotateImageResponse
- If present, text (OCR) detection or document (OCR) text detection has completed successfully.
- AnnotateImageResponse::getFullTextAnnotation() — Method in class AnnotateImageResponse
- If present, text (OCR) detection or document (OCR) text detection has completed successfully.
- AnnotateImageResponse::getSafeSearchAnnotation() — Method in class AnnotateImageResponse
- If present, safe-search annotation has completed successfully.
- AnnotateImageResponse::getImagePropertiesAnnotation() — Method in class AnnotateImageResponse
- If present, image properties were extracted successfully.
- AnnotateImageResponse::getCropHintsAnnotation() — Method in class AnnotateImageResponse
- If present, crop hints have completed successfully.
- AnnotateImageResponse::getWebDetection() — Method in class AnnotateImageResponse
- If present, web detection has completed successfully.
- AnnotateImageResponse::getError() — Method in class AnnotateImageResponse
- If set, represents the error message for the operation.
- BatchAnnotateImagesRequest::getRequests() — Method in class BatchAnnotateImagesRequest
- Individual image annotation requests for this batch.
- BatchAnnotateImagesResponse::getResponses() — Method in class BatchAnnotateImagesResponse
- Individual responses to image annotation requests within the batch.
- Block::getProperty() — Method in class Block
- Additional information detected for the block.
- Block::getBoundingBox() — Method in class Block
- The bounding box for the block.
- Block::getParagraphs() — Method in class Block
- List of paragraphs in this block (if this blocks is of type text).
- Block::getBlockType() — Method in class Block
- Detected block type (text, image etc) for this block.
- BoundingPoly::getVertices() — Method in class BoundingPoly
- The bounding polygon vertices.
- ColorInfo::getColor() — Method in class ColorInfo
- RGB components of the color.
- ColorInfo::getScore() — Method in class ColorInfo
- Image-specific score for this color. Value in range [0, 1].
- ColorInfo::getPixelFraction() — Method in class ColorInfo
- The fraction of pixels the color occupies in the image.
- CropHint::getBoundingPoly() — Method in class CropHint
- The bounding polygon for the crop region. The coordinates of the bounding
box are in the original image's scale, as returned in
ImageParams
. - CropHint::getConfidence() — Method in class CropHint
- Confidence of this being a salient region. Range [0, 1].
- CropHint::getImportanceFraction() — Method in class CropHint
- Fraction of importance of this salient region with respect to the original image.
- CropHintsAnnotation::getCropHints() — Method in class CropHintsAnnotation
- Generated from protobuf field
repeated .google.cloud.vision.v1.CropHint crop_hints = 1;
- CropHintsParams::getAspectRatios() — Method in class CropHintsParams
- Aspect ratios in floats, representing the ratio of the width to the height of the image. For example, if the desired aspect ratio is 4/3, the corresponding float value should be 1.33333. If not specified, the best possible crop is returned. The number of provided aspect ratios is limited to a maximum of 16; any aspect ratios provided after the 16th are ignored.
- DominantColorsAnnotation::getColors() — Method in class DominantColorsAnnotation
- RGB color values with their score and pixel fraction.
- EntityAnnotation::getMid() — Method in class EntityAnnotation
- Opaque entity ID. Some IDs may be available in Google Knowledge Graph Search API.
- EntityAnnotation::getLocale() — Method in class EntityAnnotation
- The language code for the locale in which the entity textual
description
is expressed. - EntityAnnotation::getDescription() — Method in class EntityAnnotation
- Entity textual description, expressed in its
locale
language. - EntityAnnotation::getScore() — Method in class EntityAnnotation
- Overall score of the result. Range [0, 1].
- EntityAnnotation::getConfidence() — Method in class EntityAnnotation
- The accuracy of the entity detection in an image.
- EntityAnnotation::getTopicality() — Method in class EntityAnnotation
- The relevancy of the ICA (Image Content Annotation) label to the image. For example, the relevancy of "tower" is likely higher to an image containing the detected "Eiffel Tower" than to an image containing a detected distant towering building, even though the confidence that there is a tower in each image may be the same. Range [0, 1].
- EntityAnnotation::getBoundingPoly() — Method in class EntityAnnotation
- Image region to which this entity belongs. Currently not produced
for
LABEL_DETECTION
features. ForTEXT_DETECTION
(OCR),boundingPoly
s are produced for the entire text detected in an image region, followed byboundingPoly
s for each word within the detected text. - EntityAnnotation::getLocations() — Method in class EntityAnnotation
- The location information for the detected entity. Multiple
LocationInfo
elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. - EntityAnnotation::getProperties() — Method in class EntityAnnotation
- Some entities may have optional user-supplied
Property
(name/value) fields, such a score or string that qualifies the entity. - FaceAnnotation::getBoundingPoly() — Method in class FaceAnnotation
- The bounding polygon around the face. The coordinates of the bounding box
are in the original image's scale, as returned in
ImageParams
. - FaceAnnotation::getFdBoundingPoly() — Method in class FaceAnnotation
- The
fd_bounding_poly
bounding polygon is tighter than theboundingPoly
, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the "amount of skin" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence thefd
(face detection) prefix. - FaceAnnotation::getLandmarks() — Method in class FaceAnnotation
- Detected face landmarks.
- FaceAnnotation::getRollAngle() — Method in class FaceAnnotation
- Roll angle, which indicates the amount of clockwise/anti-clockwise rotation of the face relative to the image vertical about the axis perpendicular to the face. Range [-180,180].
- FaceAnnotation::getPanAngle() — Method in class FaceAnnotation
- Yaw angle, which indicates the leftward/rightward angle that the face is pointing relative to the vertical plane perpendicular to the image. Range [-180,180].
- FaceAnnotation::getTiltAngle() — Method in class FaceAnnotation
- Pitch angle, which indicates the upwards/downwards angle that the face is pointing relative to the image's horizontal plane. Range [-180,180].
- FaceAnnotation::getDetectionConfidence() — Method in class FaceAnnotation
- Detection confidence. Range [0, 1].
- FaceAnnotation::getLandmarkingConfidence() — Method in class FaceAnnotation
- Face landmarking confidence. Range [0, 1].
- FaceAnnotation::getJoyLikelihood() — Method in class FaceAnnotation
- Joy likelihood.
- FaceAnnotation::getSorrowLikelihood() — Method in class FaceAnnotation
- Sorrow likelihood.
- FaceAnnotation::getAngerLikelihood() — Method in class FaceAnnotation
- Anger likelihood.
- FaceAnnotation::getSurpriseLikelihood() — Method in class FaceAnnotation
- Surprise likelihood.
- FaceAnnotation::getUnderExposedLikelihood() — Method in class FaceAnnotation
- Under-exposed likelihood.
- FaceAnnotation::getBlurredLikelihood() — Method in class FaceAnnotation
- Blurred likelihood.
- FaceAnnotation::getHeadwearLikelihood() — Method in class FaceAnnotation
- Headwear likelihood.
- FaceAnnotation_Landmark::getType() — Method in class FaceAnnotation_Landmark
- Face landmark type.
- FaceAnnotation_Landmark::getPosition() — Method in class FaceAnnotation_Landmark
- Face landmark position.
- Feature::getType() — Method in class Feature
- The feature type.
- Feature::getMaxResults() — Method in class Feature
- Maximum number of results of this type.
- Image::getContent() — Method in class Image
- Image content, represented as a stream of bytes.
- Image::getSource() — Method in class Image
- Google Cloud Storage image location. If both
content
andsource
are provided for an image,content
takes precedence and is used to perform the image annotation request. - ImageContext::getLatLongRect() — Method in class ImageContext
- lat/long rectangle that specifies the location of the image.
- ImageContext::getLanguageHints() — Method in class ImageContext
- List of languages to use for TEXT_DETECTION. In most cases, an empty value
yields the best results since it enables automatic language detection. For
languages based on the Latin alphabet, setting
language_hints
is not needed. In rare cases, when the language of the text in the image is known, setting a hint will help get better results (although it will be a significant hindrance if the hint is wrong). Text detection returns an error if one or more of the specified languages is not one of the supported languages. - ImageContext::getCropHintsParams() — Method in class ImageContext
- Parameters for crop hints annotation request.
- ImageProperties::getDominantColors() — Method in class ImageProperties
- If present, dominant colors completed successfully.
- ImageSource::getGcsImageUri() — Method in class ImageSource
- NOTE: For new code
image_uri
below is preferred. - ImageSource::getImageUri() — Method in class ImageSource
- Image URI which supports:
1) Google Cloud Storage image URI, which must be in the following form:
gs://bucket_name/object_name
(for details, see Google Cloud Storage Request URIs). - LatLongRect::getMinLatLng() — Method in class LatLongRect
- Min lat/long pair.
- LatLongRect::getMaxLatLng() — Method in class LatLongRect
- Max lat/long pair.
- LocationInfo::getLatLng() — Method in class LocationInfo
- lat/long location coordinates.
- Page::getProperty() — Method in class Page
- Additional information detected on the page.
- Page::getWidth() — Method in class Page
- Page width in pixels.
- Page::getHeight() — Method in class Page
- Page height in pixels.
- Page::getBlocks() — Method in class Page
- List of blocks of text, images etc on this page.
- Paragraph::getProperty() — Method in class Paragraph
- Additional information detected for the paragraph.
- Paragraph::getBoundingBox() — Method in class Paragraph
- The bounding box for the paragraph.
- Paragraph::getWords() — Method in class Paragraph
- List of words in this paragraph.
- Position::getX() — Method in class Position
- X coordinate.
- Position::getY() — Method in class Position
- Y coordinate.
- Position::getZ() — Method in class Position
- Z coordinate (or depth).
- Property::getName() — Method in class Property
- Name of the property.
- Property::getValue() — Method in class Property
- Value of the property.
- SafeSearchAnnotation::getAdult() — Method in class SafeSearchAnnotation
- Represents the adult content likelihood for the image.
- SafeSearchAnnotation::getSpoof() — Method in class SafeSearchAnnotation
- Spoof likelihood. The likelihood that an modification was made to the image's canonical version to make it appear funny or offensive.
- SafeSearchAnnotation::getMedical() — Method in class SafeSearchAnnotation
- Likelihood that this is a medical image.
- SafeSearchAnnotation::getViolence() — Method in class SafeSearchAnnotation
- Violence likelihood.
- Symbol::getProperty() — Method in class Symbol
- Additional information detected for the symbol.
- Symbol::getBoundingBox() — Method in class Symbol
- The bounding box for the symbol.
- Symbol::getText() — Method in class Symbol
- The actual UTF-8 representation of the symbol.
- TextAnnotation::getPages() — Method in class TextAnnotation
- List of pages detected by OCR.
- TextAnnotation::getText() — Method in class TextAnnotation
- UTF-8 text detected on the pages.
- TextAnnotation_DetectedBreak::getType() — Method in class TextAnnotation_DetectedBreak
- Generated from protobuf field
.google.cloud.vision.v1.TextAnnotation.DetectedBreak.BreakType type = 1;
- TextAnnotation_DetectedBreak::getIsPrefix() — Method in class TextAnnotation_DetectedBreak
- True if break prepends the element.
- TextAnnotation_DetectedLanguage::getLanguageCode() — Method in class TextAnnotation_DetectedLanguage
- The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
- TextAnnotation_DetectedLanguage::getConfidence() — Method in class TextAnnotation_DetectedLanguage
- Confidence of detected language. Range [0, 1].
- TextAnnotation_TextProperty::getDetectedLanguages() — Method in class TextAnnotation_TextProperty
- A list of detected languages together with confidence.
- TextAnnotation_TextProperty::getDetectedBreak() — Method in class TextAnnotation_TextProperty
- Detected start or end of a text segment.
- Vertex::getX() — Method in class Vertex
- X coordinate.
- Vertex::getY() — Method in class Vertex
- Y coordinate.
- WebDetection::getWebEntities() — Method in class WebDetection
- Deduced entities from similar images on the Internet.
- WebDetection::getFullMatchingImages() — Method in class WebDetection
- Fully matching images from the Internet.
- WebDetection::getPartialMatchingImages() — Method in class WebDetection
- Partial matching images from the Internet.
- WebDetection::getPagesWithMatchingImages() — Method in class WebDetection
- Web pages containing the matching images from the Internet.
- WebDetection_WebEntity::getEntityId() — Method in class WebDetection_WebEntity
- Opaque entity ID.
- WebDetection_WebEntity::getScore() — Method in class WebDetection_WebEntity
- Overall relevancy score for the entity.
- WebDetection_WebEntity::getDescription() — Method in class WebDetection_WebEntity
- Canonical description of the entity, in English.
- WebDetection_WebImage::getUrl() — Method in class WebDetection_WebImage
- The result image URL.
- WebDetection_WebImage::getScore() — Method in class WebDetection_WebImage
- Overall relevancy score for the image.
- WebDetection_WebPage::getUrl() — Method in class WebDetection_WebPage
- The result web page URL.
- WebDetection_WebPage::getScore() — Method in class WebDetection_WebPage
- Overall relevancy score for the web page.
- Word::getProperty() — Method in class Word
- Additional information detected for the word.
- Word::getBoundingBox() — Method in class Word
- The bounding box for the word.
- Word::getSymbols() — Method in class Word
- List of symbols in the word.
- DeleteEventsRequest::getProjectName() — Method in class DeleteEventsRequest
- [Required] The resource name of the Google Cloud Platform project. Written
as
projects/
plus the Google Cloud Platform project ID. - ErrorContext::getHttpRequest() — Method in class ErrorContext
- The HTTP request which was processed when the error was triggered.
- ErrorContext::getUser() — Method in class ErrorContext
- The user who caused or was affected by the crash.
- ErrorContext::getReportLocation() — Method in class ErrorContext
- The location in the source code where the decision was made to report the error, usually the place where it was logged.
- ErrorEvent::getEventTime() — Method in class ErrorEvent
- Time when the event occurred as provided in the error report.
- ErrorEvent::getServiceContext() — Method in class ErrorEvent
- The
ServiceContext
for which this error was reported. - ErrorEvent::getMessage() — Method in class ErrorEvent
- The stack trace that was reported or logged by the service.
- ErrorEvent::getContext() — Method in class ErrorEvent
- Data about the context in which the error occurred.
- ErrorGroup::getName() — Method in class ErrorGroup
- The group resource name.
- ErrorGroup::getGroupId() — Method in class ErrorGroup
- Group IDs are unique for a given project. If the same kind of error occurs in different service contexts, it will receive the same group ID.
- ErrorGroup::getTrackingIssues() — Method in class ErrorGroup
- Associated tracking issues.
- ErrorGroupServiceGrpcClient::GetGroup() — Method in class ErrorGroupServiceGrpcClient
- Get the specified group.
- ErrorGroupStats::getGroup() — Method in class ErrorGroupStats
- Group data that is independent of the filter criteria.
- ErrorGroupStats::getCount() — Method in class ErrorGroupStats
- Approximate total number of events in the given group that match the filter criteria.
- ErrorGroupStats::getAffectedUsersCount() — Method in class ErrorGroupStats
- Approximate number of affected users in the given group that match the filter criteria.
- ErrorGroupStats::getTimedCounts() — Method in class ErrorGroupStats
- Approximate number of occurrences over time.
- ErrorGroupStats::getFirstSeenTime() — Method in class ErrorGroupStats
- Approximate first occurrence that was ever seen for this group and which matches the given filter criteria, ignoring the time_range that was specified in the request.
- ErrorGroupStats::getLastSeenTime() — Method in class ErrorGroupStats
- Approximate last occurrence that was ever seen for this group and which matches the given filter criteria, ignoring the time_range that was specified in the request.
- ErrorGroupStats::getAffectedServices() — Method in class ErrorGroupStats
- Service contexts with a non-zero error count for the given filter criteria. This list can be truncated if multiple services are affected.
- ErrorGroupStats::getNumAffectedServices() — Method in class ErrorGroupStats
- The total number of services with a non-zero error count for the given filter criteria.
- ErrorGroupStats::getRepresentative() — Method in class ErrorGroupStats
- An arbitrary event that is chosen as representative for the whole group.
- GetGroupRequest — Class in namespace Google\Devtools\Clouderrorreporting\V1beta1
- A request to return an individual group.
- GetGroupRequest::getGroupName() — Method in class GetGroupRequest
- [Required] The group resource name. Written as
projects/projectID/groups/group_name
. - HttpRequestContext::getMethod() — Method in class HttpRequestContext
- The type of HTTP request, such as
GET
,POST
, etc. - HttpRequestContext::getUrl() — Method in class HttpRequestContext
- The URL of the request.
- HttpRequestContext::getUserAgent() — Method in class HttpRequestContext
- The user agent information that is provided with the request.
- HttpRequestContext::getReferrer() — Method in class HttpRequestContext
- The referrer information that is provided with the request.
- HttpRequestContext::getResponseStatusCode() — Method in class HttpRequestContext
- The HTTP response status code for the request.
- HttpRequestContext::getRemoteIp() — Method in class HttpRequestContext
- The IP address from which the request originated.
- ListEventsRequest::getProjectName() — Method in class ListEventsRequest
- [Required] The resource name of the Google Cloud Platform project. Written
as
projects/
plus the Google Cloud Platform project ID. - ListEventsRequest::getGroupId() — Method in class ListEventsRequest
- [Required] The group for which events shall be returned.
- ListEventsRequest::getServiceFilter() — Method in class ListEventsRequest
- [Optional] List only ErrorGroups which belong to a service context that matches the filter.
- ListEventsRequest::getTimeRange() — Method in class ListEventsRequest
- [Optional] List only data for the given time range.
- ListEventsRequest::getPageSize() — Method in class ListEventsRequest
- [Optional] The maximum number of results to return per response.
- ListEventsRequest::getPageToken() — Method in class ListEventsRequest
- [Optional] A
next_page_token
provided by a previous response. - ListEventsResponse::getErrorEvents() — Method in class ListEventsResponse
- The error events which match the given request.
- ListEventsResponse::getNextPageToken() — Method in class ListEventsResponse
- If non-empty, more results are available.
- ListEventsResponse::getTimeRangeBegin() — Method in class ListEventsResponse
- The timestamp specifies the start time to which the request was restricted.
- ListGroupStatsRequest::getProjectName() — Method in class ListGroupStatsRequest
- [Required] The resource name of the Google Cloud Platform project. Written
as
projects/
plus the Google Cloud Platform project ID. - ListGroupStatsRequest::getGroupId() — Method in class ListGroupStatsRequest
- [Optional] List all
ErrorGroupStats
with these IDs. - ListGroupStatsRequest::getServiceFilter() — Method in class ListGroupStatsRequest
- [Optional] List only
ErrorGroupStats
which belong to a service context that matches the filter. - ListGroupStatsRequest::getTimeRange() — Method in class ListGroupStatsRequest
- [Optional] List data for the given time range.
- ListGroupStatsRequest::getTimedCountDuration() — Method in class ListGroupStatsRequest
- [Optional] The preferred duration for a single returned
TimedCount
. - ListGroupStatsRequest::getAlignment() — Method in class ListGroupStatsRequest
- [Optional] The alignment of the timed counts to be returned.
- ListGroupStatsRequest::getAlignmentTime() — Method in class ListGroupStatsRequest
- [Optional] Time where the timed counts shall be aligned if rounded alignment is chosen. Default is 00:00 UTC.
- ListGroupStatsRequest::getOrder() — Method in class ListGroupStatsRequest
- [Optional] The sort order in which the results are returned.
- ListGroupStatsRequest::getPageSize() — Method in class ListGroupStatsRequest
- [Optional] The maximum number of results to return per response.
- ListGroupStatsRequest::getPageToken() — Method in class ListGroupStatsRequest
- [Optional] A
next_page_token
provided by a previous response. To view additional results, pass this token along with the identical query parameters as the first request. - ListGroupStatsResponse::getErrorGroupStats() — Method in class ListGroupStatsResponse
- The error group stats which match the given request.
- ListGroupStatsResponse::getNextPageToken() — Method in class ListGroupStatsResponse
- If non-empty, more results are available.
- ListGroupStatsResponse::getTimeRangeBegin() — Method in class ListGroupStatsResponse
- The timestamp specifies the start time to which the request was restricted.
- QueryTimeRange::getPeriod() — Method in class QueryTimeRange
- Restricts the query to the specified time range.
- ReportErrorEventRequest::getProjectName() — Method in class ReportErrorEventRequest
- [Required] The resource name of the Google Cloud Platform project. Written
as
projects/
plus the Google Cloud Platform project ID. - ReportErrorEventRequest::getEvent() — Method in class ReportErrorEventRequest
- [Required] The error event to be reported.
- ReportedErrorEvent::getEventTime() — Method in class ReportedErrorEvent
- [Optional] Time when the event occurred.
- ReportedErrorEvent::getServiceContext() — Method in class ReportedErrorEvent
- [Required] The service context in which this error has occurred.
- ReportedErrorEvent::getMessage() — Method in class ReportedErrorEvent
- [Required] A message describing the error. The message can contain an exception stack in one of the supported programming languages and formats.
- ReportedErrorEvent::getContext() — Method in class ReportedErrorEvent
- [Optional] A description of the context in which the error occurred.
- ServiceContext::getService() — Method in class ServiceContext
- An identifier of the service, such as the name of the
executable, job, or Google App Engine service name. This field is expected
to have a low number of values that are relatively stable over time, as
opposed to
version
, which can be changed whenever new code is deployed. - ServiceContext::getVersion() — Method in class ServiceContext
- Represents the source code version that the developer provided, which could represent a version label or a Git SHA-1 hash, for example.
- ServiceContext::getResourceType() — Method in class ServiceContext
- Type of the MonitoredResource. List of possible values: https://cloud.google.com/monitoring/api/resources Value is set automatically for incoming errors and must not be set when reporting errors.
- ServiceContextFilter::getService() — Method in class ServiceContextFilter
- [Optional] The exact value to match against
ServiceContext.service
. - ServiceContextFilter::getVersion() — Method in class ServiceContextFilter
- [Optional] The exact value to match against
ServiceContext.version
. - ServiceContextFilter::getResourceType() — Method in class ServiceContextFilter
- [Optional] The exact value to match against
ServiceContext.resource_type
. - SourceLocation::getFilePath() — Method in class SourceLocation
- The source code filename, which can include a truncated relative path, or a full path from a production machine.
- SourceLocation::getLineNumber() — Method in class SourceLocation
- 1-based. 0 indicates that the line number is unknown.
- SourceLocation::getFunctionName() — Method in class SourceLocation
- Human-readable name of a function or method.
- TimedCount::getCount() — Method in class TimedCount
- Approximate number of occurrences in the given time period.
- TimedCount::getStartTime() — Method in class TimedCount
- Start of the time period to which
count
refers (included). - TimedCount::getEndTime() — Method in class TimedCount
- End of the time period to which
count
refers (excluded). - TrackingIssue::getUrl() — Method in class TrackingIssue
- A URL pointing to a related entry in an issue tracking system.
- UpdateGroupRequest::getGroup() — Method in class UpdateGroupRequest
- [Required] The group which replaces the resource on the server.
- GetTraceRequest — Class in namespace Google\Devtools\Cloudtrace\V1
- The request message for the
GetTrace
method. - GetTraceRequest::getProjectId() — Method in class GetTraceRequest
- ID of the Cloud project where the trace data is stored.
- GetTraceRequest::getTraceId() — Method in class GetTraceRequest
- ID of the trace to return.
- ListTracesRequest::getProjectId() — Method in class ListTracesRequest
- ID of the Cloud project where the trace data is stored.
- ListTracesRequest::getView() — Method in class ListTracesRequest
- Type of data returned for traces in the list. Optional. Default is
MINIMAL
. - ListTracesRequest::getPageSize() — Method in class ListTracesRequest
- Maximum number of traces to return. If not specified or <= 0, the implementation selects a reasonable value. The implementation may return fewer traces than the requested page size. Optional.
- ListTracesRequest::getPageToken() — Method in class ListTracesRequest
- Token identifying the page of results to return. If provided, use the
value of the
next_page_token
field from a previous request. Optional. - ListTracesRequest::getStartTime() — Method in class ListTracesRequest
- End of the time interval (inclusive) during which the trace data was collected from the application.
- ListTracesRequest::getEndTime() — Method in class ListTracesRequest
- Start of the time interval (inclusive) during which the trace data was collected from the application.
- ListTracesRequest::getFilter() — Method in class ListTracesRequest
- An optional filter for the request.
- ListTracesRequest::getOrderBy() — Method in class ListTracesRequest
- Field used to sort the returned traces. Optional.
- ListTracesResponse::getTraces() — Method in class ListTracesResponse
- List of trace records returned.
- ListTracesResponse::getNextPageToken() — Method in class ListTracesResponse
- If defined, indicates that there are more traces that match the request and that this value should be passed to the next request to continue retrieving additional traces.
- PatchTracesRequest::getProjectId() — Method in class PatchTracesRequest
- ID of the Cloud project where the trace data is stored.
- PatchTracesRequest::getTraces() — Method in class PatchTracesRequest
- The body of the message.
- Trace::getProjectId() — Method in class Trace
- Project ID of the Cloud project where the trace data is stored.
- Trace::getTraceId() — Method in class Trace
- Globally unique identifier for the trace. This identifier is a 128-bit numeric value formatted as a 32-byte hex string.
- Trace::getSpans() — Method in class Trace
- Collection of spans in the trace.
- TraceServiceGrpcClient::GetTrace() — Method in class TraceServiceGrpcClient
- Gets a single trace by its ID.
- TraceSpan::getSpanId() — Method in class TraceSpan
- Identifier for the span. Must be a 64-bit integer other than 0 and unique within a trace.
- TraceSpan::getKind() — Method in class TraceSpan
- Distinguishes between spans generated in a particular context. For example,
two spans with the same name may be distinguished using
RPC_CLIENT
andRPC_SERVER
to identify queueing latency associated with the span. - TraceSpan::getName() — Method in class TraceSpan
- Name of the trace. The trace name is sanitized and displayed in the Stackdriver Trace tool in the Google Developers Console.
- TraceSpan::getStartTime() — Method in class TraceSpan
- Start time of the span in nanoseconds from the UNIX epoch.
- TraceSpan::getEndTime() — Method in class TraceSpan
- End time of the span in nanoseconds from the UNIX epoch.
- TraceSpan::getParentSpanId() — Method in class TraceSpan
- ID of the parent span, if any. Optional.
- TraceSpan::getLabels() — Method in class TraceSpan
- Collection of labels associated with the span.
- Traces::getTraces() — Method in class Traces
- List of traces.
- AgentHeaderDescriptor::getHeader() — Method in class AgentHeaderDescriptor
- Returns an associative array that contains GAPIC header metadata.
- AgentHeaderDescriptor::getGaxVersion() — Method in class AgentHeaderDescriptor
- Returns the version string for GAX.
- ApiException::getBasicMessage() — Method in class ApiException
- ApiException::getMetadata() — Method in class ApiException
- BackoffSettings::getInitialRetryDelayMillis() — Method in class BackoffSettings
- BackoffSettings::getRetryDelayMultiplier() — Method in class BackoffSettings
- BackoffSettings::getMaxRetryDelayMillis() — Method in class BackoffSettings
- BackoffSettings::getInitialRpcTimeoutMillis() — Method in class BackoffSettings
- BackoffSettings::getRpcTimeoutMultiplier() — Method in class BackoffSettings
- BackoffSettings::getMaxRpcTimeoutMillis() — Method in class BackoffSettings
- BackoffSettings::getTotalTimeoutMillis() — Method in class BackoffSettings
- BidiStream::getBidiStreamingCall() — Method in class BidiStream
- Return the underlying gRPC call object
- CallSettings::getTimeoutMillis() — Method in class CallSettings
- CallSettings::getRetrySettings() — Method in class CallSettings
- CallSettings::getUserHeaders() — Method in class CallSettings
- ClientStream::getClientStreamingCall() — Method in class ClientStream
- Return the underlying gRPC call object
- FixedSizeCollection::getCollectionSize() — Method in class FixedSizeCollection
- Returns the number of elements in the collection. This will be equal to the collectionSize parameter used at construction unless there are no elements remaining to be retrieved.
- FixedSizeCollection::getNextPageToken() — Method in class FixedSizeCollection
- Returns a page token that can be passed into the API list method to retrieve additional elements.
- FixedSizeCollection::getNextCollection() — Method in class FixedSizeCollection
- Retrieves the next FixedSizeCollection using one or more API calls.
- FixedSizeCollection::getIterator() — Method in class FixedSizeCollection
- Returns an iterator over the elements of the collection.
- GrpcConstants — Class in namespace Google\GAX
- Holds constants necessary for interacting with gRPC.
- GrpcConstants::getStatusCodeNames() — Method in class GrpcConstants
- Provides an array that maps from status code name to an object representing that status code.
- GrpcConstants::getStatusCodesToNamesMap() — Method in class GrpcConstants
- Provides an array that maps from status codes to status names.
- GrpcConstants::getCodeFromStatusName() — Method in class GrpcConstants
- GrpcConstants::getStatusNameFromCode() — Method in class GrpcConstants
- GrpcCredentialsHelper — Class in namespace Google\GAX
- A class that manages credentials for an API object using the Google Auth library
- GrpcCredentialsHelper::getADCCredentials() — Method in class GrpcCredentialsHelper
- Gets credentials from ADC. This exists to allow overriding in unit tests.
- Segment::getBindingCount() — Method in class Segment
- Segment::getSegmentCount() — Method in class Segment
- OperationsClient::getOperation() — Method in class OperationsClient
- Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
- OperationResponse::getName() — Method in class OperationResponse
- Get the formatted name of the operation
- OperationResponse::getResult() — Method in class OperationResponse
- Return the result of the operation. If operationSucceeded() is false, return null.
- OperationResponse::getError() — Method in class OperationResponse
- If the operation failed, return the status. If operationFailed() is false, return null.
- OperationResponse::getReturnTypeOptions() — Method in class OperationResponse
- Get an array containing the values of 'operationReturnType' and 'metadataReturnType' (which may be null). The array can be passed as the $options argument to the constructor when creating another OperationResponse object.
- OperationResponse::getLastProtoResponse() — Method in class OperationResponse
- OperationResponse::getOperationsClient() — Method in class OperationResponse
- OperationResponse::getMetadata() — Method in class OperationResponse
- Get the metadata returned with the last proto response. If a metadata type was provided, then the return value will be of that type - otherwise, the return value will be of type Any. If no metadata object is available, returns null.
- Page::getNextPageToken() — Method in class Page
- Returns the next page token from the response.
- Page::getNextPage() — Method in class Page
- Retrieves the next Page object using the next page token.
- Page::getPageElementCount() — Method in class Page
- Return the number of elements in the response.
- Page::getIterator() — Method in class Page
- Return an iterator over the elements in the response.
- Page::getRequestObject() — Method in class Page
- Gets the request object used to generate the Page.
- Page::getResponseObject() — Method in class Page
- Gets the API response object.
- PageStreamingDescriptor::getRequestPageTokenGetMethod() — Method in class PageStreamingDescriptor
- PageStreamingDescriptor::getRequestPageSizeGetMethod() — Method in class PageStreamingDescriptor
- PageStreamingDescriptor::getResponsePageTokenGetMethod() — Method in class PageStreamingDescriptor
- PageStreamingDescriptor::getResourcesGetMethod() — Method in class PageStreamingDescriptor
- PageStreamingDescriptor::getRequestPageTokenSetMethod() — Method in class PageStreamingDescriptor
- PageStreamingDescriptor::getRequestPageSizeSetMethod() — Method in class PageStreamingDescriptor
- PagedListResponse::getPage() — Method in class PagedListResponse
- Return the current page of results. If the page has not previously been accessed, it will be retrieved with a call to the underlying API.
- Parser::getSegmentCount() — Method in class Parser
- RetrySettings::getRetryableCodes() — Method in class RetrySettings
- RetrySettings::getBackoffSettings() — Method in class RetrySettings
- ServerStream::getServerStreamingCall() — Method in class ServerStream
- Return the underlying gRPC call object
- GeneratedTest — Class in namespace Google\GAX\Testing
- MockBidiStreamingCall::getStatus() — Method in class MockBidiStreamingCall
- MockServerStreamingCall::getStatus() — Method in class MockServerStreamingCall
- MockStubTrait::getReceivedCallCount() — Method in class MockStubTrait
- ReceivedRequest::getArray() — Method in class ReceivedRequest
- ReceivedRequest::getFuncCall() — Method in class ReceivedRequest
- ReceivedRequest::getRequestObject() — Method in class ReceivedRequest
- ReceivedRequest::getMetadata() — Method in class ReceivedRequest
- ReceivedRequest::getOptions() — Method in class ReceivedRequest
- Binding::getRole() — Method in class Binding
- Role that is assigned to
members
. - Binding::getMembers() — Method in class Binding
- Specifies the identities requesting access for a Cloud Platform resource.
- BindingDelta::getAction() — Method in class BindingDelta
- The action that was performed on a Binding.
- BindingDelta::getRole() — Method in class BindingDelta
- Role that is assigned to
members
. - BindingDelta::getMember() — Method in class BindingDelta
- A single identity requesting access for a Cloud Platform resource.
- GetIamPolicyRequest — Class in namespace Google\Iam\V1
- Request message for
GetIamPolicy
method. - GetIamPolicyRequest::getResource() — Method in class GetIamPolicyRequest
- REQUIRED: The resource for which the policy is being requested.
- IAMPolicyGrpcClient::GetIamPolicy() — Method in class IAMPolicyGrpcClient
- Gets the access control policy for a resource.
- Policy::getVersion() — Method in class Policy
- Version of the
Policy
. The default version is 0. - Policy::getBindings() — Method in class Policy
- Associates a list of
members
to arole
. - Policy::getEtag() — Method in class Policy
etag
is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other.- PolicyDelta::getBindingDeltas() — Method in class PolicyDelta
- The delta for Bindings between two policies.
- SetIamPolicyRequest::getResource() — Method in class SetIamPolicyRequest
- REQUIRED: The resource for which the policy is being specified.
- SetIamPolicyRequest::getPolicy() — Method in class SetIamPolicyRequest
- REQUIRED: The complete policy to be applied to the
resource
. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them. - TestIamPermissionsRequest::getResource() — Method in class TestIamPermissionsRequest
- REQUIRED: The resource for which the policy detail is being requested.
- TestIamPermissionsRequest::getPermissions() — Method in class TestIamPermissionsRequest
- The set of permissions to check for the
resource
. Permissions with wildcards (such as '' or 'storage.') are not allowed. For more information see IAM Overview. - TestIamPermissionsResponse::getPermissions() — Method in class TestIamPermissionsResponse
- A subset of
TestPermissionsRequest.permissions
that the caller is allowed. - HttpRequest::getRequestMethod() — Method in class HttpRequest
- The request method. Examples:
"GET"
,"HEAD"
,"PUT"
,"POST"
. - HttpRequest::getRequestUrl() — Method in class HttpRequest
- The scheme (http, https), the host name, the path and the query portion of the URL that was requested.
- HttpRequest::getRequestSize() — Method in class HttpRequest
- The size of the HTTP request message in bytes, including the request headers and the request body.
- HttpRequest::getStatus() — Method in class HttpRequest
- The response code indicating the status of response.
- HttpRequest::getResponseSize() — Method in class HttpRequest
- The size of the HTTP response message sent back to the client, in bytes, including the response headers and the response body.
- HttpRequest::getUserAgent() — Method in class HttpRequest
- The user agent sent by the client. Example:
"Mozilla/4.0 (compatible; MSIE 6.0; Windows 98; Q312461; .NET CLR 1.0.3705)"
. - HttpRequest::getRemoteIp() — Method in class HttpRequest
- The IP address (IPv4 or IPv6) of the client that issued the HTTP
request. Examples:
"192.168.1.1"
,"FE80::0202:B3FF:FE1E:8329"
. - HttpRequest::getServerIp() — Method in class HttpRequest
- The IP address (IPv4 or IPv6) of the origin server that the request was sent to.
- HttpRequest::getReferer() — Method in class HttpRequest
- The referer URL of the request, as defined in HTTP/1.1 Header Field Definitions.
- HttpRequest::getLatency() — Method in class HttpRequest
- The request processing latency on the server, from the time the request was received until the response was sent.
- HttpRequest::getCacheLookup() — Method in class HttpRequest
- Whether or not a cache lookup was attempted.
- HttpRequest::getCacheHit() — Method in class HttpRequest
- Whether or not an entity was served from cache (with or without validation).
- HttpRequest::getCacheValidatedWithOriginServer() — Method in class HttpRequest
- Whether or not the response was validated with the origin server before
being served from cache. This field is only meaningful if
cache_hit
is True. - HttpRequest::getCacheFillBytes() — Method in class HttpRequest
- The number of HTTP response bytes inserted into cache. Set only when a cache fill was attempted.
- ConfigServiceV2GrpcClient::GetSink() — Method in class ConfigServiceV2GrpcClient
- Gets a sink.
- CreateLogMetricRequest::getParent() — Method in class CreateLogMetricRequest
- The resource name of the project in which to create the metric: "projects/[PROJECT_ID]" The new metric must be provided in the request.
- CreateLogMetricRequest::getMetric() — Method in class CreateLogMetricRequest
- The new logs-based metric, which must not have an identifier that already exists.
- CreateSinkRequest::getParent() — Method in class CreateSinkRequest
- Required. The resource in which to create the sink:
"projects/[PROJECT_ID]"
"organizations/[ORGANIZATION_ID]"
"billingAccounts/[BILLING_ACCOUNT_ID]"
"folders/[FOLDER_ID]"
Examples:
"projects/my-logging-project"
,"organizations/123456789"
. - CreateSinkRequest::getSink() — Method in class CreateSinkRequest
- Required. The new sink, whose
name
parameter is a sink identifier that is not already in use. - CreateSinkRequest::getUniqueWriterIdentity() — Method in class CreateSinkRequest
- Optional. Determines the kind of IAM identity returned as
writer_identity
in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned aswriter_identity
is the same group or service account used by Stackdriver Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself. - DeleteLogMetricRequest::getMetricName() — Method in class DeleteLogMetricRequest
- The resource name of the metric to delete: "projects/[PROJECT_ID]/metrics/[METRIC_ID]"
- DeleteLogRequest::getLogName() — Method in class DeleteLogRequest
- Required. The resource name of the log to delete:
"projects/[PROJECT_ID]/logs/[LOG_ID]"
"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]"
"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]"
"folders/[FOLDER_ID]/logs/[LOG_ID]"
[LOG_ID]
must be URL-encoded. For example,"projects/my-project-id/logs/syslog"
,"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity"
. - DeleteSinkRequest::getSinkName() — Method in class DeleteSinkRequest
- Required. The full resource name of the sink to delete, including the
parent resource and the sink identifier:
"projects/[PROJECT_ID]/sinks/[SINK_ID]"
"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]"
"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]"
"folders/[FOLDER_ID]/sinks/[SINK_ID]"
Example:
"projects/my-project-id/sinks/my-sink-id"
. - GetLogMetricRequest — Class in namespace Google\Logging\V2
- The parameters to GetLogMetric.
- GetLogMetricRequest::getMetricName() — Method in class GetLogMetricRequest
- The resource name of the desired metric: "projects/[PROJECT_ID]/metrics/[METRIC_ID]"
- GetSinkRequest — Class in namespace Google\Logging\V2
- The parameters to
GetSink
. - GetSinkRequest::getSinkName() — Method in class GetSinkRequest
- Required. The resource name of the sink:
"projects/[PROJECT_ID]/sinks/[SINK_ID]"
"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]"
"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]"
"folders/[FOLDER_ID]/sinks/[SINK_ID]"
Example:
"projects/my-project-id/sinks/my-sink-id"
. - ListLogEntriesRequest::getProjectIds() — Method in class ListLogEntriesRequest
- Deprecated. Use
resource_names
instead. One or more project identifiers or project numbers from which to retrieve log entries. Example:"my-project-1A"
. If present, these project identifiers are converted to resource name format and added to the list of resources inresource_names
. - ListLogEntriesRequest::getResourceNames() — Method in class ListLogEntriesRequest
- Required. Names of one or more parent resources from which to
retrieve log entries:
"projects/[PROJECT_ID]"
"organizations/[ORGANIZATION_ID]"
"billingAccounts/[BILLING_ACCOUNT_ID]"
"folders/[FOLDER_ID]"
Projects listed in the
project_ids
field are added to this list. - ListLogEntriesRequest::getFilter() — Method in class ListLogEntriesRequest
- Optional. A filter that chooses which log entries to return. See Advanced
Logs Filters. Only log entries that
match the filter are returned. An empty filter matches all log entries in
the resources listed in
resource_names
. Referencing a parent resource that is not listed inresource_names
will cause the filter to return no results. - ListLogEntriesRequest::getOrderBy() — Method in class ListLogEntriesRequest
- Optional. How the results should be sorted. Presently, the only permitted
values are
"timestamp asc"
(default) and"timestamp desc"
. The first option returns entries in order of increasing values ofLogEntry.timestamp
(oldest first), and the second option returns entries in order of decreasing timestamps (newest first). Entries with equal timestamps are returned in order of theirinsert_id
values. - ListLogEntriesRequest::getPageSize() — Method in class ListLogEntriesRequest
- Optional. The maximum number of results to return from this request.
- ListLogEntriesRequest::getPageToken() — Method in class ListLogEntriesRequest
- Optional. If present, then retrieve the next batch of results from the
preceding call to this method.
page_token
must be the value ofnext_page_token
from the previous response. The values of other method parameters should be identical to those in the previous call. - ListLogEntriesResponse::getEntries() — Method in class ListLogEntriesResponse
- A list of log entries.
- ListLogEntriesResponse::getNextPageToken() — Method in class ListLogEntriesResponse
- If there might be more results than those appearing in this response, then
nextPageToken
is included. To get the next set of results, call this method again using the value ofnextPageToken
aspageToken
. - ListLogMetricsRequest::getParent() — Method in class ListLogMetricsRequest
- Required. The name of the project containing the metrics: "projects/[PROJECT_ID]"
- ListLogMetricsRequest::getPageToken() — Method in class ListLogMetricsRequest
- Optional. If present, then retrieve the next batch of results from the
preceding call to this method.
pageToken
must be the value ofnextPageToken
from the previous response. The values of other method parameters should be identical to those in the previous call. - ListLogMetricsRequest::getPageSize() — Method in class ListLogMetricsRequest
- Optional. The maximum number of results to return from this request.
- ListLogMetricsResponse::getMetrics() — Method in class ListLogMetricsResponse
- A list of logs-based metrics.
- ListLogMetricsResponse::getNextPageToken() — Method in class ListLogMetricsResponse
- If there might be more results than appear in this response, then
nextPageToken
is included. To get the next set of results, call this method again using the value ofnextPageToken
aspageToken
. - ListLogsRequest::getParent() — Method in class ListLogsRequest
- Required. The resource name that owns the logs: "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]"
- ListLogsRequest::getPageSize() — Method in class ListLogsRequest
- Optional. The maximum number of results to return from this request.
- ListLogsRequest::getPageToken() — Method in class ListLogsRequest
- Optional. If present, then retrieve the next batch of results from the
preceding call to this method.
pageToken
must be the value ofnextPageToken
from the previous response. The values of other method parameters should be identical to those in the previous call. - ListLogsResponse::getLogNames() — Method in class ListLogsResponse
- A list of log names. For example,
"projects/my-project/syslog"
or"organizations/123/cloudresourcemanager.googleapis.com%2Factivity"
. - ListLogsResponse::getNextPageToken() — Method in class ListLogsResponse
- If there might be more results than those appearing in this response, then
nextPageToken
is included. To get the next set of results, call this method again using the value ofnextPageToken
aspageToken
. - ListMonitoredResourceDescriptorsRequest::getPageSize() — Method in class ListMonitoredResourceDescriptorsRequest
- Optional. The maximum number of results to return from this request.
- ListMonitoredResourceDescriptorsRequest::getPageToken() — Method in class ListMonitoredResourceDescriptorsRequest
- Optional. If present, then retrieve the next batch of results from the
preceding call to this method.
pageToken
must be the value ofnextPageToken
from the previous response. The values of other method parameters should be identical to those in the previous call. - ListMonitoredResourceDescriptorsResponse::getResourceDescriptors() — Method in class ListMonitoredResourceDescriptorsResponse
- A list of resource descriptors.
- ListMonitoredResourceDescriptorsResponse::getNextPageToken() — Method in class ListMonitoredResourceDescriptorsResponse
- If there might be more results than those appearing in this response, then
nextPageToken
is included. To get the next set of results, call this method again using the value ofnextPageToken
aspageToken
. - ListSinksRequest::getParent() — Method in class ListSinksRequest
- Required. The parent resource whose sinks are to be listed: "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]"
- ListSinksRequest::getPageToken() — Method in class ListSinksRequest
- Optional. If present, then retrieve the next batch of results from the
preceding call to this method.
pageToken
must be the value ofnextPageToken
from the previous response. The values of other method parameters should be identical to those in the previous call. - ListSinksRequest::getPageSize() — Method in class ListSinksRequest
- Optional. The maximum number of results to return from this request.
- ListSinksResponse::getSinks() — Method in class ListSinksResponse
- A list of sinks.
- ListSinksResponse::getNextPageToken() — Method in class ListSinksResponse
- If there might be more results than appear in this response, then
nextPageToken
is included. To get the next set of results, call the same method again using the value ofnextPageToken
aspageToken
. - LogEntry::getLogName() — Method in class LogEntry
- Required. The resource name of the log to which this log entry belongs:
"projects/[PROJECT_ID]/logs/[LOG_ID]"
"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]"
"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]"
"folders/[FOLDER_ID]/logs/[LOG_ID]"
[LOG_ID]
must be URL-encoded withinlog_name
. Example:"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity"
. - LogEntry::getResource() — Method in class LogEntry
- Required. The monitored resource associated with this log entry.
- LogEntry::getProtoPayload() — Method in class LogEntry
- The log entry payload, represented as a protocol buffer. Some Google Cloud Platform services use this field for their log entry payloads.
- LogEntry::getTextPayload() — Method in class LogEntry
- The log entry payload, represented as a Unicode string (UTF-8).
- LogEntry::getJsonPayload() — Method in class LogEntry
- The log entry payload, represented as a structure that is expressed as a JSON object.
- LogEntry::getTimestamp() — Method in class LogEntry
- Optional. The time the event described by the log entry occurred. If omitted in a new log entry, Stackdriver Logging will insert the time the log entry is received. Stackdriver Logging might reject log entries whose time stamps are more than a couple of hours in the future. Log entries with time stamps in the past are accepted.
- LogEntry::getReceiveTimestamp() — Method in class LogEntry
- Output only. The time the log entry was received by Stackdriver Logging.
- LogEntry::getSeverity() — Method in class LogEntry
- Optional. The severity of the log entry. The default value is
LogSeverity.DEFAULT
. - LogEntry::getInsertId() — Method in class LogEntry
- Optional. A unique identifier for the log entry. If you provide a value,
then Stackdriver Logging considers other log entries in the same project,
with the same
timestamp
, and with the sameinsert_id
to be duplicates which can be removed. If omitted in new log entries, then Stackdriver Logging will insert its own unique identifier. Theinsert_id
is used to order log entries that have the sametimestamp
value. - LogEntry::getHttpRequest() — Method in class LogEntry
- Optional. Information about the HTTP request associated with this log entry, if applicable.
- LogEntry::getLabels() — Method in class LogEntry
- Optional. A set of user-defined (key, value) data that provides additional information about the log entry.
- LogEntry::getOperation() — Method in class LogEntry
- Optional. Information about an operation associated with the log entry, if applicable.
- LogEntry::getTrace() — Method in class LogEntry
- Optional. Resource name of the trace associated with the log entry, if any.
- LogEntry::getSourceLocation() — Method in class LogEntry
- Optional. Source code location information associated with the log entry, if any.
- LogEntry::getPayload() — Method in class LogEntry
- LogEntryOperation::getId() — Method in class LogEntryOperation
- Optional. An arbitrary operation identifier. Log entries with the same identifier are assumed to be part of the same operation.
- LogEntryOperation::getProducer() — Method in class LogEntryOperation
- Optional. An arbitrary producer identifier. The combination of
id
andproducer
must be globally unique. Examples forproducer
:"MyDivision.MyBigCompany.com"
,"github.com/MyProject/MyApplication"
. - LogEntryOperation::getFirst() — Method in class LogEntryOperation
- Optional. Set this to True if this is the first log entry in the operation.
- LogEntryOperation::getLast() — Method in class LogEntryOperation
- Optional. Set this to True if this is the last log entry in the operation.
- LogEntrySourceLocation::getFile() — Method in class LogEntrySourceLocation
- Optional. Source file name. Depending on the runtime environment, this might be a simple name or a fully-qualified name.
- LogEntrySourceLocation::getLine() — Method in class LogEntrySourceLocation
- Optional. Line within the source file. 1-based; 0 indicates no line number available.
- LogEntrySourceLocation::getFunction() — Method in class LogEntrySourceLocation
- Optional. Human-readable name of the function or method being invoked, with
optional context such as the class or package name. This information may be
used in contexts such as the logs viewer, where a file and line number are
less meaningful. The format can vary by language. For example:
qual.if.ied.Class.method
(Java),dir/package.func
(Go),function
(Python). - LogMetric::getName() — Method in class LogMetric
- Required. The client-assigned metric identifier.
- LogMetric::getDescription() — Method in class LogMetric
- Optional. A description of this metric, which is used in documentation.
- LogMetric::getFilter() — Method in class LogMetric
- Required. An advanced logs filter which is used to match log entries.
- LogMetric::getVersion() — Method in class LogMetric
- Output only. The API version that created or updated this metric.
- LogSink::getName() — Method in class LogSink
- Required. The client-assigned sink identifier, unique within the
project. Example:
"my-syslog-errors-to-pubsub"
. Sink identifiers are limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods. - LogSink::getDestination() — Method in class LogSink
- Required. The export destination:
"storage.googleapis.com/[GCS_BUCKET]"
"bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]"
"pubsub.googleapis.com/projects/[PROJECT_ID]/topics/[TOPIC_ID]"
The sink's
writer_identity
, set when the sink is created, must have permission to write to the destination or else the log entries are not exported. For more information, see Exporting Logs With Sinks. - LogSink::getFilter() — Method in class LogSink
- Optional.
- LogSink::getOutputVersionFormat() — Method in class LogSink
- Optional. The log entry format to use for this sink's exported log entries. The v2 format is used by default.
- LogSink::getWriterIdentity() — Method in class LogSink
- Output only. An IAM identity—a service account or group—under
which Stackdriver Logging writes the exported log entries to the sink's
destination. This field is set by
sinks.create
and
sinks.update,
based on the setting of
unique_writer_identity
in those methods. - LogSink::getIncludeChildren() — Method in class LogSink
- Optional. This field applies only to sinks owned by organizations and
folders. If the field is false, the default, only the logs owned by the
sink's parent resource are available for export. If the field is true, then
logs from all the projects, folders, and billing accounts contained in the
sink's parent resource are also available for export. Whether a particular
log entry from the children is exported depends on the sink's filter
expression. For example, if this field is true, then the filter
resource.type=gce_instance
would export all Compute Engine VM instance log entries from all projects in the sink's parent. To only export entries from certain child projects, filter on the project part of the log name: logName:("projects/test-project1/" OR "projects/test-project2/") AND resource.type=gce_instance - LogSink::getStartTime() — Method in class LogSink
- Optional. The time at which this sink will begin exporting log entries.
- LogSink::getEndTime() — Method in class LogSink
- Optional. The time at which this sink will stop exporting log entries. Log entries are exported only if their timestamp is earlier than the end time.
- MetricsServiceV2GrpcClient::GetLogMetric() — Method in class MetricsServiceV2GrpcClient
- Gets a logs-based metric.
- UpdateLogMetricRequest::getMetricName() — Method in class UpdateLogMetricRequest
- The resource name of the metric to update:
"projects/[PROJECT_ID]/metrics/[METRIC_ID]"
The updated metric must be provided in the request and it's
name
field must be the same as[METRIC_ID]
If the metric does not exist in[PROJECT_ID]
, then a new metric is created. - UpdateLogMetricRequest::getMetric() — Method in class UpdateLogMetricRequest
- The updated metric.
- UpdateSinkRequest::getSinkName() — Method in class UpdateSinkRequest
- Required. The full resource name of the sink to update, including the
parent resource and the sink identifier:
"projects/[PROJECT_ID]/sinks/[SINK_ID]"
"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]"
"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]"
"folders/[FOLDER_ID]/sinks/[SINK_ID]"
Example:
"projects/my-project-id/sinks/my-sink-id"
. - UpdateSinkRequest::getSink() — Method in class UpdateSinkRequest
- Required. The updated sink, whose name is the same identifier that appears
as part of
sink_name
. Ifsink_name
does not exist, then this method creates a new sink. - UpdateSinkRequest::getUniqueWriterIdentity() — Method in class UpdateSinkRequest
- Optional. See
sinks.create
for a description of this field. When updating a sink, the effect of this
field on the value of
writer_identity
in the updated sink depends on both the old and new values of this field: + If the old and new values of this field are both false or both true, then there is no change to the sink'swriter_identity
. - WriteLogEntriesPartialErrors::getLogEntryErrors() — Method in class WriteLogEntriesPartialErrors
- When
WriteLogEntriesRequest.partial_success
is true, records the error status for entries that were not written due to a permanent error, keyed by the entry's zero-based index inWriteLogEntriesRequest.entries
. - WriteLogEntriesRequest::getLogName() — Method in class WriteLogEntriesRequest
- Optional. A default log resource name that is assigned to all log entries
in
entries
that do not specify a value forlog_name
: "projects/[PROJECT_ID]/logs/[LOG_ID]" "organizations/[ORGANIZATION_ID]/logs/[LOG_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]" "folders/[FOLDER_ID]/logs/[LOG_ID]"[LOG_ID]
must be URL-encoded. For example,"projects/my-project-id/logs/syslog"
or"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity"
. - WriteLogEntriesRequest::getResource() — Method in class WriteLogEntriesRequest
- Optional. A default monitored resource object that is assigned to all log
entries in
entries
that do not specify a value forresource
. Example: { "type": "gce_instance", "labels": { "zone": "us-central1-a", "instance_id": "00000000000000000000" }} See [LogEntry][google.logging.v2.LogEntry]. - WriteLogEntriesRequest::getLabels() — Method in class WriteLogEntriesRequest
- Optional. Default labels that are added to the
labels
field of all log entries inentries
. If a log entry already has a label with the same key as a label in this parameter, then the log entry's label is not changed. - WriteLogEntriesRequest::getEntries() — Method in class WriteLogEntriesRequest
- Required. The log entries to write. Values supplied for the fields
log_name
,resource
, andlabels
in thisentries.write
request are inserted into those log entries in this list that do not provide their own values. - WriteLogEntriesRequest::getPartialSuccess() — Method in class WriteLogEntriesRequest
- Optional. Whether valid entries should be written even if some other
entries fail due to INVALID_ARGUMENT or PERMISSION_DENIED errors. If any
entry is not written, then the response status is the error associated
with one of the failed entries and the response includes error details
keyed by the entries' zero-based index in the
entries.write
method. - CancelOperationRequest::getName() — Method in class CancelOperationRequest
- The name of the operation resource to be cancelled.
- DeleteOperationRequest::getName() — Method in class DeleteOperationRequest
- The name of the operation resource to be deleted.
- GetOperationRequest — Class in namespace Google\Longrunning
- The request message for [Operations.GetOperation][google.longrunning.Operations.GetOperation].
- GetOperationRequest::getName() — Method in class GetOperationRequest
- The name of the operation resource.
- ListOperationsRequest::getName() — Method in class ListOperationsRequest
- The name of the operation collection.
- ListOperationsRequest::getFilter() — Method in class ListOperationsRequest
- The standard list filter.
- ListOperationsRequest::getPageSize() — Method in class ListOperationsRequest
- The standard list page size.
- ListOperationsRequest::getPageToken() — Method in class ListOperationsRequest
- The standard list page token.
- ListOperationsResponse::getOperations() — Method in class ListOperationsResponse
- A list of operations that matches the specified filter in the request.
- ListOperationsResponse::getNextPageToken() — Method in class ListOperationsResponse
- The standard List next-page token.
- Operation::getName() — Method in class Operation
- The server-assigned name, which is only unique within the same service that
originally returns it. If you use the default HTTP mapping, the
name
should have the format ofoperations/some/unique/name
. - Operation::getMetadata() — Method in class Operation
- Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time.
- Operation::getDone() — Method in class Operation
- If the value is
false
, it means the operation is still in progress. - Operation::getError() — Method in class Operation
- The error result of the operation in case of failure or cancellation.
- Operation::getResponse() — Method in class Operation
- The normal response of the operation in case of success. If the original
method returns no data on success, such as
Delete
, the response isgoogle.protobuf.Empty
. If the original method is standardGet
/Create
/Update
, the response should be the resource. For other methods, the response should have the typeXxxResponse
, whereXxx
is the original method name. For example, if the original method name isTakeSnapshot()
, the inferred response type isTakeSnapshotResponse
. - Operation::getResult() — Method in class Operation
- OperationsGrpcClient::GetOperation() — Method in class OperationsGrpcClient
- Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
- Aggregation::getAlignmentPeriod() — Method in class Aggregation
- The alignment period for per-[time series][google.monitoring.v3.TimeSeries]
alignment. If present,
alignmentPeriod
must be at least 60 seconds. After per-time series alignment, each time series will contain data points only on the period boundaries. IfperSeriesAligner
is not specified or equalsALIGN_NONE
, then this field is ignored. IfperSeriesAligner
is specified and does not equalALIGN_NONE
, then this field must be defined; otherwise an error is returned. - Aggregation::getPerSeriesAligner() — Method in class Aggregation
- The approach to be used to align individual time series. Not all alignment functions may be applied to all time series, depending on the metric type and value type of the original time series. Alignment may change the metric type or the value type of the time series.
- Aggregation::getCrossSeriesReducer() — Method in class Aggregation
- The approach to be used to combine time series. Not all reducer functions may be applied to all time series, depending on the metric type and the value type of the original time series. Reduction may change the metric type of value type of the time series.
- Aggregation::getGroupByFields() — Method in class Aggregation
- The set of fields to preserve when
crossSeriesReducer
is specified. ThegroupByFields
determine how the time series are partitioned into subsets prior to applying the aggregation function. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. ThecrossSeriesReducer
is applied to each subset of time series. - CreateGroupRequest::getName() — Method in class CreateGroupRequest
- The project in which to create the group. The format is
"projects/{project_id_or_number}"
. - CreateGroupRequest::getGroup() — Method in class CreateGroupRequest
- A group definition. It is an error to define the
name
field because the system assigns the name. - CreateGroupRequest::getValidateOnly() — Method in class CreateGroupRequest
- If true, validate this request but do not create the group.
- CreateMetricDescriptorRequest::getName() — Method in class CreateMetricDescriptorRequest
- The project on which to execute the request. The format is
"projects/{project_id_or_number}"
. - CreateMetricDescriptorRequest::getMetricDescriptor() — Method in class CreateMetricDescriptorRequest
- The new custom metric descriptor.
- CreateTimeSeriesError::getTimeSeries() — Method in class CreateTimeSeriesError
- The time series, including the
Metric
,MonitoredResource
, andPoint
s (including timestamp and value) that resulted in the error. This field provides all of the context that would be needed to retry the operation. - CreateTimeSeriesError::getStatus() — Method in class CreateTimeSeriesError
- The status of the requested write operation.
- CreateTimeSeriesRequest::getName() — Method in class CreateTimeSeriesRequest
- The project on which to execute the request. The format is
"projects/{project_id_or_number}"
. - CreateTimeSeriesRequest::getTimeSeries() — Method in class CreateTimeSeriesRequest
- The new data to be added to a list of time series.
- DeleteGroupRequest::getName() — Method in class DeleteGroupRequest
- The group to delete. The format is
"projects/{project_id_or_number}/groups/{group_id}"
. - DeleteMetricDescriptorRequest::getName() — Method in class DeleteMetricDescriptorRequest
- The metric descriptor on which to execute the request. The format is
"projects/{project_id_or_number}/metricDescriptors/{metric_id}"
. - GetGroupRequest — Class in namespace Google\Monitoring\V3
- The
GetGroup
request. - GetGroupRequest::getName() — Method in class GetGroupRequest
- The group to retrieve. The format is
"projects/{project_id_or_number}/groups/{group_id}"
. - GetMetricDescriptorRequest — Class in namespace Google\Monitoring\V3
- The
GetMetricDescriptor
request. - GetMetricDescriptorRequest::getName() — Method in class GetMetricDescriptorRequest
- The metric descriptor on which to execute the request. The format is
"projects/{project_id_or_number}/metricDescriptors/{metric_id}"
. - GetMonitoredResourceDescriptorRequest — Class in namespace Google\Monitoring\V3
- The
GetMonitoredResourceDescriptor
request. - GetMonitoredResourceDescriptorRequest::getName() — Method in class GetMonitoredResourceDescriptorRequest
- The monitored resource descriptor to get. The format is
"projects/{project_id_or_number}/monitoredResourceDescriptors/{resource_type}"
. - Group — Class in namespace Google\Monitoring\V3
- 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.
- Group::getName() — Method in class Group
- Output only. The name of this group. The format is
"projects/{project_id_or_number}/groups/{group_id}"
. - Group::getDisplayName() — Method in class Group
- A user-assigned name for this group, used only for display purposes.
- Group::getParentName() — Method in class Group
- The name of the group's parent, if it has one.
- Group::getFilter() — Method in class Group
- The filter used to determine which monitored resources belong to this group.
- Group::getIsCluster() — Method in class Group
- If true, the members of this group are considered to be a cluster.
- GroupServiceGrpcClient — Class in namespace Google\Monitoring\V3
- The Group API lets you inspect and manage your groups.
- GroupServiceGrpcClient::GetGroup() — Method in class GroupServiceGrpcClient
- Gets a single group.
- ListGroupMembersRequest::getName() — Method in class ListGroupMembersRequest
- The group whose members are listed. The format is
"projects/{project_id_or_number}/groups/{group_id}"
. - ListGroupMembersRequest::getPageSize() — Method in class ListGroupMembersRequest
- A positive number that is the maximum number of results to return.
- ListGroupMembersRequest::getPageToken() — Method in class ListGroupMembersRequest
- If this field is not empty then it must contain the
nextPageToken
value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call. - ListGroupMembersRequest::getFilter() — Method in class ListGroupMembersRequest
- An optional list filter describing the members to be returned. The filter may reference the type, labels, and metadata of monitored resources that comprise the group.
- ListGroupMembersRequest::getInterval() — Method in class ListGroupMembersRequest
- An optional time interval for which results should be returned. Only members that were part of the group during the specified interval are included in the response. If no interval is provided then the group membership over the last minute is returned.
- ListGroupMembersResponse::getMembers() — Method in class ListGroupMembersResponse
- A set of monitored resources in the group.
- ListGroupMembersResponse::getNextPageToken() — Method in class ListGroupMembersResponse
- If there are more results than have been returned, then this field is
set to a non-empty value. To see the additional results, use that value as
pageToken
in the next call to this method. - ListGroupMembersResponse::getTotalSize() — Method in class ListGroupMembersResponse
- The total number of elements matching this request.
- ListGroupsRequest::getName() — Method in class ListGroupsRequest
- The project whose groups are to be listed. The format is
"projects/{project_id_or_number}"
. - ListGroupsRequest::getChildrenOfGroup() — Method in class ListGroupsRequest
- A group name:
"projects/{project_id_or_number}/groups/{group_id}"
. - ListGroupsRequest::getAncestorsOfGroup() — Method in class ListGroupsRequest
- A group name:
"projects/{project_id_or_number}/groups/{group_id}"
. - ListGroupsRequest::getDescendantsOfGroup() — Method in class ListGroupsRequest
- A group name:
"projects/{project_id_or_number}/groups/{group_id}"
. - ListGroupsRequest::getPageSize() — Method in class ListGroupsRequest
- A positive number that is the maximum number of results to return.
- ListGroupsRequest::getPageToken() — Method in class ListGroupsRequest
- If this field is not empty then it must contain the
nextPageToken
value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call. - ListGroupsRequest::getFilter() — Method in class ListGroupsRequest
- ListGroupsResponse::getGroup() — Method in class ListGroupsResponse
- The groups that match the specified filters.
- ListGroupsResponse::getNextPageToken() — Method in class ListGroupsResponse
- If there are more results than have been returned, then this field is set
to a non-empty value. To see the additional results,
use that value as
pageToken
in the next call to this method. - ListMetricDescriptorsRequest::getName() — Method in class ListMetricDescriptorsRequest
- The project on which to execute the request. The format is
"projects/{project_id_or_number}"
. - ListMetricDescriptorsRequest::getFilter() — Method in class ListMetricDescriptorsRequest
- If this field is empty, all custom and system-defined metric descriptors are returned.
- ListMetricDescriptorsRequest::getPageSize() — Method in class ListMetricDescriptorsRequest
- A positive number that is the maximum number of results to return.
- ListMetricDescriptorsRequest::getPageToken() — Method in class ListMetricDescriptorsRequest
- If this field is not empty then it must contain the
nextPageToken
value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call. - ListMetricDescriptorsResponse::getMetricDescriptors() — Method in class ListMetricDescriptorsResponse
- The metric descriptors that are available to the project
and that match the value of
filter
, if present. - ListMetricDescriptorsResponse::getNextPageToken() — Method in class ListMetricDescriptorsResponse
- If there are more results than have been returned, then this field is set
to a non-empty value. To see the additional results,
use that value as
pageToken
in the next call to this method. - ListMonitoredResourceDescriptorsRequest::getName() — Method in class ListMonitoredResourceDescriptorsRequest
- The project on which to execute the request. The format is
"projects/{project_id_or_number}"
. - ListMonitoredResourceDescriptorsRequest::getFilter() — Method in class ListMonitoredResourceDescriptorsRequest
- An optional filter describing
the descriptors to be returned. The filter can reference
the descriptor's type and labels. For example, the
following filter returns only Google Compute Engine descriptors
that have an
id
label: resource.type = starts_with("gce_") AND resource.label:id - ListMonitoredResourceDescriptorsRequest::getPageSize() — Method in class ListMonitoredResourceDescriptorsRequest
- A positive number that is the maximum number of results to return.
- ListMonitoredResourceDescriptorsRequest::getPageToken() — Method in class ListMonitoredResourceDescriptorsRequest
- If this field is not empty then it must contain the
nextPageToken
value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call. - ListMonitoredResourceDescriptorsResponse::getResourceDescriptors() — Method in class ListMonitoredResourceDescriptorsResponse
- The monitored resource descriptors that are available to this project
and that match
filter
, if present. - ListMonitoredResourceDescriptorsResponse::getNextPageToken() — Method in class ListMonitoredResourceDescriptorsResponse
- If there are more results than have been returned, then this field is set
to a non-empty value. To see the additional results,
use that value as
pageToken
in the next call to this method. - ListTimeSeriesRequest::getName() — Method in class ListTimeSeriesRequest
- The project on which to execute the request. The format is "projects/{project_id_or_number}".
- ListTimeSeriesRequest::getFilter() — Method in class ListTimeSeriesRequest
- A monitoring filter that specifies which time series should be returned. The filter must specify a single metric type, and can additionally specify metric labels and other information. For example: metric.type = "compute.googleapis.com/instance/cpu/usage_time" AND metric.label.instance_name = "my-instance-name"
- ListTimeSeriesRequest::getInterval() — Method in class ListTimeSeriesRequest
- The time interval for which results should be returned. Only time series that contain data points in the specified interval are included in the response.
- ListTimeSeriesRequest::getAggregation() — Method in class ListTimeSeriesRequest
- By default, the raw time series data is returned.
- ListTimeSeriesRequest::getOrderBy() — Method in class ListTimeSeriesRequest
- Specifies the order in which the points of the time series should be returned. By default, results are not ordered. Currently, this field must be left blank.
- ListTimeSeriesRequest::getView() — Method in class ListTimeSeriesRequest
- Specifies which information is returned about the time series.
- ListTimeSeriesRequest::getPageSize() — Method in class ListTimeSeriesRequest
- A positive number that is the maximum number of results to return.
- ListTimeSeriesRequest::getPageToken() — Method in class ListTimeSeriesRequest
- If this field is not empty then it must contain the
nextPageToken
value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call. - ListTimeSeriesResponse::getTimeSeries() — Method in class ListTimeSeriesResponse
- One or more time series that match the filter included in the request.
- ListTimeSeriesResponse::getNextPageToken() — Method in class ListTimeSeriesResponse
- If there are more results than have been returned, then this field is set
to a non-empty value. To see the additional results,
use that value as
pageToken
in the next call to this method. - MetricServiceGrpcClient::GetMonitoredResourceDescriptor() — Method in class MetricServiceGrpcClient
- Gets a single monitored resource descriptor. This method does not require a Stackdriver account.
- MetricServiceGrpcClient::GetMetricDescriptor() — Method in class MetricServiceGrpcClient
- Gets a single metric descriptor. This method does not require a Stackdriver account.
- Point::getInterval() — Method in class Point
- The time interval to which the data point applies. For GAUGE metrics, only the end time of the interval is used. For DELTA metrics, the start and end time should specify a non-zero interval, with subsequent points specifying contiguous and non-overlapping intervals. For CUMULATIVE metrics, the start and end time should specify a non-zero interval, with subsequent points specifying the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points.
- Point::getValue() — Method in class Point
- The value of the data point.
- TimeInterval::getEndTime() — Method in class TimeInterval
- Required. The end of the time interval.
- TimeInterval::getStartTime() — Method in class TimeInterval
- Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time.
- TimeSeries::getMetric() — Method in class TimeSeries
- The associated metric. A fully-specified metric used to identify the time series.
- TimeSeries::getResource() — Method in class TimeSeries
- The associated resource. A fully-specified monitored resource used to identify the time series.
- TimeSeries::getMetricKind() — Method in class TimeSeries
- The metric kind of the time series. When listing time series, this metric kind might be different from the metric kind of the associated metric if this time series is an alignment or reduction of other time series.
- TimeSeries::getValueType() — Method in class TimeSeries
- The value type of the time series. When listing time series, this value type might be different from the value type of the associated metric if this time series is an alignment or reduction of other time series.
- TimeSeries::getPoints() — Method in class TimeSeries
- The data points of this time series. When listing time series, the order of the points is specified by the list method.
- TypedValue::getBoolValue() — Method in class TypedValue
- A Boolean value:
true
orfalse
. - TypedValue::getInt64Value() — Method in class TypedValue
- A 64-bit integer. Its range is approximately ±9.2x1018.
- TypedValue::getDoubleValue() — Method in class TypedValue
- A 64-bit double-precision floating-point number. Its magnitude is approximately ±10±300 and it has 16 significant digits of precision.
- TypedValue::getStringValue() — Method in class TypedValue
- A variable-length string value.
- TypedValue::getDistributionValue() — Method in class TypedValue
- A distribution value.
- TypedValue::getValue() — Method in class TypedValue
- UpdateGroupRequest::getGroup() — Method in class UpdateGroupRequest
- The new definition of the group. All fields of the existing group,
excepting
name
, are replaced with the corresponding fields of this group. - UpdateGroupRequest::getValidateOnly() — Method in class UpdateGroupRequest
- If true, validate this request but do not update the existing group.
- Any::getTypeUrl() — Method in class Any
- A URL/resource name whose content describes the type of the serialized protocol buffer message.
- Any::getValue() — Method in class Any
- Must be a valid serialized protocol buffer of the above specified type.
- Api::getName() — Method in class Api
- The fully qualified name of this api, including package name followed by the api's simple name.
- Api::getMethods() — Method in class Api
- The methods of this api, in unspecified order.
- Api::getOptions() — Method in class Api
- Any metadata attached to the API.
- Api::getVersion() — Method in class Api
- A version string for this api. If specified, must have the form
major-version.minor-version
, as in1.10
. If the minor version is omitted, it defaults to zero. If the entire version field is empty, the major version is derived from the package name, as outlined below. If the field is not empty, the version in the package name will be verified to be consistent with what is provided here. - Api::getSourceContext() — Method in class Api
- Source context for the protocol buffer service represented by this message.
- Api::getMixins() — Method in class Api
- Included APIs. See [Mixin][].
- Api::getSyntax() — Method in class Api
- The source syntax of the service.
- BoolValue::getValue() — Method in class BoolValue
- The bool value.
- BytesValue::getValue() — Method in class BytesValue
- The bytes value.
- DoubleValue::getValue() — Method in class DoubleValue
- The double value.
- Duration::getSeconds() — Method in class Duration
- Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
- Duration::getNanos() — Method in class Duration
- Signed fractions of a second at nanosecond resolution of the span
of time. Durations less than one second are represented with a 0
seconds
field and a positive or negativenanos
field. For durations of one second or more, a non-zero value for thenanos
field must be of the same sign as theseconds
field. Must be from -999,999,999 to +999,999,999 inclusive. - Enum::getName() — Method in class Enum
- Enum type name.
- Enum::getEnumvalue() — Method in class Enum
- Enum value definitions.
- Enum::getOptions() — Method in class Enum
- Protocol buffer options.
- Enum::getSourceContext() — Method in class Enum
- The source context.
- Enum::getSyntax() — Method in class Enum
- The source syntax.
- EnumValue::getName() — Method in class EnumValue
- Enum value name.
- EnumValue::getNumber() — Method in class EnumValue
- Enum value number.
- EnumValue::getOptions() — Method in class EnumValue
- Protocol buffer options.
- Field::getKind() — Method in class Field
- The field type.
- Field::getCardinality() — Method in class Field
- The field cardinality.
- Field::getNumber() — Method in class Field
- The field number.
- Field::getName() — Method in class Field
- The field name.
- Field::getTypeUrl() — Method in class Field
- The field type URL, without the scheme, for message or enumeration
types. Example:
"type.googleapis.com/google.protobuf.Timestamp"
. - Field::getOneofIndex() — Method in class Field
- The index of the field type in
Type.oneofs
, for message or enumeration types. The first type has index 1; zero means the type is not in the list. - Field::getPacked() — Method in class Field
- Whether to use alternative packed wire representation.
- Field::getOptions() — Method in class Field
- The protocol buffer options.
- Field::getJsonName() — Method in class Field
- The field JSON name.
- Field::getDefaultValue() — Method in class Field
- The string value of the default value of this field. Proto2 syntax only.
- FieldMask::getPaths() — Method in class FieldMask
- The set of field mask paths.
- FloatValue::getValue() — Method in class FloatValue
- The float value.
- GPBEmpty — Class in namespace Google\Protobuf
- 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{}
. - Int32Value::getValue() — Method in class Int32Value
- The int32 value.
- Int64Value::getValue() — Method in class Int64Value
- The int64 value.
- ListValue::getValues() — Method in class ListValue
- Repeated field of dynamically typed values.
- Method::getName() — Method in class Method
- The simple name of this method.
- Method::getRequestTypeUrl() — Method in class Method
- A URL of the input message type.
- Method::getRequestStreaming() — Method in class Method
- If true, the request is streamed.
- Method::getResponseTypeUrl() — Method in class Method
- The URL of the output message type.
- Method::getResponseStreaming() — Method in class Method
- If true, the response is streamed.
- Method::getOptions() — Method in class Method
- Any metadata attached to the method.
- Method::getSyntax() — Method in class Method
- The source syntax of this method.
- Mixin::getName() — Method in class Mixin
- The fully qualified name of the API which is included.
- Mixin::getRoot() — Method in class Mixin
- If non-empty specifies a path under which inherited HTTP paths are rooted.
- Option::getName() — Method in class Option
- The option's name. For protobuf built-in options (options defined in
descriptor.proto), this is the short name. For example,
"map_entry"
. - Option::getValue() — Method in class Option
- The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type.
- SourceContext::getFileName() — Method in class SourceContext
- The path-qualified name of the .proto file that contained the associated
protobuf element. For example:
"google/protobuf/source_context.proto"
. - StringValue::getValue() — Method in class StringValue
- The string value.
- Struct::getFields() — Method in class Struct
- Unordered map of dynamically typed values.
- Timestamp::getSeconds() — Method in class Timestamp
- Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive.
- Timestamp::getNanos() — Method in class Timestamp
- Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive.
- Type::getName() — Method in class Type
- The fully qualified message name.
- Type::getFields() — Method in class Type
- The list of fields.
- Type::getOneofs() — Method in class Type
- The list of types appearing in
oneof
definitions in this type. - Type::getOptions() — Method in class Type
- The protocol buffer options.
- Type::getSourceContext() — Method in class Type
- The source context.
- Type::getSyntax() — Method in class Type
- The source syntax.
- UInt32Value::getValue() — Method in class UInt32Value
- The uint32 value.
- UInt64Value::getValue() — Method in class UInt64Value
- The uint64 value.
- Value::getNullValue() — Method in class Value
- Represents a null value.
- Value::getNumberValue() — Method in class Value
- Represents a double value.
- Value::getStringValue() — Method in class Value
- Represents a string value.
- Value::getBoolValue() — Method in class Value
- Represents a boolean value.
- Value::getStructValue() — Method in class Value
- Represents a structured value.
- Value::getListValue() — Method in class Value
- Represents a repeated
Value
. - Value::getKind() — Method in class Value
- AcknowledgeRequest::getSubscription() — Method in class AcknowledgeRequest
- The subscription whose message is being acknowledged.
- AcknowledgeRequest::getAckIds() — Method in class AcknowledgeRequest
- The acknowledgment ID for the messages being acknowledged that was returned
by the Pub/Sub system in the
Pull
response. Must not be empty. - CreateSnapshotRequest::getName() — Method in class CreateSnapshotRequest
- Optional user-provided name for this snapshot.
- CreateSnapshotRequest::getSubscription() — Method in class CreateSnapshotRequest
- The subscription whose backlog the snapshot retains.
- DeleteSnapshotRequest::getSnapshot() — Method in class DeleteSnapshotRequest
- The name of the snapshot to delete.
- DeleteSubscriptionRequest::getSubscription() — Method in class DeleteSubscriptionRequest
- The subscription to delete.
- DeleteTopicRequest::getTopic() — Method in class DeleteTopicRequest
- Name of the topic to delete.
- GetSubscriptionRequest — Class in namespace Google\Pubsub\V1
- Request for the GetSubscription method.
- GetSubscriptionRequest::getSubscription() — Method in class GetSubscriptionRequest
- The name of the subscription to get.
- GetTopicRequest — Class in namespace Google\Pubsub\V1
- Request for the GetTopic method.
- GetTopicRequest::getTopic() — Method in class GetTopicRequest
- The name of the topic to get.
- ListSnapshotsRequest::getProject() — Method in class ListSnapshotsRequest
- The name of the cloud project that snapshots belong to.
- ListSnapshotsRequest::getPageSize() — Method in class ListSnapshotsRequest
- Maximum number of snapshots to return.
- ListSnapshotsRequest::getPageToken() — Method in class ListSnapshotsRequest
- The value returned by the last
ListSnapshotsResponse
; indicates that this is a continuation of a priorListSnapshots
call, and that the system should return the next page of data. - ListSnapshotsResponse::getSnapshots() — Method in class ListSnapshotsResponse
- The resulting snapshots.
- ListSnapshotsResponse::getNextPageToken() — Method in class ListSnapshotsResponse
- If not empty, indicates that there may be more snapshot that match the
request; this value should be passed in a new
ListSnapshotsRequest
. - ListSubscriptionsRequest::getProject() — Method in class ListSubscriptionsRequest
- The name of the cloud project that subscriptions belong to.
- ListSubscriptionsRequest::getPageSize() — Method in class ListSubscriptionsRequest
- Maximum number of subscriptions to return.
- ListSubscriptionsRequest::getPageToken() — Method in class ListSubscriptionsRequest
- The value returned by the last
ListSubscriptionsResponse
; indicates that this is a continuation of a priorListSubscriptions
call, and that the system should return the next page of data. - ListSubscriptionsResponse::getSubscriptions() — Method in class ListSubscriptionsResponse
- The subscriptions that match the request.
- ListSubscriptionsResponse::getNextPageToken() — Method in class ListSubscriptionsResponse
- If not empty, indicates that there may be more subscriptions that match
the request; this value should be passed in a new
ListSubscriptionsRequest
to get more subscriptions. - ListTopicSubscriptionsRequest::getTopic() — Method in class ListTopicSubscriptionsRequest
- The name of the topic that subscriptions are attached to.
- ListTopicSubscriptionsRequest::getPageSize() — Method in class ListTopicSubscriptionsRequest
- Maximum number of subscription names to return.
- ListTopicSubscriptionsRequest::getPageToken() — Method in class ListTopicSubscriptionsRequest
- The value returned by the last
ListTopicSubscriptionsResponse
; indicates that this is a continuation of a priorListTopicSubscriptions
call, and that the system should return the next page of data. - ListTopicSubscriptionsResponse::getSubscriptions() — Method in class ListTopicSubscriptionsResponse
- The names of the subscriptions that match the request.
- ListTopicSubscriptionsResponse::getNextPageToken() — Method in class ListTopicSubscriptionsResponse
- If not empty, indicates that there may be more subscriptions that match
the request; this value should be passed in a new
ListTopicSubscriptionsRequest
to get more subscriptions. - ListTopicsRequest::getProject() — Method in class ListTopicsRequest
- The name of the cloud project that topics belong to.
- ListTopicsRequest::getPageSize() — Method in class ListTopicsRequest
- Maximum number of topics to return.
- ListTopicsRequest::getPageToken() — Method in class ListTopicsRequest
- The value returned by the last
ListTopicsResponse
; indicates that this is a continuation of a priorListTopics
call, and that the system should return the next page of data. - ListTopicsResponse::getTopics() — Method in class ListTopicsResponse
- The resulting topics.
- ListTopicsResponse::getNextPageToken() — Method in class ListTopicsResponse
- If not empty, indicates that there may be more topics that match the
request; this value should be passed in a new
ListTopicsRequest
. - ModifyAckDeadlineRequest::getSubscription() — Method in class ModifyAckDeadlineRequest
- The name of the subscription.
- ModifyAckDeadlineRequest::getAckIds() — Method in class ModifyAckDeadlineRequest
- List of acknowledgment IDs.
- ModifyAckDeadlineRequest::getAckDeadlineSeconds() — Method in class ModifyAckDeadlineRequest
- The new ack deadline with respect to the time this request was sent to
the Pub/Sub system. For example, if the value is 10, the new
ack deadline will expire 10 seconds after the
ModifyAckDeadline
call was made. Specifying zero may immediately make the message available for another pull request. - ModifyPushConfigRequest::getSubscription() — Method in class ModifyPushConfigRequest
- The name of the subscription.
- ModifyPushConfigRequest::getPushConfig() — Method in class ModifyPushConfigRequest
- The push configuration for future deliveries.
- PublishRequest::getTopic() — Method in class PublishRequest
- The messages in the request will be published on this topic.
- PublishRequest::getMessages() — Method in class PublishRequest
- The messages to publish.
- PublishResponse::getMessageIds() — Method in class PublishResponse
- The server-assigned ID of each published message, in the same order as the messages in the request. IDs are guaranteed to be unique within the topic.
- PublisherGrpcClient::GetTopic() — Method in class PublisherGrpcClient
- Gets the configuration of a topic.
- PubsubMessage::getData() — Method in class PubsubMessage
- The message payload.
- PubsubMessage::getAttributes() — Method in class PubsubMessage
- Optional attributes for this message.
- PubsubMessage::getMessageId() — Method in class PubsubMessage
- ID of this message, assigned by the server when the message is published.
- PubsubMessage::getPublishTime() — Method in class PubsubMessage
- The time at which the message was published, populated by the server when
it receives the
Publish
call. It must not be populated by the publisher in aPublish
call. - PullRequest::getSubscription() — Method in class PullRequest
- The subscription from which messages should be pulled.
- PullRequest::getReturnImmediately() — Method in class PullRequest
- If this field set to true, the system will respond immediately even if
it there are no messages available to return in the
Pull
response. - PullRequest::getMaxMessages() — Method in class PullRequest
- The maximum number of messages returned for this request. The Pub/Sub system may return fewer than the number specified.
- PullResponse::getReceivedMessages() — Method in class PullResponse
- Received Pub/Sub messages. The Pub/Sub system will return zero messages if
there are no more available in the backlog. The Pub/Sub system may return
fewer than the
maxMessages
requested even if there are more messages available in the backlog. - PushConfig::getPushEndpoint() — Method in class PushConfig
- A URL locating the endpoint to which messages should be pushed.
- PushConfig::getAttributes() — Method in class PushConfig
- Endpoint configuration attributes.
- ReceivedMessage::getAckId() — Method in class ReceivedMessage
- This ID can be used to acknowledge the received message.
- ReceivedMessage::getMessage() — Method in class ReceivedMessage
- The message.
- SeekRequest::getSubscription() — Method in class SeekRequest
- The subscription to affect.
- SeekRequest::getTime() — Method in class SeekRequest
- The time to seek to.
- SeekRequest::getSnapshot() — Method in class SeekRequest
- The snapshot to seek to. The snapshot's topic must be the same as that of the provided subscription.
- SeekRequest::getTarget() — Method in class SeekRequest
- Snapshot::getName() — Method in class Snapshot
- The name of the snapshot.
- Snapshot::getTopic() — Method in class Snapshot
- The name of the topic from which this snapshot is retaining messages.
- Snapshot::getExpireTime() — Method in class Snapshot
- The snapshot is guaranteed to exist up until this time.
- StreamingPullRequest::getSubscription() — Method in class StreamingPullRequest
- The subscription for which to initialize the new stream. This must be provided in the first request on the stream, and must not be set in subsequent requests from client to server.
- StreamingPullRequest::getAckIds() — Method in class StreamingPullRequest
- List of acknowledgement IDs for acknowledging previously received messages
(received on this stream or a different stream). If an ack ID has expired,
the corresponding message may be redelivered later. Acknowledging a message
more than once will not result in an error. If the acknowledgement ID is
malformed, the stream will be aborted with status
INVALID_ARGUMENT
. - StreamingPullRequest::getModifyDeadlineSeconds() — Method in class StreamingPullRequest
- The list of new ack deadlines for the IDs listed in
modify_deadline_ack_ids
. The size of this list must be the same as the size ofmodify_deadline_ack_ids
. If it differs the stream will be aborted withINVALID_ARGUMENT
. Each element in this list is applied to the element in the same position inmodify_deadline_ack_ids
. The new ack deadline is with respect to the time this request was sent to the Pub/Sub system. Must be >= 0. For example, if the value is 10, the new ack deadline will expire 10 seconds after this request is received. If the value is 0, the message is immediately made available for another streaming or non-streaming pull request. If the value is < 0 (an error), the stream will be aborted with statusINVALID_ARGUMENT
. - StreamingPullRequest::getModifyDeadlineAckIds() — Method in class StreamingPullRequest
- List of acknowledgement IDs whose deadline will be modified based on the
corresponding element in
modify_deadline_seconds
. This field can be used to indicate that more time is needed to process a message by the subscriber, or to make the message available for redelivery if the processing was interrupted. - StreamingPullRequest::getStreamAckDeadlineSeconds() — Method in class StreamingPullRequest
- The ack deadline to use for the stream. This must be provided in the first request on the stream, but it can also be updated on subsequent requests from client to server. The minimum deadline you can specify is 10 seconds. The maximum deadline you can specify is 600 seconds (10 minutes).
- StreamingPullResponse::getReceivedMessages() — Method in class StreamingPullResponse
- Received Pub/Sub messages. This will not be empty.
- SubscriberGrpcClient::GetSubscription() — Method in class SubscriberGrpcClient
- Gets the configuration details of a subscription.
- Subscription::getName() — Method in class Subscription
- The name of the subscription. It must have the format
"projects/{project}/subscriptions/{subscription}"
.{subscription}
must start with a letter, and contain only letters ([A-Za-z]
), numbers ([0-9]
), dashes (-
), underscores (_
), periods (.
), tildes (~
), plus (+
) or percent signs (%
). It must be between 3 and 255 characters in length, and it must not start with"goog"
. - Subscription::getTopic() — Method in class Subscription
- The name of the topic from which this subscription is receiving messages.
- Subscription::getPushConfig() — Method in class Subscription
- If push delivery is used with this subscription, this field is
used to configure it. An empty
pushConfig
signifies that the subscriber will pull and ack messages using API methods. - Subscription::getAckDeadlineSeconds() — Method in class Subscription
- This value is the maximum time after a subscriber receives a message before the subscriber should acknowledge the message. After message delivery but before the ack deadline expires and before the message is acknowledged, it is an outstanding message and will not be delivered again during that time (on a best-effort basis).
- Subscription::getRetainAckedMessages() — Method in class Subscription
- Indicates whether to retain acknowledged messages. If true, then
messages are not expunged from the subscription's backlog, even if they are
acknowledged, until they fall out of the
message_retention_duration
window. - Subscription::getMessageRetentionDuration() — Method in class Subscription
- How long to retain unacknowledged messages in the subscription's backlog, from the moment a message is published.
- Topic::getName() — Method in class Topic
- The name of the topic. It must have the format
"projects/{project}/topics/{topic}"
.{topic}
must start with a letter, and contain only letters ([A-Za-z]
), numbers ([0-9]
), dashes (-
), underscores (_
), periods (.
), tildes (~
), plus (+
) or percent signs (%
). It must be between 3 and 255 characters in length, and it must not start with"goog"
. - UpdateSubscriptionRequest::getSubscription() — Method in class UpdateSubscriptionRequest
- The updated subscription object.
- UpdateSubscriptionRequest::getUpdateMask() — Method in class UpdateSubscriptionRequest
- Indicates which fields in the provided subscription to update.
- BadRequest::getFieldViolations() — Method in class BadRequest
- Describes all violations in a client request.
- BadRequest_FieldViolation::getField() — Method in class BadRequest_FieldViolation
- A path leading to a field in the request body. The value will be a sequence of dot-separated identifiers that identify a protocol buffer field. E.g., "field_violations.field" would identify this field.
- BadRequest_FieldViolation::getDescription() — Method in class BadRequest_FieldViolation
- A description of why the request element is bad.
- DebugInfo::getStackEntries() — Method in class DebugInfo
- The stack trace entries indicating where the error occurred.
- DebugInfo::getDetail() — Method in class DebugInfo
- Additional debugging information provided by the server.
- Help::getLinks() — Method in class Help
- URL(s) pointing to additional information on handling the current error.
- Help_Link::getDescription() — Method in class Help_Link
- Describes what the link offers.
- Help_Link::getUrl() — Method in class Help_Link
- The URL of the link.
- LocalizedMessage::getLocale() — Method in class LocalizedMessage
- The locale used following the specification defined at http://www.rfc-editor.org/rfc/bcp/bcp47.txt.
- LocalizedMessage::getMessage() — Method in class LocalizedMessage
- The localized error message in the above locale.
- QuotaFailure::getViolations() — Method in class QuotaFailure
- Describes all quota violations.
- QuotaFailure_Violation::getSubject() — Method in class QuotaFailure_Violation
- The subject on which the quota check failed.
- QuotaFailure_Violation::getDescription() — Method in class QuotaFailure_Violation
- A description of how the quota check failed. Clients can use this description to find more about the quota configuration in the service's public documentation, or find the relevant quota limit to adjust through developer console.
- RequestInfo::getRequestId() — Method in class RequestInfo
- An opaque string that should only be interpreted by the service generating it. For example, it can be used to identify requests in the service's logs.
- RequestInfo::getServingData() — Method in class RequestInfo
- Any data that was used to serve this request. For example, an encrypted stack trace that can be sent back to the service provider for debugging.
- ResourceInfo::getResourceType() — Method in class ResourceInfo
- A name for the type of resource being accessed, e.g. "sql table", "cloud storage bucket", "file", "Google calendar"; or the type URL of the resource: e.g. "type.googleapis.com/google.pubsub.v1.Topic".
- ResourceInfo::getResourceName() — Method in class ResourceInfo
- The name of the resource being accessed. For example, a shared calendar name: "example.com_4fghdhgsrgh@group.calendar.google.com", if the current error is [google.rpc.Code.PERMISSION_DENIED][google.rpc.Code.PERMISSION_DENIED].
- ResourceInfo::getOwner() — Method in class ResourceInfo
- The owner of the resource (optional).
- ResourceInfo::getDescription() — Method in class ResourceInfo
- Describes what error is encountered when accessing this resource.
- RetryInfo::getRetryDelay() — Method in class RetryInfo
- Clients should wait at least this long between retrying the same request.
- Status::getCode() — Method in class Status
- The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
- Status::getMessage() — Method in class Status
- A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
- Status::getDetails() — Method in class Status
- A list of messages that carry the error details. There will be a common set of message types for APIs to use.
- CreateDatabaseMetadata::getDatabase() — Method in class CreateDatabaseMetadata
- The database being created.
- CreateDatabaseRequest::getParent() — Method in class CreateDatabaseRequest
- Required. The name of the instance that will serve the new database.
- CreateDatabaseRequest::getCreateStatement() — Method in class CreateDatabaseRequest
- Required. A
CREATE DATABASE
statement, which specifies the ID of the new database. The database ID must conform to the regular expression[a-z][a-z0-9_\-]*[a-z0-9]
and be between 2 and 30 characters in length. - CreateDatabaseRequest::getExtraStatements() — Method in class CreateDatabaseRequest
- An optional list of DDL statements to run inside the newly created database. Statements can create tables, indexes, etc. These statements execute atomically with the creation of the database: if there is an error in any statement, the database is not created.
- Database::getName() — Method in class Database
- Required. The name of the database. Values are of the form
projects/<project>/instances/<instance>/databases/<database>
, where<database>
is as specified in theCREATE DATABASE
statement. This name can be passed to other API methods to identify the database. - Database::getState() — Method in class Database
- Output only. The current database state.
- DatabaseAdminGrpcClient::GetDatabase() — Method in class DatabaseAdminGrpcClient
- Gets the state of a Cloud Spanner database.
- DatabaseAdminGrpcClient::GetDatabaseDdl() — Method in class DatabaseAdminGrpcClient
- Returns the schema of a Cloud Spanner database as a list of formatted DDL statements. This method does not show pending schema updates, those may be queried using the [Operations][google.longrunning.Operations] API.
- DatabaseAdminGrpcClient::GetIamPolicy() — Method in class DatabaseAdminGrpcClient
- Gets the access control policy for a database resource. Returns an empty policy if a database exists but does not have a policy set.
- DropDatabaseRequest::getDatabase() — Method in class DropDatabaseRequest
- Required. The database to be dropped.
- GetDatabaseDdlRequest — Class in namespace Google\Spanner\Admin\Database\V1
- The request for [GetDatabaseDdl][google.spanner.admin.database.v1.DatabaseAdmin.GetDatabaseDdl].
- GetDatabaseDdlRequest::getDatabase() — Method in class GetDatabaseDdlRequest
- Required. The database whose schema we wish to get.
- GetDatabaseDdlResponse — Class in namespace Google\Spanner\Admin\Database\V1
- The response for [GetDatabaseDdl][google.spanner.admin.database.v1.DatabaseAdmin.GetDatabaseDdl].
- GetDatabaseDdlResponse::getStatements() — Method in class GetDatabaseDdlResponse
- A list of formatted DDL statements defining the schema of the database specified in the request.
- GetDatabaseRequest — Class in namespace Google\Spanner\Admin\Database\V1
- The request for [GetDatabase][google.spanner.admin.database.v1.DatabaseAdmin.GetDatabase].
- GetDatabaseRequest::getName() — Method in class GetDatabaseRequest
- Required. The name of the requested database. Values are of the form
projects/<project>/instances/<instance>/databases/<database>
. - ListDatabasesRequest::getParent() — Method in class ListDatabasesRequest
- Required. The instance whose databases should be listed.
- ListDatabasesRequest::getPageSize() — Method in class ListDatabasesRequest
- Number of databases to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.
- ListDatabasesRequest::getPageToken() — Method in class ListDatabasesRequest
- If non-empty,
page_token
should contain a [next_page_token][google.spanner.admin.database.v1.ListDatabasesResponse.next_page_token] from a previous [ListDatabasesResponse][google.spanner.admin.database.v1.ListDatabasesResponse]. - ListDatabasesResponse::getDatabases() — Method in class ListDatabasesResponse
- Databases that matched the request.
- ListDatabasesResponse::getNextPageToken() — Method in class ListDatabasesResponse
next_page_token
can be sent in a subsequent [ListDatabases][google.spanner.admin.database.v1.DatabaseAdmin.ListDatabases] call to fetch more of the matching databases.- UpdateDatabaseDdlMetadata::getDatabase() — Method in class UpdateDatabaseDdlMetadata
- The database being modified.
- UpdateDatabaseDdlMetadata::getStatements() — Method in class UpdateDatabaseDdlMetadata
- For an update this list contains all the statements. For an individual statement, this list contains only that statement.
- UpdateDatabaseDdlMetadata::getCommitTimestamps() — Method in class UpdateDatabaseDdlMetadata
- Reports the commit timestamps of all statements that have
succeeded so far, where
commit_timestamps[i]
is the commit timestamp for the statementstatements[i]
. - UpdateDatabaseDdlRequest::getDatabase() — Method in class UpdateDatabaseDdlRequest
- Required. The database to update.
- UpdateDatabaseDdlRequest::getStatements() — Method in class UpdateDatabaseDdlRequest
- DDL statements to be applied to the database.
- UpdateDatabaseDdlRequest::getOperationId() — Method in class UpdateDatabaseDdlRequest
- If empty, the new update request is assigned an
automatically-generated operation ID. Otherwise,
operation_id
is used to construct the name of the resulting [Operation][google.longrunning.Operation]. - CreateInstanceMetadata::getInstance() — Method in class CreateInstanceMetadata
- The instance being created.
- CreateInstanceMetadata::getStartTime() — Method in class CreateInstanceMetadata
- The time at which the [CreateInstance][google.spanner.admin.instance.v1.InstanceAdmin.CreateInstance] request was received.
- CreateInstanceMetadata::getCancelTime() — Method in class CreateInstanceMetadata
- The time at which this operation was cancelled. If set, this operation is in the process of undoing itself (which is guaranteed to succeed) and cannot be cancelled again.
- CreateInstanceMetadata::getEndTime() — Method in class CreateInstanceMetadata
- The time at which this operation failed or was completed successfully.
- CreateInstanceRequest::getParent() — Method in class CreateInstanceRequest
- Required. The name of the project in which to create the instance. Values
are of the form
projects/<project>
. - CreateInstanceRequest::getInstanceId() — Method in class CreateInstanceRequest
- Required. The ID of the instance to create. Valid identifiers are of the
form
[a-z][-a-z0-9]*[a-z0-9]
and must be between 6 and 30 characters in length. - CreateInstanceRequest::getInstance() — Method in class CreateInstanceRequest
- Required. The instance to create. The name may be omitted, but if
specified must be
<parent>/instances/<instance_id>
. - DeleteInstanceRequest::getName() — Method in class DeleteInstanceRequest
- Required. The name of the instance to be deleted. Values are of the form
projects/<project>/instances/<instance>
- GetInstanceConfigRequest — Class in namespace Google\Spanner\Admin\Instance\V1
- The request for [GetInstanceConfigRequest][google.spanner.admin.instance.v1.InstanceAdmin.GetInstanceConfig].
- GetInstanceConfigRequest::getName() — Method in class GetInstanceConfigRequest
- Required. The name of the requested instance configuration. Values are of
the form
projects/<project>/instanceConfigs/<config>
. - GetInstanceRequest — Class in namespace Google\Spanner\Admin\Instance\V1
- The request for [GetInstance][google.spanner.admin.instance.v1.InstanceAdmin.GetInstance].
- GetInstanceRequest::getName() — Method in class GetInstanceRequest
- Required. The name of the requested instance. Values are of the form
projects/<project>/instances/<instance>
. - Instance::getName() — Method in class Instance
- Required. A unique identifier for the instance, which cannot be changed
after the instance is created. Values are of the form
projects/<project>/instances/[a-z][-a-z0-9]*[a-z0-9]
. The final segment of the name must be between 6 and 30 characters in length. - Instance::getConfig() — Method in class Instance
- Required. The name of the instance's configuration. Values are of the form
projects/<project>/instanceConfigs/<configuration>
. See also [InstanceConfig][google.spanner.admin.instance.v1.InstanceConfig] and [ListInstanceConfigs][google.spanner.admin.instance.v1.InstanceAdmin.ListInstanceConfigs]. - Instance::getDisplayName() — Method in class Instance
- Required. The descriptive name for this instance as it appears in UIs.
- Instance::getNodeCount() — Method in class Instance
- Required. The number of nodes allocated to this instance.
- Instance::getState() — Method in class Instance
- Output only. The current instance state. For
[CreateInstance][google.spanner.admin.instance.v1.InstanceAdmin.CreateInstance], the state must be
either omitted or set to
CREATING
. For [UpdateInstance][google.spanner.admin.instance.v1.InstanceAdmin.UpdateInstance], the state must be either omitted or set toREADY
. - Instance::getLabels() — Method in class Instance
- Cloud Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. Cloud Labels can be used to filter collections of resources. They can be used to control how resource metrics are aggregated.
- InstanceAdminGrpcClient::GetInstanceConfig() — Method in class InstanceAdminGrpcClient
- Gets information about a particular instance configuration.
- InstanceAdminGrpcClient::GetInstance() — Method in class InstanceAdminGrpcClient
- Gets information about a particular instance.
- InstanceAdminGrpcClient::GetIamPolicy() — Method in class InstanceAdminGrpcClient
- Gets the access control policy for an instance resource. Returns an empty policy if an instance exists but does not have a policy set.
- InstanceConfig::getName() — Method in class InstanceConfig
- A unique identifier for the instance configuration. Values
are of the form
projects/<project>/instanceConfigs/[a-z][-a-z0-9]*
- InstanceConfig::getDisplayName() — Method in class InstanceConfig
- The name of this instance configuration as it appears in UIs.
- ListInstanceConfigsRequest::getParent() — Method in class ListInstanceConfigsRequest
- Required. The name of the project for which a list of supported instance
configurations is requested. Values are of the form
projects/<project>
. - ListInstanceConfigsRequest::getPageSize() — Method in class ListInstanceConfigsRequest
- Number of instance configurations to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.
- ListInstanceConfigsRequest::getPageToken() — Method in class ListInstanceConfigsRequest
- If non-empty,
page_token
should contain a [next_page_token][google.spanner.admin.instance.v1.ListInstanceConfigsResponse.next_page_token] from a previous [ListInstanceConfigsResponse][google.spanner.admin.instance.v1.ListInstanceConfigsResponse]. - ListInstanceConfigsResponse::getInstanceConfigs() — Method in class ListInstanceConfigsResponse
- The list of requested instance configurations.
- ListInstanceConfigsResponse::getNextPageToken() — Method in class ListInstanceConfigsResponse
next_page_token
can be sent in a subsequent [ListInstanceConfigs][google.spanner.admin.instance.v1.InstanceAdmin.ListInstanceConfigs] call to fetch more of the matching instance configurations.- ListInstancesRequest::getParent() — Method in class ListInstancesRequest
- Required. The name of the project for which a list of instances is
requested. Values are of the form
projects/<project>
. - ListInstancesRequest::getPageSize() — Method in class ListInstancesRequest
- Number of instances to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.
- ListInstancesRequest::getPageToken() — Method in class ListInstancesRequest
- If non-empty,
page_token
should contain a [next_page_token][google.spanner.admin.instance.v1.ListInstancesResponse.next_page_token] from a previous [ListInstancesResponse][google.spanner.admin.instance.v1.ListInstancesResponse]. - ListInstancesRequest::getFilter() — Method in class ListInstancesRequest
- An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * name * display_name * labels.key where key is the name of a label Some examples of using filters are: * name:* --> The instance has a name.
- ListInstancesResponse::getInstances() — Method in class ListInstancesResponse
- The list of requested instances.
- ListInstancesResponse::getNextPageToken() — Method in class ListInstancesResponse
next_page_token
can be sent in a subsequent [ListInstances][google.spanner.admin.instance.v1.InstanceAdmin.ListInstances] call to fetch more of the matching instances.- UpdateInstanceMetadata::getInstance() — Method in class UpdateInstanceMetadata
- The desired end state of the update.
- UpdateInstanceMetadata::getStartTime() — Method in class UpdateInstanceMetadata
- The time at which [UpdateInstance][google.spanner.admin.instance.v1.InstanceAdmin.UpdateInstance] request was received.
- UpdateInstanceMetadata::getCancelTime() — Method in class UpdateInstanceMetadata
- The time at which this operation was cancelled. If set, this operation is in the process of undoing itself (which is guaranteed to succeed) and cannot be cancelled again.
- UpdateInstanceMetadata::getEndTime() — Method in class UpdateInstanceMetadata
- The time at which this operation failed or was completed successfully.
- UpdateInstanceRequest::getInstance() — Method in class UpdateInstanceRequest
- Required. The instance to update, which must always include the instance name. Otherwise, only fields mentioned in [][google.spanner.admin.instance.v1.UpdateInstanceRequest.field_mask] need be included.
- UpdateInstanceRequest::getFieldMask() — Method in class UpdateInstanceRequest
- Required. A mask specifying which fields in [][google.spanner.admin.instance.v1.UpdateInstanceRequest.instance] should be updated.
- BeginTransactionRequest::getSession() — Method in class BeginTransactionRequest
- Required. The session in which the transaction runs.
- BeginTransactionRequest::getOptions() — Method in class BeginTransactionRequest
- Required. Options for the new transaction.
- CommitRequest::getSession() — Method in class CommitRequest
- Required. The session in which the transaction to be committed is running.
- CommitRequest::getTransactionId() — Method in class CommitRequest
- Commit a previously-started transaction.
- CommitRequest::getSingleUseTransaction() — Method in class CommitRequest
- Execute mutations in a temporary transaction. Note that unlike
commit of a previously-started transaction, commit with a
temporary transaction is non-idempotent. That is, if the
CommitRequest
is sent to Cloud Spanner more than once (for instance, due to retries in the application, or in the transport library), it is possible that the mutations are executed more than once. If this is undesirable, use [BeginTransaction][google.spanner.v1.Spanner.BeginTransaction] and [Commit][google.spanner.v1.Spanner.Commit] instead. - CommitRequest::getMutations() — Method in class CommitRequest
- The mutations to be executed when this transaction commits. All mutations are applied atomically, in the order they appear in this list.
- CommitRequest::getTransaction() — Method in class CommitRequest
- CommitResponse::getCommitTimestamp() — Method in class CommitResponse
- The Cloud Spanner timestamp at which the transaction committed.
- CreateSessionRequest::getDatabase() — Method in class CreateSessionRequest
- Required. The database in which the new session is created.
- DeleteSessionRequest::getName() — Method in class DeleteSessionRequest
- Required. The name of the session to delete.
- ExecuteSqlRequest::getSession() — Method in class ExecuteSqlRequest
- Required. The session in which the SQL query should be performed.
- ExecuteSqlRequest::getTransaction() — Method in class ExecuteSqlRequest
- The transaction to use. If none is provided, the default is a temporary read-only transaction with strong concurrency.
- ExecuteSqlRequest::getSql() — Method in class ExecuteSqlRequest
- Required. The SQL query string.
- ExecuteSqlRequest::getParams() — Method in class ExecuteSqlRequest
- The SQL query string can contain parameter placeholders. A parameter
placeholder consists of
'@'
followed by the parameter name. Parameter names consist of any combination of letters, numbers, and underscores. - ExecuteSqlRequest::getParamTypes() — Method in class ExecuteSqlRequest
- It is not always possible for Cloud Spanner to infer the right SQL type
from a JSON value. For example, values of type
BYTES
and values of typeSTRING
both appear in [params][google.spanner.v1.ExecuteSqlRequest.params] as JSON strings. - ExecuteSqlRequest::getResumeToken() — Method in class ExecuteSqlRequest
- If this request is resuming a previously interrupted SQL query
execution,
resume_token
should be copied from the last [PartialResultSet][google.spanner.v1.PartialResultSet] yielded before the interruption. Doing this enables the new SQL query execution to resume where the last one left off. The rest of the request parameters must exactly match the request that yielded this token. - ExecuteSqlRequest::getQueryMode() — Method in class ExecuteSqlRequest
- Used to control the amount of debugging information returned in [ResultSetStats][google.spanner.v1.ResultSetStats].
- GetSessionRequest — Class in namespace Google\Spanner\V1
- The request for [GetSession][google.spanner.v1.Spanner.GetSession].
- GetSessionRequest::getName() — Method in class GetSessionRequest
- Required. The name of the session to retrieve.
- KeyRange::getStartClosed() — Method in class KeyRange
- If the start is closed, then the range includes all rows whose
first
len(start_closed)
key columns exactly matchstart_closed
. - KeyRange::getStartOpen() — Method in class KeyRange
- If the start is open, then the range excludes rows whose first
len(start_open)
key columns exactly matchstart_open
. - KeyRange::getEndClosed() — Method in class KeyRange
- If the end is closed, then the range includes all rows whose
first
len(end_closed)
key columns exactly matchend_closed
. - KeyRange::getEndOpen() — Method in class KeyRange
- If the end is open, then the range excludes rows whose first
len(end_open)
key columns exactly matchend_open
. - KeyRange::getStartKeyType() — Method in class KeyRange
- KeyRange::getEndKeyType() — Method in class KeyRange
- KeySet::getKeys() — Method in class KeySet
- A list of specific keys. Entries in
keys
should have exactly as many elements as there are columns in the primary or index key with which thisKeySet
is used. Individual key values are encoded as described [here][google.spanner.v1.TypeCode]. - KeySet::getRanges() — Method in class KeySet
- A list of key ranges. See [KeyRange][google.spanner.v1.KeyRange] for more information about key range specifications.
- KeySet::getAll() — Method in class KeySet
- For convenience
all
can be set totrue
to indicate that thisKeySet
matches all keys in the table or index. Note that any keys specified inkeys
orranges
are only yielded once. - Mutation::getInsert() — Method in class Mutation
- Insert new rows in a table. If any of the rows already exist,
the write or transaction fails with error
ALREADY_EXISTS
. - Mutation::getUpdate() — Method in class Mutation
- Update existing rows in a table. If any of the rows does not
already exist, the transaction fails with error
NOT_FOUND
. - Mutation::getInsertOrUpdate() — Method in class Mutation
- Like [insert][google.spanner.v1.Mutation.insert], except that if the row already exists, then its column values are overwritten with the ones provided. Any column values not explicitly written are preserved.
- Mutation::getReplace() — Method in class Mutation
- Like [insert][google.spanner.v1.Mutation.insert], except that if the row already exists, it is
deleted, and the column values provided are inserted
instead. Unlike [insert_or_update][google.spanner.v1.Mutation.insert_or_update], this means any values not
explicitly written become
NULL
. - Mutation::getDelete() — Method in class Mutation
- Delete rows from a table. Succeeds whether or not the named rows were present.
- Mutation::getOperation() — Method in class Mutation
- Mutation_Delete::getTable() — Method in class Mutation_Delete
- Required. The table whose rows will be deleted.
- Mutation_Delete::getKeySet() — Method in class Mutation_Delete
- Required. The primary keys of the rows within [table][google.spanner.v1.Mutation.Delete.table] to delete.
- Mutation_Write::getTable() — Method in class Mutation_Write
- Required. The table whose rows will be written.
- Mutation_Write::getColumns() — Method in class Mutation_Write
- The names of the columns in [table][google.spanner.v1.Mutation.Write.table] to be written.
- Mutation_Write::getValues() — Method in class Mutation_Write
- The values to be written.
values
can contain more than one list of values. If it does, then multiple rows are written, one for each entry invalues
. Each list invalues
must have exactly as many entries as there are entries in [columns][google.spanner.v1.Mutation.Write.columns] above. Sending multiple lists is equivalent to sending multipleMutation
s, each containing onevalues
entry and repeating [table][google.spanner.v1.Mutation.Write.table] and [columns][google.spanner.v1.Mutation.Write.columns]. Individual values in each list are encoded as described [here][google.spanner.v1.TypeCode]. - PartialResultSet::getMetadata() — Method in class PartialResultSet
- Metadata about the result set, such as row type information.
- PartialResultSet::getValues() — Method in class PartialResultSet
- A streamed result set consists of a stream of values, which might
be split into many
PartialResultSet
messages to accommodate large rows and/or large values. Every N complete values defines a row, where N is equal to the number of entries in [metadata.row_type.fields][google.spanner.v1.StructType.fields]. - PartialResultSet::getChunkedValue() — Method in class PartialResultSet
- If true, then the final value in [values][google.spanner.v1.PartialResultSet.values] is chunked, and must
be combined with more values from subsequent
PartialResultSet
s to obtain a complete field value. - PartialResultSet::getResumeToken() — Method in class PartialResultSet
- Streaming calls might be interrupted for a variety of reasons, such
as TCP connection loss. If this occurs, the stream of results can
be resumed by re-sending the original request and including
resume_token
. Note that executing any other transaction in the same session invalidates the token. - PartialResultSet::getStats() — Method in class PartialResultSet
- Query plan and execution statistics for the query that produced this streaming result set. These can be requested by setting [ExecuteSqlRequest.query_mode][google.spanner.v1.ExecuteSqlRequest.query_mode] and are sent only once with the last response in the stream.
- PlanNode::getIndex() — Method in class PlanNode
- The
PlanNode
's index in [node list][google.spanner.v1.QueryPlan.plan_nodes]. - PlanNode::getKind() — Method in class PlanNode
- Used to determine the type of node. May be needed for visualizing different kinds of nodes differently. For example, If the node is a [SCALAR][google.spanner.v1.PlanNode.Kind.SCALAR] node, it will have a condensed representation which can be used to directly embed a description of the node in its parent.
- PlanNode::getDisplayName() — Method in class PlanNode
- The display name for the node.
- PlanNode::getChildLinks() — Method in class PlanNode
- List of child node
index
es and their relationship to this parent. - PlanNode::getShortRepresentation() — Method in class PlanNode
- Condensed representation for [SCALAR][google.spanner.v1.PlanNode.Kind.SCALAR] nodes.
- PlanNode::getMetadata() — Method in class PlanNode
- Attributes relevant to the node contained in a group of key-value pairs.
- PlanNode::getExecutionStats() — Method in class PlanNode
- The execution statistics associated with the node, contained in a group of key-value pairs. Only present if the plan was returned as a result of a profile query. For example, number of executions, number of rows/time per execution etc.
- PlanNode_ChildLink::getChildIndex() — Method in class PlanNode_ChildLink
- The node to which the link points.
- PlanNode_ChildLink::getType() — Method in class PlanNode_ChildLink
- The type of the link. For example, in Hash Joins this could be used to distinguish between the build child and the probe child, or in the case of the child being an output variable, to represent the tag associated with the output variable.
- PlanNode_ChildLink::getVariable() — Method in class PlanNode_ChildLink
- Only present if the child node is [SCALAR][google.spanner.v1.PlanNode.Kind.SCALAR] and corresponds to an output variable of the parent node. The field carries the name of the output variable.
- PlanNode_ShortRepresentation::getDescription() — Method in class PlanNode_ShortRepresentation
- A string representation of the expression subtree rooted at this node.
- PlanNode_ShortRepresentation::getSubqueries() — Method in class PlanNode_ShortRepresentation
- A mapping of (subquery variable name) -> (subquery node id) for cases
where the
description
string of this node references aSCALAR
subquery contained in the expression subtree rooted at this node. The referencedSCALAR
subquery may not necessarily be a direct child of this node. - QueryPlan::getPlanNodes() — Method in class QueryPlan
- The nodes in the query plan. Plan nodes are returned in pre-order starting
with the plan root. Each [PlanNode][google.spanner.v1.PlanNode]'s
id
corresponds to its index inplan_nodes
. - ReadRequest::getSession() — Method in class ReadRequest
- Required. The session in which the read should be performed.
- ReadRequest::getTransaction() — Method in class ReadRequest
- The transaction to use. If none is provided, the default is a temporary read-only transaction with strong concurrency.
- ReadRequest::getTable() — Method in class ReadRequest
- Required. The name of the table in the database to be read.
- ReadRequest::getIndex() — Method in class ReadRequest
- If non-empty, the name of an index on [table][google.spanner.v1.ReadRequest.table]. This index is used instead of the table primary key when interpreting [key_set][google.spanner.v1.ReadRequest.key_set] and sorting result rows. See [key_set][google.spanner.v1.ReadRequest.key_set] for further information.
- ReadRequest::getColumns() — Method in class ReadRequest
- The columns of [table][google.spanner.v1.ReadRequest.table] to be returned for each row matching this request.
- ReadRequest::getKeySet() — Method in class ReadRequest
- Required.
key_set
identifies the rows to be yielded.key_set
names the primary keys of the rows in [table][google.spanner.v1.ReadRequest.table] to be yielded, unless [index][google.spanner.v1.ReadRequest.index] is present. If [index][google.spanner.v1.ReadRequest.index] is present, then [key_set][google.spanner.v1.ReadRequest.key_set] instead names index keys in [index][google.spanner.v1.ReadRequest.index]. - ReadRequest::getLimit() — Method in class ReadRequest
- If greater than zero, only the first
limit
rows are yielded. Iflimit
is zero, the default is no limit. - ReadRequest::getResumeToken() — Method in class ReadRequest
- If this request is resuming a previously interrupted read,
resume_token
should be copied from the last [PartialResultSet][google.spanner.v1.PartialResultSet] yielded before the interruption. Doing this enables the new read to resume where the last read left off. The rest of the request parameters must exactly match the request that yielded this token. - ResultSet::getMetadata() — Method in class ResultSet
- Metadata about the result set, such as row type information.
- ResultSet::getRows() — Method in class ResultSet
- Each element in
rows
is a row whose format is defined by [metadata.row_type][google.spanner.v1.ResultSetMetadata.row_type]. The ith element in each row matches the ith field in [metadata.row_type][google.spanner.v1.ResultSetMetadata.row_type]. Elements are encoded based on type as described [here][google.spanner.v1.TypeCode]. - ResultSet::getStats() — Method in class ResultSet
- Query plan and execution statistics for the query that produced this result set. These can be requested by setting [ExecuteSqlRequest.query_mode][google.spanner.v1.ExecuteSqlRequest.query_mode].
- ResultSetMetadata::getRowType() — Method in class ResultSetMetadata
- Indicates the field names and types for the rows in the result
set. For example, a SQL query like
"SELECT UserId, UserName FROM Users"
could return arow_type
value like: "fields": [ { "name": "UserId", "type": { "code": "INT64" } }, { "name": "UserName", "type": { "code": "STRING" } }, ] - ResultSetMetadata::getTransaction() — Method in class ResultSetMetadata
- If the read or SQL query began a transaction as a side-effect, the information about the new transaction is yielded here.
- ResultSetStats::getQueryPlan() — Method in class ResultSetStats
- [QueryPlan][google.spanner.v1.QueryPlan] for the query associated with this result.
- ResultSetStats::getQueryStats() — Method in class ResultSetStats
- Aggregated statistics from the execution of the query. Only present when the query is profiled. For example, a query could return the statistics as follows: { "rows_returned": "3", "elapsed_time": "1.22 secs", "cpu_time": "1.19 secs" }
- RollbackRequest::getSession() — Method in class RollbackRequest
- Required. The session in which the transaction to roll back is running.
- RollbackRequest::getTransactionId() — Method in class RollbackRequest
- Required. The transaction to roll back.
- Session::getName() — Method in class Session
- Required. The name of the session.
- SpannerGrpcClient::GetSession() — Method in class SpannerGrpcClient
- Gets a session. Returns
NOT_FOUND
if the session does not exist. - StructType::getFields() — Method in class StructType
- The list of fields that make up this struct. Order is
significant, because values of this struct type are represented as
lists, where the order of field values matches the order of
fields in the [StructType][google.spanner.v1.StructType]. In turn, the order of fields
matches the order of columns in a read request, or the order of
fields in the
SELECT
clause of a query. - StructType_Field::getName() — Method in class StructType_Field
- The name of the field. For reads, this is the column name. For
SQL queries, it is the column alias (e.g.,
"Word"
in the query"SELECT 'hello' AS Word"
), or the column name (e.g.,"ColName"
in the query"SELECT ColName FROM Table"
). Some columns might have an empty name (e.g., !"SELECT UPPER(ColName)"`). Note that a query result can contain multiple fields with the same name. - StructType_Field::getType() — Method in class StructType_Field
- The type of the field.
- Transaction::getId() — Method in class Transaction
id
may be used to identify the transaction in subsequent [Read][google.spanner.v1.Spanner.Read], [ExecuteSql][google.spanner.v1.Spanner.ExecuteSql], [Commit][google.spanner.v1.Spanner.Commit], or [Rollback][google.spanner.v1.Spanner.Rollback] calls.- Transaction::getReadTimestamp() — Method in class Transaction
- For snapshot read-only transactions, the read timestamp chosen for the transaction. Not returned by default: see [TransactionOptions.ReadOnly.return_read_timestamp][google.spanner.v1.TransactionOptions.ReadOnly.return_read_timestamp].
- TransactionOptions::getReadWrite() — Method in class TransactionOptions
- Transaction may write.
- TransactionOptions::getReadOnly() — Method in class TransactionOptions
- Transaction will not write.
- TransactionOptions::getMode() — Method in class TransactionOptions
- TransactionOptions_ReadOnly::getStrong() — Method in class TransactionOptions_ReadOnly
- Read at a timestamp where all previously committed transactions are visible.
- TransactionOptions_ReadOnly::getMinReadTimestamp() — Method in class TransactionOptions_ReadOnly
- Executes all reads at a timestamp >=
min_read_timestamp
. - TransactionOptions_ReadOnly::getMaxStaleness() — Method in class TransactionOptions_ReadOnly
- Read data at a timestamp >=
NOW - max_staleness
seconds. Guarantees that all writes that have committed more than the specified number of seconds ago are visible. Because Cloud Spanner chooses the exact timestamp, this mode works even if the client's local clock is substantially skewed from Cloud Spanner commit timestamps. - TransactionOptions_ReadOnly::getReadTimestamp() — Method in class TransactionOptions_ReadOnly
- Executes all reads at the given timestamp. Unlike other modes, reads at a specific timestamp are repeatable; the same read at the same timestamp always returns the same data. If the timestamp is in the future, the read will block until the specified timestamp, modulo the read's deadline.
- TransactionOptions_ReadOnly::getExactStaleness() — Method in class TransactionOptions_ReadOnly
- Executes all reads at a timestamp that is
exact_staleness
old. The timestamp is chosen soon after the read is started. - TransactionOptions_ReadOnly::getReturnReadTimestamp() — Method in class TransactionOptions_ReadOnly
- If true, the Cloud Spanner-selected read timestamp is included in the [Transaction][google.spanner.v1.Transaction] message that describes the transaction.
- TransactionOptions_ReadOnly::getTimestampBound() — Method in class TransactionOptions_ReadOnly
- TransactionSelector::getSingleUse() — Method in class TransactionSelector
- Execute the read or SQL query in a temporary transaction.
- TransactionSelector::getId() — Method in class TransactionSelector
- Execute the read or SQL query in a previously-started transaction.
- TransactionSelector::getBegin() — Method in class TransactionSelector
- Begin a new transaction and execute this read or SQL query in it. The transaction ID of the new transaction is returned in [ResultSetMetadata.transaction][google.spanner.v1.ResultSetMetadata.transaction], which is a [Transaction][google.spanner.v1.Transaction].
- TransactionSelector::getSelector() — Method in class TransactionSelector
- Type::getCode() — Method in class Type
- Required. The [TypeCode][google.spanner.v1.TypeCode] for this type.
- Type::getArrayElementType() — Method in class Type
- If [code][google.spanner.v1.Type.code] == [ARRAY][google.spanner.v1.TypeCode.ARRAY], then
array_element_type
is the type of the array elements. - Type::getStructType() — Method in class Type
- If [code][google.spanner.v1.Type.code] == [STRUCT][google.spanner.v1.TypeCode.STRUCT], then
struct_type
provides type information for the struct's fields. - Color::getRed() — Method in class Color
- The amount of red in the color as a value in the interval [0, 1].
- Color::getGreen() — Method in class Color
- The amount of green in the color as a value in the interval [0, 1].
- Color::getBlue() — Method in class Color
- The amount of blue in the color as a value in the interval [0, 1].
- Color::getAlpha() — Method in class Color
- The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: pixel color = alpha * (this color) + (1.0 - alpha) * (background color) This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset.
- Date::getYear() — Method in class Date
- Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.
- Date::getMonth() — Method in class Date
- Month of year. Must be from 1 to 12.
- Date::getDay() — Method in class Date
- Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year/month where the day is not significant.
- LatLng::getLatitude() — Method in class LatLng
- The latitude in degrees. It must be in the range [-90.0, +90.0].
- LatLng::getLongitude() — Method in class LatLng
- The longitude in degrees. It must be in the range [-180.0, +180.0].
- Money::getCurrencyCode() — Method in class Money
- The 3-letter currency code defined in ISO 4217.
- Money::getUnits() — Method in class Money
- The whole units of the amount.
- Money::getNanos() — Method in class Money
- Number of nano (10^-9) units of the amount.
- PostalAddress::getRevision() — Method in class PostalAddress
- The schema revision of the
PostalAddress
. - PostalAddress::getRegionCode() — Method in class PostalAddress
- Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See http://cldr.unicode.org/ and http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
- PostalAddress::getLanguageCode() — Method in class PostalAddress
- Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents.
- PostalAddress::getPostalCode() — Method in class PostalAddress
- Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (e.g. state/zip validation in the U.S.A.).
- PostalAddress::getSortingCode() — Method in class PostalAddress
- Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).
- PostalAddress::getAdministrativeArea() — Method in class PostalAddress
- Optional. Highest administrative subdivision which is used for postal addresses of a country or region.
- PostalAddress::getLocality() — Method in class PostalAddress
- Optional. Generally refers to the city/town portion of the address.
- PostalAddress::getSublocality() — Method in class PostalAddress
- Optional. Sublocality of the address.
- PostalAddress::getAddressLines() — Method in class PostalAddress
- Unstructured address lines describing the lower levels of an address.
- PostalAddress::getRecipients() — Method in class PostalAddress
- Optional. The recipient at the address.
- PostalAddress::getOrganization() — Method in class PostalAddress
- Optional. The name of the organization at the address.
- TimeOfDay::getHours() — Method in class TimeOfDay
- Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
- TimeOfDay::getMinutes() — Method in class TimeOfDay
- Minutes of hour of day. Must be from 0 to 59.
- TimeOfDay::getSeconds() — Method in class TimeOfDay
- Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
- TimeOfDay::getNanos() — Method in class TimeOfDay
- Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
H
- Http — Class in namespace Google\Api
- 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.
- HttpBody — Class in namespace Google\Api
- 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 — Class in namespace Google\Api
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 angoogle.api.http
annotation, see "google/api/annotations.proto" for details.- HttpRequestContext — Class in namespace Google\Devtools\Clouderrorreporting\V1beta1
- HTTP request data that is related to a reported error.
- FixedSizeCollection::hasNextCollection() — Method in class FixedSizeCollection
- Returns true if there are more elements that can be retrieved from the API.
- Page::hasNextPage() — Method in class Page
- Returns true if there are more pages that can be retrieved from the API.
- HttpRequest — Class in namespace Google\Logging\Type
- 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.
- Help — Class in namespace Google\Rpc
- Provides links to documentation or for performing an out of band action.
- Help_Link — Class in namespace Google\Rpc
- Describes a URL link.
I
- Image — Class in namespace Google\Cloud\Vision\V1
- Client image to perform Google Cloud Vision API tasks over.
- ImageAnnotatorGrpcClient — Class in namespace Google\Cloud\Vision\V1
- 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.
- ImageContext — Class in namespace Google\Cloud\Vision\V1
- Image context and/or feature-specific parameters.
- ImageProperties — Class in namespace Google\Cloud\Vision\V1
- Stores image properties, such as dominant colors.
- ImageSource — Class in namespace Google\Cloud\Vision\V1
- External image source (Google Cloud Storage image location).
- FixedSizeCollection::iterateCollections() — Method in class FixedSizeCollection
- Returns an iterator over FixedSizeCollections, starting with this and making API calls as required until all of the elements have been retrieved.
- $LexerConditions — Property in class LexerConditions
- $Parser — Property in class Parser
- Parser::input() — Method in class Parser
- $ParserState — Property in class ParserState
- $ParserSymbol — Property in class ParserSymbol
- Segment::incrementBindingCount() — Method in class Segment
- Segment::incrementSegmentCount() — Method in class Segment
- OperationResponse::isDone() — Method in class OperationResponse
- Check whether the operation has completed.
- Page::iteratePages() — Method in class Page
- Return an iterator over Page objects, beginning with this object.
- PagedListResponse::iterateAllElements() — Method in class PagedListResponse
- Returns an iterator over the full list of elements. Elements of the list are retrieved lazily using the underlying API.
- PagedListResponse::iteratePages() — Method in class PagedListResponse
- Returns an iterator over pages of results. The pages are retrieved lazily from the underlying API.
- PagedListResponse::iterateFixedSizeCollections() — Method in class PagedListResponse
- Returns an iterator over fixed size collections of results.
- RetrySettings::inherit() — Method in class RetrySettings
- Create a special instance that indicates that the retry settings should be inherited from defaults.
- MockStubTrait::isExhausted() — Method in class MockStubTrait
- IAMPolicyGrpcClient — Class in namespace Google\Iam\V1
API Overview
- Int32Value — Class in namespace Google\Protobuf
- Wrapper message for
int32
. - Int64Value — Class in namespace Google\Protobuf
- Wrapper message for
int64
. - Instance — Class in namespace Google\Spanner\Admin\Instance\V1
- An isolated set of Cloud Spanner resources on which databases can be hosted.
- InstanceAdminGrpcClient — Class in namespace Google\Spanner\Admin\Instance\V1
- Cloud Spanner Instance Admin API
- InstanceConfig — Class in namespace Google\Spanner\Admin\Instance\V1
- A possible configuration for a Cloud Spanner instance. Configurations define the geographic placement of nodes and their replication.
- Instance_State — Class in namespace Google\Spanner\Admin\Instance\V1
- Indicates the current state of the instance.
K
- $Segment — Property in class Segment
- $Value — Property in class Value
- KeyRange — Class in namespace Google\Spanner\V1
- KeyRange represents a range of rows in a table or index.
- KeySet — Class in namespace Google\Spanner\V1
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.
L
- LabelDescriptor — Class in namespace Google\Api
- A description of a label.
- LabelDescriptor_ValueType — Class in namespace Google\Api
- Value types that can be used as label values.
- LogDescriptor — Class in namespace Google\Api
- 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 — Class in namespace Google\Api
- Logging configuration of the service.
- Logging_LoggingDestination — Class in namespace Google\Api
- Configuration of a specific logging destination (the producer project or the consumer project).
- LanguageServiceGrpcClient — Class in namespace Google\Cloud\Language\V1beta2
- Provides text analysis operations such as sentiment analysis and entity recognition.
- LongRunningRecognizeMetadata — Class in namespace Google\Cloud\Speech\V1
- Describes the progress of a long-running
LongRunningRecognize
call. It is included in themetadata
field of theOperation
returned by theGetOperation
call of thegoogle::longrunning::Operations
service. - LongRunningRecognizeRequest — Class in namespace Google\Cloud\Speech\V1
- The top-level message sent by the client for the
LongRunningRecognize
method. - LongRunningRecognizeResponse — Class in namespace Google\Cloud\Speech\V1
- The only message returned to the client by the
LongRunningRecognize
method. - SpeechGrpcClient::LongRunningRecognize() — Method in class SpeechGrpcClient
- Performs asynchronous speech recognition: receive results via the
google.longrunning.Operations interface. Returns either an
Operation.error
or anOperation.response
which contains aLongRunningRecognizeResponse
message. - LabelAnnotation — Class in namespace Google\Cloud\Videointelligence\V1beta1
- Label annotation.
- LabelDetectionMode — Class in namespace Google\Cloud\Videointelligence\V1beta1
- Label detection mode.
- LabelLevel — Class in namespace Google\Cloud\Videointelligence\V1beta1
- Label level (scope).
- LabelLocation — Class in namespace Google\Cloud\Videointelligence\V1beta1
- Label location.
- Likelihood — Class in namespace Google\Cloud\Videointelligence\V1beta1
- Bucketized representation of likelihood.
- LatLongRect — Class in namespace Google\Cloud\Vision\V1
- Rectangle determined by min and max
LatLng
pairs. - Likelihood — Class in namespace Google\Cloud\Vision\V1
- A bucketized representation of likelihood, which is intended to give clients highly stable results across model upgrades.
- LocationInfo — Class in namespace Google\Cloud\Vision\V1
- Detected entity location information.
- ErrorStatsServiceGrpcClient::ListGroupStats() — Method in class ErrorStatsServiceGrpcClient
- Lists the specified groups.
- ErrorStatsServiceGrpcClient::ListEvents() — Method in class ErrorStatsServiceGrpcClient
- Lists the specified events.
- ListEventsRequest — Class in namespace Google\Devtools\Clouderrorreporting\V1beta1
- Specifies a set of error events to return.
- ListEventsResponse — Class in namespace Google\Devtools\Clouderrorreporting\V1beta1
- Contains a set of requested error events.
- ListGroupStatsRequest — Class in namespace Google\Devtools\Clouderrorreporting\V1beta1
- Specifies a set of
ErrorGroupStats
to return. - ListGroupStatsResponse — Class in namespace Google\Devtools\Clouderrorreporting\V1beta1
- Contains a set of requested error group stats.
- ListTracesRequest — Class in namespace Google\Devtools\Cloudtrace\V1
- The request message for the
ListTraces
method. All fields are required unless specified. - ListTracesRequest_ViewType — Class in namespace Google\Devtools\Cloudtrace\V1
- Type of data returned for traces in the list.
- ListTracesResponse — Class in namespace Google\Devtools\Cloudtrace\V1
- The response message for the
ListTraces
method. - TraceServiceGrpcClient::ListTraces() — Method in class TraceServiceGrpcClient
- Returns of a list of traces that match the specified filter conditions.
- CallSettings::load() — Method in class CallSettings
- Constructs an array mapping method names to CallSettings.
- LexerConditions — Class in namespace Google\GAX\Jison
- LexerError — Class in namespace Google\GAX\Jison
- $LexerError — Property in class LexerError
- $Parser — Property in class Parser
- Parser::lexerError() — Method in class Parser
- Parser::lexerLex() — Method in class Parser
- Parser::LexerPerformAction() — Method in class Parser
- $ParserError — Property in class ParserError
- $ParserError — Property in class ParserError
- $ParserLocation — Property in class ParserLocation
- $ParserLocation — Property in class ParserLocation
- $ParserProduction — Property in class ParserProduction
- $ParserValue — Property in class ParserValue
- $ParserValue — Property in class ParserValue
- $ParserValue — Property in class ParserValue
- $Segment — Property in class Segment
- OperationsClient::listOperations() — Method in class OperationsClient
- Lists operations that match the specified filter in the request. If the
server doesn't support this method, it returns
UNIMPLEMENTED
. - LogSeverity — Class in namespace Google\Logging\Type
- 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.
- ConfigServiceV2GrpcClient::ListSinks() — Method in class ConfigServiceV2GrpcClient
- Lists sinks.
- ListLogEntriesRequest — Class in namespace Google\Logging\V2
- The parameters to
ListLogEntries
. - ListLogEntriesResponse — Class in namespace Google\Logging\V2
- Result returned from
ListLogEntries
. - ListLogMetricsRequest — Class in namespace Google\Logging\V2
- The parameters to ListLogMetrics.
- ListLogMetricsResponse — Class in namespace Google\Logging\V2
- Result returned from ListLogMetrics.
- ListLogsRequest — Class in namespace Google\Logging\V2
- The parameters to ListLogs.
- ListLogsResponse — Class in namespace Google\Logging\V2
- Result returned from ListLogs.
- ListMonitoredResourceDescriptorsRequest — Class in namespace Google\Logging\V2
- The parameters to ListMonitoredResourceDescriptors
- ListMonitoredResourceDescriptorsResponse — Class in namespace Google\Logging\V2
- Result returned from ListMonitoredResourceDescriptors.
- ListSinksRequest — Class in namespace Google\Logging\V2
- The parameters to
ListSinks
. - ListSinksResponse — Class in namespace Google\Logging\V2
- Result returned from
ListSinks
. - LogEntry — Class in namespace Google\Logging\V2
- An individual entry in a log.
- LogEntryOperation — Class in namespace Google\Logging\V2
- Additional information about a potentially long-running operation with which a log entry is associated.
- LogEntrySourceLocation — Class in namespace Google\Logging\V2
- Additional information about the source code location that produced the log entry.
- LogMetric — Class in namespace Google\Logging\V2
- 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.
- LogMetric_ApiVersion — Class in namespace Google\Logging\V2
- Stackdriver Logging API version.
- LogSink — Class in namespace Google\Logging\V2
- 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.
- LogSink_VersionFormat — Class in namespace Google\Logging\V2
- Available log entry formats. Log entries can be written to Stackdriver Logging in either format and can be exported in either format.
- LoggingServiceV2GrpcClient — Class in namespace Google\Logging\V2
- Service for ingesting and querying logs.
- LoggingServiceV2GrpcClient::ListLogEntries() — Method in class LoggingServiceV2GrpcClient
- Lists log entries. Use this method to retrieve log entries from Stackdriver Logging. For ways to export log entries, see Exporting Logs.
- LoggingServiceV2GrpcClient::ListMonitoredResourceDescriptors() — Method in class LoggingServiceV2GrpcClient
- Lists the descriptors for monitored resource types used by Stackdriver Logging.
- LoggingServiceV2GrpcClient::ListLogs() — Method in class LoggingServiceV2GrpcClient
- Lists the logs in projects, organizations, folders, or billing accounts.
- MetricsServiceV2GrpcClient::ListLogMetrics() — Method in class MetricsServiceV2GrpcClient
- Lists logs-based metrics.
- ListOperationsRequest — Class in namespace Google\Longrunning
- The request message for [Operations.ListOperations][google.longrunning.Operations.ListOperations].
- ListOperationsResponse — Class in namespace Google\Longrunning
- The response message for [Operations.ListOperations][google.longrunning.Operations.ListOperations].
- OperationsGrpcClient::ListOperations() — Method in class OperationsGrpcClient
- Lists operations that match the specified filter in the request. If the
server doesn't support this method, it returns
UNIMPLEMENTED
. - GroupServiceGrpcClient::ListGroups() — Method in class GroupServiceGrpcClient
- Lists the existing groups.
- GroupServiceGrpcClient::ListGroupMembers() — Method in class GroupServiceGrpcClient
- Lists the monitored resources that are members of a group.
- ListGroupMembersRequest — Class in namespace Google\Monitoring\V3
- The
ListGroupMembers
request. - ListGroupMembersResponse — Class in namespace Google\Monitoring\V3
- The
ListGroupMembers
response. - ListGroupsRequest — Class in namespace Google\Monitoring\V3
- The
ListGroup
request. - ListGroupsResponse — Class in namespace Google\Monitoring\V3
- The
ListGroups
response. - ListMetricDescriptorsRequest — Class in namespace Google\Monitoring\V3
- The
ListMetricDescriptors
request. - ListMetricDescriptorsResponse — Class in namespace Google\Monitoring\V3
- The
ListMetricDescriptors
response. - ListMonitoredResourceDescriptorsRequest — Class in namespace Google\Monitoring\V3
- The
ListMonitoredResourceDescriptors
request. - ListMonitoredResourceDescriptorsResponse — Class in namespace Google\Monitoring\V3
- The
ListMonitoredResourcDescriptors
response. - ListTimeSeriesRequest — Class in namespace Google\Monitoring\V3
- The
ListTimeSeries
request. - ListTimeSeriesRequest_TimeSeriesView — Class in namespace Google\Monitoring\V3
- Controls which fields are returned by
ListTimeSeries
. - ListTimeSeriesResponse — Class in namespace Google\Monitoring\V3
- The
ListTimeSeries
response. - MetricServiceGrpcClient::ListMonitoredResourceDescriptors() — Method in class MetricServiceGrpcClient
- Lists monitored resource descriptors that match a filter. This method does not require a Stackdriver account.
- MetricServiceGrpcClient::ListMetricDescriptors() — Method in class MetricServiceGrpcClient
- Lists metric descriptors that match a filter. This method does not require a Stackdriver account.
- MetricServiceGrpcClient::ListTimeSeries() — Method in class MetricServiceGrpcClient
- Lists time series that match a filter. This method does not require a Stackdriver account.
- ListValue — Class in namespace Google\Protobuf
ListValue
is a wrapper around a repeated field of values.- ListSnapshotsRequest — Class in namespace Google\Pubsub\V1
- Request for the
ListSnapshots
method. - ListSnapshotsResponse — Class in namespace Google\Pubsub\V1
- Response for the
ListSnapshots
method. - ListSubscriptionsRequest — Class in namespace Google\Pubsub\V1
- Request for the
ListSubscriptions
method. - ListSubscriptionsResponse — Class in namespace Google\Pubsub\V1
- Response for the
ListSubscriptions
method. - ListTopicSubscriptionsRequest — Class in namespace Google\Pubsub\V1
- Request for the
ListTopicSubscriptions
method. - ListTopicSubscriptionsResponse — Class in namespace Google\Pubsub\V1
- Response for the
ListTopicSubscriptions
method. - ListTopicsRequest — Class in namespace Google\Pubsub\V1
- Request for the
ListTopics
method. - ListTopicsResponse — Class in namespace Google\Pubsub\V1
- Response for the
ListTopics
method. - PublisherGrpcClient::ListTopics() — Method in class PublisherGrpcClient
- Lists matching topics.
- PublisherGrpcClient::ListTopicSubscriptions() — Method in class PublisherGrpcClient
- Lists the name of the subscriptions for this topic.
- SubscriberGrpcClient::ListSubscriptions() — Method in class SubscriberGrpcClient
- Lists matching subscriptions.
- SubscriberGrpcClient::ListSnapshots() — Method in class SubscriberGrpcClient
- Lists the existing snapshots.
- LocalizedMessage — Class in namespace Google\Rpc
- Provides a localized error message that is safe to return to the user which can be attached to an RPC error.
- DatabaseAdminGrpcClient::ListDatabases() — Method in class DatabaseAdminGrpcClient
- Lists Cloud Spanner databases.
- ListDatabasesRequest — Class in namespace Google\Spanner\Admin\Database\V1
- The request for [ListDatabases][google.spanner.admin.database.v1.DatabaseAdmin.ListDatabases].
- ListDatabasesResponse — Class in namespace Google\Spanner\Admin\Database\V1
- The response for [ListDatabases][google.spanner.admin.database.v1.DatabaseAdmin.ListDatabases].
- InstanceAdminGrpcClient::ListInstanceConfigs() — Method in class InstanceAdminGrpcClient
- Lists the supported instance configurations for a given project.
- InstanceAdminGrpcClient::ListInstances() — Method in class InstanceAdminGrpcClient
- Lists all instances in the given project.
- ListInstanceConfigsRequest — Class in namespace Google\Spanner\Admin\Instance\V1
- The request for [ListInstanceConfigs][google.spanner.admin.instance.v1.InstanceAdmin.ListInstanceConfigs].
- ListInstanceConfigsResponse — Class in namespace Google\Spanner\Admin\Instance\V1
- The response for [ListInstanceConfigs][google.spanner.admin.instance.v1.InstanceAdmin.ListInstanceConfigs].
- ListInstancesRequest — Class in namespace Google\Spanner\Admin\Instance\V1
- The request for [ListInstances][google.spanner.admin.instance.v1.InstanceAdmin.ListInstances].
- ListInstancesResponse — Class in namespace Google\Spanner\Admin\Instance\V1
- The response for [ListInstances][google.spanner.admin.instance.v1.InstanceAdmin.ListInstances].
- LatLng — Class in namespace Google\Type
- 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.
M
- Metric — Class in namespace Google\Api
- A specific metric, identified by specifying values for all of the
labels of a [
MetricDescriptor
][google.api.MetricDescriptor]. - MetricDescriptor — Class in namespace Google\Api
- 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_MetricKind — Class in namespace Google\Api
- The kind of measurement. It describes how the data is reported.
- MetricDescriptor_ValueType — Class in namespace Google\Api
- The value type of a metric.
- MetricRule — Class in namespace Google\Api
- 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.
- MonitoredResource — Class in namespace Google\Api
- 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 thelabels
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" }} - MonitoredResourceDescriptor — Class in namespace Google\Api
- 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 — Class in namespace Google\Api
- Monitoring configuration of the service.
- Monitoring_MonitoringDestination — Class in namespace Google\Api
- Configuration of a specific monitoring destination (the producer project or the consumer project).
- CallSettings::merge() — Method in class CallSettings
- Returns a new CallSettings merged from this and another CallSettings object.
- $Parser — Property in class Parser
- $Parser — Property in class Parser
- $Parser — Property in class Parser
- Parser::more() — Method in class Parser
- PathTemplate::match() — Method in class PathTemplate
- Matches a fully qualified path template string.
- MockOperationsImpl — Class in namespace Google\GAX\Testing\LongRunning
- MockBidiStreamingCall — Class in namespace Google\GAX\Testing
- 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)
- MockClientStreamingCall — Class in namespace Google\GAX\Testing
- 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)
- MockServerStreamingCall — Class in namespace Google\GAX\Testing
- 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)
- MockStatus — Class in namespace Google\GAX\Testing
- $MockStatus — Property in class MockStatus
- MockStubTrait — Class in namespace Google\GAX\Testing
- 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.
- MockUnaryCall — Class in namespace Google\GAX\Testing
- 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)
- MetricsServiceV2GrpcClient — Class in namespace Google\Logging\V2
- Service for configuring logs-based metrics.
- MetricServiceGrpcClient — Class in namespace Google\Monitoring\V3
- Manages metric descriptors, monitored resource descriptors, and time series data.
- Method — Class in namespace Google\Protobuf
- Method represents a method of an api.
- Mixin — Class in namespace Google\Protobuf
- 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.
- ModifyAckDeadlineRequest — Class in namespace Google\Pubsub\V1
- Request for the ModifyAckDeadline method.
- ModifyPushConfigRequest — Class in namespace Google\Pubsub\V1
- Request for the ModifyPushConfig method.
- SubscriberGrpcClient::ModifyAckDeadline() — Method in class SubscriberGrpcClient
- Modifies the ack deadline for a specific message. This method is useful
to indicate that more time is needed to process a message by the
subscriber, or to make the message available for redelivery if the
processing was interrupted. Note that this does not modify the
subscription-level
ackDeadlineSeconds
used for subsequent messages. - SubscriberGrpcClient::ModifyPushConfig() — Method in class SubscriberGrpcClient
- Modifies the
PushConfig
for a specified subscription. - Mutation — Class in namespace Google\Spanner\V1
- 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.
- Mutation_Delete — Class in namespace Google\Spanner\V1
- Arguments to [delete][google.spanner.v1.Mutation.delete] operations.
- Mutation_Write — Class in namespace Google\Spanner\V1
- 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.
- $TransactionOptions — Property in class TransactionOptions
- Money — Class in namespace Google\Type
- Represents an amount of money with its currency type.
N
- $Parser — Property in class Parser
- Parser::next() — Method in class Parser
- $ParserSymbol — Property in class ParserSymbol
- NullValue — Class in namespace Google\Protobuf
NullValue
is a singleton enumeration to represent the null value for theValue
type union.
O
- $Distribution_BucketOptions — Property in class Distribution_BucketOptions
- OAuthRequirements — Class in namespace Google\Api
- 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.
- $Parser — Property in class Parser
- OperationsClient — Class in namespace Google\GAX\LongRunning
- Service Description: Manages long-running operations with an API service.
- OperationResponse — Class in namespace Google\GAX
- Response object from a long running API method.
- OperationResponse::operationSucceeded() — Method in class OperationResponse
- Check whether the operation completed successfully. If the operation is not complete, or if the operation failed, return false.
- OperationResponse::operationFailed() — Method in class OperationResponse
- Check whether the operation failed. If the operation is not complete, or if the operation succeeded, return false.
- Operation — Class in namespace Google\Longrunning
- This resource represents a long-running operation that is the result of a network API call.
- OperationsGrpcClient — Class in namespace Google\Longrunning
- Manages long-running operations with an API service.
- Option — Class in namespace Google\Protobuf
- A protocol buffer option, which can be attached to a message, field, enumeration, etc.
- $Mutation — Property in class Mutation
P
- $HttpRule — Property in class HttpRule
- Page — Class in namespace Google\Api
- Represents a documentation page. A page can contain subpages to represent nested documentation set structure.
- ProjectProperties — Class in namespace Google\Api
- 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.
- Property — Class in namespace Google\Api
- Defines project properties.
- Property_PropertyType — Class in namespace Google\Api
- Supported data type of the property values
- PartOfSpeech — Class in namespace Google\Cloud\Language\V1beta2
- Represents part of speech information for a token.
- PartOfSpeech_Aspect — Class in namespace Google\Cloud\Language\V1beta2
- The characteristic of a verb that expresses time flow during an event.
- PartOfSpeech_Case — Class in namespace Google\Cloud\Language\V1beta2
- 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.
- PartOfSpeech_Form — Class in namespace Google\Cloud\Language\V1beta2
- 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
- PartOfSpeech_Gender — Class in namespace Google\Cloud\Language\V1beta2
- Gender classes of nouns reflected in the behaviour of associated words.
- PartOfSpeech_Mood — Class in namespace Google\Cloud\Language\V1beta2
- The grammatical feature of verbs, used for showing modality and attitude.
- PartOfSpeech_Number — Class in namespace Google\Cloud\Language\V1beta2
- Count distinctions.
- PartOfSpeech_Person — Class in namespace Google\Cloud\Language\V1beta2
- The distinction between the speaker, second person, third person, etc.
- PartOfSpeech_Proper — Class in namespace Google\Cloud\Language\V1beta2
- This category shows if the token is part of a proper name.
- PartOfSpeech_Reciprocity — Class in namespace Google\Cloud\Language\V1beta2
- Reciprocal features of a pronoun.
- PartOfSpeech_Tag — Class in namespace Google\Cloud\Language\V1beta2
- The part of speech tags enum.
- PartOfSpeech_Tense — Class in namespace Google\Cloud\Language\V1beta2
- Time reference.
- PartOfSpeech_Voice — Class in namespace Google\Cloud\Language\V1beta2
- The relationship between the action that a verb expresses and the participants identified by its arguments.
- Page — Class in namespace Google\Cloud\Vision\V1
- Detected page from OCR.
- Paragraph — Class in namespace Google\Cloud\Vision\V1
- Structural unit of text representing a number of words in certain order.
- Position — Class in namespace Google\Cloud\Vision\V1
- A 3D position in the image, used primarily for Face detection landmarks.
- Property — Class in namespace Google\Cloud\Vision\V1
- A
Property
consists of a user-supplied name/value pair. - PatchTracesRequest — Class in namespace Google\Devtools\Cloudtrace\V1
- The request message for the
PatchTraces
method. - TraceServiceGrpcClient::PatchTraces() — Method in class TraceServiceGrpcClient
- Sends new traces to Stackdriver Trace or updates existing traces. If the ID of a trace that you send matches that of an existing trace, any fields in the existing trace and its spans are overwritten by the provided values, and any new fields provided are merged with the existing trace data. If the ID does not match, a new trace is created.
- Parser — Class in namespace Google\GAX\Jison
- $Parser — Property in class Parser
- Parser::parserPerformAction() — Method in class Parser
- Parser::parserLex() — Method in class Parser
- Parser::parseError() — Method in class Parser
- Parser::parse() — Method in class Parser
- Parser::pastInput() — Method in class Parser
- Parser::popState() — Method in class Parser
- ParserAction — Class in namespace Google\GAX\Jison
- ParserCachedAction — Class in namespace Google\GAX\Jison
- ParserError — Class in namespace Google\GAX\Jison
- ParserLocation — Class in namespace Google\GAX\Jison
- ParserProduction — Class in namespace Google\GAX\Jison
- ParserRange — Class in namespace Google\GAX\Jison
- ParserState — Class in namespace Google\GAX\Jison
- ParserSymbol — Class in namespace Google\GAX\Jison
- ParserValue — Class in namespace Google\GAX\Jison
- OperationResponse::pollUntilComplete() — Method in class OperationResponse
- Poll the server in a loop until the operation is complete.
- Page — Class in namespace Google\GAX
- A Page object wraps an API list method response and provides methods to retrieve additional pages using the page token.
- PageStreamingDescriptor — Class in namespace Google\GAX
- Holds the description information used for page streaming.
- PagedListResponse — Class in namespace Google\GAX
- Response object for paged results from a list API method
- Parser — Class in namespace Google\GAX
- Parser::parse() — Method in class Parser
- Returns an array of path template segments parsed from data.
- PathTemplate — Class in namespace Google\GAX
- MockBidiStreamingCall::popReceivedCalls() — Method in class MockBidiStreamingCall
- Return a list of calls made to write(), and clear $receivedFuncCalls.
- MockClientStreamingCall::popReceivedCalls() — Method in class MockClientStreamingCall
- Return a list of calls made to write(), and clear $receivedFuncCalls.
- MockStubTrait::popReceivedCalls() — Method in class MockStubTrait
- Return a list of calls made to _simpleRequest, and clear $receivedFuncCalls.
- MockStubTrait::popCallObjects() — Method in class MockStubTrait
- Policy — Class in namespace Google\Iam\V1
- Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.
- PolicyDelta — Class in namespace Google\Iam\V1
- The difference delta between two policies.
- $LogEntry — Property in class LogEntry
- Point — Class in namespace Google\Monitoring\V3
- A single data point in a time series.
- PublishRequest — Class in namespace Google\Pubsub\V1
- Request for the Publish method.
- PublishResponse — Class in namespace Google\Pubsub\V1
- Response for the
Publish
method. - PublisherGrpcClient — Class in namespace Google\Pubsub\V1
- The service that an application uses to manipulate topics, and to send messages to a topic.
- PublisherGrpcClient::Publish() — Method in class PublisherGrpcClient
- Adds one or more messages to the topic. Returns
NOT_FOUND
if the topic does not exist. The message payload must not be empty; it must contain either a non-empty data field, or at least one attribute. - PubsubMessage — Class in namespace Google\Pubsub\V1
- 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.
- PullRequest — Class in namespace Google\Pubsub\V1
- Request for the
Pull
method. - PullResponse — Class in namespace Google\Pubsub\V1
- Response for the
Pull
method. - PushConfig — Class in namespace Google\Pubsub\V1
- Configuration for a push delivery endpoint.
- SubscriberGrpcClient::Pull() — Method in class SubscriberGrpcClient
- Pulls messages from the server. Returns an empty list if there are no
messages available in the backlog. The server may return
UNAVAILABLE
if there are too many concurrent pull requests pending for the given subscription. - PartialResultSet — Class in namespace Google\Spanner\V1
- 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.
- PlanNode — Class in namespace Google\Spanner\V1
- Node information for nodes appearing in a [QueryPlan.plan_nodes][google.spanner.v1.QueryPlan.plan_nodes].
- PlanNode_ChildLink — Class in namespace Google\Spanner\V1
- Metadata associated with a parent-child relationship appearing in a [PlanNode][google.spanner.v1.PlanNode].
- PlanNode_Kind — Class in namespace Google\Spanner\V1
- The kind of [PlanNode][google.spanner.v1.PlanNode]. Distinguishes between the two different kinds of nodes that can appear in a query plan.
- PlanNode_ShortRepresentation — Class in namespace Google\Spanner\V1
- Condensed representation of a node and its subtree. Only present for
SCALAR
[PlanNode(s)][google.spanner.v1.PlanNode]. - PostalAddress — Class in namespace Google\Type
- Represents a postal address, e.g. for postal delivery or payments addresses.
Q
- Quota — Class in namespace Google\Api
- Quota configuration helps to achieve fairness and budgeting in service usage.
- QuotaLimit — Class in namespace Google\Api
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 aQuotaGroup
.- QueryTimeRange — Class in namespace Google\Devtools\Clouderrorreporting\V1beta1
- Requests might be rejected or the resulting timed count durations might be adjusted for lower durations.
- QueryTimeRange_Period — Class in namespace Google\Devtools\Clouderrorreporting\V1beta1
- The supported time ranges.
- QuotaFailure — Class in namespace Google\Rpc
- Describes how a quota check failed.
- QuotaFailure_Violation — Class in namespace Google\Rpc
- A message type used to describe a single quota violation. For example, a daily quota or a custom quota that was exceeded.
- QueryPlan — Class in namespace Google\Spanner\V1
- Contains an ordered list of nodes appearing in the query plan.
R
- RequestMetadata — Class in namespace Google\Cloud\Audit
- Metadata about the request.
- RecognitionAudio — Class in namespace Google\Cloud\Speech\V1
- Contains audio data in the encoding specified in the
RecognitionConfig
. - RecognitionConfig — Class in namespace Google\Cloud\Speech\V1
- Provides information to the recognizer that specifies how to process the request.
- RecognitionConfig_AudioEncoding — Class in namespace Google\Cloud\Speech\V1
- 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. - RecognizeRequest — Class in namespace Google\Cloud\Speech\V1
- The top-level message sent by the client for the
Recognize
method. - RecognizeResponse — Class in namespace Google\Cloud\Speech\V1
- The only message returned to the client by the
Recognize
method. It contains the result as zero or more sequentialSpeechRecognitionResult
messages. - SpeechGrpcClient::Recognize() — Method in class SpeechGrpcClient
- Performs synchronous speech recognition: receive results after all audio has been sent and processed.
- RecognitionAudio — Class in namespace Google\Cloud\Speech\V1beta1
- Contains audio data in the encoding specified in the
RecognitionConfig
. - RecognitionConfig — Class in namespace Google\Cloud\Speech\V1beta1
- Provides information to the recognizer that specifies how to process the request.
- RecognitionConfig_AudioEncoding — Class in namespace Google\Cloud\Speech\V1beta1
- 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. - ReportErrorEventRequest — Class in namespace Google\Devtools\Clouderrorreporting\V1beta1
- A request for reporting an individual error event.
- ReportErrorEventResponse — Class in namespace Google\Devtools\Clouderrorreporting\V1beta1
- Response for reporting an individual error event.
- ReportErrorsServiceGrpcClient — Class in namespace Google\Devtools\Clouderrorreporting\V1beta1
- An API for reporting error events.
- ReportErrorsServiceGrpcClient::ReportErrorEvent() — Method in class ReportErrorsServiceGrpcClient
- Report an individual error event.
- ReportedErrorEvent — Class in namespace Google\Devtools\Clouderrorreporting\V1beta1
- An error event which is reported to the Error Reporting system.
- BidiStream::read() — Method in class BidiStream
- Read the next response from the server. Returns null if the streaming call completed successfully. Throws an ApiException if the streaming call failed.
- ClientStream::readResponse() — Method in class ClientStream
- Read the response from the server, completing the streaming call.
- $LexerConditions — Property in class LexerConditions
- $Parser — Property in class Parser
- $Parser — Property in class Parser
- $Parser — Property in class Parser
- $ParserLocation — Property in class ParserLocation
- ParserLocation::Range() — Method in class ParserLocation
- Segment::resetBindingCount() — Method in class Segment
- Segment::resetSegmentCount() — Method in class Segment
- OperationResponse::reload() — Method in class OperationResponse
- Reload the status of the operation with a request to the service.
- PageStreamingDescriptor::requestHasPageSizeField() — Method in class PageStreamingDescriptor
- PathTemplate::render() — Method in class PathTemplate
- Renders a path template using the provided bindings.
- RetrySettings — Class in namespace Google\GAX
- Holds the parameters for retry and timeout logic with exponential backoff. Actual implementation of the logic is elsewhere.
- ServerStream::readAll() — Method in class ServerStream
- A generator which yields results from the server until the streaming call completes. Throws an ApiException if the streaming call failed.
- MockBidiStreamingCall::read() — Method in class MockBidiStreamingCall
- MockServerStreamingCall::responses() — Method in class MockServerStreamingCall
- ReceivedRequest — Class in namespace Google\GAX\Testing
- Class ReceivedRequest used to hold the function name and request object of a call make to a mock gRPC stub.
- $Operation — Property in class Operation
- ReceivedMessage — Class in namespace Google\Pubsub\V1
- A message and its corresponding acknowledgment ID.
- RequestInfo — Class in namespace Google\Rpc
- Contains metadata about the request that clients can attach when filing a bug or providing other forms of feedback.
- ResourceInfo — Class in namespace Google\Rpc
- Describes the resource that is being accessed.
- RetryInfo — Class in namespace Google\Rpc
- 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.
- ReadRequest — Class in namespace Google\Spanner\V1
- The request for [Read][google.spanner.v1.Spanner.Read] and [StreamingRead][google.spanner.v1.Spanner.StreamingRead].
- ResultSet — Class in namespace Google\Spanner\V1
- Results from [Read][google.spanner.v1.Spanner.Read] or [ExecuteSql][google.spanner.v1.Spanner.ExecuteSql].
- ResultSetMetadata — Class in namespace Google\Spanner\V1
- Metadata about a [ResultSet][google.spanner.v1.ResultSet] or [PartialResultSet][google.spanner.v1.PartialResultSet].
- ResultSetStats — Class in namespace Google\Spanner\V1
- Additional statistics about a [ResultSet][google.spanner.v1.ResultSet] or [PartialResultSet][google.spanner.v1.PartialResultSet].
- RollbackRequest — Class in namespace Google\Spanner\V1
- The request for [Rollback][google.spanner.v1.Spanner.Rollback].
- SpannerGrpcClient::Read() — Method in class SpannerGrpcClient
- Reads rows from the database using key lookups and scans, as a
simple key/value style alternative to
[ExecuteSql][google.spanner.v1.Spanner.ExecuteSql]. This method cannot be used to
return a result set larger than 10 MiB; if the read matches more
data than that, the read fails with a
FAILED_PRECONDITION
error. - SpannerGrpcClient::Rollback() — Method in class SpannerGrpcClient
- Rolls back a transaction, releasing any locks it holds. It is a good idea to call this for any transaction that includes one or more [Read][google.spanner.v1.Spanner.Read] or [ExecuteSql][google.spanner.v1.Spanner.ExecuteSql] requests and ultimately decides not to commit.
S
- Advice::setDescription() — Method in class Advice
- Useful description for why this advice was applied and what actions should be taken to mitigate any implied risks.
- AuthProvider::setId() — Method in class AuthProvider
- The unique identifier of the auth provider. It will be referred to by
AuthRequirement.provider_id
. - AuthProvider::setIssuer() — Method in class AuthProvider
- Identifies the principal that issued the JWT. See https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 Usually a URL or an email address.
- AuthProvider::setJwksUri() — Method in class AuthProvider
- URL of the provider's public key set to validate signature of the JWT. See OpenID Discovery.
- AuthProvider::setAudiences() — Method in class AuthProvider
- The list of JWT audiences.
- AuthRequirement::setProviderId() — Method in class AuthRequirement
- [id][google.api.AuthProvider.id] from authentication provider.
- AuthRequirement::setAudiences() — Method in class AuthRequirement
- NOTE: This will be deprecated soon, once AuthProvider.audiences is implemented and accepted in all the runtime components.
- Authentication::setRules() — Method in class Authentication
- A list of authentication rules that apply to individual API methods.
- Authentication::setProviders() — Method in class Authentication
- Defines a set of authentication providers that a service supports.
- AuthenticationRule::setSelector() — Method in class AuthenticationRule
- Selects the methods to which this rule applies.
- AuthenticationRule::setOauth() — Method in class AuthenticationRule
- The requirements for OAuth credentials.
- AuthenticationRule::setAllowWithoutCredential() — Method in class AuthenticationRule
- Whether to allow requests without a credential. The credential can be an OAuth token, Google cookies (first-party auth) or EndUserCreds.
- AuthenticationRule::setRequirements() — Method in class AuthenticationRule
- Requirements for additional authentication providers.
- AuthorizationConfig::setProvider() — Method in class AuthorizationConfig
- The name of the authorization provider, such as firebaserules.googleapis.com.
- Backend::setRules() — Method in class Backend
- A list of API backend rules that apply to individual API methods.
- BackendRule::setSelector() — Method in class BackendRule
- Selects the methods to which this rule applies.
- BackendRule::setAddress() — Method in class BackendRule
- The address of the API backend.
- BackendRule::setDeadline() — Method in class BackendRule
- The number of seconds to wait for a response from a request. The default depends on the deployment context.
- Billing::setMetrics() — Method in class Billing
- Names of the metrics to report to billing. Each name must be defined in [Service.metrics][google.api.Service.metrics] section.
- Billing::setRules() — Method in class Billing
- A list of billing status rules for configuring billing status check.
- BillingStatusRule::setSelector() — Method in class BillingStatusRule
- Selects the operation names to which this rule applies.
- BillingStatusRule::setAllowedStatuses() — Method in class BillingStatusRule
- Allowed billing statuses. The billing status check passes if the actual billing status matches any of the provided values here.
- ConfigChange::setElement() — Method in class ConfigChange
- Object hierarchy path to the change, with levels separated by a '.' character. For repeated fields, an applicable unique identifier field is used for the index (usually selector, name, or id). For maps, the term 'key' is used. If the field has no unique identifier, the numeric index is used.
- ConfigChange::setOldValue() — Method in class ConfigChange
- Value of the changed object in the old Service configuration, in JSON format. This field will not be populated if ChangeType == ADDED.
- ConfigChange::setNewValue() — Method in class ConfigChange
- Value of the changed object in the new Service configuration, in JSON format. This field will not be populated if ChangeType == REMOVED.
- ConfigChange::setChangeType() — Method in class ConfigChange
- The type for this change, either ADDED, REMOVED, or MODIFIED.
- ConfigChange::setAdvices() — Method in class ConfigChange
- Collection of advice provided for this change, useful for determining the possible impact of this change.
- Context::setRules() — Method in class Context
- A list of RPC context rules that apply to individual API methods.
- ContextRule::setSelector() — Method in class ContextRule
- Selects the methods to which this rule applies.
- ContextRule::setRequested() — Method in class ContextRule
- A list of full type names of requested contexts.
- ContextRule::setProvided() — Method in class ContextRule
- A list of full type names of provided contexts.
- Control::setEnvironment() — Method in class Control
- The service control environment to use. If empty, no control plane feature (like quota and billing) will be enabled.
- CustomHttpPattern::setKind() — Method in class CustomHttpPattern
- The name of this custom HTTP verb.
- CustomHttpPattern::setPath() — Method in class CustomHttpPattern
- The path matched by this custom verb.
- Distribution::setCount() — Method in class Distribution
- The number of values in the population. Must be non-negative.
- Distribution::setMean() — Method in class Distribution
- The arithmetic mean of the values in the population. If
count
is zero then this field must be zero. - Distribution::setSumOfSquaredDeviation() — Method in class Distribution
- The sum of squared deviations from the mean of the values in the population. For values x_i this is: Sum[i=1.
- Distribution::setRange() — Method in class Distribution
- If specified, contains the range of the population values. The field
must not be present if the
count
is zero. - Distribution::setBucketOptions() — Method in class Distribution
- Defines the histogram bucket boundaries.
- Distribution::setBucketCounts() — Method in class Distribution
- If
bucket_options
is given, then the sum of the values inbucket_counts
must equal the value incount
. Ifbucket_options
is not given, nobucket_counts
fields may be given. - Distribution_BucketOptions::setLinearBuckets() — Method in class Distribution_BucketOptions
- The linear bucket.
- Distribution_BucketOptions::setExponentialBuckets() — Method in class Distribution_BucketOptions
- The exponential buckets.
- Distribution_BucketOptions::setExplicitBuckets() — Method in class Distribution_BucketOptions
- The explicit buckets.
- Distribution_BucketOptions_Explicit::setBounds() — Method in class Distribution_BucketOptions_Explicit
- The values must be monotonically increasing.
- Distribution_BucketOptions_Exponential::setNumFiniteBuckets() — Method in class Distribution_BucketOptions_Exponential
- Must be greater than 0.
- Distribution_BucketOptions_Exponential::setGrowthFactor() — Method in class Distribution_BucketOptions_Exponential
- Must be greater than 1.
- Distribution_BucketOptions_Exponential::setScale() — Method in class Distribution_BucketOptions_Exponential
- Must be greater than 0.
- Distribution_BucketOptions_Linear::setNumFiniteBuckets() — Method in class Distribution_BucketOptions_Linear
- Must be greater than 0.
- Distribution_BucketOptions_Linear::setWidth() — Method in class Distribution_BucketOptions_Linear
- Must be greater than 0.
- Distribution_BucketOptions_Linear::setOffset() — Method in class Distribution_BucketOptions_Linear
- Lower bound of the first bucket.
- Distribution_Range::setMin() — Method in class Distribution_Range
- The minimum of the population values.
- Distribution_Range::setMax() — Method in class Distribution_Range
- The maximum of the population values.
- Documentation::setSummary() — Method in class Documentation
- A short summary of what the service does. Can only be provided by plain text.
- Documentation::setPages() — Method in class Documentation
- The top level pages for the documentation set.
- Documentation::setRules() — Method in class Documentation
- A list of documentation rules that apply to individual API elements.
- Documentation::setDocumentationRootUrl() — Method in class Documentation
- The URL to the root of documentation.
- Documentation::setOverview() — Method in class Documentation
- Declares a single overview page. For example:
<
pre>
documentation: summary: .
- DocumentationRule::setSelector() — Method in class DocumentationRule
- The selector is a comma-separated list of patterns. Each pattern is a qualified name of the element which may end in "*", indicating a wildcard.
- DocumentationRule::setDescription() — Method in class DocumentationRule
- Description of the selected API(s).
- DocumentationRule::setDeprecationDescription() — Method in class DocumentationRule
- Deprecation description of the selected element(s). It can be provided if an
element is marked as
deprecated
. - Endpoint::setName() — Method in class Endpoint
- The canonical name of this endpoint.
- Endpoint::setAliases() — Method in class Endpoint
- DEPRECATED: This field is no longer supported. Instead of using aliases, please specify multiple [google.api.Endpoint][google.api.Endpoint] for each of the intented alias.
- Endpoint::setApis() — Method in class Endpoint
- The list of APIs served by this endpoint.
- Endpoint::setFeatures() — Method in class Endpoint
- The list of features enabled on this endpoint.
- Endpoint::setTarget() — Method in class Endpoint
- The specification of an Internet routable address of API frontend that will handle requests to this API Endpoint.
- Endpoint::setAllowCors() — Method in class Endpoint
- Allowing CORS, aka cross-domain traffic, would allow the backends served from this endpoint to receive and respond to HTTP OPTIONS requests. The response will be used by the browser to determine whether the subsequent cross-origin request is allowed to proceed.
- Experimental::setAuthorization() — Method in class Experimental
- Authorization configuration.
- Http::setRules() — Method in class Http
- A list of HTTP configuration rules that apply to individual API methods.
- HttpBody::setContentType() — Method in class HttpBody
- The HTTP Content-Type string representing the content type of the body.
- HttpBody::setData() — Method in class HttpBody
- HTTP body binary data.
- HttpRule::setSelector() — Method in class HttpRule
- Selects methods to which this rule applies.
- HttpRule::setGet() — Method in class HttpRule
- Used for listing and getting information about resources.
- HttpRule::setPut() — Method in class HttpRule
- Used for updating a resource.
- HttpRule::setPost() — Method in class HttpRule
- Used for creating a resource.
- HttpRule::setDelete() — Method in class HttpRule
- Used for deleting a resource.
- HttpRule::setPatch() — Method in class HttpRule
- Used for updating a resource.
- HttpRule::setCustom() — Method in class HttpRule
- Custom pattern is used for defining custom verbs.
- HttpRule::setBody() — Method in class HttpRule
- The name of the request field whose value is mapped to the HTTP body, or
*
for mapping all fields not captured by the path pattern to the HTTP body. NOTE: the referred field must not be a repeated field and must be present at the top-level of request message type. - HttpRule::setAdditionalBindings() — Method in class HttpRule
- Additional HTTP bindings for the selector. Nested bindings must
not contain an
additional_bindings
field themselves (that is, the nesting may only be one level deep). - LabelDescriptor::setKey() — Method in class LabelDescriptor
- The label key.
- LabelDescriptor::setValueType() — Method in class LabelDescriptor
- The type of data that can be assigned to the label.
- LabelDescriptor::setDescription() — Method in class LabelDescriptor
- A human-readable description for the label.
- LogDescriptor::setName() — Method in class LogDescriptor
- The name of the log. It must be less than 512 characters long and can include the following characters: upper- and lower-case alphanumeric characters [A-Za-z0-9], and punctuation characters including slash, underscore, hyphen, period [/_-.].
- LogDescriptor::setLabels() — Method in class LogDescriptor
- The set of labels that are available to describe a specific log entry.
- LogDescriptor::setDescription() — Method in class LogDescriptor
- A human-readable description of this log. This information appears in the documentation and can contain details.
- LogDescriptor::setDisplayName() — Method in class LogDescriptor
- The human-readable name for this log. This information appears on the user interface and should be concise.
- Logging::setProducerDestinations() — Method in class Logging
- Logging configurations for sending logs to the producer project.
- Logging::setConsumerDestinations() — Method in class Logging
- Logging configurations for sending logs to the consumer project.
- Logging_LoggingDestination::setMonitoredResource() — Method in class Logging_LoggingDestination
- The monitored resource type. The type must be defined in the [Service.monitored_resources][google.api.Service.monitored_resources] section.
- Logging_LoggingDestination::setLogs() — Method in class Logging_LoggingDestination
- Names of the logs to be sent to this destination. Each name must be defined in the [Service.logs][google.api.Service.logs] section. If the log name is not a domain scoped name, it will be automatically prefixed with the service name followed by "/".
- Metric::setType() — Method in class Metric
- An existing metric type, see [google.api.MetricDescriptor][google.api.MetricDescriptor].
- Metric::setLabels() — Method in class Metric
- The set of label values that uniquely identify this metric. All
labels listed in the
MetricDescriptor
must be assigned values. - MetricDescriptor::setName() — Method in class MetricDescriptor
- The resource name of the metric descriptor. Depending on the
implementation, the name typically includes: (1) the parent resource name
that defines the scope of the metric type or of its data; and (2) the
metric's URL-encoded type, which also appears in the
type
field of this descriptor. For example, following is the resource name of a custom metric within the GCP projectmy-project-id
: "projects/my-project-id/metricDescriptors/custom.googleapis.com%2Finvoice%2Fpaid%2Famount" - MetricDescriptor::setType() — Method in class MetricDescriptor
- The metric type, including its DNS name prefix. The type is not
URL-encoded. All user-defined custom metric types have the DNS name
custom.googleapis.com
. Metric types should use a natural hierarchical grouping. For example: "custom.googleapis.com/invoice/paid/amount" "appengine.googleapis.com/http/server/response_latencies" - MetricDescriptor::setLabels() — Method in class MetricDescriptor
- The set of labels that can be used to describe a specific
instance of this metric type. For example, the
appengine.googleapis.com/http/server/response_latencies
metric type has a label for the HTTP response code,response_code
, so you can look at latencies for successful responses or just for responses that failed. - MetricDescriptor::setMetricKind() — Method in class MetricDescriptor
- Whether the metric records instantaneous values, changes to a value, etc.
- MetricDescriptor::setValueType() — Method in class MetricDescriptor
- Whether the measurement is an integer, a floating-point number, etc.
- MetricDescriptor::setUnit() — Method in class MetricDescriptor
- The unit in which the metric value is reported. It is only applicable
if the
value_type
isINT64
,DOUBLE
, orDISTRIBUTION
. The supported units are a subset of The Unified Code for Units of Measure standard: Basic units (UNIT) *bit
bit *By
byte *s
second *min
minute *h
hour *d
day Prefixes (PREFIX) *k
kilo (103) *M
mega (106) *G
giga (109) *T
tera (1012) *P
peta (1015) *E
exa (1018) *Z
zetta (1021) *Y
yotta (1024) *m
milli (10-3) *u
micro (10-6) *n
nano (10-9) *p
pico (10-12) *f
femto (10-15) *a
atto (10-18) *z
zepto (10-21) *y
yocto (10-24) *Ki
kibi (210) *Mi
mebi (220) *Gi
gibi (230) *Ti
tebi (240) Grammar The grammar includes the dimensionless unit1
, such as1/s
. - MetricDescriptor::setDescription() — Method in class MetricDescriptor
- A detailed description of the metric, which can be used in documentation.
- MetricDescriptor::setDisplayName() — Method in class MetricDescriptor
- A concise name for the metric, which can be displayed in user interfaces.
- MetricRule::setSelector() — Method in class MetricRule
- Selects the methods to which this rule applies.
- MetricRule::setMetricCosts() — Method in class MetricRule
- Metrics to update when the selected methods are called, and the associated cost applied to each metric.
- MonitoredResource::setType() — Method in class MonitoredResource
- Required. The monitored resource type. This field must match
the
type
field of a [MonitoredResourceDescriptor][google.api.MonitoredResourceDescriptor] object. For example, the type of a Cloud SQL database is"cloudsql_database"
. - MonitoredResource::setLabels() — Method in class MonitoredResource
- Required. Values for all of the labels listed in the associated monitored
resource descriptor. For example, Cloud SQL databases use the labels
"database_id"
and"zone"
. - MonitoredResourceDescriptor::setName() — Method in class MonitoredResourceDescriptor
- Optional. The resource name of the monitored resource descriptor:
"projects/{project_id}/monitoredResourceDescriptors/{type}"
where {type} is the value of thetype
field in this object and {project_id} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format"monitoredResourceDescriptors/{type}"
. - MonitoredResourceDescriptor::setType() — Method in class MonitoredResourceDescriptor
- Required. The monitored resource type. For example, the type
"cloudsql_database"
represents databases in Google Cloud SQL. - MonitoredResourceDescriptor::setDisplayName() — Method in class MonitoredResourceDescriptor
- Optional. A concise name for the monitored resource type that might be
displayed in user interfaces. It should be a Title Cased Noun Phrase,
without any article or other determiners. For example,
"Google Cloud SQL Database"
. - MonitoredResourceDescriptor::setDescription() — Method in class MonitoredResourceDescriptor
- Optional. A detailed description of the monitored resource type that might be used in documentation.
- MonitoredResourceDescriptor::setLabels() — Method in class MonitoredResourceDescriptor
- Required. A set of labels used to describe instances of this monitored
resource type. For example, an individual Google Cloud SQL database is
identified by values for the labels
"database_id"
and"zone"
. - Monitoring::setProducerDestinations() — Method in class Monitoring
- Monitoring configurations for sending metrics to the producer project.
- Monitoring::setConsumerDestinations() — Method in class Monitoring
- Monitoring configurations for sending metrics to the consumer project.
- Monitoring_MonitoringDestination::setMonitoredResource() — Method in class Monitoring_MonitoringDestination
- The monitored resource type. The type must be defined in [Service.monitored_resources][google.api.Service.monitored_resources] section.
- Monitoring_MonitoringDestination::setMetrics() — Method in class Monitoring_MonitoringDestination
- Names of the metrics to report to this monitoring destination.
- OAuthRequirements::setCanonicalScopes() — Method in class OAuthRequirements
- The list of publicly documented OAuth scopes that are allowed access. An OAuth token containing any of these scopes will be accepted.
- Page::setName() — Method in class Page
- The name of the page. It will be used as an identity of the page to
generate URI of the page, text of the link to this page in navigation,
etc. The full page name (start from the root page name to this page
concatenated with
.
) can be used as reference to the page in your documentation. For example:pages: - name: Tutorial content: (== include tutorial.md ==) subpages: - name: Java content: (== include tutorial_java.md ==)
You can reference
Java
page using Markdown reference link syntax:[Java][Tutorial.Java]
. - Page::setContent() — Method in class Page
- The Markdown content of the page. You can use
(== include {path} ==)
to include content from a Markdown file. - Page::setSubpages() — Method in class Page
- Subpages of this page. The order of subpages specified here will be honored in the generated docset.
- ProjectProperties::setProperties() — Method in class ProjectProperties
- List of per consumer project-specific properties.
- Property::setName() — Method in class Property
- The name of the property (a.k.a key).
- Property::setType() — Method in class Property
- The type of this property.
- Property::setDescription() — Method in class Property
- The description of the property
- Quota::setLimits() — Method in class Quota
- List of
QuotaLimit
definitions for the service. - Quota::setMetricRules() — Method in class Quota
- List of
MetricRule
definitions, each one mapping a selected method to one or more metrics. - QuotaLimit::setName() — Method in class QuotaLimit
- Name of the quota limit. The name is used to refer to the limit when overriding the default limit on per-consumer basis.
- QuotaLimit::setDescription() — Method in class QuotaLimit
- Optional. User-visible, extended description for this quota limit.
- QuotaLimit::setDefaultLimit() — Method in class QuotaLimit
- Default number of tokens that can be consumed during the specified duration. This is the number of tokens assigned when a client application developer activates the service for his/her project.
- QuotaLimit::setMaxLimit() — Method in class QuotaLimit
- Maximum number of tokens that can be consumed during the specified duration. Client application developers can override the default limit up to this maximum. If specified, this value cannot be set to a value less than the default limit. If not specified, it is set to the default limit.
- QuotaLimit::setFreeTier() — Method in class QuotaLimit
- Free tier value displayed in the Developers Console for this limit.
- QuotaLimit::setDuration() — Method in class QuotaLimit
- Duration of this limit in textual notation. Example: "100s", "24h", "1d".
- QuotaLimit::setMetric() — Method in class QuotaLimit
- The name of the metric this quota limit applies to. The quota limits with the same metric will be checked together during runtime. The metric must be defined within the service config.
- QuotaLimit::setUnit() — Method in class QuotaLimit
- Specify the unit of the quota limit. It uses the same syntax as [Metric.unit][]. The supported unit kinds are determined by the quota backend system.
- QuotaLimit::setValues() — Method in class QuotaLimit
- Tiered limit values. Also allows for regional or zone overrides for these values if "/{region}" or "/{zone}" is specified in the unit field.
- QuotaLimit::setDisplayName() — Method in class QuotaLimit
- User-visible display name for this limit.
- Service — Class in namespace Google\Api
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.- Service::setConfigVersion() — Method in class Service
- The version of the service configuration. The config version may
influence interpretation of the configuration, for example, to
determine defaults. This is documented together with applicable
options. The current default for the config version itself is
3
. - Service::setName() — Method in class Service
- The DNS address at which this service is available,
e.g.
calendar.googleapis.com
. - Service::setId() — Method in class Service
- A unique ID for a specific instance of this message, typically assigned by the client for tracking purpose. If empty, the server may choose to generate one instead.
- Service::setTitle() — Method in class Service
- The product title associated with this service.
- Service::setProducerProjectId() — Method in class Service
- The id of the Google developer project that owns the service.
- Service::setApis() — Method in class Service
- A list of API interfaces exported by this service. Only the
name
field of the [google.protobuf.Api][google.protobuf.Api] needs to be provided by the configuration author, as the remaining fields will be derived from the IDL during the normalization process. It is an error to specify an API interface here which cannot be resolved against the associated IDL files. - Service::setTypes() — Method in class Service
- A list of all proto message types included in this API service.
- Service::setEnums() — Method in class Service
- A list of all enum types included in this API service. Enums
referenced directly or indirectly by the
apis
are automatically included. Enums which are not referenced but shall be included should be listed here by name. Example: enums: - name: google.someapi.v1.SomeEnum - Service::setDocumentation() — Method in class Service
- Additional API documentation.
- Service::setBackend() — Method in class Service
- API backend configuration.
- Service::setHttp() — Method in class Service
- HTTP configuration.
- Service::setQuota() — Method in class Service
- Quota configuration.
- Service::setAuthentication() — Method in class Service
- Auth configuration.
- Service::setContext() — Method in class Service
- Context configuration.
- Service::setUsage() — Method in class Service
- Configuration controlling usage of this service.
- Service::setEndpoints() — Method in class Service
- Configuration for network endpoints. If this is empty, then an endpoint with the same name as the service is automatically generated to service all defined APIs.
- Service::setControl() — Method in class Service
- Configuration for the service control plane.
- Service::setLogs() — Method in class Service
- Defines the logs used by this service.
- Service::setMetrics() — Method in class Service
- Defines the metrics used by this service.
- Service::setMonitoredResources() — Method in class Service
- Defines the monitored resources used by this service. This is required by the [Service.monitoring][google.api.Service.monitoring] and [Service.logging][google.api.Service.logging] configurations.
- Service::setLogging() — Method in class Service
- Logging configuration.
- Service::setMonitoring() — Method in class Service
- Monitoring configuration.
- Service::setSystemParameters() — Method in class Service
- System parameter configuration.
- Service::setSourceInfo() — Method in class Service
- Output only. The source information for this configuration if available.
- Service::setExperimental() — Method in class Service
- Experimental configuration.
- SourceInfo — Class in namespace Google\Api
- Source information used to create a Service Config
- SourceInfo::setSourceFiles() — Method in class SourceInfo
- All files used during config generation.
- SystemParameter — Class in namespace Google\Api
- 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.
- SystemParameter::setName() — Method in class SystemParameter
- Define the name of the parameter, such as "api_key" . It is case sensitive.
- SystemParameter::setHttpHeader() — Method in class SystemParameter
- Define the HTTP header name to use for the parameter. It is case insensitive.
- SystemParameter::setUrlQueryParameter() — Method in class SystemParameter
- Define the URL query parameter name to use for the parameter. It is case sensitive.
- SystemParameterRule — Class in namespace Google\Api
- Define a system parameter rule mapping system parameter definitions to methods.
- SystemParameterRule::setSelector() — Method in class SystemParameterRule
- Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs.
- SystemParameterRule::setParameters() — Method in class SystemParameterRule
- Define parameters. Multiple names may be defined for a parameter.
- SystemParameters — Class in namespace Google\Api
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.
- SystemParameters::setRules() — Method in class SystemParameters
- Define system parameters.
- Usage::setRequirements() — Method in class Usage
- Requirements that must be satisfied before a consumer project can use the
service. Each requirement is of the form <service.name>/
; for example 'serviceusage.googleapis.com/billing-enabled'. - Usage::setRules() — Method in class Usage
- A list of usage rules that apply to individual API methods.
- Usage::setProducerNotificationChannel() — Method in class Usage
- The full resource name of a channel used for sending notifications to the service producer.
- UsageRule::setSelector() — Method in class UsageRule
- Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs.
- UsageRule::setAllowUnregisteredCalls() — Method in class UsageRule
- True, if the method allows unregistered calls; false otherwise.
- UsageRule::setSkipServiceControl() — Method in class UsageRule
- True, if the method should skip service control. If so, no control plane feature (like quota and billing) will be enabled.
- AuditLog::setServiceName() — Method in class AuditLog
- The name of the API service performing the operation. For example,
"datastore.googleapis.com"
. - AuditLog::setMethodName() — Method in class AuditLog
- The name of the service method or operation.
- AuditLog::setResourceName() — Method in class AuditLog
- The resource or collection that is the target of the operation.
- AuditLog::setNumResponseItems() — Method in class AuditLog
- The number of items returned from a List or Query API method, if applicable.
- AuditLog::setStatus() — Method in class AuditLog
- The status of the overall operation.
- AuditLog::setAuthenticationInfo() — Method in class AuditLog
- Authentication information.
- AuditLog::setAuthorizationInfo() — Method in class AuditLog
- Authorization information. If there are multiple resources or permissions involved, then there is one AuthorizationInfo element for each {resource, permission} tuple.
- AuditLog::setRequestMetadata() — Method in class AuditLog
- Metadata about the operation.
- AuditLog::setRequest() — Method in class AuditLog
- The operation request. This may not include all request parameters, such as those that are too large, privacy-sensitive, or duplicated elsewhere in the log record.
- AuditLog::setResponse() — Method in class AuditLog
- The operation response. This may not include all response elements, such as those that are too large, privacy-sensitive, or duplicated elsewhere in the log record.
- AuditLog::setServiceData() — Method in class AuditLog
- Other service-specific data about the request, response, and other activities.
- AuthenticationInfo::setPrincipalEmail() — Method in class AuthenticationInfo
- The email address of the authenticated user making the request.
- AuthorizationInfo::setResource() — Method in class AuthorizationInfo
- The resource being accessed, as a REST-style string. For example: bigquery.googlapis.com/projects/PROJECTID/datasets/DATASETID
- AuthorizationInfo::setPermission() — Method in class AuthorizationInfo
- The required IAM permission.
- AuthorizationInfo::setGranted() — Method in class AuthorizationInfo
- Whether or not authorization for
resource
andpermission
was granted. - RequestMetadata::setCallerIp() — Method in class RequestMetadata
- The IP address of the caller.
- RequestMetadata::setCallerSuppliedUserAgent() — Method in class RequestMetadata
- The user agent of the caller.
- AnalyzeEntitiesRequest::setDocument() — Method in class AnalyzeEntitiesRequest
- Input document.
- AnalyzeEntitiesRequest::setEncodingType() — Method in class AnalyzeEntitiesRequest
- The encoding type used by the API to calculate offsets.
- AnalyzeEntitiesResponse::setEntities() — Method in class AnalyzeEntitiesResponse
- The recognized entities in the input document.
- AnalyzeEntitiesResponse::setLanguage() — Method in class AnalyzeEntitiesResponse
- The language of the text, which will be the same as the language specified in the request or, if not specified, the automatically-detected language.
- AnalyzeEntitySentimentRequest::setDocument() — Method in class AnalyzeEntitySentimentRequest
- Input document.
- AnalyzeEntitySentimentRequest::setEncodingType() — Method in class AnalyzeEntitySentimentRequest
- The encoding type used by the API to calculate offsets.
- AnalyzeEntitySentimentResponse::setEntities() — Method in class AnalyzeEntitySentimentResponse
- The recognized entities in the input document with associated sentiments.
- AnalyzeEntitySentimentResponse::setLanguage() — Method in class AnalyzeEntitySentimentResponse
- The language of the text, which will be the same as the language specified in the request or, if not specified, the automatically-detected language.
- AnalyzeSentimentRequest::setDocument() — Method in class AnalyzeSentimentRequest
- Input document.
- AnalyzeSentimentRequest::setEncodingType() — Method in class AnalyzeSentimentRequest
- The encoding type used by the API to calculate sentence offsets for the sentence sentiment.
- AnalyzeSentimentResponse::setDocumentSentiment() — Method in class AnalyzeSentimentResponse
- The overall sentiment of the input document.
- AnalyzeSentimentResponse::setLanguage() — Method in class AnalyzeSentimentResponse
- The language of the text, which will be the same as the language specified in the request or, if not specified, the automatically-detected language.
- AnalyzeSentimentResponse::setSentences() — Method in class AnalyzeSentimentResponse
- The sentiment for all the sentences in the document.
- AnalyzeSyntaxRequest::setDocument() — Method in class AnalyzeSyntaxRequest
- Input document.
- AnalyzeSyntaxRequest::setEncodingType() — Method in class AnalyzeSyntaxRequest
- The encoding type used by the API to calculate offsets.
- AnalyzeSyntaxResponse::setSentences() — Method in class AnalyzeSyntaxResponse
- Sentences in the input document.
- AnalyzeSyntaxResponse::setTokens() — Method in class AnalyzeSyntaxResponse
- Tokens, along with their syntactic information, in the input document.
- AnalyzeSyntaxResponse::setLanguage() — Method in class AnalyzeSyntaxResponse
- The language of the text, which will be the same as the language specified in the request or, if not specified, the automatically-detected language.
- AnnotateTextRequest::setDocument() — Method in class AnnotateTextRequest
- Input document.
- AnnotateTextRequest::setFeatures() — Method in class AnnotateTextRequest
- The enabled features.
- AnnotateTextRequest::setEncodingType() — Method in class AnnotateTextRequest
- The encoding type used by the API to calculate offsets.
- AnnotateTextRequest_Features::setExtractSyntax() — Method in class AnnotateTextRequest_Features
- Extract syntax information.
- AnnotateTextRequest_Features::setExtractEntities() — Method in class AnnotateTextRequest_Features
- Extract entities.
- AnnotateTextRequest_Features::setExtractDocumentSentiment() — Method in class AnnotateTextRequest_Features
- Extract document-level sentiment.
- AnnotateTextRequest_Features::setExtractEntitySentiment() — Method in class AnnotateTextRequest_Features
- Extract entities and their associated sentiment.
- AnnotateTextResponse::setSentences() — Method in class AnnotateTextResponse
- Sentences in the input document. Populated if the user enables [AnnotateTextRequest.Features.extract_syntax][google.cloud.language.v1beta2.AnnotateTextRequest.Features.extract_syntax].
- AnnotateTextResponse::setTokens() — Method in class AnnotateTextResponse
- Tokens, along with their syntactic information, in the input document.
- AnnotateTextResponse::setEntities() — Method in class AnnotateTextResponse
- Entities, along with their semantic information, in the input document.
- AnnotateTextResponse::setDocumentSentiment() — Method in class AnnotateTextResponse
- The overall sentiment for the document. Populated if the user enables [AnnotateTextRequest.Features.extract_document_sentiment][google.cloud.language.v1beta2.AnnotateTextRequest.Features.extract_document_sentiment].
- AnnotateTextResponse::setLanguage() — Method in class AnnotateTextResponse
- The language of the text, which will be the same as the language specified in the request or, if not specified, the automatically-detected language.
- DependencyEdge::setHeadTokenIndex() — Method in class DependencyEdge
- Represents the head of this token in the dependency tree.
- DependencyEdge::setLabel() — Method in class DependencyEdge
- The parse label for the token.
- $Document — Property in class Document
- Document::setType() — Method in class Document
- Required. If the type is not set or is
TYPE_UNSPECIFIED
, returns anINVALID_ARGUMENT
error. - Document::setContent() — Method in class Document
- The content of the input in string format.
- Document::setGcsContentUri() — Method in class Document
- The Google Cloud Storage URI where the file content is located.
- Document::setLanguage() — Method in class Document
- The language of the document (if not specified, the language is
automatically detected). Both ISO and BCP-47 language codes are
accepted.
Language Support lists currently supported languages for each API method. - Entity::setName() — Method in class Entity
- The representative name for the entity.
- Entity::setType() — Method in class Entity
- The entity type.
- Entity::setMetadata() — Method in class Entity
- Metadata associated with the entity.
- Entity::setSalience() — Method in class Entity
- The salience score associated with the entity in the [0, 1.0] range.
- Entity::setMentions() — Method in class Entity
- The mentions of this entity in the input document. The API currently supports proper noun mentions.
- Entity::setSentiment() — Method in class Entity
- For calls to [AnalyzeEntitySentiment][] or if [AnnotateTextRequest.Features.extract_entity_sentiment][google.cloud.language.v1beta2.AnnotateTextRequest.Features.extract_entity_sentiment] is set to true, this field will contain the aggregate sentiment expressed for this entity in the provided document.
- EntityMention::setText() — Method in class EntityMention
- The mention text.
- EntityMention::setType() — Method in class EntityMention
- The type of the entity mention.
- EntityMention::setSentiment() — Method in class EntityMention
- For calls to [AnalyzeEntitySentiment][] or if [AnnotateTextRequest.Features.extract_entity_sentiment][google.cloud.language.v1beta2.AnnotateTextRequest.Features.extract_entity_sentiment] is set to true, this field will contain the sentiment expressed for this mention of the entity in the provided document.
- PartOfSpeech::setTag() — Method in class PartOfSpeech
- The part of speech tag.
- PartOfSpeech::setAspect() — Method in class PartOfSpeech
- The grammatical aspect.
- PartOfSpeech::setCase() — Method in class PartOfSpeech
- The grammatical case.
- PartOfSpeech::setForm() — Method in class PartOfSpeech
- The grammatical form.
- PartOfSpeech::setGender() — Method in class PartOfSpeech
- The grammatical gender.
- PartOfSpeech::setMood() — Method in class PartOfSpeech
- The grammatical mood.
- PartOfSpeech::setNumber() — Method in class PartOfSpeech
- The grammatical number.
- PartOfSpeech::setPerson() — Method in class PartOfSpeech
- The grammatical person.
- PartOfSpeech::setProper() — Method in class PartOfSpeech
- The grammatical properness.
- PartOfSpeech::setReciprocity() — Method in class PartOfSpeech
- The grammatical reciprocity.
- PartOfSpeech::setTense() — Method in class PartOfSpeech
- The grammatical tense.
- PartOfSpeech::setVoice() — Method in class PartOfSpeech
- The grammatical voice.
- Sentence — Class in namespace Google\Cloud\Language\V1beta2
- Represents a sentence in the input document.
- Sentence::setText() — Method in class Sentence
- The sentence text.
- Sentence::setSentiment() — Method in class Sentence
- For calls to [AnalyzeSentiment][] or if [AnnotateTextRequest.Features.extract_document_sentiment][google.cloud.language.v1beta2.AnnotateTextRequest.Features.extract_document_sentiment] is set to true, this field will contain the sentiment for the sentence.
- Sentiment — Class in namespace Google\Cloud\Language\V1beta2
- Represents the feeling associated with the entire text or entities in the text.
- Sentiment::setMagnitude() — Method in class Sentiment
- A non-negative number in the [0, +inf) range, which represents the absolute magnitude of sentiment regardless of score (positive or negative).
- Sentiment::setScore() — Method in class Sentiment
- Sentiment score between -1.0 (negative sentiment) and 1.0 (positive sentiment).
- TextSpan::setContent() — Method in class TextSpan
- The content of the output text.
- TextSpan::setBeginOffset() — Method in class TextSpan
- The API calculates the beginning offset of the content in the original document according to the [EncodingType][google.cloud.language.v1beta2.EncodingType] specified in the API request.
- Token::setText() — Method in class Token
- The token text.
- Token::setPartOfSpeech() — Method in class Token
- Parts of speech tag for this token.
- Token::setDependencyEdge() — Method in class Token
- Dependency tree parse for this token.
- Token::setLemma() — Method in class Token
- Lemma of the token.
- LongRunningRecognizeMetadata::setProgressPercent() — Method in class LongRunningRecognizeMetadata
- Approximate percentage of audio processed thus far. Guaranteed to be 100 when the audio is fully processed and the results are available.
- LongRunningRecognizeMetadata::setStartTime() — Method in class LongRunningRecognizeMetadata
- Time when the request was received.
- LongRunningRecognizeMetadata::setLastUpdateTime() — Method in class LongRunningRecognizeMetadata
- Time of the most recent processing update.
- LongRunningRecognizeRequest::setConfig() — Method in class LongRunningRecognizeRequest
- Required Provides information to the recognizer that specifies how to process the request.
- LongRunningRecognizeRequest::setAudio() — Method in class LongRunningRecognizeRequest
- Required The audio data to be recognized.
- LongRunningRecognizeResponse::setResults() — Method in class LongRunningRecognizeResponse
- Output-only Sequential list of transcription results corresponding to sequential portions of audio.
- RecognitionAudio::setContent() — Method in class RecognitionAudio
- The audio data bytes encoded as specified in
RecognitionConfig
. Note: as with all bytes fields, protobuffers use a pure binary representation, whereas JSON representations use base64. - RecognitionAudio::setUri() — Method in class RecognitionAudio
- URI that points to a file that contains audio data bytes as specified in
RecognitionConfig
. Currently, only Google Cloud Storage URIs are supported, which must be specified in the following format:gs://bucket_name/object_name
(other URI formats return [google.rpc.Code.INVALID_ARGUMENT][]). For more information, see Request URIs. - RecognitionConfig::setEncoding() — Method in class RecognitionConfig
- Required Encoding of audio data sent in all
RecognitionAudio
messages. - RecognitionConfig::setSampleRateHertz() — Method in class RecognitionConfig
- Required Sample rate in Hertz of the audio data sent in all
RecognitionAudio
messages. Valid values are: 8000-48000. - RecognitionConfig::setLanguageCode() — Method in class RecognitionConfig
- Required The language of the supplied audio as a BCP-47 language tag.
- RecognitionConfig::setMaxAlternatives() — Method in class RecognitionConfig
- Optional Maximum number of recognition hypotheses to be returned.
- RecognitionConfig::setProfanityFilter() — Method in class RecognitionConfig
- Optional If set to
true
, the server will attempt to filter out profanities, replacing all but the initial character in each filtered word with asterisks, e.g. "f***". If set tofalse
or omitted, profanities won't be filtered out. - RecognitionConfig::setSpeechContexts() — Method in class RecognitionConfig
- Optional A means to provide context to assist the speech recognition.
- RecognizeRequest::setConfig() — Method in class RecognizeRequest
- Required Provides information to the recognizer that specifies how to process the request.
- RecognizeRequest::setAudio() — Method in class RecognizeRequest
- Required The audio data to be recognized.
- RecognizeResponse::setResults() — Method in class RecognizeResponse
- Output-only Sequential list of transcription results corresponding to sequential portions of audio.
- SpeechContext — Class in namespace Google\Cloud\Speech\V1
- Provides "hints" to the speech recognizer to favor specific words and phrases in the results.
- SpeechContext::setPhrases() — Method in class SpeechContext
- Optional A list of strings containing words and phrases "hints" so that the speech recognition is more likely to recognize them. This can be used to improve the accuracy for specific words and phrases, for example, if specific commands are typically spoken by the user. This can also be used to add additional words to the vocabulary of the recognizer. See usage limits.
- SpeechGrpcClient — Class in namespace Google\Cloud\Speech\V1
- Service that implements Google Cloud Speech API.
- SpeechGrpcClient::StreamingRecognize() — Method in class SpeechGrpcClient
- Performs bidirectional streaming speech recognition: receive results while sending audio. This method is only available via the gRPC API (not REST).
- SpeechRecognitionAlternative — Class in namespace Google\Cloud\Speech\V1
- Alternative hypotheses (a.k.a. n-best list).
- SpeechRecognitionAlternative::setTranscript() — Method in class SpeechRecognitionAlternative
- Output-only Transcript text representing the words that the user spoke.
- SpeechRecognitionAlternative::setConfidence() — Method in class SpeechRecognitionAlternative
- Output-only The confidence estimate between 0.0 and 1.0. A higher number
indicates an estimated greater likelihood that the recognized words are
correct. This field is typically provided only for the top hypothesis, and
only for
is_final=true
results. Clients should not rely on theconfidence
field as it is not guaranteed to be accurate, or even set, in any of the results. - SpeechRecognitionResult — Class in namespace Google\Cloud\Speech\V1
- A speech recognition result corresponding to a portion of the audio.
- SpeechRecognitionResult::setAlternatives() — Method in class SpeechRecognitionResult
- Output-only May contain one or more recognition hypotheses (up to the
maximum specified in
max_alternatives
). - StreamingRecognitionConfig — Class in namespace Google\Cloud\Speech\V1
- Provides information to the recognizer that specifies how to process the request.
- StreamingRecognitionConfig::setConfig() — Method in class StreamingRecognitionConfig
- Required Provides information to the recognizer that specifies how to process the request.
- StreamingRecognitionConfig::setSingleUtterance() — Method in class StreamingRecognitionConfig
- Optional If
false
or omitted, the recognizer will perform continuous recognition (continuing to wait for and process audio even if the user pauses speaking) until the client closes the input stream (gRPC API) or until the maximum time limit has been reached. May return multipleStreamingRecognitionResult
s with theis_final
flag set totrue
. - StreamingRecognitionConfig::setInterimResults() — Method in class StreamingRecognitionConfig
- Optional If
true
, interim results (tentative hypotheses) may be returned as they become available (these interim results are indicated with theis_final=false
flag). - StreamingRecognitionResult — Class in namespace Google\Cloud\Speech\V1
- A streaming speech recognition result corresponding to a portion of the audio that is currently being processed.
- StreamingRecognitionResult::setAlternatives() — Method in class StreamingRecognitionResult
- Output-only May contain one or more recognition hypotheses (up to the
maximum specified in
max_alternatives
). - StreamingRecognitionResult::setIsFinal() — Method in class StreamingRecognitionResult
- Output-only If
false
, thisStreamingRecognitionResult
represents an interim result that may change. Iftrue
, this is the final time the speech service will return this particularStreamingRecognitionResult
, the recognizer will not return any further hypotheses for this portion of the transcript and corresponding audio. - StreamingRecognitionResult::setStability() — Method in class StreamingRecognitionResult
- Output-only An estimate of the likelihood that the recognizer will not change its guess about this interim result. Values range from 0.0 (completely unstable) to 1.0 (completely stable).
- StreamingRecognizeRequest — Class in namespace Google\Cloud\Speech\V1
- The top-level message sent by the client for the
StreamingRecognize
method. - $StreamingRecognizeRequest — Property in class StreamingRecognizeRequest
- StreamingRecognizeRequest::setStreamingConfig() — Method in class StreamingRecognizeRequest
- Provides information to the recognizer that specifies how to process the
request. The first
StreamingRecognizeRequest
message must contain astreaming_config
message. - StreamingRecognizeRequest::setAudioContent() — Method in class StreamingRecognizeRequest
- The audio data to be recognized. Sequential chunks of audio data are sent
in sequential
StreamingRecognizeRequest
messages. The firstStreamingRecognizeRequest
message must not containaudio_content
data and all subsequentStreamingRecognizeRequest
messages must containaudio_content
data. The audio bytes must be encoded as specified inRecognitionConfig
. Note: as with all bytes fields, protobuffers use a pure binary representation (not base64). See audio limits. - StreamingRecognizeResponse — Class in namespace Google\Cloud\Speech\V1
StreamingRecognizeResponse
is the only message returned to the client byStreamingRecognize
. A series of one or moreStreamingRecognizeResponse
messages are streamed back to the client.- StreamingRecognizeResponse::setError() — Method in class StreamingRecognizeResponse
- Output-only If set, returns a [google.rpc.Status][] message that specifies the error for the operation.
- StreamingRecognizeResponse::setResults() — Method in class StreamingRecognizeResponse
- Output-only This repeated list contains zero or more results that correspond to consecutive portions of the audio currently being processed.
- StreamingRecognizeResponse::setSpeechEventType() — Method in class StreamingRecognizeResponse
- Output-only Indicates the type of speech event.
- StreamingRecognizeResponse_SpeechEventType — Class in namespace Google\Cloud\Speech\V1
- Indicates the type of speech event.
- AsyncRecognizeMetadata::setProgressPercent() — Method in class AsyncRecognizeMetadata
- Approximate percentage of audio processed thus far. Guaranteed to be 100 when the audio is fully processed and the results are available.
- AsyncRecognizeMetadata::setStartTime() — Method in class AsyncRecognizeMetadata
- Time when the request was received.
- AsyncRecognizeMetadata::setLastUpdateTime() — Method in class AsyncRecognizeMetadata
- Time of the most recent processing update.
- AsyncRecognizeRequest::setConfig() — Method in class AsyncRecognizeRequest
- Required Provides information to the recognizer that specifies how to process the request.
- AsyncRecognizeRequest::setAudio() — Method in class AsyncRecognizeRequest
- Required The audio data to be recognized.
- AsyncRecognizeResponse::setResults() — Method in class AsyncRecognizeResponse
- Output-only Sequential list of transcription results corresponding to sequential portions of audio.
- RecognitionAudio::setContent() — Method in class RecognitionAudio
- The audio data bytes encoded as specified in
RecognitionConfig
. Note: as with all bytes fields, protobuffers use a pure binary representation, whereas JSON representations use base64. - RecognitionAudio::setUri() — Method in class RecognitionAudio
- URI that points to a file that contains audio data bytes as specified in
RecognitionConfig
. Currently, only Google Cloud Storage URIs are supported, which must be specified in the following format:gs://bucket_name/object_name
(other URI formats return [google.rpc.Code.INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT]). For more information, see Request URIs. - RecognitionConfig::setEncoding() — Method in class RecognitionConfig
- Required Encoding of audio data sent in all
RecognitionAudio
messages. - RecognitionConfig::setSampleRate() — Method in class RecognitionConfig
- Required Sample rate in Hertz of the audio data sent in all
RecognitionAudio
messages. Valid values are: 8000-48000. - RecognitionConfig::setLanguageCode() — Method in class RecognitionConfig
- Optional The language of the supplied audio as a BCP-47 language tag.
- RecognitionConfig::setMaxAlternatives() — Method in class RecognitionConfig
- Optional Maximum number of recognition hypotheses to be returned.
- RecognitionConfig::setProfanityFilter() — Method in class RecognitionConfig
- Optional If set to
true
, the server will attempt to filter out profanities, replacing all but the initial character in each filtered word with asterisks, e.g. "f***". If set tofalse
or omitted, profanities won't be filtered out. - RecognitionConfig::setSpeechContext() — Method in class RecognitionConfig
- Optional A means to provide context to assist the speech recognition.
- SpeechContext — Class in namespace Google\Cloud\Speech\V1beta1
- Provides "hints" to the speech recognizer to favor specific words and phrases in the results.
- SpeechContext::setPhrases() — Method in class SpeechContext
- Optional A list of strings containing words and phrases "hints" so that the speech recognition is more likely to recognize them. This can be used to improve the accuracy for specific words and phrases, for example, if specific commands are typically spoken by the user. This can also be used to add additional words to the vocabulary of the recognizer. See usage limits.
- SpeechGrpcClient — Class in namespace Google\Cloud\Speech\V1beta1
- Service that implements Google Cloud Speech API.
- SpeechGrpcClient::SyncRecognize() — Method in class SpeechGrpcClient
- Performs synchronous speech recognition: receive results after all audio has been sent and processed.
- SpeechGrpcClient::StreamingRecognize() — Method in class SpeechGrpcClient
- Performs bidirectional streaming speech recognition: receive results while sending audio. This method is only available via the gRPC API (not REST).
- SpeechRecognitionAlternative — Class in namespace Google\Cloud\Speech\V1beta1
- Alternative hypotheses (a.k.a. n-best list).
- SpeechRecognitionAlternative::setTranscript() — Method in class SpeechRecognitionAlternative
- Output-only Transcript text representing the words that the user spoke.
- SpeechRecognitionAlternative::setConfidence() — Method in class SpeechRecognitionAlternative
- Output-only The confidence estimate between 0.0 and 1.0. A higher number
indicates an estimated greater likelihood that the recognized words are
correct. This field is typically provided only for the top hypothesis, and
only for
is_final=true
results. Clients should not rely on theconfidence
field as it is not guaranteed to be accurate, or even set, in any of the results. - SpeechRecognitionResult — Class in namespace Google\Cloud\Speech\V1beta1
- A speech recognition result corresponding to a portion of the audio.
- SpeechRecognitionResult::setAlternatives() — Method in class SpeechRecognitionResult
- Output-only May contain one or more recognition hypotheses (up to the
maximum specified in
max_alternatives
). - StreamingRecognitionConfig — Class in namespace Google\Cloud\Speech\V1beta1
- Provides information to the recognizer that specifies how to process the request.
- StreamingRecognitionConfig::setConfig() — Method in class StreamingRecognitionConfig
- Required Provides information to the recognizer that specifies how to process the request.
- StreamingRecognitionConfig::setSingleUtterance() — Method in class StreamingRecognitionConfig
- Optional If
false
or omitted, the recognizer will perform continuous recognition (continuing to wait for and process audio even if the user pauses speaking) until the client closes the input stream (gRPC API) or until the maximum time limit has been reached. May return multipleStreamingRecognitionResult
s with theis_final
flag set totrue
. - StreamingRecognitionConfig::setInterimResults() — Method in class StreamingRecognitionConfig
- Optional If
true
, interim results (tentative hypotheses) may be returned as they become available (these interim results are indicated with theis_final=false
flag). - StreamingRecognitionResult — Class in namespace Google\Cloud\Speech\V1beta1
- A streaming speech recognition result corresponding to a portion of the audio that is currently being processed.
- StreamingRecognitionResult::setAlternatives() — Method in class StreamingRecognitionResult
- Output-only May contain one or more recognition hypotheses (up to the
maximum specified in
max_alternatives
). - StreamingRecognitionResult::setIsFinal() — Method in class StreamingRecognitionResult
- Output-only If
false
, thisStreamingRecognitionResult
represents an interim result that may change. Iftrue
, this is the final time the speech service will return this particularStreamingRecognitionResult
, the recognizer will not return any further hypotheses for this portion of the transcript and corresponding audio. - StreamingRecognitionResult::setStability() — Method in class StreamingRecognitionResult
- Output-only An estimate of the likelihood that the recognizer will not change its guess about this interim result. Values range from 0.0 (completely unstable) to 1.0 (completely stable).
- StreamingRecognizeRequest — Class in namespace Google\Cloud\Speech\V1beta1
- The top-level message sent by the client for the
StreamingRecognize
method. - $StreamingRecognizeRequest — Property in class StreamingRecognizeRequest
- StreamingRecognizeRequest::setStreamingConfig() — Method in class StreamingRecognizeRequest
- Provides information to the recognizer that specifies how to process the
request. The first
StreamingRecognizeRequest
message must contain astreaming_config
message. - StreamingRecognizeRequest::setAudioContent() — Method in class StreamingRecognizeRequest
- The audio data to be recognized. Sequential chunks of audio data are sent
in sequential
StreamingRecognizeRequest
messages. The firstStreamingRecognizeRequest
message must not containaudio_content
data and all subsequentStreamingRecognizeRequest
messages must containaudio_content
data. The audio bytes must be encoded as specified inRecognitionConfig
. Note: as with all bytes fields, protobuffers use a pure binary representation (not base64). See audio limits. - StreamingRecognizeResponse — Class in namespace Google\Cloud\Speech\V1beta1
StreamingRecognizeResponse
is the only message returned to the client byStreamingRecognize
. A series of one or moreStreamingRecognizeResponse
messages are streamed back to the client.- StreamingRecognizeResponse::setError() — Method in class StreamingRecognizeResponse
- Output-only If set, returns a [google.rpc.Status][google.rpc.Status] message that specifies the error for the operation.
- StreamingRecognizeResponse::setResults() — Method in class StreamingRecognizeResponse
- Output-only This repeated list contains zero or more results that correspond to consecutive portions of the audio currently being processed.
- StreamingRecognizeResponse::setResultIndex() — Method in class StreamingRecognizeResponse
- Output-only Indicates the lowest index in the
results
array that has changed. The repeatedStreamingRecognitionResult
results overwrite past results at this index and higher. - StreamingRecognizeResponse::setEndpointerType() — Method in class StreamingRecognizeResponse
- Output-only Indicates the type of endpointer event.
- StreamingRecognizeResponse_EndpointerType — Class in namespace Google\Cloud\Speech\V1beta1
- Indicates the type of endpointer event.
- SyncRecognizeRequest — Class in namespace Google\Cloud\Speech\V1beta1
- The top-level message sent by the client for the
SyncRecognize
method. - SyncRecognizeRequest::setConfig() — Method in class SyncRecognizeRequest
- Required Provides information to the recognizer that specifies how to process the request.
- SyncRecognizeRequest::setAudio() — Method in class SyncRecognizeRequest
- Required The audio data to be recognized.
- SyncRecognizeResponse — Class in namespace Google\Cloud\Speech\V1beta1
- The only message returned to the client by
SyncRecognize
. It contains the result as zero or more sequentialSpeechRecognitionResult
messages. - SyncRecognizeResponse::setResults() — Method in class SyncRecognizeResponse
- Output-only Sequential list of transcription results corresponding to sequential portions of audio.
- AnnotateVideoProgress::setAnnotationProgress() — Method in class AnnotateVideoProgress
- Progress metadata for all videos specified in
AnnotateVideoRequest
. - AnnotateVideoRequest::setInputUri() — Method in class AnnotateVideoRequest
- Input video location. Currently, only
Google Cloud Storage URIs are
supported, which must be specified in the following format:
gs://bucket-id/object-id
(other URI formats return [google.rpc.Code.INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT]). For more information, see Request URIs. - AnnotateVideoRequest::setInputContent() — Method in class AnnotateVideoRequest
- The video data bytes. Encoding: base64. If unset, the input video(s)
should be specified via
input_uri
. If set,input_uri
should be unset. - AnnotateVideoRequest::setFeatures() — Method in class AnnotateVideoRequest
- Requested video annotation features.
- AnnotateVideoRequest::setVideoContext() — Method in class AnnotateVideoRequest
- Additional video context and/or feature-specific parameters.
- AnnotateVideoRequest::setOutputUri() — Method in class AnnotateVideoRequest
- Optional location where the output (in JSON format) should be stored.
- AnnotateVideoRequest::setLocationId() — Method in class AnnotateVideoRequest
- Optional cloud region where annotation should take place. Supported cloud
regions:
us-east1
,us-west1
,europe-west1
,asia-east1
. If no region is specified, a region will be determined based on video file location. - AnnotateVideoResponse::setAnnotationResults() — Method in class AnnotateVideoResponse
- Annotation results for all videos specified in
AnnotateVideoRequest
. - BoundingBox::setLeft() — Method in class BoundingBox
- Left X coordinate.
- BoundingBox::setRight() — Method in class BoundingBox
- Right X coordinate.
- BoundingBox::setBottom() — Method in class BoundingBox
- Bottom Y coordinate.
- BoundingBox::setTop() — Method in class BoundingBox
- Top Y coordinate.
- FaceAnnotation::setThumbnail() — Method in class FaceAnnotation
- Thumbnail of a representative face view (in JPEG format). Encoding: base64.
- FaceAnnotation::setSegments() — Method in class FaceAnnotation
- All locations where a face was detected.
- FaceAnnotation::setLocations() — Method in class FaceAnnotation
- Face locations at one frame per second.
- FaceLocation::setBoundingBox() — Method in class FaceLocation
- Bounding box in a frame.
- FaceLocation::setTimeOffset() — Method in class FaceLocation
- Video time offset in microseconds.
- LabelAnnotation::setDescription() — Method in class LabelAnnotation
- Textual description, e.g.
Fixed-gear bicycle
. - LabelAnnotation::setLanguageCode() — Method in class LabelAnnotation
- Language code for
description
in BCP-47 format. - LabelAnnotation::setLocations() — Method in class LabelAnnotation
- Where the label was detected and with what confidence.
- LabelLocation::setSegment() — Method in class LabelLocation
- Video segment. Set to [-1, -1] for video-level labels.
- LabelLocation::setConfidence() — Method in class LabelLocation
- Confidence that the label is accurate. Range: [0, 1].
- LabelLocation::setLevel() — Method in class LabelLocation
- Label level.
- SafeSearchAnnotation — Class in namespace Google\Cloud\Videointelligence\V1beta1
- Safe search annotation (based on per-frame visual signals only).
- SafeSearchAnnotation::setAdult() — Method in class SafeSearchAnnotation
- Likelihood of adult content.
- SafeSearchAnnotation::setSpoof() — Method in class SafeSearchAnnotation
- Likelihood that an obvious modification was made to the original version to make it appear funny or offensive.
- SafeSearchAnnotation::setMedical() — Method in class SafeSearchAnnotation
- Likelihood of medical content.
- SafeSearchAnnotation::setViolent() — Method in class SafeSearchAnnotation
- Likelihood of violent content.
- SafeSearchAnnotation::setRacy() — Method in class SafeSearchAnnotation
- Likelihood of racy content.
- SafeSearchAnnotation::setTimeOffset() — Method in class SafeSearchAnnotation
- Video time offset in microseconds.
- VideoAnnotationProgress::setInputUri() — Method in class VideoAnnotationProgress
- Video file location in Google Cloud Storage.
- VideoAnnotationProgress::setProgressPercent() — Method in class VideoAnnotationProgress
- Approximate percentage processed thus far.
- VideoAnnotationProgress::setStartTime() — Method in class VideoAnnotationProgress
- Time when the request was received.
- VideoAnnotationProgress::setUpdateTime() — Method in class VideoAnnotationProgress
- Time of the most recent update.
- VideoAnnotationResults::setInputUri() — Method in class VideoAnnotationResults
- Video file location in Google Cloud Storage.
- VideoAnnotationResults::setLabelAnnotations() — Method in class VideoAnnotationResults
- Label annotations. There is exactly one element for each unique label.
- VideoAnnotationResults::setFaceAnnotations() — Method in class VideoAnnotationResults
- Face annotations. There is exactly one element for each unique face.
- VideoAnnotationResults::setShotAnnotations() — Method in class VideoAnnotationResults
- Shot annotations. Each shot is represented as a video segment.
- VideoAnnotationResults::setSafeSearchAnnotations() — Method in class VideoAnnotationResults
- Safe search annotations.
- VideoAnnotationResults::setError() — Method in class VideoAnnotationResults
- If set, indicates an error. Note that for a single
AnnotateVideoRequest
some videos may succeed and some may fail. - VideoContext::setSegments() — Method in class VideoContext
- Video segments to annotate. The segments may overlap and are not required to be contiguous or span the whole video. If unspecified, each video is treated as a single segment.
- VideoContext::setLabelDetectionMode() — Method in class VideoContext
- If label detection has been requested, what labels should be detected
in addition to video-level labels or segment-level labels. If unspecified,
defaults to
SHOT_MODE
. - VideoContext::setStationaryCamera() — Method in class VideoContext
- Whether the video has been shot from a stationary (i.e. non-moving) camera.
- VideoContext::setLabelDetectionModel() — Method in class VideoContext
- Model to use for label detection.
- VideoContext::setFaceDetectionModel() — Method in class VideoContext
- Model to use for face detection.
- VideoContext::setShotChangeDetectionModel() — Method in class VideoContext
- Model to use for shot change detection.
- VideoContext::setSafeSearchDetectionModel() — Method in class VideoContext
- Model to use for safe search detection.
- VideoSegment::setStartTimeOffset() — Method in class VideoSegment
- Start offset in microseconds (inclusive). Unset means 0.
- VideoSegment::setEndTimeOffset() — Method in class VideoSegment
- End offset in microseconds (inclusive). Unset means 0.
- AnnotateImageRequest::setImage() — Method in class AnnotateImageRequest
- The image to be processed.
- AnnotateImageRequest::setFeatures() — Method in class AnnotateImageRequest
- Requested features.
- AnnotateImageRequest::setImageContext() — Method in class AnnotateImageRequest
- Additional context that may accompany the image.
- AnnotateImageResponse::setFaceAnnotations() — Method in class AnnotateImageResponse
- If present, face detection has completed successfully.
- AnnotateImageResponse::setLandmarkAnnotations() — Method in class AnnotateImageResponse
- If present, landmark detection has completed successfully.
- AnnotateImageResponse::setLogoAnnotations() — Method in class AnnotateImageResponse
- If present, logo detection has completed successfully.
- AnnotateImageResponse::setLabelAnnotations() — Method in class AnnotateImageResponse
- If present, label detection has completed successfully.
- AnnotateImageResponse::setTextAnnotations() — Method in class AnnotateImageResponse
- If present, text (OCR) detection or document (OCR) text detection has completed successfully.
- AnnotateImageResponse::setFullTextAnnotation() — Method in class AnnotateImageResponse
- If present, text (OCR) detection or document (OCR) text detection has completed successfully.
- AnnotateImageResponse::setSafeSearchAnnotation() — Method in class AnnotateImageResponse
- If present, safe-search annotation has completed successfully.
- AnnotateImageResponse::setImagePropertiesAnnotation() — Method in class AnnotateImageResponse
- If present, image properties were extracted successfully.
- AnnotateImageResponse::setCropHintsAnnotation() — Method in class AnnotateImageResponse
- If present, crop hints have completed successfully.
- AnnotateImageResponse::setWebDetection() — Method in class AnnotateImageResponse
- If present, web detection has completed successfully.
- AnnotateImageResponse::setError() — Method in class AnnotateImageResponse
- If set, represents the error message for the operation.
- BatchAnnotateImagesRequest::setRequests() — Method in class BatchAnnotateImagesRequest
- Individual image annotation requests for this batch.
- BatchAnnotateImagesResponse::setResponses() — Method in class BatchAnnotateImagesResponse
- Individual responses to image annotation requests within the batch.
- Block::setProperty() — Method in class Block
- Additional information detected for the block.
- Block::setBoundingBox() — Method in class Block
- The bounding box for the block.
- Block::setParagraphs() — Method in class Block
- List of paragraphs in this block (if this blocks is of type text).
- Block::setBlockType() — Method in class Block
- Detected block type (text, image etc) for this block.
- BoundingPoly::setVertices() — Method in class BoundingPoly
- The bounding polygon vertices.
- ColorInfo::setColor() — Method in class ColorInfo
- RGB components of the color.
- ColorInfo::setScore() — Method in class ColorInfo
- Image-specific score for this color. Value in range [0, 1].
- ColorInfo::setPixelFraction() — Method in class ColorInfo
- The fraction of pixels the color occupies in the image.
- CropHint::setBoundingPoly() — Method in class CropHint
- The bounding polygon for the crop region. The coordinates of the bounding
box are in the original image's scale, as returned in
ImageParams
. - CropHint::setConfidence() — Method in class CropHint
- Confidence of this being a salient region. Range [0, 1].
- CropHint::setImportanceFraction() — Method in class CropHint
- Fraction of importance of this salient region with respect to the original image.
- CropHintsAnnotation::setCropHints() — Method in class CropHintsAnnotation
- Generated from protobuf field
repeated .google.cloud.vision.v1.CropHint crop_hints = 1;
- CropHintsParams::setAspectRatios() — Method in class CropHintsParams
- Aspect ratios in floats, representing the ratio of the width to the height of the image. For example, if the desired aspect ratio is 4/3, the corresponding float value should be 1.33333. If not specified, the best possible crop is returned. The number of provided aspect ratios is limited to a maximum of 16; any aspect ratios provided after the 16th are ignored.
- DominantColorsAnnotation::setColors() — Method in class DominantColorsAnnotation
- RGB color values with their score and pixel fraction.
- EntityAnnotation::setMid() — Method in class EntityAnnotation
- Opaque entity ID. Some IDs may be available in Google Knowledge Graph Search API.
- EntityAnnotation::setLocale() — Method in class EntityAnnotation
- The language code for the locale in which the entity textual
description
is expressed. - EntityAnnotation::setDescription() — Method in class EntityAnnotation
- Entity textual description, expressed in its
locale
language. - EntityAnnotation::setScore() — Method in class EntityAnnotation
- Overall score of the result. Range [0, 1].
- EntityAnnotation::setConfidence() — Method in class EntityAnnotation
- The accuracy of the entity detection in an image.
- EntityAnnotation::setTopicality() — Method in class EntityAnnotation
- The relevancy of the ICA (Image Content Annotation) label to the image. For example, the relevancy of "tower" is likely higher to an image containing the detected "Eiffel Tower" than to an image containing a detected distant towering building, even though the confidence that there is a tower in each image may be the same. Range [0, 1].
- EntityAnnotation::setBoundingPoly() — Method in class EntityAnnotation
- Image region to which this entity belongs. Currently not produced
for
LABEL_DETECTION
features. ForTEXT_DETECTION
(OCR),boundingPoly
s are produced for the entire text detected in an image region, followed byboundingPoly
s for each word within the detected text. - EntityAnnotation::setLocations() — Method in class EntityAnnotation
- The location information for the detected entity. Multiple
LocationInfo
elements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. - EntityAnnotation::setProperties() — Method in class EntityAnnotation
- Some entities may have optional user-supplied
Property
(name/value) fields, such a score or string that qualifies the entity. - FaceAnnotation::setBoundingPoly() — Method in class FaceAnnotation
- The bounding polygon around the face. The coordinates of the bounding box
are in the original image's scale, as returned in
ImageParams
. - FaceAnnotation::setFdBoundingPoly() — Method in class FaceAnnotation
- The
fd_bounding_poly
bounding polygon is tighter than theboundingPoly
, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the "amount of skin" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence thefd
(face detection) prefix. - FaceAnnotation::setLandmarks() — Method in class FaceAnnotation
- Detected face landmarks.
- FaceAnnotation::setRollAngle() — Method in class FaceAnnotation
- Roll angle, which indicates the amount of clockwise/anti-clockwise rotation of the face relative to the image vertical about the axis perpendicular to the face. Range [-180,180].
- FaceAnnotation::setPanAngle() — Method in class FaceAnnotation
- Yaw angle, which indicates the leftward/rightward angle that the face is pointing relative to the vertical plane perpendicular to the image. Range [-180,180].
- FaceAnnotation::setTiltAngle() — Method in class FaceAnnotation
- Pitch angle, which indicates the upwards/downwards angle that the face is pointing relative to the image's horizontal plane. Range [-180,180].
- FaceAnnotation::setDetectionConfidence() — Method in class FaceAnnotation
- Detection confidence. Range [0, 1].
- FaceAnnotation::setLandmarkingConfidence() — Method in class FaceAnnotation
- Face landmarking confidence. Range [0, 1].
- FaceAnnotation::setJoyLikelihood() — Method in class FaceAnnotation
- Joy likelihood.
- FaceAnnotation::setSorrowLikelihood() — Method in class FaceAnnotation
- Sorrow likelihood.
- FaceAnnotation::setAngerLikelihood() — Method in class FaceAnnotation
- Anger likelihood.
- FaceAnnotation::setSurpriseLikelihood() — Method in class FaceAnnotation
- Surprise likelihood.
- FaceAnnotation::setUnderExposedLikelihood() — Method in class FaceAnnotation
- Under-exposed likelihood.
- FaceAnnotation::setBlurredLikelihood() — Method in class FaceAnnotation
- Blurred likelihood.
- FaceAnnotation::setHeadwearLikelihood() — Method in class FaceAnnotation
- Headwear likelihood.
- FaceAnnotation_Landmark::setType() — Method in class FaceAnnotation_Landmark
- Face landmark type.
- FaceAnnotation_Landmark::setPosition() — Method in class FaceAnnotation_Landmark
- Face landmark position.
- Feature::setType() — Method in class Feature
- The feature type.
- Feature::setMaxResults() — Method in class Feature
- Maximum number of results of this type.
- Image::setContent() — Method in class Image
- Image content, represented as a stream of bytes.
- Image::setSource() — Method in class Image
- Google Cloud Storage image location. If both
content
andsource
are provided for an image,content
takes precedence and is used to perform the image annotation request. - ImageContext::setLatLongRect() — Method in class ImageContext
- lat/long rectangle that specifies the location of the image.
- ImageContext::setLanguageHints() — Method in class ImageContext
- List of languages to use for TEXT_DETECTION. In most cases, an empty value
yields the best results since it enables automatic language detection. For
languages based on the Latin alphabet, setting
language_hints
is not needed. In rare cases, when the language of the text in the image is known, setting a hint will help get better results (although it will be a significant hindrance if the hint is wrong). Text detection returns an error if one or more of the specified languages is not one of the supported languages. - ImageContext::setCropHintsParams() — Method in class ImageContext
- Parameters for crop hints annotation request.
- ImageProperties::setDominantColors() — Method in class ImageProperties
- If present, dominant colors completed successfully.
- ImageSource::setGcsImageUri() — Method in class ImageSource
- NOTE: For new code
image_uri
below is preferred. - ImageSource::setImageUri() — Method in class ImageSource
- Image URI which supports:
1) Google Cloud Storage image URI, which must be in the following form:
gs://bucket_name/object_name
(for details, see Google Cloud Storage Request URIs). - LatLongRect::setMinLatLng() — Method in class LatLongRect
- Min lat/long pair.
- LatLongRect::setMaxLatLng() — Method in class LatLongRect
- Max lat/long pair.
- LocationInfo::setLatLng() — Method in class LocationInfo
- lat/long location coordinates.
- Page::setProperty() — Method in class Page
- Additional information detected on the page.
- Page::setWidth() — Method in class Page
- Page width in pixels.
- Page::setHeight() — Method in class Page
- Page height in pixels.
- Page::setBlocks() — Method in class Page
- List of blocks of text, images etc on this page.
- Paragraph::setProperty() — Method in class Paragraph
- Additional information detected for the paragraph.
- Paragraph::setBoundingBox() — Method in class Paragraph
- The bounding box for the paragraph.
- Paragraph::setWords() — Method in class Paragraph
- List of words in this paragraph.
- Position::setX() — Method in class Position
- X coordinate.
- Position::setY() — Method in class Position
- Y coordinate.
- Position::setZ() — Method in class Position
- Z coordinate (or depth).
- Property::setName() — Method in class Property
- Name of the property.
- Property::setValue() — Method in class Property
- Value of the property.
- SafeSearchAnnotation — Class in namespace Google\Cloud\Vision\V1
- Set of features pertaining to the image, computed by computer vision methods over safe-search verticals (for example, adult, spoof, medical, violence).
- SafeSearchAnnotation::setAdult() — Method in class SafeSearchAnnotation
- Represents the adult content likelihood for the image.
- SafeSearchAnnotation::setSpoof() — Method in class SafeSearchAnnotation
- Spoof likelihood. The likelihood that an modification was made to the image's canonical version to make it appear funny or offensive.
- SafeSearchAnnotation::setMedical() — Method in class SafeSearchAnnotation
- Likelihood that this is a medical image.
- SafeSearchAnnotation::setViolence() — Method in class SafeSearchAnnotation
- Violence likelihood.
- Symbol — Class in namespace Google\Cloud\Vision\V1
- A single symbol representation.
- Symbol::setProperty() — Method in class Symbol
- Additional information detected for the symbol.
- Symbol::setBoundingBox() — Method in class Symbol
- The bounding box for the symbol.
- Symbol::setText() — Method in class Symbol
- The actual UTF-8 representation of the symbol.
- TextAnnotation::setPages() — Method in class TextAnnotation
- List of pages detected by OCR.
- TextAnnotation::setText() — Method in class TextAnnotation
- UTF-8 text detected on the pages.
- TextAnnotation_DetectedBreak::setType() — Method in class TextAnnotation_DetectedBreak
- Generated from protobuf field
.google.cloud.vision.v1.TextAnnotation.DetectedBreak.BreakType type = 1;
- TextAnnotation_DetectedBreak::setIsPrefix() — Method in class TextAnnotation_DetectedBreak
- True if break prepends the element.
- TextAnnotation_DetectedLanguage::setLanguageCode() — Method in class TextAnnotation_DetectedLanguage
- The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
- TextAnnotation_DetectedLanguage::setConfidence() — Method in class TextAnnotation_DetectedLanguage
- Confidence of detected language. Range [0, 1].
- TextAnnotation_TextProperty::setDetectedLanguages() — Method in class TextAnnotation_TextProperty
- A list of detected languages together with confidence.
- TextAnnotation_TextProperty::setDetectedBreak() — Method in class TextAnnotation_TextProperty
- Detected start or end of a text segment.
- Vertex::setX() — Method in class Vertex
- X coordinate.
- Vertex::setY() — Method in class Vertex
- Y coordinate.
- WebDetection::setWebEntities() — Method in class WebDetection
- Deduced entities from similar images on the Internet.
- WebDetection::setFullMatchingImages() — Method in class WebDetection
- Fully matching images from the Internet.
- WebDetection::setPartialMatchingImages() — Method in class WebDetection
- Partial matching images from the Internet.
- WebDetection::setPagesWithMatchingImages() — Method in class WebDetection
- Web pages containing the matching images from the Internet.
- WebDetection_WebEntity::setEntityId() — Method in class WebDetection_WebEntity
- Opaque entity ID.
- WebDetection_WebEntity::setScore() — Method in class WebDetection_WebEntity
- Overall relevancy score for the entity.
- WebDetection_WebEntity::setDescription() — Method in class WebDetection_WebEntity
- Canonical description of the entity, in English.
- WebDetection_WebImage::setUrl() — Method in class WebDetection_WebImage
- The result image URL.
- WebDetection_WebImage::setScore() — Method in class WebDetection_WebImage
- Overall relevancy score for the image.
- WebDetection_WebPage::setUrl() — Method in class WebDetection_WebPage
- The result web page URL.
- WebDetection_WebPage::setScore() — Method in class WebDetection_WebPage
- Overall relevancy score for the web page.
- Word::setProperty() — Method in class Word
- Additional information detected for the word.
- Word::setBoundingBox() — Method in class Word
- The bounding box for the word.
- Word::setSymbols() — Method in class Word
- List of symbols in the word.
- DeleteEventsRequest::setProjectName() — Method in class DeleteEventsRequest
- [Required] The resource name of the Google Cloud Platform project. Written
as
projects/
plus the Google Cloud Platform project ID. - ErrorContext::setHttpRequest() — Method in class ErrorContext
- The HTTP request which was processed when the error was triggered.
- ErrorContext::setUser() — Method in class ErrorContext
- The user who caused or was affected by the crash.
- ErrorContext::setReportLocation() — Method in class ErrorContext
- The location in the source code where the decision was made to report the error, usually the place where it was logged.
- ErrorEvent::setEventTime() — Method in class ErrorEvent
- Time when the event occurred as provided in the error report.
- ErrorEvent::setServiceContext() — Method in class ErrorEvent
- The
ServiceContext
for which this error was reported. - ErrorEvent::setMessage() — Method in class ErrorEvent
- The stack trace that was reported or logged by the service.
- ErrorEvent::setContext() — Method in class ErrorEvent
- Data about the context in which the error occurred.
- ErrorGroup::setName() — Method in class ErrorGroup
- The group resource name.
- ErrorGroup::setGroupId() — Method in class ErrorGroup
- Group IDs are unique for a given project. If the same kind of error occurs in different service contexts, it will receive the same group ID.
- ErrorGroup::setTrackingIssues() — Method in class ErrorGroup
- Associated tracking issues.
- ErrorGroupStats::setGroup() — Method in class ErrorGroupStats
- Group data that is independent of the filter criteria.
- ErrorGroupStats::setCount() — Method in class ErrorGroupStats
- Approximate total number of events in the given group that match the filter criteria.
- ErrorGroupStats::setAffectedUsersCount() — Method in class ErrorGroupStats
- Approximate number of affected users in the given group that match the filter criteria.
- ErrorGroupStats::setTimedCounts() — Method in class ErrorGroupStats
- Approximate number of occurrences over time.
- ErrorGroupStats::setFirstSeenTime() — Method in class ErrorGroupStats
- Approximate first occurrence that was ever seen for this group and which matches the given filter criteria, ignoring the time_range that was specified in the request.
- ErrorGroupStats::setLastSeenTime() — Method in class ErrorGroupStats
- Approximate last occurrence that was ever seen for this group and which matches the given filter criteria, ignoring the time_range that was specified in the request.
- ErrorGroupStats::setAffectedServices() — Method in class ErrorGroupStats
- Service contexts with a non-zero error count for the given filter criteria. This list can be truncated if multiple services are affected.
- ErrorGroupStats::setNumAffectedServices() — Method in class ErrorGroupStats
- The total number of services with a non-zero error count for the given filter criteria.
- ErrorGroupStats::setRepresentative() — Method in class ErrorGroupStats
- An arbitrary event that is chosen as representative for the whole group.
- GetGroupRequest::setGroupName() — Method in class GetGroupRequest
- [Required] The group resource name. Written as
projects/projectID/groups/group_name
. - HttpRequestContext::setMethod() — Method in class HttpRequestContext
- The type of HTTP request, such as
GET
,POST
, etc. - HttpRequestContext::setUrl() — Method in class HttpRequestContext
- The URL of the request.
- HttpRequestContext::setUserAgent() — Method in class HttpRequestContext
- The user agent information that is provided with the request.
- HttpRequestContext::setReferrer() — Method in class HttpRequestContext
- The referrer information that is provided with the request.
- HttpRequestContext::setResponseStatusCode() — Method in class HttpRequestContext
- The HTTP response status code for the request.
- HttpRequestContext::setRemoteIp() — Method in class HttpRequestContext
- The IP address from which the request originated.
- ListEventsRequest::setProjectName() — Method in class ListEventsRequest
- [Required] The resource name of the Google Cloud Platform project. Written
as
projects/
plus the Google Cloud Platform project ID. - ListEventsRequest::setGroupId() — Method in class ListEventsRequest
- [Required] The group for which events shall be returned.
- ListEventsRequest::setServiceFilter() — Method in class ListEventsRequest
- [Optional] List only ErrorGroups which belong to a service context that matches the filter.
- ListEventsRequest::setTimeRange() — Method in class ListEventsRequest
- [Optional] List only data for the given time range.
- ListEventsRequest::setPageSize() — Method in class ListEventsRequest
- [Optional] The maximum number of results to return per response.
- ListEventsRequest::setPageToken() — Method in class ListEventsRequest
- [Optional] A
next_page_token
provided by a previous response. - ListEventsResponse::setErrorEvents() — Method in class ListEventsResponse
- The error events which match the given request.
- ListEventsResponse::setNextPageToken() — Method in class ListEventsResponse
- If non-empty, more results are available.
- ListEventsResponse::setTimeRangeBegin() — Method in class ListEventsResponse
- The timestamp specifies the start time to which the request was restricted.
- ListGroupStatsRequest::setProjectName() — Method in class ListGroupStatsRequest
- [Required] The resource name of the Google Cloud Platform project. Written
as
projects/
plus the Google Cloud Platform project ID. - ListGroupStatsRequest::setGroupId() — Method in class ListGroupStatsRequest
- [Optional] List all
ErrorGroupStats
with these IDs. - ListGroupStatsRequest::setServiceFilter() — Method in class ListGroupStatsRequest
- [Optional] List only
ErrorGroupStats
which belong to a service context that matches the filter. - ListGroupStatsRequest::setTimeRange() — Method in class ListGroupStatsRequest
- [Optional] List data for the given time range.
- ListGroupStatsRequest::setTimedCountDuration() — Method in class ListGroupStatsRequest
- [Optional] The preferred duration for a single returned
TimedCount
. - ListGroupStatsRequest::setAlignment() — Method in class ListGroupStatsRequest
- [Optional] The alignment of the timed counts to be returned.
- ListGroupStatsRequest::setAlignmentTime() — Method in class ListGroupStatsRequest
- [Optional] Time where the timed counts shall be aligned if rounded alignment is chosen. Default is 00:00 UTC.
- ListGroupStatsRequest::setOrder() — Method in class ListGroupStatsRequest
- [Optional] The sort order in which the results are returned.
- ListGroupStatsRequest::setPageSize() — Method in class ListGroupStatsRequest
- [Optional] The maximum number of results to return per response.
- ListGroupStatsRequest::setPageToken() — Method in class ListGroupStatsRequest
- [Optional] A
next_page_token
provided by a previous response. To view additional results, pass this token along with the identical query parameters as the first request. - ListGroupStatsResponse::setErrorGroupStats() — Method in class ListGroupStatsResponse
- The error group stats which match the given request.
- ListGroupStatsResponse::setNextPageToken() — Method in class ListGroupStatsResponse
- If non-empty, more results are available.
- ListGroupStatsResponse::setTimeRangeBegin() — Method in class ListGroupStatsResponse
- The timestamp specifies the start time to which the request was restricted.
- QueryTimeRange::setPeriod() — Method in class QueryTimeRange
- Restricts the query to the specified time range.
- ReportErrorEventRequest::setProjectName() — Method in class ReportErrorEventRequest
- [Required] The resource name of the Google Cloud Platform project. Written
as
projects/
plus the Google Cloud Platform project ID. - ReportErrorEventRequest::setEvent() — Method in class ReportErrorEventRequest
- [Required] The error event to be reported.
- ReportedErrorEvent::setEventTime() — Method in class ReportedErrorEvent
- [Optional] Time when the event occurred.
- ReportedErrorEvent::setServiceContext() — Method in class ReportedErrorEvent
- [Required] The service context in which this error has occurred.
- ReportedErrorEvent::setMessage() — Method in class ReportedErrorEvent
- [Required] A message describing the error. The message can contain an exception stack in one of the supported programming languages and formats.
- ReportedErrorEvent::setContext() — Method in class ReportedErrorEvent
- [Optional] A description of the context in which the error occurred.
- ServiceContext — Class in namespace Google\Devtools\Clouderrorreporting\V1beta1
- Describes a running service that sends errors.
- ServiceContext::setService() — Method in class ServiceContext
- An identifier of the service, such as the name of the
executable, job, or Google App Engine service name. This field is expected
to have a low number of values that are relatively stable over time, as
opposed to
version
, which can be changed whenever new code is deployed. - ServiceContext::setVersion() — Method in class ServiceContext
- Represents the source code version that the developer provided, which could represent a version label or a Git SHA-1 hash, for example.
- ServiceContext::setResourceType() — Method in class ServiceContext
- Type of the MonitoredResource. List of possible values: https://cloud.google.com/monitoring/api/resources Value is set automatically for incoming errors and must not be set when reporting errors.
- ServiceContextFilter — Class in namespace Google\Devtools\Clouderrorreporting\V1beta1
- Specifies criteria for filtering a subset of service contexts.
- ServiceContextFilter::setService() — Method in class ServiceContextFilter
- [Optional] The exact value to match against
ServiceContext.service
. - ServiceContextFilter::setVersion() — Method in class ServiceContextFilter
- [Optional] The exact value to match against
ServiceContext.version
. - ServiceContextFilter::setResourceType() — Method in class ServiceContextFilter
- [Optional] The exact value to match against
ServiceContext.resource_type
. - SourceLocation — Class in namespace Google\Devtools\Clouderrorreporting\V1beta1
- Indicates a location in the source code of the service for which errors are reported.
- SourceLocation::setFilePath() — Method in class SourceLocation
- The source code filename, which can include a truncated relative path, or a full path from a production machine.
- SourceLocation::setLineNumber() — Method in class SourceLocation
- 1-based. 0 indicates that the line number is unknown.
- SourceLocation::setFunctionName() — Method in class SourceLocation
- Human-readable name of a function or method.
- TimedCount::setCount() — Method in class TimedCount
- Approximate number of occurrences in the given time period.
- TimedCount::setStartTime() — Method in class TimedCount
- Start of the time period to which
count
refers (included). - TimedCount::setEndTime() — Method in class TimedCount
- End of the time period to which
count
refers (excluded). - TrackingIssue::setUrl() — Method in class TrackingIssue
- A URL pointing to a related entry in an issue tracking system.
- UpdateGroupRequest::setGroup() — Method in class UpdateGroupRequest
- [Required] The group which replaces the resource on the server.
- GetTraceRequest::setProjectId() — Method in class GetTraceRequest
- ID of the Cloud project where the trace data is stored.
- GetTraceRequest::setTraceId() — Method in class GetTraceRequest
- ID of the trace to return.
- ListTracesRequest::setProjectId() — Method in class ListTracesRequest
- ID of the Cloud project where the trace data is stored.
- ListTracesRequest::setView() — Method in class ListTracesRequest
- Type of data returned for traces in the list. Optional. Default is
MINIMAL
. - ListTracesRequest::setPageSize() — Method in class ListTracesRequest
- Maximum number of traces to return. If not specified or <= 0, the implementation selects a reasonable value. The implementation may return fewer traces than the requested page size. Optional.
- ListTracesRequest::setPageToken() — Method in class ListTracesRequest
- Token identifying the page of results to return. If provided, use the
value of the
next_page_token
field from a previous request. Optional. - ListTracesRequest::setStartTime() — Method in class ListTracesRequest
- End of the time interval (inclusive) during which the trace data was collected from the application.
- ListTracesRequest::setEndTime() — Method in class ListTracesRequest
- Start of the time interval (inclusive) during which the trace data was collected from the application.
- ListTracesRequest::setFilter() — Method in class ListTracesRequest
- An optional filter for the request.
- ListTracesRequest::setOrderBy() — Method in class ListTracesRequest
- Field used to sort the returned traces. Optional.
- ListTracesResponse::setTraces() — Method in class ListTracesResponse
- List of trace records returned.
- ListTracesResponse::setNextPageToken() — Method in class ListTracesResponse
- If defined, indicates that there are more traces that match the request and that this value should be passed to the next request to continue retrieving additional traces.
- PatchTracesRequest::setProjectId() — Method in class PatchTracesRequest
- ID of the Cloud project where the trace data is stored.
- PatchTracesRequest::setTraces() — Method in class PatchTracesRequest
- The body of the message.
- Trace::setProjectId() — Method in class Trace
- Project ID of the Cloud project where the trace data is stored.
- Trace::setTraceId() — Method in class Trace
- Globally unique identifier for the trace. This identifier is a 128-bit numeric value formatted as a 32-byte hex string.
- Trace::setSpans() — Method in class Trace
- Collection of spans in the trace.
- TraceSpan::setSpanId() — Method in class TraceSpan
- Identifier for the span. Must be a 64-bit integer other than 0 and unique within a trace.
- TraceSpan::setKind() — Method in class TraceSpan
- Distinguishes between spans generated in a particular context. For example,
two spans with the same name may be distinguished using
RPC_CLIENT
andRPC_SERVER
to identify queueing latency associated with the span. - TraceSpan::setName() — Method in class TraceSpan
- Name of the trace. The trace name is sanitized and displayed in the Stackdriver Trace tool in the Google Developers Console.
- TraceSpan::setStartTime() — Method in class TraceSpan
- Start time of the span in nanoseconds from the UNIX epoch.
- TraceSpan::setEndTime() — Method in class TraceSpan
- End time of the span in nanoseconds from the UNIX epoch.
- TraceSpan::setParentSpanId() — Method in class TraceSpan
- ID of the parent span, if any. Optional.
- TraceSpan::setLabels() — Method in class TraceSpan
- Collection of labels associated with the span.
- Traces::setTraces() — Method in class Traces
- List of traces.
- $Parser — Property in class Parser
- $Parser — Property in class Parser
- Parser::setInput() — Method in class Parser
- Parser::showPosition() — Method in class Parser
- $ParserAction — Property in class ParserAction
- $ParserAction — Property in class ParserAction
- $ParserCachedAction — Property in class ParserCachedAction
- $ParserError — Property in class ParserError
- $ParserError — Property in class ParserError
- $ParserProduction — Property in class ParserProduction
- ParserState::setActions() — Method in class ParserState
- $ParserSymbol — Property in class ParserSymbol
- $ParserSymbol — Property in class ParserSymbol
- Segment — Class in namespace Google\GAX\Jison
- This class represents a segment in a path template.
- RetrySettings::shouldInherit() — Method in class RetrySettings
- Serializer — Class in namespace Google\GAX
- Collection of methods to help with serialization of protobuf objects
- Serializer::serializeToJson() — Method in class Serializer
- Serializer::serializeToPhpArray() — Method in class Serializer
- ServerStream — Class in namespace Google\GAX
- ServerStream is the response object from a gRPC server streaming API call.
- MockStubTrait::stripStatusFromResponses() — Method in class MockStubTrait
- MockStubTrait::setStreamingStatus() — Method in class MockStubTrait
- Set the status object to be used when creating streaming calls.
- SerializationTrait — Class in namespace Google\GAX\Testing
- Binding::setRole() — Method in class Binding
- Role that is assigned to
members
. - Binding::setMembers() — Method in class Binding
- Specifies the identities requesting access for a Cloud Platform resource.
- BindingDelta::setAction() — Method in class BindingDelta
- The action that was performed on a Binding.
- BindingDelta::setRole() — Method in class BindingDelta
- Role that is assigned to
members
. - BindingDelta::setMember() — Method in class BindingDelta
- A single identity requesting access for a Cloud Platform resource.
- GetIamPolicyRequest::setResource() — Method in class GetIamPolicyRequest
- REQUIRED: The resource for which the policy is being requested.
- IAMPolicyGrpcClient::SetIamPolicy() — Method in class IAMPolicyGrpcClient
- Sets the access control policy on the specified resource. Replaces any existing policy.
- Policy::setVersion() — Method in class Policy
- Version of the
Policy
. The default version is 0. - Policy::setBindings() — Method in class Policy
- Associates a list of
members
to arole
. - Policy::setEtag() — Method in class Policy
etag
is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other.- PolicyDelta::setBindingDeltas() — Method in class PolicyDelta
- The delta for Bindings between two policies.
- SetIamPolicyRequest — Class in namespace Google\Iam\V1
- Request message for
SetIamPolicy
method. - SetIamPolicyRequest::setResource() — Method in class SetIamPolicyRequest
- REQUIRED: The resource for which the policy is being specified.
- SetIamPolicyRequest::setPolicy() — Method in class SetIamPolicyRequest
- REQUIRED: The complete policy to be applied to the
resource
. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them. - TestIamPermissionsRequest::setResource() — Method in class TestIamPermissionsRequest
- REQUIRED: The resource for which the policy detail is being requested.
- TestIamPermissionsRequest::setPermissions() — Method in class TestIamPermissionsRequest
- The set of permissions to check for the
resource
. Permissions with wildcards (such as '' or 'storage.') are not allowed. For more information see IAM Overview. - TestIamPermissionsResponse::setPermissions() — Method in class TestIamPermissionsResponse
- A subset of
TestPermissionsRequest.permissions
that the caller is allowed. - HttpRequest::setRequestMethod() — Method in class HttpRequest
- The request method. Examples:
"GET"
,"HEAD"
,"PUT"
,"POST"
. - HttpRequest::setRequestUrl() — Method in class HttpRequest
- The scheme (http, https), the host name, the path and the query portion of the URL that was requested.
- HttpRequest::setRequestSize() — Method in class HttpRequest
- The size of the HTTP request message in bytes, including the request headers and the request body.
- HttpRequest::setStatus() — Method in class HttpRequest
- The response code indicating the status of response.
- HttpRequest::setResponseSize() — Method in class HttpRequest
- The size of the HTTP response message sent back to the client, in bytes, including the response headers and the response body.
- HttpRequest::setUserAgent() — Method in class HttpRequest
- The user agent sent by the client. Example:
"Mozilla/4.0 (compatible; MSIE 6.0; Windows 98; Q312461; .NET CLR 1.0.3705)"
. - HttpRequest::setRemoteIp() — Method in class HttpRequest
- The IP address (IPv4 or IPv6) of the client that issued the HTTP
request. Examples:
"192.168.1.1"
,"FE80::0202:B3FF:FE1E:8329"
. - HttpRequest::setServerIp() — Method in class HttpRequest
- The IP address (IPv4 or IPv6) of the origin server that the request was sent to.
- HttpRequest::setReferer() — Method in class HttpRequest
- The referer URL of the request, as defined in HTTP/1.1 Header Field Definitions.
- HttpRequest::setLatency() — Method in class HttpRequest
- The request processing latency on the server, from the time the request was received until the response was sent.
- HttpRequest::setCacheLookup() — Method in class HttpRequest
- Whether or not a cache lookup was attempted.
- HttpRequest::setCacheHit() — Method in class HttpRequest
- Whether or not an entity was served from cache (with or without validation).
- HttpRequest::setCacheValidatedWithOriginServer() — Method in class HttpRequest
- Whether or not the response was validated with the origin server before
being served from cache. This field is only meaningful if
cache_hit
is True. - HttpRequest::setCacheFillBytes() — Method in class HttpRequest
- The number of HTTP response bytes inserted into cache. Set only when a cache fill was attempted.
- CreateLogMetricRequest::setParent() — Method in class CreateLogMetricRequest
- The resource name of the project in which to create the metric: "projects/[PROJECT_ID]" The new metric must be provided in the request.
- CreateLogMetricRequest::setMetric() — Method in class CreateLogMetricRequest
- The new logs-based metric, which must not have an identifier that already exists.
- CreateSinkRequest::setParent() — Method in class CreateSinkRequest
- Required. The resource in which to create the sink:
"projects/[PROJECT_ID]"
"organizations/[ORGANIZATION_ID]"
"billingAccounts/[BILLING_ACCOUNT_ID]"
"folders/[FOLDER_ID]"
Examples:
"projects/my-logging-project"
,"organizations/123456789"
. - CreateSinkRequest::setSink() — Method in class CreateSinkRequest
- Required. The new sink, whose
name
parameter is a sink identifier that is not already in use. - CreateSinkRequest::setUniqueWriterIdentity() — Method in class CreateSinkRequest
- Optional. Determines the kind of IAM identity returned as
writer_identity
in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned aswriter_identity
is the same group or service account used by Stackdriver Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself. - DeleteLogMetricRequest::setMetricName() — Method in class DeleteLogMetricRequest
- The resource name of the metric to delete: "projects/[PROJECT_ID]/metrics/[METRIC_ID]"
- DeleteLogRequest::setLogName() — Method in class DeleteLogRequest
- Required. The resource name of the log to delete:
"projects/[PROJECT_ID]/logs/[LOG_ID]"
"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]"
"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]"
"folders/[FOLDER_ID]/logs/[LOG_ID]"
[LOG_ID]
must be URL-encoded. For example,"projects/my-project-id/logs/syslog"
,"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity"
. - DeleteSinkRequest::setSinkName() — Method in class DeleteSinkRequest
- Required. The full resource name of the sink to delete, including the
parent resource and the sink identifier:
"projects/[PROJECT_ID]/sinks/[SINK_ID]"
"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]"
"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]"
"folders/[FOLDER_ID]/sinks/[SINK_ID]"
Example:
"projects/my-project-id/sinks/my-sink-id"
. - GetLogMetricRequest::setMetricName() — Method in class GetLogMetricRequest
- The resource name of the desired metric: "projects/[PROJECT_ID]/metrics/[METRIC_ID]"
- GetSinkRequest::setSinkName() — Method in class GetSinkRequest
- Required. The resource name of the sink:
"projects/[PROJECT_ID]/sinks/[SINK_ID]"
"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]"
"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]"
"folders/[FOLDER_ID]/sinks/[SINK_ID]"
Example:
"projects/my-project-id/sinks/my-sink-id"
. - ListLogEntriesRequest::setProjectIds() — Method in class ListLogEntriesRequest
- Deprecated. Use
resource_names
instead. One or more project identifiers or project numbers from which to retrieve log entries. Example:"my-project-1A"
. If present, these project identifiers are converted to resource name format and added to the list of resources inresource_names
. - ListLogEntriesRequest::setResourceNames() — Method in class ListLogEntriesRequest
- Required. Names of one or more parent resources from which to
retrieve log entries:
"projects/[PROJECT_ID]"
"organizations/[ORGANIZATION_ID]"
"billingAccounts/[BILLING_ACCOUNT_ID]"
"folders/[FOLDER_ID]"
Projects listed in the
project_ids
field are added to this list. - ListLogEntriesRequest::setFilter() — Method in class ListLogEntriesRequest
- Optional. A filter that chooses which log entries to return. See Advanced
Logs Filters. Only log entries that
match the filter are returned. An empty filter matches all log entries in
the resources listed in
resource_names
. Referencing a parent resource that is not listed inresource_names
will cause the filter to return no results. - ListLogEntriesRequest::setOrderBy() — Method in class ListLogEntriesRequest
- Optional. How the results should be sorted. Presently, the only permitted
values are
"timestamp asc"
(default) and"timestamp desc"
. The first option returns entries in order of increasing values ofLogEntry.timestamp
(oldest first), and the second option returns entries in order of decreasing timestamps (newest first). Entries with equal timestamps are returned in order of theirinsert_id
values. - ListLogEntriesRequest::setPageSize() — Method in class ListLogEntriesRequest
- Optional. The maximum number of results to return from this request.
- ListLogEntriesRequest::setPageToken() — Method in class ListLogEntriesRequest
- Optional. If present, then retrieve the next batch of results from the
preceding call to this method.
page_token
must be the value ofnext_page_token
from the previous response. The values of other method parameters should be identical to those in the previous call. - ListLogEntriesResponse::setEntries() — Method in class ListLogEntriesResponse
- A list of log entries.
- ListLogEntriesResponse::setNextPageToken() — Method in class ListLogEntriesResponse
- If there might be more results than those appearing in this response, then
nextPageToken
is included. To get the next set of results, call this method again using the value ofnextPageToken
aspageToken
. - ListLogMetricsRequest::setParent() — Method in class ListLogMetricsRequest
- Required. The name of the project containing the metrics: "projects/[PROJECT_ID]"
- ListLogMetricsRequest::setPageToken() — Method in class ListLogMetricsRequest
- Optional. If present, then retrieve the next batch of results from the
preceding call to this method.
pageToken
must be the value ofnextPageToken
from the previous response. The values of other method parameters should be identical to those in the previous call. - ListLogMetricsRequest::setPageSize() — Method in class ListLogMetricsRequest
- Optional. The maximum number of results to return from this request.
- ListLogMetricsResponse::setMetrics() — Method in class ListLogMetricsResponse
- A list of logs-based metrics.
- ListLogMetricsResponse::setNextPageToken() — Method in class ListLogMetricsResponse
- If there might be more results than appear in this response, then
nextPageToken
is included. To get the next set of results, call this method again using the value ofnextPageToken
aspageToken
. - ListLogsRequest::setParent() — Method in class ListLogsRequest
- Required. The resource name that owns the logs: "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]"
- ListLogsRequest::setPageSize() — Method in class ListLogsRequest
- Optional. The maximum number of results to return from this request.
- ListLogsRequest::setPageToken() — Method in class ListLogsRequest
- Optional. If present, then retrieve the next batch of results from the
preceding call to this method.
pageToken
must be the value ofnextPageToken
from the previous response. The values of other method parameters should be identical to those in the previous call. - ListLogsResponse::setLogNames() — Method in class ListLogsResponse
- A list of log names. For example,
"projects/my-project/syslog"
or"organizations/123/cloudresourcemanager.googleapis.com%2Factivity"
. - ListLogsResponse::setNextPageToken() — Method in class ListLogsResponse
- If there might be more results than those appearing in this response, then
nextPageToken
is included. To get the next set of results, call this method again using the value ofnextPageToken
aspageToken
. - ListMonitoredResourceDescriptorsRequest::setPageSize() — Method in class ListMonitoredResourceDescriptorsRequest
- Optional. The maximum number of results to return from this request.
- ListMonitoredResourceDescriptorsRequest::setPageToken() — Method in class ListMonitoredResourceDescriptorsRequest
- Optional. If present, then retrieve the next batch of results from the
preceding call to this method.
pageToken
must be the value ofnextPageToken
from the previous response. The values of other method parameters should be identical to those in the previous call. - ListMonitoredResourceDescriptorsResponse::setResourceDescriptors() — Method in class ListMonitoredResourceDescriptorsResponse
- A list of resource descriptors.
- ListMonitoredResourceDescriptorsResponse::setNextPageToken() — Method in class ListMonitoredResourceDescriptorsResponse
- If there might be more results than those appearing in this response, then
nextPageToken
is included. To get the next set of results, call this method again using the value ofnextPageToken
aspageToken
. - ListSinksRequest::setParent() — Method in class ListSinksRequest
- Required. The parent resource whose sinks are to be listed: "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]"
- ListSinksRequest::setPageToken() — Method in class ListSinksRequest
- Optional. If present, then retrieve the next batch of results from the
preceding call to this method.
pageToken
must be the value ofnextPageToken
from the previous response. The values of other method parameters should be identical to those in the previous call. - ListSinksRequest::setPageSize() — Method in class ListSinksRequest
- Optional. The maximum number of results to return from this request.
- ListSinksResponse::setSinks() — Method in class ListSinksResponse
- A list of sinks.
- ListSinksResponse::setNextPageToken() — Method in class ListSinksResponse
- If there might be more results than appear in this response, then
nextPageToken
is included. To get the next set of results, call the same method again using the value ofnextPageToken
aspageToken
. - LogEntry::setLogName() — Method in class LogEntry
- Required. The resource name of the log to which this log entry belongs:
"projects/[PROJECT_ID]/logs/[LOG_ID]"
"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]"
"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]"
"folders/[FOLDER_ID]/logs/[LOG_ID]"
[LOG_ID]
must be URL-encoded withinlog_name
. Example:"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity"
. - LogEntry::setResource() — Method in class LogEntry
- Required. The monitored resource associated with this log entry.
- LogEntry::setProtoPayload() — Method in class LogEntry
- The log entry payload, represented as a protocol buffer. Some Google Cloud Platform services use this field for their log entry payloads.
- LogEntry::setTextPayload() — Method in class LogEntry
- The log entry payload, represented as a Unicode string (UTF-8).
- LogEntry::setJsonPayload() — Method in class LogEntry
- The log entry payload, represented as a structure that is expressed as a JSON object.
- LogEntry::setTimestamp() — Method in class LogEntry
- Optional. The time the event described by the log entry occurred. If omitted in a new log entry, Stackdriver Logging will insert the time the log entry is received. Stackdriver Logging might reject log entries whose time stamps are more than a couple of hours in the future. Log entries with time stamps in the past are accepted.
- LogEntry::setReceiveTimestamp() — Method in class LogEntry
- Output only. The time the log entry was received by Stackdriver Logging.
- LogEntry::setSeverity() — Method in class LogEntry
- Optional. The severity of the log entry. The default value is
LogSeverity.DEFAULT
. - LogEntry::setInsertId() — Method in class LogEntry
- Optional. A unique identifier for the log entry. If you provide a value,
then Stackdriver Logging considers other log entries in the same project,
with the same
timestamp
, and with the sameinsert_id
to be duplicates which can be removed. If omitted in new log entries, then Stackdriver Logging will insert its own unique identifier. Theinsert_id
is used to order log entries that have the sametimestamp
value. - LogEntry::setHttpRequest() — Method in class LogEntry
- Optional. Information about the HTTP request associated with this log entry, if applicable.
- LogEntry::setLabels() — Method in class LogEntry
- Optional. A set of user-defined (key, value) data that provides additional information about the log entry.
- LogEntry::setOperation() — Method in class LogEntry
- Optional. Information about an operation associated with the log entry, if applicable.
- LogEntry::setTrace() — Method in class LogEntry
- Optional. Resource name of the trace associated with the log entry, if any.
- LogEntry::setSourceLocation() — Method in class LogEntry
- Optional. Source code location information associated with the log entry, if any.
- LogEntryOperation::setId() — Method in class LogEntryOperation
- Optional. An arbitrary operation identifier. Log entries with the same identifier are assumed to be part of the same operation.
- LogEntryOperation::setProducer() — Method in class LogEntryOperation
- Optional. An arbitrary producer identifier. The combination of
id
andproducer
must be globally unique. Examples forproducer
:"MyDivision.MyBigCompany.com"
,"github.com/MyProject/MyApplication"
. - LogEntryOperation::setFirst() — Method in class LogEntryOperation
- Optional. Set this to True if this is the first log entry in the operation.
- LogEntryOperation::setLast() — Method in class LogEntryOperation
- Optional. Set this to True if this is the last log entry in the operation.
- LogEntrySourceLocation::setFile() — Method in class LogEntrySourceLocation
- Optional. Source file name. Depending on the runtime environment, this might be a simple name or a fully-qualified name.
- LogEntrySourceLocation::setLine() — Method in class LogEntrySourceLocation
- Optional. Line within the source file. 1-based; 0 indicates no line number available.
- LogEntrySourceLocation::setFunction() — Method in class LogEntrySourceLocation
- Optional. Human-readable name of the function or method being invoked, with
optional context such as the class or package name. This information may be
used in contexts such as the logs viewer, where a file and line number are
less meaningful. The format can vary by language. For example:
qual.if.ied.Class.method
(Java),dir/package.func
(Go),function
(Python). - LogMetric::setName() — Method in class LogMetric
- Required. The client-assigned metric identifier.
- LogMetric::setDescription() — Method in class LogMetric
- Optional. A description of this metric, which is used in documentation.
- LogMetric::setFilter() — Method in class LogMetric
- Required. An advanced logs filter which is used to match log entries.
- LogMetric::setVersion() — Method in class LogMetric
- Output only. The API version that created or updated this metric.
- LogSink::setName() — Method in class LogSink
- Required. The client-assigned sink identifier, unique within the
project. Example:
"my-syslog-errors-to-pubsub"
. Sink identifiers are limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods. - LogSink::setDestination() — Method in class LogSink
- Required. The export destination:
"storage.googleapis.com/[GCS_BUCKET]"
"bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]"
"pubsub.googleapis.com/projects/[PROJECT_ID]/topics/[TOPIC_ID]"
The sink's
writer_identity
, set when the sink is created, must have permission to write to the destination or else the log entries are not exported. For more information, see Exporting Logs With Sinks. - LogSink::setFilter() — Method in class LogSink
- Optional.
- LogSink::setOutputVersionFormat() — Method in class LogSink
- Optional. The log entry format to use for this sink's exported log entries. The v2 format is used by default.
- LogSink::setWriterIdentity() — Method in class LogSink
- Output only. An IAM identity—a service account or group—under
which Stackdriver Logging writes the exported log entries to the sink's
destination. This field is set by
sinks.create
and
sinks.update,
based on the setting of
unique_writer_identity
in those methods. - LogSink::setIncludeChildren() — Method in class LogSink
- Optional. This field applies only to sinks owned by organizations and
folders. If the field is false, the default, only the logs owned by the
sink's parent resource are available for export. If the field is true, then
logs from all the projects, folders, and billing accounts contained in the
sink's parent resource are also available for export. Whether a particular
log entry from the children is exported depends on the sink's filter
expression. For example, if this field is true, then the filter
resource.type=gce_instance
would export all Compute Engine VM instance log entries from all projects in the sink's parent. To only export entries from certain child projects, filter on the project part of the log name: logName:("projects/test-project1/" OR "projects/test-project2/") AND resource.type=gce_instance - LogSink::setStartTime() — Method in class LogSink
- Optional. The time at which this sink will begin exporting log entries.
- LogSink::setEndTime() — Method in class LogSink
- Optional. The time at which this sink will stop exporting log entries. Log entries are exported only if their timestamp is earlier than the end time.
- UpdateLogMetricRequest::setMetricName() — Method in class UpdateLogMetricRequest
- The resource name of the metric to update:
"projects/[PROJECT_ID]/metrics/[METRIC_ID]"
The updated metric must be provided in the request and it's
name
field must be the same as[METRIC_ID]
If the metric does not exist in[PROJECT_ID]
, then a new metric is created. - UpdateLogMetricRequest::setMetric() — Method in class UpdateLogMetricRequest
- The updated metric.
- UpdateSinkRequest::setSinkName() — Method in class UpdateSinkRequest
- Required. The full resource name of the sink to update, including the
parent resource and the sink identifier:
"projects/[PROJECT_ID]/sinks/[SINK_ID]"
"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]"
"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]"
"folders/[FOLDER_ID]/sinks/[SINK_ID]"
Example:
"projects/my-project-id/sinks/my-sink-id"
. - UpdateSinkRequest::setSink() — Method in class UpdateSinkRequest
- Required. The updated sink, whose name is the same identifier that appears
as part of
sink_name
. Ifsink_name
does not exist, then this method creates a new sink. - UpdateSinkRequest::setUniqueWriterIdentity() — Method in class UpdateSinkRequest
- Optional. See
sinks.create
for a description of this field. When updating a sink, the effect of this
field on the value of
writer_identity
in the updated sink depends on both the old and new values of this field: + If the old and new values of this field are both false or both true, then there is no change to the sink'swriter_identity
. - WriteLogEntriesPartialErrors::setLogEntryErrors() — Method in class WriteLogEntriesPartialErrors
- When
WriteLogEntriesRequest.partial_success
is true, records the error status for entries that were not written due to a permanent error, keyed by the entry's zero-based index inWriteLogEntriesRequest.entries
. - WriteLogEntriesRequest::setLogName() — Method in class WriteLogEntriesRequest
- Optional. A default log resource name that is assigned to all log entries
in
entries
that do not specify a value forlog_name
: "projects/[PROJECT_ID]/logs/[LOG_ID]" "organizations/[ORGANIZATION_ID]/logs/[LOG_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]" "folders/[FOLDER_ID]/logs/[LOG_ID]"[LOG_ID]
must be URL-encoded. For example,"projects/my-project-id/logs/syslog"
or"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity"
. - WriteLogEntriesRequest::setResource() — Method in class WriteLogEntriesRequest
- Optional. A default monitored resource object that is assigned to all log
entries in
entries
that do not specify a value forresource
. Example: { "type": "gce_instance", "labels": { "zone": "us-central1-a", "instance_id": "00000000000000000000" }} See [LogEntry][google.logging.v2.LogEntry]. - WriteLogEntriesRequest::setLabels() — Method in class WriteLogEntriesRequest
- Optional. Default labels that are added to the
labels
field of all log entries inentries
. If a log entry already has a label with the same key as a label in this parameter, then the log entry's label is not changed. - WriteLogEntriesRequest::setEntries() — Method in class WriteLogEntriesRequest
- Required. The log entries to write. Values supplied for the fields
log_name
,resource
, andlabels
in thisentries.write
request are inserted into those log entries in this list that do not provide their own values. - WriteLogEntriesRequest::setPartialSuccess() — Method in class WriteLogEntriesRequest
- Optional. Whether valid entries should be written even if some other
entries fail due to INVALID_ARGUMENT or PERMISSION_DENIED errors. If any
entry is not written, then the response status is the error associated
with one of the failed entries and the response includes error details
keyed by the entries' zero-based index in the
entries.write
method. - CancelOperationRequest::setName() — Method in class CancelOperationRequest
- The name of the operation resource to be cancelled.
- DeleteOperationRequest::setName() — Method in class DeleteOperationRequest
- The name of the operation resource to be deleted.
- GetOperationRequest::setName() — Method in class GetOperationRequest
- The name of the operation resource.
- ListOperationsRequest::setName() — Method in class ListOperationsRequest
- The name of the operation collection.
- ListOperationsRequest::setFilter() — Method in class ListOperationsRequest
- The standard list filter.
- ListOperationsRequest::setPageSize() — Method in class ListOperationsRequest
- The standard list page size.
- ListOperationsRequest::setPageToken() — Method in class ListOperationsRequest
- The standard list page token.
- ListOperationsResponse::setOperations() — Method in class ListOperationsResponse
- A list of operations that matches the specified filter in the request.
- ListOperationsResponse::setNextPageToken() — Method in class ListOperationsResponse
- The standard List next-page token.
- Operation::setName() — Method in class Operation
- The server-assigned name, which is only unique within the same service that
originally returns it. If you use the default HTTP mapping, the
name
should have the format ofoperations/some/unique/name
. - Operation::setMetadata() — Method in class Operation
- Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time.
- Operation::setDone() — Method in class Operation
- If the value is
false
, it means the operation is still in progress. - Operation::setError() — Method in class Operation
- The error result of the operation in case of failure or cancellation.
- Operation::setResponse() — Method in class Operation
- The normal response of the operation in case of success. If the original
method returns no data on success, such as
Delete
, the response isgoogle.protobuf.Empty
. If the original method is standardGet
/Create
/Update
, the response should be the resource. For other methods, the response should have the typeXxxResponse
, whereXxx
is the original method name. For example, if the original method name isTakeSnapshot()
, the inferred response type isTakeSnapshotResponse
. - Aggregation::setAlignmentPeriod() — Method in class Aggregation
- The alignment period for per-[time series][google.monitoring.v3.TimeSeries]
alignment. If present,
alignmentPeriod
must be at least 60 seconds. After per-time series alignment, each time series will contain data points only on the period boundaries. IfperSeriesAligner
is not specified or equalsALIGN_NONE
, then this field is ignored. IfperSeriesAligner
is specified and does not equalALIGN_NONE
, then this field must be defined; otherwise an error is returned. - Aggregation::setPerSeriesAligner() — Method in class Aggregation
- The approach to be used to align individual time series. Not all alignment functions may be applied to all time series, depending on the metric type and value type of the original time series. Alignment may change the metric type or the value type of the time series.
- Aggregation::setCrossSeriesReducer() — Method in class Aggregation
- The approach to be used to combine time series. Not all reducer functions may be applied to all time series, depending on the metric type and the value type of the original time series. Reduction may change the metric type of value type of the time series.
- Aggregation::setGroupByFields() — Method in class Aggregation
- The set of fields to preserve when
crossSeriesReducer
is specified. ThegroupByFields
determine how the time series are partitioned into subsets prior to applying the aggregation function. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. ThecrossSeriesReducer
is applied to each subset of time series. - CreateGroupRequest::setName() — Method in class CreateGroupRequest
- The project in which to create the group. The format is
"projects/{project_id_or_number}"
. - CreateGroupRequest::setGroup() — Method in class CreateGroupRequest
- A group definition. It is an error to define the
name
field because the system assigns the name. - CreateGroupRequest::setValidateOnly() — Method in class CreateGroupRequest
- If true, validate this request but do not create the group.
- CreateMetricDescriptorRequest::setName() — Method in class CreateMetricDescriptorRequest
- The project on which to execute the request. The format is
"projects/{project_id_or_number}"
. - CreateMetricDescriptorRequest::setMetricDescriptor() — Method in class CreateMetricDescriptorRequest
- The new custom metric descriptor.
- CreateTimeSeriesError::setTimeSeries() — Method in class CreateTimeSeriesError
- The time series, including the
Metric
,MonitoredResource
, andPoint
s (including timestamp and value) that resulted in the error. This field provides all of the context that would be needed to retry the operation. - CreateTimeSeriesError::setStatus() — Method in class CreateTimeSeriesError
- The status of the requested write operation.
- CreateTimeSeriesRequest::setName() — Method in class CreateTimeSeriesRequest
- The project on which to execute the request. The format is
"projects/{project_id_or_number}"
. - CreateTimeSeriesRequest::setTimeSeries() — Method in class CreateTimeSeriesRequest
- The new data to be added to a list of time series.
- DeleteGroupRequest::setName() — Method in class DeleteGroupRequest
- The group to delete. The format is
"projects/{project_id_or_number}/groups/{group_id}"
. - DeleteMetricDescriptorRequest::setName() — Method in class DeleteMetricDescriptorRequest
- The metric descriptor on which to execute the request. The format is
"projects/{project_id_or_number}/metricDescriptors/{metric_id}"
. - GetGroupRequest::setName() — Method in class GetGroupRequest
- The group to retrieve. The format is
"projects/{project_id_or_number}/groups/{group_id}"
. - GetMetricDescriptorRequest::setName() — Method in class GetMetricDescriptorRequest
- The metric descriptor on which to execute the request. The format is
"projects/{project_id_or_number}/metricDescriptors/{metric_id}"
. - GetMonitoredResourceDescriptorRequest::setName() — Method in class GetMonitoredResourceDescriptorRequest
- The monitored resource descriptor to get. The format is
"projects/{project_id_or_number}/monitoredResourceDescriptors/{resource_type}"
. - Group::setName() — Method in class Group
- Output only. The name of this group. The format is
"projects/{project_id_or_number}/groups/{group_id}"
. - Group::setDisplayName() — Method in class Group
- A user-assigned name for this group, used only for display purposes.
- Group::setParentName() — Method in class Group
- The name of the group's parent, if it has one.
- Group::setFilter() — Method in class Group
- The filter used to determine which monitored resources belong to this group.
- Group::setIsCluster() — Method in class Group
- If true, the members of this group are considered to be a cluster.
- ListGroupMembersRequest::setName() — Method in class ListGroupMembersRequest
- The group whose members are listed. The format is
"projects/{project_id_or_number}/groups/{group_id}"
. - ListGroupMembersRequest::setPageSize() — Method in class ListGroupMembersRequest
- A positive number that is the maximum number of results to return.
- ListGroupMembersRequest::setPageToken() — Method in class ListGroupMembersRequest
- If this field is not empty then it must contain the
nextPageToken
value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call. - ListGroupMembersRequest::setFilter() — Method in class ListGroupMembersRequest
- An optional list filter describing the members to be returned. The filter may reference the type, labels, and metadata of monitored resources that comprise the group.
- ListGroupMembersRequest::setInterval() — Method in class ListGroupMembersRequest
- An optional time interval for which results should be returned. Only members that were part of the group during the specified interval are included in the response. If no interval is provided then the group membership over the last minute is returned.
- ListGroupMembersResponse::setMembers() — Method in class ListGroupMembersResponse
- A set of monitored resources in the group.
- ListGroupMembersResponse::setNextPageToken() — Method in class ListGroupMembersResponse
- If there are more results than have been returned, then this field is
set to a non-empty value. To see the additional results, use that value as
pageToken
in the next call to this method. - ListGroupMembersResponse::setTotalSize() — Method in class ListGroupMembersResponse
- The total number of elements matching this request.
- ListGroupsRequest::setName() — Method in class ListGroupsRequest
- The project whose groups are to be listed. The format is
"projects/{project_id_or_number}"
. - ListGroupsRequest::setChildrenOfGroup() — Method in class ListGroupsRequest
- A group name:
"projects/{project_id_or_number}/groups/{group_id}"
. - ListGroupsRequest::setAncestorsOfGroup() — Method in class ListGroupsRequest
- A group name:
"projects/{project_id_or_number}/groups/{group_id}"
. - ListGroupsRequest::setDescendantsOfGroup() — Method in class ListGroupsRequest
- A group name:
"projects/{project_id_or_number}/groups/{group_id}"
. - ListGroupsRequest::setPageSize() — Method in class ListGroupsRequest
- A positive number that is the maximum number of results to return.
- ListGroupsRequest::setPageToken() — Method in class ListGroupsRequest
- If this field is not empty then it must contain the
nextPageToken
value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call. - ListGroupsResponse::setGroup() — Method in class ListGroupsResponse
- The groups that match the specified filters.
- ListGroupsResponse::setNextPageToken() — Method in class ListGroupsResponse
- If there are more results than have been returned, then this field is set
to a non-empty value. To see the additional results,
use that value as
pageToken
in the next call to this method. - ListMetricDescriptorsRequest::setName() — Method in class ListMetricDescriptorsRequest
- The project on which to execute the request. The format is
"projects/{project_id_or_number}"
. - ListMetricDescriptorsRequest::setFilter() — Method in class ListMetricDescriptorsRequest
- If this field is empty, all custom and system-defined metric descriptors are returned.
- ListMetricDescriptorsRequest::setPageSize() — Method in class ListMetricDescriptorsRequest
- A positive number that is the maximum number of results to return.
- ListMetricDescriptorsRequest::setPageToken() — Method in class ListMetricDescriptorsRequest
- If this field is not empty then it must contain the
nextPageToken
value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call. - ListMetricDescriptorsResponse::setMetricDescriptors() — Method in class ListMetricDescriptorsResponse
- The metric descriptors that are available to the project
and that match the value of
filter
, if present. - ListMetricDescriptorsResponse::setNextPageToken() — Method in class ListMetricDescriptorsResponse
- If there are more results than have been returned, then this field is set
to a non-empty value. To see the additional results,
use that value as
pageToken
in the next call to this method. - ListMonitoredResourceDescriptorsRequest::setName() — Method in class ListMonitoredResourceDescriptorsRequest
- The project on which to execute the request. The format is
"projects/{project_id_or_number}"
. - ListMonitoredResourceDescriptorsRequest::setFilter() — Method in class ListMonitoredResourceDescriptorsRequest
- An optional filter describing
the descriptors to be returned. The filter can reference
the descriptor's type and labels. For example, the
following filter returns only Google Compute Engine descriptors
that have an
id
label: resource.type = starts_with("gce_") AND resource.label:id - ListMonitoredResourceDescriptorsRequest::setPageSize() — Method in class ListMonitoredResourceDescriptorsRequest
- A positive number that is the maximum number of results to return.
- ListMonitoredResourceDescriptorsRequest::setPageToken() — Method in class ListMonitoredResourceDescriptorsRequest
- If this field is not empty then it must contain the
nextPageToken
value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call. - ListMonitoredResourceDescriptorsResponse::setResourceDescriptors() — Method in class ListMonitoredResourceDescriptorsResponse
- The monitored resource descriptors that are available to this project
and that match
filter
, if present. - ListMonitoredResourceDescriptorsResponse::setNextPageToken() — Method in class ListMonitoredResourceDescriptorsResponse
- If there are more results than have been returned, then this field is set
to a non-empty value. To see the additional results,
use that value as
pageToken
in the next call to this method. - ListTimeSeriesRequest::setName() — Method in class ListTimeSeriesRequest
- The project on which to execute the request. The format is "projects/{project_id_or_number}".
- ListTimeSeriesRequest::setFilter() — Method in class ListTimeSeriesRequest
- A monitoring filter that specifies which time series should be returned. The filter must specify a single metric type, and can additionally specify metric labels and other information. For example: metric.type = "compute.googleapis.com/instance/cpu/usage_time" AND metric.label.instance_name = "my-instance-name"
- ListTimeSeriesRequest::setInterval() — Method in class ListTimeSeriesRequest
- The time interval for which results should be returned. Only time series that contain data points in the specified interval are included in the response.
- ListTimeSeriesRequest::setAggregation() — Method in class ListTimeSeriesRequest
- By default, the raw time series data is returned.
- ListTimeSeriesRequest::setOrderBy() — Method in class ListTimeSeriesRequest
- Specifies the order in which the points of the time series should be returned. By default, results are not ordered. Currently, this field must be left blank.
- ListTimeSeriesRequest::setView() — Method in class ListTimeSeriesRequest
- Specifies which information is returned about the time series.
- ListTimeSeriesRequest::setPageSize() — Method in class ListTimeSeriesRequest
- A positive number that is the maximum number of results to return.
- ListTimeSeriesRequest::setPageToken() — Method in class ListTimeSeriesRequest
- If this field is not empty then it must contain the
nextPageToken
value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call. - ListTimeSeriesResponse::setTimeSeries() — Method in class ListTimeSeriesResponse
- One or more time series that match the filter included in the request.
- ListTimeSeriesResponse::setNextPageToken() — Method in class ListTimeSeriesResponse
- If there are more results than have been returned, then this field is set
to a non-empty value. To see the additional results,
use that value as
pageToken
in the next call to this method. - Point::setInterval() — Method in class Point
- The time interval to which the data point applies. For GAUGE metrics, only the end time of the interval is used. For DELTA metrics, the start and end time should specify a non-zero interval, with subsequent points specifying contiguous and non-overlapping intervals. For CUMULATIVE metrics, the start and end time should specify a non-zero interval, with subsequent points specifying the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points.
- Point::setValue() — Method in class Point
- The value of the data point.
- TimeInterval::setEndTime() — Method in class TimeInterval
- Required. The end of the time interval.
- TimeInterval::setStartTime() — Method in class TimeInterval
- Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time.
- TimeSeries::setMetric() — Method in class TimeSeries
- The associated metric. A fully-specified metric used to identify the time series.
- TimeSeries::setResource() — Method in class TimeSeries
- The associated resource. A fully-specified monitored resource used to identify the time series.
- TimeSeries::setMetricKind() — Method in class TimeSeries
- The metric kind of the time series. When listing time series, this metric kind might be different from the metric kind of the associated metric if this time series is an alignment or reduction of other time series.
- TimeSeries::setValueType() — Method in class TimeSeries
- The value type of the time series. When listing time series, this value type might be different from the value type of the associated metric if this time series is an alignment or reduction of other time series.
- TimeSeries::setPoints() — Method in class TimeSeries
- The data points of this time series. When listing time series, the order of the points is specified by the list method.
- TypedValue::setBoolValue() — Method in class TypedValue
- A Boolean value:
true
orfalse
. - TypedValue::setInt64Value() — Method in class TypedValue
- A 64-bit integer. Its range is approximately ±9.2x1018.
- TypedValue::setDoubleValue() — Method in class TypedValue
- A 64-bit double-precision floating-point number. Its magnitude is approximately ±10±300 and it has 16 significant digits of precision.
- TypedValue::setStringValue() — Method in class TypedValue
- A variable-length string value.
- TypedValue::setDistributionValue() — Method in class TypedValue
- A distribution value.
- UpdateGroupRequest::setGroup() — Method in class UpdateGroupRequest
- The new definition of the group. All fields of the existing group,
excepting
name
, are replaced with the corresponding fields of this group. - UpdateGroupRequest::setValidateOnly() — Method in class UpdateGroupRequest
- If true, validate this request but do not update the existing group.
- Any::setTypeUrl() — Method in class Any
- A URL/resource name whose content describes the type of the serialized protocol buffer message.
- Any::setValue() — Method in class Any
- Must be a valid serialized protocol buffer of the above specified type.
- Api::setName() — Method in class Api
- The fully qualified name of this api, including package name followed by the api's simple name.
- Api::setMethods() — Method in class Api
- The methods of this api, in unspecified order.
- Api::setOptions() — Method in class Api
- Any metadata attached to the API.
- Api::setVersion() — Method in class Api
- A version string for this api. If specified, must have the form
major-version.minor-version
, as in1.10
. If the minor version is omitted, it defaults to zero. If the entire version field is empty, the major version is derived from the package name, as outlined below. If the field is not empty, the version in the package name will be verified to be consistent with what is provided here. - Api::setSourceContext() — Method in class Api
- Source context for the protocol buffer service represented by this message.
- Api::setMixins() — Method in class Api
- Included APIs. See [Mixin][].
- Api::setSyntax() — Method in class Api
- The source syntax of the service.
- BoolValue::setValue() — Method in class BoolValue
- The bool value.
- BytesValue::setValue() — Method in class BytesValue
- The bytes value.
- DoubleValue::setValue() — Method in class DoubleValue
- The double value.
- Duration::setSeconds() — Method in class Duration
- Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
- Duration::setNanos() — Method in class Duration
- Signed fractions of a second at nanosecond resolution of the span
of time. Durations less than one second are represented with a 0
seconds
field and a positive or negativenanos
field. For durations of one second or more, a non-zero value for thenanos
field must be of the same sign as theseconds
field. Must be from -999,999,999 to +999,999,999 inclusive. - Enum::setName() — Method in class Enum
- Enum type name.
- Enum::setEnumvalue() — Method in class Enum
- Enum value definitions.
- Enum::setOptions() — Method in class Enum
- Protocol buffer options.
- Enum::setSourceContext() — Method in class Enum
- The source context.
- Enum::setSyntax() — Method in class Enum
- The source syntax.
- EnumValue::setName() — Method in class EnumValue
- Enum value name.
- EnumValue::setNumber() — Method in class EnumValue
- Enum value number.
- EnumValue::setOptions() — Method in class EnumValue
- Protocol buffer options.
- Field::setKind() — Method in class Field
- The field type.
- Field::setCardinality() — Method in class Field
- The field cardinality.
- Field::setNumber() — Method in class Field
- The field number.
- Field::setName() — Method in class Field
- The field name.
- Field::setTypeUrl() — Method in class Field
- The field type URL, without the scheme, for message or enumeration
types. Example:
"type.googleapis.com/google.protobuf.Timestamp"
. - Field::setOneofIndex() — Method in class Field
- The index of the field type in
Type.oneofs
, for message or enumeration types. The first type has index 1; zero means the type is not in the list. - Field::setPacked() — Method in class Field
- Whether to use alternative packed wire representation.
- Field::setOptions() — Method in class Field
- The protocol buffer options.
- Field::setJsonName() — Method in class Field
- The field JSON name.
- Field::setDefaultValue() — Method in class Field
- The string value of the default value of this field. Proto2 syntax only.
- FieldMask::setPaths() — Method in class FieldMask
- The set of field mask paths.
- FloatValue::setValue() — Method in class FloatValue
- The float value.
- Int32Value::setValue() — Method in class Int32Value
- The int32 value.
- Int64Value::setValue() — Method in class Int64Value
- The int64 value.
- ListValue::setValues() — Method in class ListValue
- Repeated field of dynamically typed values.
- Method::setName() — Method in class Method
- The simple name of this method.
- Method::setRequestTypeUrl() — Method in class Method
- A URL of the input message type.
- Method::setRequestStreaming() — Method in class Method
- If true, the request is streamed.
- Method::setResponseTypeUrl() — Method in class Method
- The URL of the output message type.
- Method::setResponseStreaming() — Method in class Method
- If true, the response is streamed.
- Method::setOptions() — Method in class Method
- Any metadata attached to the method.
- Method::setSyntax() — Method in class Method
- The source syntax of this method.
- Mixin::setName() — Method in class Mixin
- The fully qualified name of the API which is included.
- Mixin::setRoot() — Method in class Mixin
- If non-empty specifies a path under which inherited HTTP paths are rooted.
- Option::setName() — Method in class Option
- The option's name. For protobuf built-in options (options defined in
descriptor.proto), this is the short name. For example,
"map_entry"
. - Option::setValue() — Method in class Option
- The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type.
- SourceContext — Class in namespace Google\Protobuf
SourceContext
represents information about the source of a protobuf element, like the file in which it is defined.- SourceContext::setFileName() — Method in class SourceContext
- The path-qualified name of the .proto file that contained the associated
protobuf element. For example:
"google/protobuf/source_context.proto"
. - StringValue — Class in namespace Google\Protobuf
- Wrapper message for
string
. - StringValue::setValue() — Method in class StringValue
- The string value.
- Struct — Class in namespace Google\Protobuf
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.- Struct::setFields() — Method in class Struct
- Unordered map of dynamically typed values.
- Syntax — Class in namespace Google\Protobuf
- The syntax in which a protocol buffer element is defined.
- Timestamp::setSeconds() — Method in class Timestamp
- Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive.
- Timestamp::setNanos() — Method in class Timestamp
- Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive.
- Type::setName() — Method in class Type
- The fully qualified message name.
- Type::setFields() — Method in class Type
- The list of fields.
- Type::setOneofs() — Method in class Type
- The list of types appearing in
oneof
definitions in this type. - Type::setOptions() — Method in class Type
- The protocol buffer options.
- Type::setSourceContext() — Method in class Type
- The source context.
- Type::setSyntax() — Method in class Type
- The source syntax.
- UInt32Value::setValue() — Method in class UInt32Value
- The uint32 value.
- UInt64Value::setValue() — Method in class UInt64Value
- The uint64 value.
- Value::setNullValue() — Method in class Value
- Represents a null value.
- Value::setNumberValue() — Method in class Value
- Represents a double value.
- Value::setStringValue() — Method in class Value
- Represents a string value.
- Value::setBoolValue() — Method in class Value
- Represents a boolean value.
- Value::setStructValue() — Method in class Value
- Represents a structured value.
- Value::setListValue() — Method in class Value
- Represents a repeated
Value
. - AcknowledgeRequest::setSubscription() — Method in class AcknowledgeRequest
- The subscription whose message is being acknowledged.
- AcknowledgeRequest::setAckIds() — Method in class AcknowledgeRequest
- The acknowledgment ID for the messages being acknowledged that was returned
by the Pub/Sub system in the
Pull
response. Must not be empty. - CreateSnapshotRequest::setName() — Method in class CreateSnapshotRequest
- Optional user-provided name for this snapshot.
- CreateSnapshotRequest::setSubscription() — Method in class CreateSnapshotRequest
- The subscription whose backlog the snapshot retains.
- DeleteSnapshotRequest::setSnapshot() — Method in class DeleteSnapshotRequest
- The name of the snapshot to delete.
- DeleteSubscriptionRequest::setSubscription() — Method in class DeleteSubscriptionRequest
- The subscription to delete.
- DeleteTopicRequest::setTopic() — Method in class DeleteTopicRequest
- Name of the topic to delete.
- GetSubscriptionRequest::setSubscription() — Method in class GetSubscriptionRequest
- The name of the subscription to get.
- GetTopicRequest::setTopic() — Method in class GetTopicRequest
- The name of the topic to get.
- ListSnapshotsRequest::setProject() — Method in class ListSnapshotsRequest
- The name of the cloud project that snapshots belong to.
- ListSnapshotsRequest::setPageSize() — Method in class ListSnapshotsRequest
- Maximum number of snapshots to return.
- ListSnapshotsRequest::setPageToken() — Method in class ListSnapshotsRequest
- The value returned by the last
ListSnapshotsResponse
; indicates that this is a continuation of a priorListSnapshots
call, and that the system should return the next page of data. - ListSnapshotsResponse::setSnapshots() — Method in class ListSnapshotsResponse
- The resulting snapshots.
- ListSnapshotsResponse::setNextPageToken() — Method in class ListSnapshotsResponse
- If not empty, indicates that there may be more snapshot that match the
request; this value should be passed in a new
ListSnapshotsRequest
. - ListSubscriptionsRequest::setProject() — Method in class ListSubscriptionsRequest
- The name of the cloud project that subscriptions belong to.
- ListSubscriptionsRequest::setPageSize() — Method in class ListSubscriptionsRequest
- Maximum number of subscriptions to return.
- ListSubscriptionsRequest::setPageToken() — Method in class ListSubscriptionsRequest
- The value returned by the last
ListSubscriptionsResponse
; indicates that this is a continuation of a priorListSubscriptions
call, and that the system should return the next page of data. - ListSubscriptionsResponse::setSubscriptions() — Method in class ListSubscriptionsResponse
- The subscriptions that match the request.
- ListSubscriptionsResponse::setNextPageToken() — Method in class ListSubscriptionsResponse
- If not empty, indicates that there may be more subscriptions that match
the request; this value should be passed in a new
ListSubscriptionsRequest
to get more subscriptions. - ListTopicSubscriptionsRequest::setTopic() — Method in class ListTopicSubscriptionsRequest
- The name of the topic that subscriptions are attached to.
- ListTopicSubscriptionsRequest::setPageSize() — Method in class ListTopicSubscriptionsRequest
- Maximum number of subscription names to return.
- ListTopicSubscriptionsRequest::setPageToken() — Method in class ListTopicSubscriptionsRequest
- The value returned by the last
ListTopicSubscriptionsResponse
; indicates that this is a continuation of a priorListTopicSubscriptions
call, and that the system should return the next page of data. - ListTopicSubscriptionsResponse::setSubscriptions() — Method in class ListTopicSubscriptionsResponse
- The names of the subscriptions that match the request.
- ListTopicSubscriptionsResponse::setNextPageToken() — Method in class ListTopicSubscriptionsResponse
- If not empty, indicates that there may be more subscriptions that match
the request; this value should be passed in a new
ListTopicSubscriptionsRequest
to get more subscriptions. - ListTopicsRequest::setProject() — Method in class ListTopicsRequest
- The name of the cloud project that topics belong to.
- ListTopicsRequest::setPageSize() — Method in class ListTopicsRequest
- Maximum number of topics to return.
- ListTopicsRequest::setPageToken() — Method in class ListTopicsRequest
- The value returned by the last
ListTopicsResponse
; indicates that this is a continuation of a priorListTopics
call, and that the system should return the next page of data. - ListTopicsResponse::setTopics() — Method in class ListTopicsResponse
- The resulting topics.
- ListTopicsResponse::setNextPageToken() — Method in class ListTopicsResponse
- If not empty, indicates that there may be more topics that match the
request; this value should be passed in a new
ListTopicsRequest
. - ModifyAckDeadlineRequest::setSubscription() — Method in class ModifyAckDeadlineRequest
- The name of the subscription.
- ModifyAckDeadlineRequest::setAckIds() — Method in class ModifyAckDeadlineRequest
- List of acknowledgment IDs.
- ModifyAckDeadlineRequest::setAckDeadlineSeconds() — Method in class ModifyAckDeadlineRequest
- The new ack deadline with respect to the time this request was sent to
the Pub/Sub system. For example, if the value is 10, the new
ack deadline will expire 10 seconds after the
ModifyAckDeadline
call was made. Specifying zero may immediately make the message available for another pull request. - ModifyPushConfigRequest::setSubscription() — Method in class ModifyPushConfigRequest
- The name of the subscription.
- ModifyPushConfigRequest::setPushConfig() — Method in class ModifyPushConfigRequest
- The push configuration for future deliveries.
- PublishRequest::setTopic() — Method in class PublishRequest
- The messages in the request will be published on this topic.
- PublishRequest::setMessages() — Method in class PublishRequest
- The messages to publish.
- PublishResponse::setMessageIds() — Method in class PublishResponse
- The server-assigned ID of each published message, in the same order as the messages in the request. IDs are guaranteed to be unique within the topic.
- PubsubMessage::setData() — Method in class PubsubMessage
- The message payload.
- PubsubMessage::setAttributes() — Method in class PubsubMessage
- Optional attributes for this message.
- PubsubMessage::setMessageId() — Method in class PubsubMessage
- ID of this message, assigned by the server when the message is published.
- PubsubMessage::setPublishTime() — Method in class PubsubMessage
- The time at which the message was published, populated by the server when
it receives the
Publish
call. It must not be populated by the publisher in aPublish
call. - PullRequest::setSubscription() — Method in class PullRequest
- The subscription from which messages should be pulled.
- PullRequest::setReturnImmediately() — Method in class PullRequest
- If this field set to true, the system will respond immediately even if
it there are no messages available to return in the
Pull
response. - PullRequest::setMaxMessages() — Method in class PullRequest
- The maximum number of messages returned for this request. The Pub/Sub system may return fewer than the number specified.
- PullResponse::setReceivedMessages() — Method in class PullResponse
- Received Pub/Sub messages. The Pub/Sub system will return zero messages if
there are no more available in the backlog. The Pub/Sub system may return
fewer than the
maxMessages
requested even if there are more messages available in the backlog. - PushConfig::setPushEndpoint() — Method in class PushConfig
- A URL locating the endpoint to which messages should be pushed.
- PushConfig::setAttributes() — Method in class PushConfig
- Endpoint configuration attributes.
- ReceivedMessage::setAckId() — Method in class ReceivedMessage
- This ID can be used to acknowledge the received message.
- ReceivedMessage::setMessage() — Method in class ReceivedMessage
- The message.
- SeekRequest — Class in namespace Google\Pubsub\V1
- Request for the
Seek
method. - SeekRequest::setSubscription() — Method in class SeekRequest
- The subscription to affect.
- SeekRequest::setTime() — Method in class SeekRequest
- The time to seek to.
- SeekRequest::setSnapshot() — Method in class SeekRequest
- The snapshot to seek to. The snapshot's topic must be the same as that of the provided subscription.
- SeekResponse — Class in namespace Google\Pubsub\V1
- Protobuf type
Google\Pubsub\V1\SeekResponse
- Snapshot — Class in namespace Google\Pubsub\V1
- A snapshot resource.
- Snapshot::setName() — Method in class Snapshot
- The name of the snapshot.
- Snapshot::setTopic() — Method in class Snapshot
- The name of the topic from which this snapshot is retaining messages.
- Snapshot::setExpireTime() — Method in class Snapshot
- The snapshot is guaranteed to exist up until this time.
- StreamingPullRequest — Class in namespace Google\Pubsub\V1
- 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. - StreamingPullRequest::setSubscription() — Method in class StreamingPullRequest
- The subscription for which to initialize the new stream. This must be provided in the first request on the stream, and must not be set in subsequent requests from client to server.
- StreamingPullRequest::setAckIds() — Method in class StreamingPullRequest
- List of acknowledgement IDs for acknowledging previously received messages
(received on this stream or a different stream). If an ack ID has expired,
the corresponding message may be redelivered later. Acknowledging a message
more than once will not result in an error. If the acknowledgement ID is
malformed, the stream will be aborted with status
INVALID_ARGUMENT
. - StreamingPullRequest::setModifyDeadlineSeconds() — Method in class StreamingPullRequest
- The list of new ack deadlines for the IDs listed in
modify_deadline_ack_ids
. The size of this list must be the same as the size ofmodify_deadline_ack_ids
. If it differs the stream will be aborted withINVALID_ARGUMENT
. Each element in this list is applied to the element in the same position inmodify_deadline_ack_ids
. The new ack deadline is with respect to the time this request was sent to the Pub/Sub system. Must be >= 0. For example, if the value is 10, the new ack deadline will expire 10 seconds after this request is received. If the value is 0, the message is immediately made available for another streaming or non-streaming pull request. If the value is < 0 (an error), the stream will be aborted with statusINVALID_ARGUMENT
. - StreamingPullRequest::setModifyDeadlineAckIds() — Method in class StreamingPullRequest
- List of acknowledgement IDs whose deadline will be modified based on the
corresponding element in
modify_deadline_seconds
. This field can be used to indicate that more time is needed to process a message by the subscriber, or to make the message available for redelivery if the processing was interrupted. - StreamingPullRequest::setStreamAckDeadlineSeconds() — Method in class StreamingPullRequest
- The ack deadline to use for the stream. This must be provided in the first request on the stream, but it can also be updated on subsequent requests from client to server. The minimum deadline you can specify is 10 seconds. The maximum deadline you can specify is 600 seconds (10 minutes).
- StreamingPullResponse — Class in namespace Google\Pubsub\V1
- Response for the
StreamingPull
method. This response is used to stream messages from the server to the client. - StreamingPullResponse::setReceivedMessages() — Method in class StreamingPullResponse
- Received Pub/Sub messages. This will not be empty.
- SubscriberGrpcClient — Class in namespace Google\Pubsub\V1
- The service that an application uses to manipulate subscriptions and to
consume messages from a subscription via the
Pull
method. - SubscriberGrpcClient::StreamingPull() — Method in class SubscriberGrpcClient
- (EXPERIMENTAL) StreamingPull is an experimental feature. This RPC will respond with UNIMPLEMENTED errors unless you have been invited to test this feature. Contact cloud-pubsub@google.com with any questions.
- SubscriberGrpcClient::Seek() — Method in class SubscriberGrpcClient
- Seeks an existing subscription to a point in time or to a given snapshot, whichever is provided in the request.
- Subscription — Class in namespace Google\Pubsub\V1
- A subscription resource.
- Subscription::setName() — Method in class Subscription
- The name of the subscription. It must have the format
"projects/{project}/subscriptions/{subscription}"
.{subscription}
must start with a letter, and contain only letters ([A-Za-z]
), numbers ([0-9]
), dashes (-
), underscores (_
), periods (.
), tildes (~
), plus (+
) or percent signs (%
). It must be between 3 and 255 characters in length, and it must not start with"goog"
. - Subscription::setTopic() — Method in class Subscription
- The name of the topic from which this subscription is receiving messages.
- Subscription::setPushConfig() — Method in class Subscription
- If push delivery is used with this subscription, this field is
used to configure it. An empty
pushConfig
signifies that the subscriber will pull and ack messages using API methods. - Subscription::setAckDeadlineSeconds() — Method in class Subscription
- This value is the maximum time after a subscriber receives a message before the subscriber should acknowledge the message. After message delivery but before the ack deadline expires and before the message is acknowledged, it is an outstanding message and will not be delivered again during that time (on a best-effort basis).
- Subscription::setRetainAckedMessages() — Method in class Subscription
- Indicates whether to retain acknowledged messages. If true, then
messages are not expunged from the subscription's backlog, even if they are
acknowledged, until they fall out of the
message_retention_duration
window. - Subscription::setMessageRetentionDuration() — Method in class Subscription
- How long to retain unacknowledged messages in the subscription's backlog, from the moment a message is published.
- Topic::setName() — Method in class Topic
- The name of the topic. It must have the format
"projects/{project}/topics/{topic}"
.{topic}
must start with a letter, and contain only letters ([A-Za-z]
), numbers ([0-9]
), dashes (-
), underscores (_
), periods (.
), tildes (~
), plus (+
) or percent signs (%
). It must be between 3 and 255 characters in length, and it must not start with"goog"
. - UpdateSubscriptionRequest::setSubscription() — Method in class UpdateSubscriptionRequest
- The updated subscription object.
- UpdateSubscriptionRequest::setUpdateMask() — Method in class UpdateSubscriptionRequest
- Indicates which fields in the provided subscription to update.
- BadRequest::setFieldViolations() — Method in class BadRequest
- Describes all violations in a client request.
- BadRequest_FieldViolation::setField() — Method in class BadRequest_FieldViolation
- A path leading to a field in the request body. The value will be a sequence of dot-separated identifiers that identify a protocol buffer field. E.g., "field_violations.field" would identify this field.
- BadRequest_FieldViolation::setDescription() — Method in class BadRequest_FieldViolation
- A description of why the request element is bad.
- DebugInfo::setStackEntries() — Method in class DebugInfo
- The stack trace entries indicating where the error occurred.
- DebugInfo::setDetail() — Method in class DebugInfo
- Additional debugging information provided by the server.
- Help::setLinks() — Method in class Help
- URL(s) pointing to additional information on handling the current error.
- Help_Link::setDescription() — Method in class Help_Link
- Describes what the link offers.
- Help_Link::setUrl() — Method in class Help_Link
- The URL of the link.
- LocalizedMessage::setLocale() — Method in class LocalizedMessage
- The locale used following the specification defined at http://www.rfc-editor.org/rfc/bcp/bcp47.txt.
- LocalizedMessage::setMessage() — Method in class LocalizedMessage
- The localized error message in the above locale.
- QuotaFailure::setViolations() — Method in class QuotaFailure
- Describes all quota violations.
- QuotaFailure_Violation::setSubject() — Method in class QuotaFailure_Violation
- The subject on which the quota check failed.
- QuotaFailure_Violation::setDescription() — Method in class QuotaFailure_Violation
- A description of how the quota check failed. Clients can use this description to find more about the quota configuration in the service's public documentation, or find the relevant quota limit to adjust through developer console.
- RequestInfo::setRequestId() — Method in class RequestInfo
- An opaque string that should only be interpreted by the service generating it. For example, it can be used to identify requests in the service's logs.
- RequestInfo::setServingData() — Method in class RequestInfo
- Any data that was used to serve this request. For example, an encrypted stack trace that can be sent back to the service provider for debugging.
- ResourceInfo::setResourceType() — Method in class ResourceInfo
- A name for the type of resource being accessed, e.g. "sql table", "cloud storage bucket", "file", "Google calendar"; or the type URL of the resource: e.g. "type.googleapis.com/google.pubsub.v1.Topic".
- ResourceInfo::setResourceName() — Method in class ResourceInfo
- The name of the resource being accessed. For example, a shared calendar name: "example.com_4fghdhgsrgh@group.calendar.google.com", if the current error is [google.rpc.Code.PERMISSION_DENIED][google.rpc.Code.PERMISSION_DENIED].
- ResourceInfo::setOwner() — Method in class ResourceInfo
- The owner of the resource (optional).
- ResourceInfo::setDescription() — Method in class ResourceInfo
- Describes what error is encountered when accessing this resource.
- RetryInfo::setRetryDelay() — Method in class RetryInfo
- Clients should wait at least this long between retrying the same request.
- Status — Class in namespace Google\Rpc
- 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 needsOverview
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 packagegoogle.rpc
which can be used for common error conditions. - Status::setCode() — Method in class Status
- The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
- Status::setMessage() — Method in class Status
- A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
- Status::setDetails() — Method in class Status
- A list of messages that carry the error details. There will be a common set of message types for APIs to use.
- CreateDatabaseMetadata::setDatabase() — Method in class CreateDatabaseMetadata
- The database being created.
- CreateDatabaseRequest::setParent() — Method in class CreateDatabaseRequest
- Required. The name of the instance that will serve the new database.
- CreateDatabaseRequest::setCreateStatement() — Method in class CreateDatabaseRequest
- Required. A
CREATE DATABASE
statement, which specifies the ID of the new database. The database ID must conform to the regular expression[a-z][a-z0-9_\-]*[a-z0-9]
and be between 2 and 30 characters in length. - CreateDatabaseRequest::setExtraStatements() — Method in class CreateDatabaseRequest
- An optional list of DDL statements to run inside the newly created database. Statements can create tables, indexes, etc. These statements execute atomically with the creation of the database: if there is an error in any statement, the database is not created.
- Database::setName() — Method in class Database
- Required. The name of the database. Values are of the form
projects/<project>/instances/<instance>/databases/<database>
, where<database>
is as specified in theCREATE DATABASE
statement. This name can be passed to other API methods to identify the database. - Database::setState() — Method in class Database
- Output only. The current database state.
- DatabaseAdminGrpcClient::SetIamPolicy() — Method in class DatabaseAdminGrpcClient
- Sets the access control policy on a database resource. Replaces any existing policy.
- DropDatabaseRequest::setDatabase() — Method in class DropDatabaseRequest
- Required. The database to be dropped.
- GetDatabaseDdlRequest::setDatabase() — Method in class GetDatabaseDdlRequest
- Required. The database whose schema we wish to get.
- GetDatabaseDdlResponse::setStatements() — Method in class GetDatabaseDdlResponse
- A list of formatted DDL statements defining the schema of the database specified in the request.
- GetDatabaseRequest::setName() — Method in class GetDatabaseRequest
- Required. The name of the requested database. Values are of the form
projects/<project>/instances/<instance>/databases/<database>
. - ListDatabasesRequest::setParent() — Method in class ListDatabasesRequest
- Required. The instance whose databases should be listed.
- ListDatabasesRequest::setPageSize() — Method in class ListDatabasesRequest
- Number of databases to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.
- ListDatabasesRequest::setPageToken() — Method in class ListDatabasesRequest
- If non-empty,
page_token
should contain a [next_page_token][google.spanner.admin.database.v1.ListDatabasesResponse.next_page_token] from a previous [ListDatabasesResponse][google.spanner.admin.database.v1.ListDatabasesResponse]. - ListDatabasesResponse::setDatabases() — Method in class ListDatabasesResponse
- Databases that matched the request.
- ListDatabasesResponse::setNextPageToken() — Method in class ListDatabasesResponse
next_page_token
can be sent in a subsequent [ListDatabases][google.spanner.admin.database.v1.DatabaseAdmin.ListDatabases] call to fetch more of the matching databases.- UpdateDatabaseDdlMetadata::setDatabase() — Method in class UpdateDatabaseDdlMetadata
- The database being modified.
- UpdateDatabaseDdlMetadata::setStatements() — Method in class UpdateDatabaseDdlMetadata
- For an update this list contains all the statements. For an individual statement, this list contains only that statement.
- UpdateDatabaseDdlMetadata::setCommitTimestamps() — Method in class UpdateDatabaseDdlMetadata
- Reports the commit timestamps of all statements that have
succeeded so far, where
commit_timestamps[i]
is the commit timestamp for the statementstatements[i]
. - UpdateDatabaseDdlRequest::setDatabase() — Method in class UpdateDatabaseDdlRequest
- Required. The database to update.
- UpdateDatabaseDdlRequest::setStatements() — Method in class UpdateDatabaseDdlRequest
- DDL statements to be applied to the database.
- UpdateDatabaseDdlRequest::setOperationId() — Method in class UpdateDatabaseDdlRequest
- If empty, the new update request is assigned an
automatically-generated operation ID. Otherwise,
operation_id
is used to construct the name of the resulting [Operation][google.longrunning.Operation]. - CreateInstanceMetadata::setInstance() — Method in class CreateInstanceMetadata
- The instance being created.
- CreateInstanceMetadata::setStartTime() — Method in class CreateInstanceMetadata
- The time at which the [CreateInstance][google.spanner.admin.instance.v1.InstanceAdmin.CreateInstance] request was received.
- CreateInstanceMetadata::setCancelTime() — Method in class CreateInstanceMetadata
- The time at which this operation was cancelled. If set, this operation is in the process of undoing itself (which is guaranteed to succeed) and cannot be cancelled again.
- CreateInstanceMetadata::setEndTime() — Method in class CreateInstanceMetadata
- The time at which this operation failed or was completed successfully.
- CreateInstanceRequest::setParent() — Method in class CreateInstanceRequest
- Required. The name of the project in which to create the instance. Values
are of the form
projects/<project>
. - CreateInstanceRequest::setInstanceId() — Method in class CreateInstanceRequest
- Required. The ID of the instance to create. Valid identifiers are of the
form
[a-z][-a-z0-9]*[a-z0-9]
and must be between 6 and 30 characters in length. - CreateInstanceRequest::setInstance() — Method in class CreateInstanceRequest
- Required. The instance to create. The name may be omitted, but if
specified must be
<parent>/instances/<instance_id>
. - DeleteInstanceRequest::setName() — Method in class DeleteInstanceRequest
- Required. The name of the instance to be deleted. Values are of the form
projects/<project>/instances/<instance>
- GetInstanceConfigRequest::setName() — Method in class GetInstanceConfigRequest
- Required. The name of the requested instance configuration. Values are of
the form
projects/<project>/instanceConfigs/<config>
. - GetInstanceRequest::setName() — Method in class GetInstanceRequest
- Required. The name of the requested instance. Values are of the form
projects/<project>/instances/<instance>
. - Instance::setName() — Method in class Instance
- Required. A unique identifier for the instance, which cannot be changed
after the instance is created. Values are of the form
projects/<project>/instances/[a-z][-a-z0-9]*[a-z0-9]
. The final segment of the name must be between 6 and 30 characters in length. - Instance::setConfig() — Method in class Instance
- Required. The name of the instance's configuration. Values are of the form
projects/<project>/instanceConfigs/<configuration>
. See also [InstanceConfig][google.spanner.admin.instance.v1.InstanceConfig] and [ListInstanceConfigs][google.spanner.admin.instance.v1.InstanceAdmin.ListInstanceConfigs]. - Instance::setDisplayName() — Method in class Instance
- Required. The descriptive name for this instance as it appears in UIs.
- Instance::setNodeCount() — Method in class Instance
- Required. The number of nodes allocated to this instance.
- Instance::setState() — Method in class Instance
- Output only. The current instance state. For
[CreateInstance][google.spanner.admin.instance.v1.InstanceAdmin.CreateInstance], the state must be
either omitted or set to
CREATING
. For [UpdateInstance][google.spanner.admin.instance.v1.InstanceAdmin.UpdateInstance], the state must be either omitted or set toREADY
. - Instance::setLabels() — Method in class Instance
- Cloud Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. Cloud Labels can be used to filter collections of resources. They can be used to control how resource metrics are aggregated.
- InstanceAdminGrpcClient::SetIamPolicy() — Method in class InstanceAdminGrpcClient
- Sets the access control policy on an instance resource. Replaces any existing policy.
- InstanceConfig::setName() — Method in class InstanceConfig
- A unique identifier for the instance configuration. Values
are of the form
projects/<project>/instanceConfigs/[a-z][-a-z0-9]*
- InstanceConfig::setDisplayName() — Method in class InstanceConfig
- The name of this instance configuration as it appears in UIs.
- ListInstanceConfigsRequest::setParent() — Method in class ListInstanceConfigsRequest
- Required. The name of the project for which a list of supported instance
configurations is requested. Values are of the form
projects/<project>
. - ListInstanceConfigsRequest::setPageSize() — Method in class ListInstanceConfigsRequest
- Number of instance configurations to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.
- ListInstanceConfigsRequest::setPageToken() — Method in class ListInstanceConfigsRequest
- If non-empty,
page_token
should contain a [next_page_token][google.spanner.admin.instance.v1.ListInstanceConfigsResponse.next_page_token] from a previous [ListInstanceConfigsResponse][google.spanner.admin.instance.v1.ListInstanceConfigsResponse]. - ListInstanceConfigsResponse::setInstanceConfigs() — Method in class ListInstanceConfigsResponse
- The list of requested instance configurations.
- ListInstanceConfigsResponse::setNextPageToken() — Method in class ListInstanceConfigsResponse
next_page_token
can be sent in a subsequent [ListInstanceConfigs][google.spanner.admin.instance.v1.InstanceAdmin.ListInstanceConfigs] call to fetch more of the matching instance configurations.- ListInstancesRequest::setParent() — Method in class ListInstancesRequest
- Required. The name of the project for which a list of instances is
requested. Values are of the form
projects/<project>
. - ListInstancesRequest::setPageSize() — Method in class ListInstancesRequest
- Number of instances to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.
- ListInstancesRequest::setPageToken() — Method in class ListInstancesRequest
- If non-empty,
page_token
should contain a [next_page_token][google.spanner.admin.instance.v1.ListInstancesResponse.next_page_token] from a previous [ListInstancesResponse][google.spanner.admin.instance.v1.ListInstancesResponse]. - ListInstancesRequest::setFilter() — Method in class ListInstancesRequest
- An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * name * display_name * labels.key where key is the name of a label Some examples of using filters are: * name:* --> The instance has a name.
- ListInstancesResponse::setInstances() — Method in class ListInstancesResponse
- The list of requested instances.
- ListInstancesResponse::setNextPageToken() — Method in class ListInstancesResponse
next_page_token
can be sent in a subsequent [ListInstances][google.spanner.admin.instance.v1.InstanceAdmin.ListInstances] call to fetch more of the matching instances.- UpdateInstanceMetadata::setInstance() — Method in class UpdateInstanceMetadata
- The desired end state of the update.
- UpdateInstanceMetadata::setStartTime() — Method in class UpdateInstanceMetadata
- The time at which [UpdateInstance][google.spanner.admin.instance.v1.InstanceAdmin.UpdateInstance] request was received.
- UpdateInstanceMetadata::setCancelTime() — Method in class UpdateInstanceMetadata
- The time at which this operation was cancelled. If set, this operation is in the process of undoing itself (which is guaranteed to succeed) and cannot be cancelled again.
- UpdateInstanceMetadata::setEndTime() — Method in class UpdateInstanceMetadata
- The time at which this operation failed or was completed successfully.
- UpdateInstanceRequest::setInstance() — Method in class UpdateInstanceRequest
- Required. The instance to update, which must always include the instance name. Otherwise, only fields mentioned in [][google.spanner.admin.instance.v1.UpdateInstanceRequest.field_mask] need be included.
- UpdateInstanceRequest::setFieldMask() — Method in class UpdateInstanceRequest
- Required. A mask specifying which fields in [][google.spanner.admin.instance.v1.UpdateInstanceRequest.instance] should be updated.
- BeginTransactionRequest::setSession() — Method in class BeginTransactionRequest
- Required. The session in which the transaction runs.
- BeginTransactionRequest::setOptions() — Method in class BeginTransactionRequest
- Required. Options for the new transaction.
- CommitRequest::setSession() — Method in class CommitRequest
- Required. The session in which the transaction to be committed is running.
- CommitRequest::setTransactionId() — Method in class CommitRequest
- Commit a previously-started transaction.
- CommitRequest::setSingleUseTransaction() — Method in class CommitRequest
- Execute mutations in a temporary transaction. Note that unlike
commit of a previously-started transaction, commit with a
temporary transaction is non-idempotent. That is, if the
CommitRequest
is sent to Cloud Spanner more than once (for instance, due to retries in the application, or in the transport library), it is possible that the mutations are executed more than once. If this is undesirable, use [BeginTransaction][google.spanner.v1.Spanner.BeginTransaction] and [Commit][google.spanner.v1.Spanner.Commit] instead. - CommitRequest::setMutations() — Method in class CommitRequest
- The mutations to be executed when this transaction commits. All mutations are applied atomically, in the order they appear in this list.
- CommitResponse::setCommitTimestamp() — Method in class CommitResponse
- The Cloud Spanner timestamp at which the transaction committed.
- CreateSessionRequest::setDatabase() — Method in class CreateSessionRequest
- Required. The database in which the new session is created.
- DeleteSessionRequest::setName() — Method in class DeleteSessionRequest
- Required. The name of the session to delete.
- ExecuteSqlRequest::setSession() — Method in class ExecuteSqlRequest
- Required. The session in which the SQL query should be performed.
- ExecuteSqlRequest::setTransaction() — Method in class ExecuteSqlRequest
- The transaction to use. If none is provided, the default is a temporary read-only transaction with strong concurrency.
- ExecuteSqlRequest::setSql() — Method in class ExecuteSqlRequest
- Required. The SQL query string.
- ExecuteSqlRequest::setParams() — Method in class ExecuteSqlRequest
- The SQL query string can contain parameter placeholders. A parameter
placeholder consists of
'@'
followed by the parameter name. Parameter names consist of any combination of letters, numbers, and underscores. - ExecuteSqlRequest::setParamTypes() — Method in class ExecuteSqlRequest
- It is not always possible for Cloud Spanner to infer the right SQL type
from a JSON value. For example, values of type
BYTES
and values of typeSTRING
both appear in [params][google.spanner.v1.ExecuteSqlRequest.params] as JSON strings. - ExecuteSqlRequest::setResumeToken() — Method in class ExecuteSqlRequest
- If this request is resuming a previously interrupted SQL query
execution,
resume_token
should be copied from the last [PartialResultSet][google.spanner.v1.PartialResultSet] yielded before the interruption. Doing this enables the new SQL query execution to resume where the last one left off. The rest of the request parameters must exactly match the request that yielded this token. - ExecuteSqlRequest::setQueryMode() — Method in class ExecuteSqlRequest
- Used to control the amount of debugging information returned in [ResultSetStats][google.spanner.v1.ResultSetStats].
- GetSessionRequest::setName() — Method in class GetSessionRequest
- Required. The name of the session to retrieve.
- $KeyRange — Property in class KeyRange
- KeyRange::setStartClosed() — Method in class KeyRange
- If the start is closed, then the range includes all rows whose
first
len(start_closed)
key columns exactly matchstart_closed
. - KeyRange::setStartOpen() — Method in class KeyRange
- If the start is open, then the range excludes rows whose first
len(start_open)
key columns exactly matchstart_open
. - KeyRange::setEndClosed() — Method in class KeyRange
- If the end is closed, then the range includes all rows whose
first
len(end_closed)
key columns exactly matchend_closed
. - KeyRange::setEndOpen() — Method in class KeyRange
- If the end is open, then the range excludes rows whose first
len(end_open)
key columns exactly matchend_open
. - KeySet::setKeys() — Method in class KeySet
- A list of specific keys. Entries in
keys
should have exactly as many elements as there are columns in the primary or index key with which thisKeySet
is used. Individual key values are encoded as described [here][google.spanner.v1.TypeCode]. - KeySet::setRanges() — Method in class KeySet
- A list of key ranges. See [KeyRange][google.spanner.v1.KeyRange] for more information about key range specifications.
- KeySet::setAll() — Method in class KeySet
- For convenience
all
can be set totrue
to indicate that thisKeySet
matches all keys in the table or index. Note that any keys specified inkeys
orranges
are only yielded once. - Mutation::setInsert() — Method in class Mutation
- Insert new rows in a table. If any of the rows already exist,
the write or transaction fails with error
ALREADY_EXISTS
. - Mutation::setUpdate() — Method in class Mutation
- Update existing rows in a table. If any of the rows does not
already exist, the transaction fails with error
NOT_FOUND
. - Mutation::setInsertOrUpdate() — Method in class Mutation
- Like [insert][google.spanner.v1.Mutation.insert], except that if the row already exists, then its column values are overwritten with the ones provided. Any column values not explicitly written are preserved.
- Mutation::setReplace() — Method in class Mutation
- Like [insert][google.spanner.v1.Mutation.insert], except that if the row already exists, it is
deleted, and the column values provided are inserted
instead. Unlike [insert_or_update][google.spanner.v1.Mutation.insert_or_update], this means any values not
explicitly written become
NULL
. - Mutation::setDelete() — Method in class Mutation
- Delete rows from a table. Succeeds whether or not the named rows were present.
- Mutation_Delete::setTable() — Method in class Mutation_Delete
- Required. The table whose rows will be deleted.
- Mutation_Delete::setKeySet() — Method in class Mutation_Delete
- Required. The primary keys of the rows within [table][google.spanner.v1.Mutation.Delete.table] to delete.
- Mutation_Write::setTable() — Method in class Mutation_Write
- Required. The table whose rows will be written.
- Mutation_Write::setColumns() — Method in class Mutation_Write
- The names of the columns in [table][google.spanner.v1.Mutation.Write.table] to be written.
- Mutation_Write::setValues() — Method in class Mutation_Write
- The values to be written.
values
can contain more than one list of values. If it does, then multiple rows are written, one for each entry invalues
. Each list invalues
must have exactly as many entries as there are entries in [columns][google.spanner.v1.Mutation.Write.columns] above. Sending multiple lists is equivalent to sending multipleMutation
s, each containing onevalues
entry and repeating [table][google.spanner.v1.Mutation.Write.table] and [columns][google.spanner.v1.Mutation.Write.columns]. Individual values in each list are encoded as described [here][google.spanner.v1.TypeCode]. - PartialResultSet::setMetadata() — Method in class PartialResultSet
- Metadata about the result set, such as row type information.
- PartialResultSet::setValues() — Method in class PartialResultSet
- A streamed result set consists of a stream of values, which might
be split into many
PartialResultSet
messages to accommodate large rows and/or large values. Every N complete values defines a row, where N is equal to the number of entries in [metadata.row_type.fields][google.spanner.v1.StructType.fields]. - PartialResultSet::setChunkedValue() — Method in class PartialResultSet
- If true, then the final value in [values][google.spanner.v1.PartialResultSet.values] is chunked, and must
be combined with more values from subsequent
PartialResultSet
s to obtain a complete field value. - PartialResultSet::setResumeToken() — Method in class PartialResultSet
- Streaming calls might be interrupted for a variety of reasons, such
as TCP connection loss. If this occurs, the stream of results can
be resumed by re-sending the original request and including
resume_token
. Note that executing any other transaction in the same session invalidates the token. - PartialResultSet::setStats() — Method in class PartialResultSet
- Query plan and execution statistics for the query that produced this streaming result set. These can be requested by setting [ExecuteSqlRequest.query_mode][google.spanner.v1.ExecuteSqlRequest.query_mode] and are sent only once with the last response in the stream.
- PlanNode::setIndex() — Method in class PlanNode
- The
PlanNode
's index in [node list][google.spanner.v1.QueryPlan.plan_nodes]. - PlanNode::setKind() — Method in class PlanNode
- Used to determine the type of node. May be needed for visualizing different kinds of nodes differently. For example, If the node is a [SCALAR][google.spanner.v1.PlanNode.Kind.SCALAR] node, it will have a condensed representation which can be used to directly embed a description of the node in its parent.
- PlanNode::setDisplayName() — Method in class PlanNode
- The display name for the node.
- PlanNode::setChildLinks() — Method in class PlanNode
- List of child node
index
es and their relationship to this parent. - PlanNode::setShortRepresentation() — Method in class PlanNode
- Condensed representation for [SCALAR][google.spanner.v1.PlanNode.Kind.SCALAR] nodes.
- PlanNode::setMetadata() — Method in class PlanNode
- Attributes relevant to the node contained in a group of key-value pairs.
- PlanNode::setExecutionStats() — Method in class PlanNode
- The execution statistics associated with the node, contained in a group of key-value pairs. Only present if the plan was returned as a result of a profile query. For example, number of executions, number of rows/time per execution etc.
- PlanNode_ChildLink::setChildIndex() — Method in class PlanNode_ChildLink
- The node to which the link points.
- PlanNode_ChildLink::setType() — Method in class PlanNode_ChildLink
- The type of the link. For example, in Hash Joins this could be used to distinguish between the build child and the probe child, or in the case of the child being an output variable, to represent the tag associated with the output variable.
- PlanNode_ChildLink::setVariable() — Method in class PlanNode_ChildLink
- Only present if the child node is [SCALAR][google.spanner.v1.PlanNode.Kind.SCALAR] and corresponds to an output variable of the parent node. The field carries the name of the output variable.
- PlanNode_ShortRepresentation::setDescription() — Method in class PlanNode_ShortRepresentation
- A string representation of the expression subtree rooted at this node.
- PlanNode_ShortRepresentation::setSubqueries() — Method in class PlanNode_ShortRepresentation
- A mapping of (subquery variable name) -> (subquery node id) for cases
where the
description
string of this node references aSCALAR
subquery contained in the expression subtree rooted at this node. The referencedSCALAR
subquery may not necessarily be a direct child of this node. - QueryPlan::setPlanNodes() — Method in class QueryPlan
- The nodes in the query plan. Plan nodes are returned in pre-order starting
with the plan root. Each [PlanNode][google.spanner.v1.PlanNode]'s
id
corresponds to its index inplan_nodes
. - ReadRequest::setSession() — Method in class ReadRequest
- Required. The session in which the read should be performed.
- ReadRequest::setTransaction() — Method in class ReadRequest
- The transaction to use. If none is provided, the default is a temporary read-only transaction with strong concurrency.
- ReadRequest::setTable() — Method in class ReadRequest
- Required. The name of the table in the database to be read.
- ReadRequest::setIndex() — Method in class ReadRequest
- If non-empty, the name of an index on [table][google.spanner.v1.ReadRequest.table]. This index is used instead of the table primary key when interpreting [key_set][google.spanner.v1.ReadRequest.key_set] and sorting result rows. See [key_set][google.spanner.v1.ReadRequest.key_set] for further information.
- ReadRequest::setColumns() — Method in class ReadRequest
- The columns of [table][google.spanner.v1.ReadRequest.table] to be returned for each row matching this request.
- ReadRequest::setKeySet() — Method in class ReadRequest
- Required.
key_set
identifies the rows to be yielded.key_set
names the primary keys of the rows in [table][google.spanner.v1.ReadRequest.table] to be yielded, unless [index][google.spanner.v1.ReadRequest.index] is present. If [index][google.spanner.v1.ReadRequest.index] is present, then [key_set][google.spanner.v1.ReadRequest.key_set] instead names index keys in [index][google.spanner.v1.ReadRequest.index]. - ReadRequest::setLimit() — Method in class ReadRequest
- If greater than zero, only the first
limit
rows are yielded. Iflimit
is zero, the default is no limit. - ReadRequest::setResumeToken() — Method in class ReadRequest
- If this request is resuming a previously interrupted read,
resume_token
should be copied from the last [PartialResultSet][google.spanner.v1.PartialResultSet] yielded before the interruption. Doing this enables the new read to resume where the last read left off. The rest of the request parameters must exactly match the request that yielded this token. - ResultSet::setMetadata() — Method in class ResultSet
- Metadata about the result set, such as row type information.
- ResultSet::setRows() — Method in class ResultSet
- Each element in
rows
is a row whose format is defined by [metadata.row_type][google.spanner.v1.ResultSetMetadata.row_type]. The ith element in each row matches the ith field in [metadata.row_type][google.spanner.v1.ResultSetMetadata.row_type]. Elements are encoded based on type as described [here][google.spanner.v1.TypeCode]. - ResultSet::setStats() — Method in class ResultSet
- Query plan and execution statistics for the query that produced this result set. These can be requested by setting [ExecuteSqlRequest.query_mode][google.spanner.v1.ExecuteSqlRequest.query_mode].
- ResultSetMetadata::setRowType() — Method in class ResultSetMetadata
- Indicates the field names and types for the rows in the result
set. For example, a SQL query like
"SELECT UserId, UserName FROM Users"
could return arow_type
value like: "fields": [ { "name": "UserId", "type": { "code": "INT64" } }, { "name": "UserName", "type": { "code": "STRING" } }, ] - ResultSetMetadata::setTransaction() — Method in class ResultSetMetadata
- If the read or SQL query began a transaction as a side-effect, the information about the new transaction is yielded here.
- ResultSetStats::setQueryPlan() — Method in class ResultSetStats
- [QueryPlan][google.spanner.v1.QueryPlan] for the query associated with this result.
- ResultSetStats::setQueryStats() — Method in class ResultSetStats
- Aggregated statistics from the execution of the query. Only present when the query is profiled. For example, a query could return the statistics as follows: { "rows_returned": "3", "elapsed_time": "1.22 secs", "cpu_time": "1.19 secs" }
- RollbackRequest::setSession() — Method in class RollbackRequest
- Required. The session in which the transaction to roll back is running.
- RollbackRequest::setTransactionId() — Method in class RollbackRequest
- Required. The transaction to roll back.
- Session — Class in namespace Google\Spanner\V1
- A session in the Cloud Spanner API.
- Session::setName() — Method in class Session
- Required. The name of the session.
- SpannerGrpcClient — Class in namespace Google\Spanner\V1
- Cloud Spanner API
- SpannerGrpcClient::StreamingRead() — Method in class SpannerGrpcClient
- Like [Read][google.spanner.v1.Spanner.Read], except returns the result set as a stream. Unlike [Read][google.spanner.v1.Spanner.Read], there is no limit on the size of the returned result set. However, no individual row in the result set can exceed 100 MiB, and no column value can exceed 10 MiB.
- StructType — Class in namespace Google\Spanner\V1
StructType
defines the fields of a [STRUCT][google.spanner.v1.TypeCode.STRUCT] type.- StructType::setFields() — Method in class StructType
- The list of fields that make up this struct. Order is
significant, because values of this struct type are represented as
lists, where the order of field values matches the order of
fields in the [StructType][google.spanner.v1.StructType]. In turn, the order of fields
matches the order of columns in a read request, or the order of
fields in the
SELECT
clause of a query. - StructType_Field — Class in namespace Google\Spanner\V1
- Message representing a single field of a struct.
- StructType_Field::setName() — Method in class StructType_Field
- The name of the field. For reads, this is the column name. For
SQL queries, it is the column alias (e.g.,
"Word"
in the query"SELECT 'hello' AS Word"
), or the column name (e.g.,"ColName"
in the query"SELECT ColName FROM Table"
). Some columns might have an empty name (e.g., !"SELECT UPPER(ColName)"`). Note that a query result can contain multiple fields with the same name. - StructType_Field::setType() — Method in class StructType_Field
- The type of the field.
- Transaction::setId() — Method in class Transaction
id
may be used to identify the transaction in subsequent [Read][google.spanner.v1.Spanner.Read], [ExecuteSql][google.spanner.v1.Spanner.ExecuteSql], [Commit][google.spanner.v1.Spanner.Commit], or [Rollback][google.spanner.v1.Spanner.Rollback] calls.- Transaction::setReadTimestamp() — Method in class Transaction
- For snapshot read-only transactions, the read timestamp chosen for the transaction. Not returned by default: see [TransactionOptions.ReadOnly.return_read_timestamp][google.spanner.v1.TransactionOptions.ReadOnly.return_read_timestamp].
- TransactionOptions::setReadWrite() — Method in class TransactionOptions
- Transaction may write.
- TransactionOptions::setReadOnly() — Method in class TransactionOptions
- Transaction will not write.
- TransactionOptions_ReadOnly::setStrong() — Method in class TransactionOptions_ReadOnly
- Read at a timestamp where all previously committed transactions are visible.
- TransactionOptions_ReadOnly::setMinReadTimestamp() — Method in class TransactionOptions_ReadOnly
- Executes all reads at a timestamp >=
min_read_timestamp
. - TransactionOptions_ReadOnly::setMaxStaleness() — Method in class TransactionOptions_ReadOnly
- Read data at a timestamp >=
NOW - max_staleness
seconds. Guarantees that all writes that have committed more than the specified number of seconds ago are visible. Because Cloud Spanner chooses the exact timestamp, this mode works even if the client's local clock is substantially skewed from Cloud Spanner commit timestamps. - TransactionOptions_ReadOnly::setReadTimestamp() — Method in class TransactionOptions_ReadOnly
- Executes all reads at the given timestamp. Unlike other modes, reads at a specific timestamp are repeatable; the same read at the same timestamp always returns the same data. If the timestamp is in the future, the read will block until the specified timestamp, modulo the read's deadline.
- TransactionOptions_ReadOnly::setExactStaleness() — Method in class TransactionOptions_ReadOnly
- Executes all reads at a timestamp that is
exact_staleness
old. The timestamp is chosen soon after the read is started. - TransactionOptions_ReadOnly::setReturnReadTimestamp() — Method in class TransactionOptions_ReadOnly
- If true, the Cloud Spanner-selected read timestamp is included in the [Transaction][google.spanner.v1.Transaction] message that describes the transaction.
- $TransactionSelector — Property in class TransactionSelector
- TransactionSelector::setSingleUse() — Method in class TransactionSelector
- Execute the read or SQL query in a temporary transaction.
- TransactionSelector::setId() — Method in class TransactionSelector
- Execute the read or SQL query in a previously-started transaction.
- TransactionSelector::setBegin() — Method in class TransactionSelector
- Begin a new transaction and execute this read or SQL query in it. The transaction ID of the new transaction is returned in [ResultSetMetadata.transaction][google.spanner.v1.ResultSetMetadata.transaction], which is a [Transaction][google.spanner.v1.Transaction].
- Type::setCode() — Method in class Type
- Required. The [TypeCode][google.spanner.v1.TypeCode] for this type.
- Type::setArrayElementType() — Method in class Type
- If [code][google.spanner.v1.Type.code] == [ARRAY][google.spanner.v1.TypeCode.ARRAY], then
array_element_type
is the type of the array elements. - Type::setStructType() — Method in class Type
- If [code][google.spanner.v1.Type.code] == [STRUCT][google.spanner.v1.TypeCode.STRUCT], then
struct_type
provides type information for the struct's fields. - Color::setRed() — Method in class Color
- The amount of red in the color as a value in the interval [0, 1].
- Color::setGreen() — Method in class Color
- The amount of green in the color as a value in the interval [0, 1].
- Color::setBlue() — Method in class Color
- The amount of blue in the color as a value in the interval [0, 1].
- Color::setAlpha() — Method in class Color
- The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: pixel color = alpha * (this color) + (1.0 - alpha) * (background color) This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset.
- Date::setYear() — Method in class Date
- Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.
- Date::setMonth() — Method in class Date
- Month of year. Must be from 1 to 12.
- Date::setDay() — Method in class Date
- Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year/month where the day is not significant.
- LatLng::setLatitude() — Method in class LatLng
- The latitude in degrees. It must be in the range [-90.0, +90.0].
- LatLng::setLongitude() — Method in class LatLng
- The longitude in degrees. It must be in the range [-180.0, +180.0].
- Money::setCurrencyCode() — Method in class Money
- The 3-letter currency code defined in ISO 4217.
- Money::setUnits() — Method in class Money
- The whole units of the amount.
- Money::setNanos() — Method in class Money
- Number of nano (10^-9) units of the amount.
- PostalAddress::setRevision() — Method in class PostalAddress
- The schema revision of the
PostalAddress
. - PostalAddress::setRegionCode() — Method in class PostalAddress
- Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See http://cldr.unicode.org/ and http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
- PostalAddress::setLanguageCode() — Method in class PostalAddress
- Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents.
- PostalAddress::setPostalCode() — Method in class PostalAddress
- Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (e.g. state/zip validation in the U.S.A.).
- PostalAddress::setSortingCode() — Method in class PostalAddress
- Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).
- PostalAddress::setAdministrativeArea() — Method in class PostalAddress
- Optional. Highest administrative subdivision which is used for postal addresses of a country or region.
- PostalAddress::setLocality() — Method in class PostalAddress
- Optional. Generally refers to the city/town portion of the address.
- PostalAddress::setSublocality() — Method in class PostalAddress
- Optional. Sublocality of the address.
- PostalAddress::setAddressLines() — Method in class PostalAddress
- Unstructured address lines describing the lower levels of an address.
- PostalAddress::setRecipients() — Method in class PostalAddress
- Optional. The recipient at the address.
- PostalAddress::setOrganization() — Method in class PostalAddress
- Optional. The name of the organization at the address.
- TimeOfDay::setHours() — Method in class TimeOfDay
- Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
- TimeOfDay::setMinutes() — Method in class TimeOfDay
- Minutes of hour of day. Must be from 0 to 59.
- TimeOfDay::setSeconds() — Method in class TimeOfDay
- Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
- TimeOfDay::setNanos() — Method in class TimeOfDay
- Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
T
- TextSpan — Class in namespace Google\Cloud\Language\V1beta2
- Represents an output piece of text.
- Token — Class in namespace Google\Cloud\Language\V1beta2
- Represents the smallest syntactic building block of the text.
- TextAnnotation — Class in namespace Google\Cloud\Vision\V1
- TextAnnotation contains a structured representation of OCR extracted text.
- TextAnnotation_DetectedBreak — Class in namespace Google\Cloud\Vision\V1
- Detected start or end of a structural component.
- TextAnnotation_DetectedBreak_BreakType — Class in namespace Google\Cloud\Vision\V1
- Enum to denote the type of break found. New line, space etc.
- TextAnnotation_DetectedLanguage — Class in namespace Google\Cloud\Vision\V1
- Detected language for a structural component.
- TextAnnotation_TextProperty — Class in namespace Google\Cloud\Vision\V1
- Additional information detected on the structural component.
- TimedCount — Class in namespace Google\Devtools\Clouderrorreporting\V1beta1
- The number of errors in a given time period.
- TimedCountAlignment — Class in namespace Google\Devtools\Clouderrorreporting\V1beta1
- Specifies how the time periods of error group counts are aligned.
- TrackingIssue — Class in namespace Google\Devtools\Clouderrorreporting\V1beta1
- Information related to tracking the progress on resolving the error.
- Trace — Class in namespace Google\Devtools\Cloudtrace\V1
- 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.
- TraceServiceGrpcClient — Class in namespace Google\Devtools\Cloudtrace\V1
- 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.
- TraceSpan — Class in namespace Google\Devtools\Cloudtrace\V1
- 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.
- TraceSpan_SpanKind — Class in namespace Google\Devtools\Cloudtrace\V1
- Type of span. Can be used to specify additional relationships between spans in addition to a parent/child relationship.
- Traces — Class in namespace Google\Devtools\Cloudtrace\V1
- List of new or updated traces.
- $LexerError — Property in class LexerError
- $LexerError — Property in class LexerError
- $Parser — Property in class Parser
- $Parser — Property in class Parser
- Parser::trace() — Method in class Parser
- $ParserError — Property in class ParserError
- $ParserValue — Property in class ParserValue
- Serializer::toSnakeCase() — Method in class Serializer
- Serializer::toCamelCase() — Method in class Serializer
- IAMPolicyGrpcClient::TestIamPermissions() — Method in class IAMPolicyGrpcClient
- Returns permissions that a caller has on the specified resource.
- TestIamPermissionsRequest — Class in namespace Google\Iam\V1
- Request message for
TestIamPermissions
method. - TestIamPermissionsResponse — Class in namespace Google\Iam\V1
- Response message for
TestIamPermissions
method. - TimeInterval — Class in namespace Google\Monitoring\V3
- A time interval extending just after a start time through an end time.
- TimeSeries — Class in namespace Google\Monitoring\V3
- 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.
- TypedValue — Class in namespace Google\Monitoring\V3
- A single strongly-typed value.
- Timestamp — Class in namespace Google\Protobuf
- 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.
- Type — Class in namespace Google\Protobuf
- A protocol buffer message type.
- $SeekRequest — Property in class SeekRequest
- Topic — Class in namespace Google\Pubsub\V1
- A topic resource.
- DatabaseAdminGrpcClient::TestIamPermissions() — Method in class DatabaseAdminGrpcClient
- Returns permissions that the caller has on the specified database resource.
- InstanceAdminGrpcClient::TestIamPermissions() — Method in class InstanceAdminGrpcClient
- Returns permissions that the caller has on the specified instance resource.
- $CommitRequest — Property in class CommitRequest
- Transaction — Class in namespace Google\Spanner\V1
- A transaction.
- TransactionOptions — Class in namespace Google\Spanner\V1
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.
- TransactionOptions_ReadOnly — Class in namespace Google\Spanner\V1
- Options for read-only transactions.
- $TransactionOptions_ReadOnly — Property in class TransactionOptions_ReadOnly
- TransactionOptions_ReadWrite — Class in namespace Google\Spanner\V1
- Options for read-write transactions.
- TransactionSelector — Class in namespace Google\Spanner\V1
- 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 — Class in namespace Google\Spanner\V1
Type
indicates the type of a Cloud Spanner value, as might be stored in a table cell or returned from an SQL query.- TypeCode — Class in namespace Google\Spanner\V1
TypeCode
is used as part of [Type][google.spanner.v1.Type] to indicate the type of a Cloud Spanner value.- TimeOfDay — Class in namespace Google\Type
- 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
.
U
- Usage — Class in namespace Google\Api
- Configuration controlling usage of a service.
- UsageRule — Class in namespace Google\Api
- Usage configuration rules for the service.
- ErrorGroupServiceGrpcClient::UpdateGroup() — Method in class ErrorGroupServiceGrpcClient
- Replace the data for the specified group.
- UpdateGroupRequest — Class in namespace Google\Devtools\Clouderrorreporting\V1beta1
- A request to replace the existing data for the given group.
- Parser::unput() — Method in class Parser
- Parser::upcomingInput() — Method in class Parser
- ConfigServiceV2GrpcClient::UpdateSink() — Method in class ConfigServiceV2GrpcClient
- Updates a sink. If the named sink doesn't exist, then this method is identical to sinks.create.
- MetricsServiceV2GrpcClient::UpdateLogMetric() — Method in class MetricsServiceV2GrpcClient
- Creates or updates a logs-based metric.
- UpdateLogMetricRequest — Class in namespace Google\Logging\V2
- The parameters to UpdateLogMetric.
- UpdateSinkRequest — Class in namespace Google\Logging\V2
- The parameters to
UpdateSink
. - GroupServiceGrpcClient::UpdateGroup() — Method in class GroupServiceGrpcClient
- Updates an existing group.
- UpdateGroupRequest — Class in namespace Google\Monitoring\V3
- The
UpdateGroup
request. - UInt32Value — Class in namespace Google\Protobuf
- Wrapper message for
uint32
. - UInt64Value — Class in namespace Google\Protobuf
- Wrapper message for
uint64
. - SubscriberGrpcClient::UpdateSubscription() — Method in class SubscriberGrpcClient
- Updates an existing subscription. Note that certain properties of a subscription, such as its topic, are not modifiable.
- UpdateSubscriptionRequest — Class in namespace Google\Pubsub\V1
- Request for the UpdateSubscription method.
- DatabaseAdminGrpcClient::UpdateDatabaseDdl() — Method in class DatabaseAdminGrpcClient
- Updates the schema of a Cloud Spanner database by
creating/altering/dropping tables, columns, indexes, etc. The returned
[long-running operation][google.longrunning.Operation] will have a name of
the format
<database_name>/operations/<operation_id>
and can be used to track execution of the schema change(s). The [metadata][google.longrunning.Operation.metadata] field type is [UpdateDatabaseDdlMetadata][google.spanner.admin.database.v1.UpdateDatabaseDdlMetadata]. The operation has no response. - UpdateDatabaseDdlMetadata — Class in namespace Google\Spanner\Admin\Database\V1
- Metadata type for the operation returned by [UpdateDatabaseDdl][google.spanner.admin.database.v1.DatabaseAdmin.UpdateDatabaseDdl].
- UpdateDatabaseDdlRequest — Class in namespace Google\Spanner\Admin\Database\V1
- 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 whichNOT NULL
would be added). If a statement fails, all subsequent statements in the batch are automatically cancelled. - InstanceAdminGrpcClient::UpdateInstance() — Method in class InstanceAdminGrpcClient
- Updates an instance, and begins allocating or releasing resources
as requested. The returned [long-running
operation][google.longrunning.Operation] can be used to track the
progress of updating the instance. If the named instance does not
exist, returns
NOT_FOUND
. - UpdateInstanceMetadata — Class in namespace Google\Spanner\Admin\Instance\V1
- Metadata type for the operation returned by [UpdateInstance][google.spanner.admin.instance.v1.InstanceAdmin.UpdateInstance].
- UpdateInstanceRequest — Class in namespace Google\Spanner\Admin\Instance\V1
- The request for [UpdateInstance][google.spanner.admin.instance.v1.InstanceAdmin.UpdateInstance].
V
- VideoAnnotationProgress — Class in namespace Google\Cloud\Videointelligence\V1beta1
- Annotation progress for a single video.
- VideoAnnotationResults — Class in namespace Google\Cloud\Videointelligence\V1beta1
- Annotation results for a single video.
- VideoContext — Class in namespace Google\Cloud\Videointelligence\V1beta1
- Video context and/or feature-specific parameters.
- VideoIntelligenceServiceGrpcClient — Class in namespace Google\Cloud\Videointelligence\V1beta1
- Service that implements Google Cloud Video Intelligence API.
- VideoSegment — Class in namespace Google\Cloud\Videointelligence\V1beta1
- Video segment.
- Vertex — Class in namespace Google\Cloud\Vision\V1
- A vertex represents a 2D point in the image.
- $Parser — Property in class Parser
- ValidationException — Class in namespace Google\GAX
- $TypedValue — Property in class TypedValue
- Value — Class in namespace Google\Protobuf
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.
W
- WebDetection — Class in namespace Google\Cloud\Vision\V1
- Relevant information for the image from the Internet.
- WebDetection_WebEntity — Class in namespace Google\Cloud\Vision\V1
- Entity deduced from similar images on the Internet.
- WebDetection_WebImage — Class in namespace Google\Cloud\Vision\V1
- Metadata for online images.
- WebDetection_WebPage — Class in namespace Google\Cloud\Vision\V1
- Metadata for web pages.
- Word — Class in namespace Google\Cloud\Vision\V1
- A word representation.
- BidiStream::write() — Method in class BidiStream
- Write request to the server.
- BidiStream::writeAll() — Method in class BidiStream
- Write all requests in $requests.
- ClientStream::write() — Method in class ClientStream
- Write request to the server.
- ClientStream::writeAllAndReadResponse() — Method in class ClientStream
- Write all data in $dataArray and read the response from the server, completing the streaming call.
- MockBidiStreamingCall::write() — Method in class MockBidiStreamingCall
- Save the request object, to be retrieved via getReceivedCalls()
- MockBidiStreamingCall::writesDone() — Method in class MockBidiStreamingCall
- Set writesDone to true
- MockClientStreamingCall::wait() — Method in class MockClientStreamingCall
- Immediately return the preset response object and status.
- MockClientStreamingCall::write() — Method in class MockClientStreamingCall
- Save the request object, to be retrieved via getReceivedCalls()
- MockUnaryCall::wait() — Method in class MockUnaryCall
- Immediately return the preset response object and status.
- LoggingServiceV2GrpcClient::WriteLogEntries() — Method in class LoggingServiceV2GrpcClient
- Writes log entries to Stackdriver Logging.
- WriteLogEntriesPartialErrors — Class in namespace Google\Logging\V2
- Error details for WriteLogEntries with partial success.
- WriteLogEntriesRequest — Class in namespace Google\Logging\V2
- The parameters to WriteLogEntries.
- WriteLogEntriesResponse — Class in namespace Google\Logging\V2
- Result returned from WriteLogEntries.
X
- $ParserRange — Property in class ParserRange
Y
- $Parser — Property in class Parser
- $ParserRange — Property in class ParserRange
_
- Advice::__construct() — Method in class Advice
- AuthProvider::__construct() — Method in class AuthProvider
- AuthRequirement::__construct() — Method in class AuthRequirement
- Authentication::__construct() — Method in class Authentication
- AuthenticationRule::__construct() — Method in class AuthenticationRule
- AuthorizationConfig::__construct() — Method in class AuthorizationConfig
- Backend::__construct() — Method in class Backend
- BackendRule::__construct() — Method in class BackendRule
- Billing::__construct() — Method in class Billing
- BillingStatusRule::__construct() — Method in class BillingStatusRule
- ConfigChange::__construct() — Method in class ConfigChange
- Context::__construct() — Method in class Context
- ContextRule::__construct() — Method in class ContextRule
- Control::__construct() — Method in class Control
- CustomHttpPattern::__construct() — Method in class CustomHttpPattern
- Distribution::__construct() — Method in class Distribution
- Distribution_BucketOptions::__construct() — Method in class Distribution_BucketOptions
- Distribution_BucketOptions_Explicit::__construct() — Method in class Distribution_BucketOptions_Explicit
- Distribution_BucketOptions_Exponential::__construct() — Method in class Distribution_BucketOptions_Exponential
- Distribution_BucketOptions_Linear::__construct() — Method in class Distribution_BucketOptions_Linear
- Distribution_Range::__construct() — Method in class Distribution_Range
- Documentation::__construct() — Method in class Documentation
- DocumentationRule::__construct() — Method in class DocumentationRule
- Endpoint::__construct() — Method in class Endpoint
- Experimental::__construct() — Method in class Experimental
- Http::__construct() — Method in class Http
- HttpBody::__construct() — Method in class HttpBody
- HttpRule::__construct() — Method in class HttpRule
- LabelDescriptor::__construct() — Method in class LabelDescriptor
- LogDescriptor::__construct() — Method in class LogDescriptor
- Logging::__construct() — Method in class Logging
- Logging_LoggingDestination::__construct() — Method in class Logging_LoggingDestination
- Metric::__construct() — Method in class Metric
- MetricDescriptor::__construct() — Method in class MetricDescriptor
- MetricRule::__construct() — Method in class MetricRule
- MonitoredResource::__construct() — Method in class MonitoredResource
- MonitoredResourceDescriptor::__construct() — Method in class MonitoredResourceDescriptor
- Monitoring::__construct() — Method in class Monitoring
- Monitoring_MonitoringDestination::__construct() — Method in class Monitoring_MonitoringDestination
- OAuthRequirements::__construct() — Method in class OAuthRequirements
- Page::__construct() — Method in class Page
- ProjectProperties::__construct() — Method in class ProjectProperties
- Property::__construct() — Method in class Property
- Quota::__construct() — Method in class Quota
- QuotaLimit::__construct() — Method in class QuotaLimit
- Service::__construct() — Method in class Service
- SourceInfo::__construct() — Method in class SourceInfo
- SystemParameter::__construct() — Method in class SystemParameter
- SystemParameterRule::__construct() — Method in class SystemParameterRule
- SystemParameters::__construct() — Method in class SystemParameters
- Usage::__construct() — Method in class Usage
- UsageRule::__construct() — Method in class UsageRule
- AuditLog::__construct() — Method in class AuditLog
- AuthenticationInfo::__construct() — Method in class AuthenticationInfo
- AuthorizationInfo::__construct() — Method in class AuthorizationInfo
- RequestMetadata::__construct() — Method in class RequestMetadata
- AnalyzeEntitiesRequest::__construct() — Method in class AnalyzeEntitiesRequest
- AnalyzeEntitiesResponse::__construct() — Method in class AnalyzeEntitiesResponse
- AnalyzeEntitySentimentRequest::__construct() — Method in class AnalyzeEntitySentimentRequest
- AnalyzeEntitySentimentResponse::__construct() — Method in class AnalyzeEntitySentimentResponse
- AnalyzeSentimentRequest::__construct() — Method in class AnalyzeSentimentRequest
- AnalyzeSentimentResponse::__construct() — Method in class AnalyzeSentimentResponse
- AnalyzeSyntaxRequest::__construct() — Method in class AnalyzeSyntaxRequest
- AnalyzeSyntaxResponse::__construct() — Method in class AnalyzeSyntaxResponse
- AnnotateTextRequest::__construct() — Method in class AnnotateTextRequest
- AnnotateTextRequest_Features::__construct() — Method in class AnnotateTextRequest_Features
- AnnotateTextResponse::__construct() — Method in class AnnotateTextResponse
- DependencyEdge::__construct() — Method in class DependencyEdge
- Document::__construct() — Method in class Document
- Entity::__construct() — Method in class Entity
- EntityMention::__construct() — Method in class EntityMention
- LanguageServiceGrpcClient::__construct() — Method in class LanguageServiceGrpcClient
- PartOfSpeech::__construct() — Method in class PartOfSpeech
- Sentence::__construct() — Method in class Sentence
- Sentiment::__construct() — Method in class Sentiment
- TextSpan::__construct() — Method in class TextSpan
- Token::__construct() — Method in class Token
- LongRunningRecognizeMetadata::__construct() — Method in class LongRunningRecognizeMetadata
- LongRunningRecognizeRequest::__construct() — Method in class LongRunningRecognizeRequest
- LongRunningRecognizeResponse::__construct() — Method in class LongRunningRecognizeResponse
- RecognitionAudio::__construct() — Method in class RecognitionAudio
- RecognitionConfig::__construct() — Method in class RecognitionConfig
- RecognizeRequest::__construct() — Method in class RecognizeRequest
- RecognizeResponse::__construct() — Method in class RecognizeResponse
- SpeechContext::__construct() — Method in class SpeechContext
- SpeechGrpcClient::__construct() — Method in class SpeechGrpcClient
- SpeechRecognitionAlternative::__construct() — Method in class SpeechRecognitionAlternative
- SpeechRecognitionResult::__construct() — Method in class SpeechRecognitionResult
- StreamingRecognitionConfig::__construct() — Method in class StreamingRecognitionConfig
- StreamingRecognitionResult::__construct() — Method in class StreamingRecognitionResult
- StreamingRecognizeRequest::__construct() — Method in class StreamingRecognizeRequest
- StreamingRecognizeResponse::__construct() — Method in class StreamingRecognizeResponse
- AsyncRecognizeMetadata::__construct() — Method in class AsyncRecognizeMetadata
- AsyncRecognizeRequest::__construct() — Method in class AsyncRecognizeRequest
- AsyncRecognizeResponse::__construct() — Method in class AsyncRecognizeResponse
- RecognitionAudio::__construct() — Method in class RecognitionAudio
- RecognitionConfig::__construct() — Method in class RecognitionConfig
- SpeechContext::__construct() — Method in class SpeechContext
- SpeechGrpcClient::__construct() — Method in class SpeechGrpcClient
- SpeechRecognitionAlternative::__construct() — Method in class SpeechRecognitionAlternative
- SpeechRecognitionResult::__construct() — Method in class SpeechRecognitionResult
- StreamingRecognitionConfig::__construct() — Method in class StreamingRecognitionConfig
- StreamingRecognitionResult::__construct() — Method in class StreamingRecognitionResult
- StreamingRecognizeRequest::__construct() — Method in class StreamingRecognizeRequest
- StreamingRecognizeResponse::__construct() — Method in class StreamingRecognizeResponse
- SyncRecognizeRequest::__construct() — Method in class SyncRecognizeRequest
- SyncRecognizeResponse::__construct() — Method in class SyncRecognizeResponse
- AnnotateVideoProgress::__construct() — Method in class AnnotateVideoProgress
- AnnotateVideoRequest::__construct() — Method in class AnnotateVideoRequest
- AnnotateVideoResponse::__construct() — Method in class AnnotateVideoResponse
- BoundingBox::__construct() — Method in class BoundingBox
- FaceAnnotation::__construct() — Method in class FaceAnnotation
- FaceLocation::__construct() — Method in class FaceLocation
- LabelAnnotation::__construct() — Method in class LabelAnnotation
- LabelLocation::__construct() — Method in class LabelLocation
- SafeSearchAnnotation::__construct() — Method in class SafeSearchAnnotation
- VideoAnnotationProgress::__construct() — Method in class VideoAnnotationProgress
- VideoAnnotationResults::__construct() — Method in class VideoAnnotationResults
- VideoContext::__construct() — Method in class VideoContext
- VideoIntelligenceServiceGrpcClient::__construct() — Method in class VideoIntelligenceServiceGrpcClient
- VideoSegment::__construct() — Method in class VideoSegment
- AnnotateImageRequest::__construct() — Method in class AnnotateImageRequest
- AnnotateImageResponse::__construct() — Method in class AnnotateImageResponse
- BatchAnnotateImagesRequest::__construct() — Method in class BatchAnnotateImagesRequest
- BatchAnnotateImagesResponse::__construct() — Method in class BatchAnnotateImagesResponse
- Block::__construct() — Method in class Block
- BoundingPoly::__construct() — Method in class BoundingPoly
- ColorInfo::__construct() — Method in class ColorInfo
- CropHint::__construct() — Method in class CropHint
- CropHintsAnnotation::__construct() — Method in class CropHintsAnnotation
- CropHintsParams::__construct() — Method in class CropHintsParams
- DominantColorsAnnotation::__construct() — Method in class DominantColorsAnnotation
- EntityAnnotation::__construct() — Method in class EntityAnnotation
- FaceAnnotation::__construct() — Method in class FaceAnnotation
- FaceAnnotation_Landmark::__construct() — Method in class FaceAnnotation_Landmark
- Feature::__construct() — Method in class Feature
- Image::__construct() — Method in class Image
- ImageAnnotatorGrpcClient::__construct() — Method in class ImageAnnotatorGrpcClient
- ImageContext::__construct() — Method in class ImageContext
- ImageProperties::__construct() — Method in class ImageProperties
- ImageSource::__construct() — Method in class ImageSource
- LatLongRect::__construct() — Method in class LatLongRect
- LocationInfo::__construct() — Method in class LocationInfo
- Page::__construct() — Method in class Page
- Paragraph::__construct() — Method in class Paragraph
- Position::__construct() — Method in class Position
- Property::__construct() — Method in class Property
- SafeSearchAnnotation::__construct() — Method in class SafeSearchAnnotation
- Symbol::__construct() — Method in class Symbol
- TextAnnotation::__construct() — Method in class TextAnnotation
- TextAnnotation_DetectedBreak::__construct() — Method in class TextAnnotation_DetectedBreak
- TextAnnotation_DetectedLanguage::__construct() — Method in class TextAnnotation_DetectedLanguage
- TextAnnotation_TextProperty::__construct() — Method in class TextAnnotation_TextProperty
- Vertex::__construct() — Method in class Vertex
- WebDetection::__construct() — Method in class WebDetection
- WebDetection_WebEntity::__construct() — Method in class WebDetection_WebEntity
- WebDetection_WebImage::__construct() — Method in class WebDetection_WebImage
- WebDetection_WebPage::__construct() — Method in class WebDetection_WebPage
- Word::__construct() — Method in class Word
- DeleteEventsRequest::__construct() — Method in class DeleteEventsRequest
- DeleteEventsResponse::__construct() — Method in class DeleteEventsResponse
- ErrorContext::__construct() — Method in class ErrorContext
- ErrorEvent::__construct() — Method in class ErrorEvent
- ErrorGroup::__construct() — Method in class ErrorGroup
- ErrorGroupServiceGrpcClient::__construct() — Method in class ErrorGroupServiceGrpcClient
- ErrorGroupStats::__construct() — Method in class ErrorGroupStats
- ErrorStatsServiceGrpcClient::__construct() — Method in class ErrorStatsServiceGrpcClient
- GetGroupRequest::__construct() — Method in class GetGroupRequest
- HttpRequestContext::__construct() — Method in class HttpRequestContext
- ListEventsRequest::__construct() — Method in class ListEventsRequest
- ListEventsResponse::__construct() — Method in class ListEventsResponse
- ListGroupStatsRequest::__construct() — Method in class ListGroupStatsRequest
- ListGroupStatsResponse::__construct() — Method in class ListGroupStatsResponse
- QueryTimeRange::__construct() — Method in class QueryTimeRange
- ReportErrorEventRequest::__construct() — Method in class ReportErrorEventRequest
- ReportErrorEventResponse::__construct() — Method in class ReportErrorEventResponse
- ReportErrorsServiceGrpcClient::__construct() — Method in class ReportErrorsServiceGrpcClient
- ReportedErrorEvent::__construct() — Method in class ReportedErrorEvent
- ServiceContext::__construct() — Method in class ServiceContext
- ServiceContextFilter::__construct() — Method in class ServiceContextFilter
- SourceLocation::__construct() — Method in class SourceLocation
- TimedCount::__construct() — Method in class TimedCount
- TrackingIssue::__construct() — Method in class TrackingIssue
- UpdateGroupRequest::__construct() — Method in class UpdateGroupRequest
- GetTraceRequest::__construct() — Method in class GetTraceRequest
- ListTracesRequest::__construct() — Method in class ListTracesRequest
- ListTracesResponse::__construct() — Method in class ListTracesResponse
- PatchTracesRequest::__construct() — Method in class PatchTracesRequest
- Trace::__construct() — Method in class Trace
- TraceServiceGrpcClient::__construct() — Method in class TraceServiceGrpcClient
- TraceSpan::__construct() — Method in class TraceSpan
- Traces::__construct() — Method in class Traces
- AgentHeaderDescriptor::__construct() — Method in class AgentHeaderDescriptor
- ApiException::__construct() — Method in class ApiException
- ApiException::__toString() — Method in class ApiException
- String representation of ApiException
- BackoffSettings::__construct() — Method in class BackoffSettings
- Constructs an instance.
- BidiStream::__construct() — Method in class BidiStream
- BidiStream constructor.
- CallSettings::__construct() — Method in class CallSettings
- Construct an instance.
- ClientStream::__construct() — Method in class ClientStream
- ClientStream constructor.
- FixedSizeCollection::__construct() — Method in class FixedSizeCollection
- FixedSizeCollection constructor.
- GrpcCredentialsHelper::__construct() — Method in class GrpcCredentialsHelper
- Accepts an optional credentialsLoader argument, to be used instead of using the ApplicationDefaultCredentials
- LexerConditions::__construct() — Method in class LexerConditions
- LexerError::__construct() — Method in class LexerError
- Parser::__construct() — Method in class Parser
- ParserAction::__construct() — Method in class ParserAction
- ParserCachedAction::__construct() — Method in class ParserCachedAction
- ParserError::__construct() — Method in class ParserError
- ParserLocation::__construct() — Method in class ParserLocation
- ParserLocation::__clone() — Method in class ParserLocation
- ParserProduction::__construct() — Method in class ParserProduction
- ParserRange::__construct() — Method in class ParserRange
- ParserState::__construct() — Method in class ParserState
- ParserSymbol::__construct() — Method in class ParserSymbol
- ParserValue::__clone() — Method in class ParserValue
- Segment::__construct() — Method in class Segment
- OperationsClient::__construct() — Method in class OperationsClient
- Constructor.
- OperationResponse::__construct() — Method in class OperationResponse
- OperationResponse constructor.
- Page::__construct() — Method in class Page
- Page constructor.
- PageStreamingDescriptor::__construct() — Method in class PageStreamingDescriptor
- PagedListResponse::__construct() — Method in class PagedListResponse
- PagedListResponse constructor.
- Parser::__construct() — Method in class Parser
- PathTemplate::__construct() — Method in class PathTemplate
- PathTemplate::__toString() — Method in class PathTemplate
- RetrySettings::__construct() — Method in class RetrySettings
- Construct an instance.
- Serializer::__construct() — Method in class Serializer
- ServerStream::__construct() — Method in class ServerStream
- ServerStream constructor.
- MockBidiStreamingCall::__construct() — Method in class MockBidiStreamingCall
- MockBidiStreamingCall constructor.
- MockClientStreamingCall::__construct() — Method in class MockClientStreamingCall
- MockClientStreamingCall constructor.
- MockServerStreamingCall::__construct() — Method in class MockServerStreamingCall
- MockServerStreamingCall constructor.
- MockStatus::__construct() — Method in class MockStatus
- MockStubTrait::_simpleRequest() — Method in class MockStubTrait
- Overrides the _simpleRequest method in \Grpc\BaseStub (https://github.com/grpc/grpc/blob/master/src/php/lib/Grpc/BaseStub.php) Returns a MockUnaryCall object that will return the first item from $responses
- MockStubTrait::_clientStreamRequest() — Method in class MockStubTrait
- Overrides the _clientStreamRequest method in \Grpc\BaseStub (https://github.com/grpc/grpc/blob/master/src/php/lib/Grpc/BaseStub.php) Returns a MockClientStreamingCall object that will return the first item from $responses
- MockStubTrait::_serverStreamRequest() — Method in class MockStubTrait
- Overrides the _serverStreamRequest method in \Grpc\BaseStub (https://github.com/grpc/grpc/blob/master/src/php/lib/Grpc/BaseStub.php) Returns a MockServerStreamingCall object that will stream items from $responses, and return a final status of $serverStreamingStatus.
- MockStubTrait::_bidiRequest() — Method in class MockStubTrait
- Overrides the _bidiRequest method in \Grpc\BaseStub (https://github.com/grpc/grpc/blob/master/src/php/lib/Grpc/BaseStub.php) Returns a MockBidiStreamingCall object that will stream items from $responses, and return a final status of $serverStreamingStatus.
- MockUnaryCall::__construct() — Method in class MockUnaryCall
- MockUnaryCall constructor.
- ReceivedRequest::__construct() — Method in class ReceivedRequest
- Binding::__construct() — Method in class Binding
- BindingDelta::__construct() — Method in class BindingDelta
- GetIamPolicyRequest::__construct() — Method in class GetIamPolicyRequest
- IAMPolicyGrpcClient::__construct() — Method in class IAMPolicyGrpcClient
- Policy::__construct() — Method in class Policy
- PolicyDelta::__construct() — Method in class PolicyDelta
- SetIamPolicyRequest::__construct() — Method in class SetIamPolicyRequest
- TestIamPermissionsRequest::__construct() — Method in class TestIamPermissionsRequest
- TestIamPermissionsResponse::__construct() — Method in class TestIamPermissionsResponse
- HttpRequest::__construct() — Method in class HttpRequest
- ConfigServiceV2GrpcClient::__construct() — Method in class ConfigServiceV2GrpcClient
- CreateLogMetricRequest::__construct() — Method in class CreateLogMetricRequest
- CreateSinkRequest::__construct() — Method in class CreateSinkRequest
- DeleteLogMetricRequest::__construct() — Method in class DeleteLogMetricRequest
- DeleteLogRequest::__construct() — Method in class DeleteLogRequest
- DeleteSinkRequest::__construct() — Method in class DeleteSinkRequest
- GetLogMetricRequest::__construct() — Method in class GetLogMetricRequest
- GetSinkRequest::__construct() — Method in class GetSinkRequest
- ListLogEntriesRequest::__construct() — Method in class ListLogEntriesRequest
- ListLogEntriesResponse::__construct() — Method in class ListLogEntriesResponse
- ListLogMetricsRequest::__construct() — Method in class ListLogMetricsRequest
- ListLogMetricsResponse::__construct() — Method in class ListLogMetricsResponse
- ListLogsRequest::__construct() — Method in class ListLogsRequest
- ListLogsResponse::__construct() — Method in class ListLogsResponse
- ListMonitoredResourceDescriptorsRequest::__construct() — Method in class ListMonitoredResourceDescriptorsRequest
- ListMonitoredResourceDescriptorsResponse::__construct() — Method in class ListMonitoredResourceDescriptorsResponse
- ListSinksRequest::__construct() — Method in class ListSinksRequest
- ListSinksResponse::__construct() — Method in class ListSinksResponse
- LogEntry::__construct() — Method in class LogEntry
- LogEntryOperation::__construct() — Method in class LogEntryOperation
- LogEntrySourceLocation::__construct() — Method in class LogEntrySourceLocation
- LogMetric::__construct() — Method in class LogMetric
- LogSink::__construct() — Method in class LogSink
- LoggingServiceV2GrpcClient::__construct() — Method in class LoggingServiceV2GrpcClient
- MetricsServiceV2GrpcClient::__construct() — Method in class MetricsServiceV2GrpcClient
- UpdateLogMetricRequest::__construct() — Method in class UpdateLogMetricRequest
- UpdateSinkRequest::__construct() — Method in class UpdateSinkRequest
- WriteLogEntriesPartialErrors::__construct() — Method in class WriteLogEntriesPartialErrors
- WriteLogEntriesRequest::__construct() — Method in class WriteLogEntriesRequest
- WriteLogEntriesResponse::__construct() — Method in class WriteLogEntriesResponse
- CancelOperationRequest::__construct() — Method in class CancelOperationRequest
- DeleteOperationRequest::__construct() — Method in class DeleteOperationRequest
- GetOperationRequest::__construct() — Method in class GetOperationRequest
- ListOperationsRequest::__construct() — Method in class ListOperationsRequest
- ListOperationsResponse::__construct() — Method in class ListOperationsResponse
- Operation::__construct() — Method in class Operation
- OperationsGrpcClient::__construct() — Method in class OperationsGrpcClient
- Aggregation::__construct() — Method in class Aggregation
- CreateGroupRequest::__construct() — Method in class CreateGroupRequest
- CreateMetricDescriptorRequest::__construct() — Method in class CreateMetricDescriptorRequest
- CreateTimeSeriesError::__construct() — Method in class CreateTimeSeriesError
- CreateTimeSeriesRequest::__construct() — Method in class CreateTimeSeriesRequest
- DeleteGroupRequest::__construct() — Method in class DeleteGroupRequest
- DeleteMetricDescriptorRequest::__construct() — Method in class DeleteMetricDescriptorRequest
- GetGroupRequest::__construct() — Method in class GetGroupRequest
- GetMetricDescriptorRequest::__construct() — Method in class GetMetricDescriptorRequest
- GetMonitoredResourceDescriptorRequest::__construct() — Method in class GetMonitoredResourceDescriptorRequest
- Group::__construct() — Method in class Group
- GroupServiceGrpcClient::__construct() — Method in class GroupServiceGrpcClient
- ListGroupMembersRequest::__construct() — Method in class ListGroupMembersRequest
- ListGroupMembersResponse::__construct() — Method in class ListGroupMembersResponse
- ListGroupsRequest::__construct() — Method in class ListGroupsRequest
- ListGroupsResponse::__construct() — Method in class ListGroupsResponse
- ListMetricDescriptorsRequest::__construct() — Method in class ListMetricDescriptorsRequest
- ListMetricDescriptorsResponse::__construct() — Method in class ListMetricDescriptorsResponse
- ListMonitoredResourceDescriptorsRequest::__construct() — Method in class ListMonitoredResourceDescriptorsRequest
- ListMonitoredResourceDescriptorsResponse::__construct() — Method in class ListMonitoredResourceDescriptorsResponse
- ListTimeSeriesRequest::__construct() — Method in class ListTimeSeriesRequest
- ListTimeSeriesResponse::__construct() — Method in class ListTimeSeriesResponse
- MetricServiceGrpcClient::__construct() — Method in class MetricServiceGrpcClient
- Point::__construct() — Method in class Point
- TimeInterval::__construct() — Method in class TimeInterval
- TimeSeries::__construct() — Method in class TimeSeries
- TypedValue::__construct() — Method in class TypedValue
- UpdateGroupRequest::__construct() — Method in class UpdateGroupRequest
- Any::__construct() — Method in class Any
- Api::__construct() — Method in class Api
- BoolValue::__construct() — Method in class BoolValue
- BytesValue::__construct() — Method in class BytesValue
- DoubleValue::__construct() — Method in class DoubleValue
- Duration::__construct() — Method in class Duration
- Enum::__construct() — Method in class Enum
- EnumValue::__construct() — Method in class EnumValue
- Field::__construct() — Method in class Field
- FieldMask::__construct() — Method in class FieldMask
- FloatValue::__construct() — Method in class FloatValue
- GPBEmpty::__construct() — Method in class GPBEmpty
- Int32Value::__construct() — Method in class Int32Value
- Int64Value::__construct() — Method in class Int64Value
- ListValue::__construct() — Method in class ListValue
- Method::__construct() — Method in class Method
- Mixin::__construct() — Method in class Mixin
- Option::__construct() — Method in class Option
- SourceContext::__construct() — Method in class SourceContext
- StringValue::__construct() — Method in class StringValue
- Struct::__construct() — Method in class Struct
- Timestamp::__construct() — Method in class Timestamp
- Type::__construct() — Method in class Type
- UInt32Value::__construct() — Method in class UInt32Value
- UInt64Value::__construct() — Method in class UInt64Value
- Value::__construct() — Method in class Value
- AcknowledgeRequest::__construct() — Method in class AcknowledgeRequest
- CreateSnapshotRequest::__construct() — Method in class CreateSnapshotRequest
- DeleteSnapshotRequest::__construct() — Method in class DeleteSnapshotRequest
- DeleteSubscriptionRequest::__construct() — Method in class DeleteSubscriptionRequest
- DeleteTopicRequest::__construct() — Method in class DeleteTopicRequest
- GetSubscriptionRequest::__construct() — Method in class GetSubscriptionRequest
- GetTopicRequest::__construct() — Method in class GetTopicRequest
- ListSnapshotsRequest::__construct() — Method in class ListSnapshotsRequest
- ListSnapshotsResponse::__construct() — Method in class ListSnapshotsResponse
- ListSubscriptionsRequest::__construct() — Method in class ListSubscriptionsRequest
- ListSubscriptionsResponse::__construct() — Method in class ListSubscriptionsResponse
- ListTopicSubscriptionsRequest::__construct() — Method in class ListTopicSubscriptionsRequest
- ListTopicSubscriptionsResponse::__construct() — Method in class ListTopicSubscriptionsResponse
- ListTopicsRequest::__construct() — Method in class ListTopicsRequest
- ListTopicsResponse::__construct() — Method in class ListTopicsResponse
- ModifyAckDeadlineRequest::__construct() — Method in class ModifyAckDeadlineRequest
- ModifyPushConfigRequest::__construct() — Method in class ModifyPushConfigRequest
- PublishRequest::__construct() — Method in class PublishRequest
- PublishResponse::__construct() — Method in class PublishResponse
- PublisherGrpcClient::__construct() — Method in class PublisherGrpcClient
- PubsubMessage::__construct() — Method in class PubsubMessage
- PullRequest::__construct() — Method in class PullRequest
- PullResponse::__construct() — Method in class PullResponse
- PushConfig::__construct() — Method in class PushConfig
- ReceivedMessage::__construct() — Method in class ReceivedMessage
- SeekRequest::__construct() — Method in class SeekRequest
- SeekResponse::__construct() — Method in class SeekResponse
- Snapshot::__construct() — Method in class Snapshot
- StreamingPullRequest::__construct() — Method in class StreamingPullRequest
- StreamingPullResponse::__construct() — Method in class StreamingPullResponse
- SubscriberGrpcClient::__construct() — Method in class SubscriberGrpcClient
- Subscription::__construct() — Method in class Subscription
- Topic::__construct() — Method in class Topic
- UpdateSubscriptionRequest::__construct() — Method in class UpdateSubscriptionRequest
- BadRequest::__construct() — Method in class BadRequest
- BadRequest_FieldViolation::__construct() — Method in class BadRequest_FieldViolation
- DebugInfo::__construct() — Method in class DebugInfo
- Help::__construct() — Method in class Help
- Help_Link::__construct() — Method in class Help_Link
- LocalizedMessage::__construct() — Method in class LocalizedMessage
- QuotaFailure::__construct() — Method in class QuotaFailure
- QuotaFailure_Violation::__construct() — Method in class QuotaFailure_Violation
- RequestInfo::__construct() — Method in class RequestInfo
- ResourceInfo::__construct() — Method in class ResourceInfo
- RetryInfo::__construct() — Method in class RetryInfo
- Status::__construct() — Method in class Status
- CreateDatabaseMetadata::__construct() — Method in class CreateDatabaseMetadata
- CreateDatabaseRequest::__construct() — Method in class CreateDatabaseRequest
- Database::__construct() — Method in class Database
- DatabaseAdminGrpcClient::__construct() — Method in class DatabaseAdminGrpcClient
- DropDatabaseRequest::__construct() — Method in class DropDatabaseRequest
- GetDatabaseDdlRequest::__construct() — Method in class GetDatabaseDdlRequest
- GetDatabaseDdlResponse::__construct() — Method in class GetDatabaseDdlResponse
- GetDatabaseRequest::__construct() — Method in class GetDatabaseRequest
- ListDatabasesRequest::__construct() — Method in class ListDatabasesRequest
- ListDatabasesResponse::__construct() — Method in class ListDatabasesResponse
- UpdateDatabaseDdlMetadata::__construct() — Method in class UpdateDatabaseDdlMetadata
- UpdateDatabaseDdlRequest::__construct() — Method in class UpdateDatabaseDdlRequest
- CreateInstanceMetadata::__construct() — Method in class CreateInstanceMetadata
- CreateInstanceRequest::__construct() — Method in class CreateInstanceRequest
- DeleteInstanceRequest::__construct() — Method in class DeleteInstanceRequest
- GetInstanceConfigRequest::__construct() — Method in class GetInstanceConfigRequest
- GetInstanceRequest::__construct() — Method in class GetInstanceRequest
- Instance::__construct() — Method in class Instance
- InstanceAdminGrpcClient::__construct() — Method in class InstanceAdminGrpcClient
- InstanceConfig::__construct() — Method in class InstanceConfig
- ListInstanceConfigsRequest::__construct() — Method in class ListInstanceConfigsRequest
- ListInstanceConfigsResponse::__construct() — Method in class ListInstanceConfigsResponse
- ListInstancesRequest::__construct() — Method in class ListInstancesRequest
- ListInstancesResponse::__construct() — Method in class ListInstancesResponse
- UpdateInstanceMetadata::__construct() — Method in class UpdateInstanceMetadata
- UpdateInstanceRequest::__construct() — Method in class UpdateInstanceRequest
- BeginTransactionRequest::__construct() — Method in class BeginTransactionRequest
- CommitRequest::__construct() — Method in class CommitRequest
- CommitResponse::__construct() — Method in class CommitResponse
- CreateSessionRequest::__construct() — Method in class CreateSessionRequest
- DeleteSessionRequest::__construct() — Method in class DeleteSessionRequest
- ExecuteSqlRequest::__construct() — Method in class ExecuteSqlRequest
- GetSessionRequest::__construct() — Method in class GetSessionRequest
- KeyRange::__construct() — Method in class KeyRange
- KeySet::__construct() — Method in class KeySet
- Mutation::__construct() — Method in class Mutation
- Mutation_Delete::__construct() — Method in class Mutation_Delete
- Mutation_Write::__construct() — Method in class Mutation_Write
- PartialResultSet::__construct() — Method in class PartialResultSet
- PlanNode::__construct() — Method in class PlanNode
- PlanNode_ChildLink::__construct() — Method in class PlanNode_ChildLink
- PlanNode_ShortRepresentation::__construct() — Method in class PlanNode_ShortRepresentation
- QueryPlan::__construct() — Method in class QueryPlan
- ReadRequest::__construct() — Method in class ReadRequest
- ResultSet::__construct() — Method in class ResultSet
- ResultSetMetadata::__construct() — Method in class ResultSetMetadata
- ResultSetStats::__construct() — Method in class ResultSetStats
- RollbackRequest::__construct() — Method in class RollbackRequest
- Session::__construct() — Method in class Session
- SpannerGrpcClient::__construct() — Method in class SpannerGrpcClient
- StructType::__construct() — Method in class StructType
- StructType_Field::__construct() — Method in class StructType_Field
- Transaction::__construct() — Method in class Transaction
- TransactionOptions::__construct() — Method in class TransactionOptions
- TransactionOptions_ReadOnly::__construct() — Method in class TransactionOptions_ReadOnly
- TransactionOptions_ReadWrite::__construct() — Method in class TransactionOptions_ReadWrite
- TransactionSelector::__construct() — Method in class TransactionSelector
- Type::__construct() — Method in class Type
- Color::__construct() — Method in class Color
- Date::__construct() — Method in class Date
- LatLng::__construct() — Method in class LatLng
- Money::__construct() — Method in class Money
- PostalAddress::__construct() — Method in class PostalAddress
- TimeOfDay::__construct() — Method in class TimeOfDay