Core classes for the google-cloud library.
Classes
AsyncPageImpl<T>
Base implementation for asynchronously consuming Google Cloud paginated results.
BaseService<OptionsT>
Base class for service objects.
BaseServiceException.Error
BaseServiceException.ExceptionData
BaseServiceException.ExceptionData.Builder
BaseWriteChannel<ServiceOptionsT,EntityT>
Base implementation for a WriteChannel.
BaseWriteChannel.BaseState<ServiceOptionsT,EntityT>
BaseWriteChannel.BaseState.Builder<ServiceOptionsT,EntityT>
Base builder for a write channel's state. Users are not supposed to access this class directly.
BaseWriteChannel.BaseState.ValueHolder
BatchResult<T,E>
This class holds a single result of a batch call. The class is not thread-safe.
Binding
Class for Identity and Access Management (IAM) policies. IAM policies are used to specify access settings for Cloud Platform resources. A policy is a list of bindings. A binding assigns a set of identities to a role, where the identities can be user accounts, Google groups, Google domains, and service accounts. A role is a named list of permissions defined by IAM. See Also: Policy
Binding.Builder
ByteArray
An immutable byte array holder.
Condition
Class for Identity and Access Management (IAM) policies. IAM policies are used to specify access settings for Cloud Platform resources. A policy is a list of bindings. A binding assigns a set of identities to a role, where the identities can be user accounts, Google groups, Google domains, and service accounts. A role is a named list of permissions defined by IAM. See Also: Policy, IAM Conditions
Condition.Builder
Date
Represents a Date without time, such as 2017-03-17. Date is timezone independent.
ExceptionHandler
Exception retry algorithm implementation used by RetryHelper.
ExceptionHandler.Builder
ExceptionHandler builder.
ExtendedOperationsProto
FieldSelector.Helper
A helper class used to build composite selectors given a number of fields. This class is not supposed to be used directly by users.
GcpLaunchStage
A qualifier indicating what level of access and support can be expected of a particular Google Cloud Platform feature. The "GeneralAvailability" qualifier is not provided since the vast majority of features are in this category. Note that features may be in a later launch stage than the client library annotation indicates.
See more at the Launch Stages Documentation.
Identity
An identity in a Policy. The following types of identities are permitted in IAM policies:
- Google account
- Service account
- Google group
- Google Apps domain
There are also two special identities that represent all users and all Google-authenticated accounts. See Also: Concepts related to identity
Identity.Type
The types of IAM identities.
MetadataConfig
Retrieves Google Cloud project-id and a limited set of instance attributes from Metadata server. See Also: https://cloud.google.com/compute/docs/storing-retrieving-metadata
MonitoredResource
Objects of this class represent a resource that can be used for monitoring, logging, billing, or other purposes. Examples include virtual machine instances, databases, and storage devices such as disks. The type field identifies a MonitoredResourceDescriptor object that describes the resource's schema. Information in the labels field identifies the actual resource and its attributes according to the schema.
For example, the monitored resource for Google Compute Engine VM instances has
gce_instance type and specifies values for the labels instance_id and zone to
identify particular VM instances.
MonitoredResource.Builder
A builder for MonitoredResource objects.
MonitoredResourceDescriptor
This class describes the schema of Cloud monitored resources. Monitored resource descriptors
contain 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.
MonitoredResourceDescriptor.LabelDescriptor
This class describes a label for a monitored resource. Label descriptors contain the key for the label, the type of data that the label can hold and an optional description.
NoCredentials
A placeholder for credentials to signify that requests sent to the server should not be authenticated. This is typically useful when using local service emulators.
PageImpl<T>
Base implementation for Google Cloud paginated results.
PlatformInformation
Policy
Class for Identity and Access Management (IAM) policies. IAM policies are used to specify access settings for Cloud Platform resources. A policy is a list of bindings. A binding assigns a set of identities to a role, where the identities can be user accounts, Google groups, Google domains, and service accounts. A role is a named list of permissions defined by IAM. See Also: Policy
Policy.Builder
A builder for Policy objects.
Policy.DefaultMarshaller
Policy.Marshaller<T>
RetryHelper
Utility class for retrying operations. For more details about the parameters, see RetrySettings. In case if retrying is unsuccessful, RetryHelperException will be thrown.
RetryOption
This class represents an options wrapper around the RetrySettings class and is an alternative way of initializing it. The retry options are usually provided in a form of varargs for methods that wait for changes in the status of a resource, do poll operations or retry on failures.
Role
A role in a IAM Policy. Project owners can grant access to team members to access project's resources and APIs by granting IAM roles to team members. See Also: Viewing the Grantable Roles on Resources, Understanding Roles
ServiceOptions<ServiceT,OptionsT>
Abstract class representing service options.
ServiceOptions.Builder<ServiceT,OptionsT,B>
Builder for ServiceOptions.
StringEnumType<EnumT>
This represents a concept having a known set of acceptable String values, which can expand later due to new API features.
StringEnumValue
This represents a specific instance of a concept having a known set of acceptable String values, which can expand later due to new API features. Standard Java enums can't be used in such a context.
Timestamp
Represents a timestamp with nanosecond precision. Timestamps cover the range [0001-01-01, 9999-12-31].
Timestamp instances are immutable.
Tuple<X,Y>
Interfaces
AsyncPageImpl.NextPageFetcher<T>
Interface for asynchronously fetching the next page of results from the service.
BatchResult.Callback<T,E>
An interface for the batch callbacks.
ExceptionHandler.Interceptor
FieldSelector
Interface for Google Cloud resource's fields. Implementations of this interface can be used to select only desired fields from a returned Google Cloud resource.
PageImpl.NextPageFetcher<T>
Interface for fetching the next page of results from the service.
ReadChannel
A channel for reading data from a Google Cloud object.
Implementations of this class may buffer data internally to reduce remote calls. This interface implements Restorable to allow saving the reader's state to continue reading afterwards.
Restorable<T>
Implementation of this interface can persist their state and restore from it.
A typical capture usage:
X restorableObj; // X instanceof Restorable
A typical restore usage:
RestorableStateRestorableState<T>
A common interface for restorable states. Implementations of RestorableState are capable
of saving the state of an object to restore it for later use.
Implementations of this class must implement java.io.Serializable to ensure that the state of a the object can be correctly serialized.
Service<OptionsT>
Interface for service objects.
ServiceDefaults<ServiceT,OptionsT>
ServiceFactory<ServiceT,ServiceOptionsT>
A base interface for all service factories.
Implementation must provide a public no-arg constructor. Loading of a factory implementation is done via java.util.ServiceLoader.
ServiceRpc
TransportOptions
An abstraction for transport-specific options, e.g. for http1.1 vs grpc.
WriteChannel
A channel for writing data to Google Cloud services.
Implementations of this class may further buffer data internally to reduce remote calls. Written data might not be visible until calling #close(). This interface implements Restorable to allow saving the writer's state to continue writing afterwards.
Enums
MonitoredResourceDescriptor.LabelDescriptor.ValueType
Value types that can be used as label values.
OperationResponseMapping
Exceptions
BaseServiceException
Base class for all service exceptions.
ExceptionHandler.Interceptor.RetryResult
RetryHelper.RetryHelperException
Annotation Types
GcpLaunchStage.Alpha
Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects whitelisted. Alpha releases don’t have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases.
GcpLaunchStage.Beta
Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release, and charges may be waived in some cases. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases.
GcpLaunchStage.Deprecated
Deprecated features are scheduled to be shut down and removed. For more information, see the “Deprecation Policy” section of our Terms of Service and the Google Cloud Platform Subject to the Deprecation Policy documentation.
GcpLaunchStage.EarlyAccess
Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released.