google::cloud::storage Namespace Reference

Contains all the Google Cloud Storage C++ client APIs. More...

Namespaces
	event_type
	Contains functions to return well-known notification event type names.
	examples
	oauth2
	payload_format
	Contains functions to return well-known notification payload format names.
	storage_class
	Contains functions to return well-known storage class names.
	v1
	The Google Cloud Storage C++ client APIs inlined, versioned namespace.

Classes
struct	AutoFinalize
	Control whether upload streams auto-finalize on destruction. More...
class	Client
	The Google Cloud Storage (GCS) Client. More...
class	HmacKeyMetadata
	Represents the metadata for a Google Cloud Storage HmacKeyResource. More...
struct	RewriteProgress
	Represents the status of a rewrite operation. More...
class	ObjectRewriter
	Complete long running object rewrite operations. More...
class	HashMismatchError
	Report checksum mismatches as exceptions. More...
class	ObjectReadStream
	Defines a std::basic_istream<char> to read from a GCS Object. More...
class	ObjectWriteStream
	Defines a std::basic_ostream<char> to write to a GCS object. More...
struct	UseResumableUploadSession
	Request a resumable upload, restoring a previous session if necessary. More...
struct	UploadContentLength
	Provide an expected final length of an uploaded object. More...
struct	UploadFromOffset
	Upload the local file to GCS server starting at the given offset. More...
struct	UploadLimit
	The maximum length of the local file to upload to GCS server. More...
class	ChannelOptions
	Describes the configuration for low-level connection features. More...
class	ClientOptions
	Describes the configuration for a storage::Client object. More...
struct	CustomerEncryption
	A simple representation for the customerEncryption field. More...
struct	ComposeSourceObject
	Defines one of the source objects for a compose operation. More...
class	ObjectMetadata
	Represents the metadata for a Google Cloud Storage Object. More...
class	ObjectMetadataPatchBuilder
	Prepares a patch for the Bucket resource. More...
struct	WithObjectMetadata
	A request option to define the object metadata attributes. More...
struct	ContentType
	Set the MIME content type of an object. More...
class	CustomHeader
	An option to inject custom headers into the request. More...
struct	IfMatchEtag
	A pre-condition: apply this operation only if the HTTP Entity Tag matches. More...
struct	IfNoneMatchEtag
	A pre-condition: apply this operation only if the HTTP Entity Tag does not match. More...
struct	EncryptionKeyData
	A simple wrapper for the encryption key attributes. More...
struct	EncryptionKey
	An optional parameter to set the Customer-Supplied Encryption key. More...
struct	SourceEncryptionKey
	An optional parameter to set the Customer-Supplied Encryption key for rewrite source object. More...
struct	ExpirationTime
	Define the expiration time for a signed URL. More...
struct	AddExtensionHeaderOption
	Add a extension header to a signed URL. More...
struct	AddQueryParameterOption
	Add a extension header to a signed URL. More...
struct	SubResourceOption
	Specify a sub-resource in a signed URL. More...
struct	SignedUrlTimestamp
	Define the timestamp duration for a V4 signed URL. More...
struct	SignedUrlDuration
	Define the duration for a V4 signed URL. More...
struct	SigningAccount
	Specify the service account used to sign a blob. More...
struct	SigningAccountDelegates
	Specify the sequence of delegates used to sign a blob. More...
struct	VirtualHostname
	Indicate that the bucket should be a part of hostname in the URL. More...
struct	BucketBoundHostname
	Use domain-named bucket in a V4 signed URL. More...
struct	Scheme
	Use the specified scheme (e.g. "http") in a V4 signed URL. More...
struct	AddExtensionFieldOption
	Add a extension header to a POST policy. More...
struct	RestEndpointOption
	Configure the REST endpoint for the GCS client library. More...
struct	IamEndpointOption
	Configure the IAM endpoint for the GCS client library. More...
struct	Oauth2CredentialsOption
	Configure oauth2::Credentials for the GCS client library. More...
struct	ProjectIdOption
	Set the Google Cloud Platform project id. More...
struct	ConnectionPoolSizeOption
struct	DownloadBufferSizeOption
	Control the formatted I/O download buffer. More...
struct	UploadBufferSizeOption
	Control the formatted I/O upload buffer. More...
struct	MaximumSimpleUploadSizeOption
	Defines the threshold to switch from simple to resumable uploads for files. More...
struct	EnableCurlSslLockingOption
	Disables automatic OpenSSL locking. More...
struct	EnableCurlSigpipeHandlerOption
	Disables automatic OpenSSL sigpipe handler. More...
struct	MaximumCurlSocketRecvSizeOption
	Control the maximum socket receive buffer. More...
struct	MaximumCurlSocketSendSizeOption
	Control the maximum socket send buffer. More...
struct	DownloadStallTimeoutOption
	Sets the "stall" timeout. More...
struct	RetryPolicyOption
	Set the retry policy for a GCS client. More...
struct	BackoffPolicyOption
	Set the backoff policy for a GCS client. More...
struct	IdempotencyPolicyOption
	Set the idempotency policy for a GCS client. More...
class	ObjectAccessControl
	Wraps the objectAccessControl resource in Google Cloud Storage. More...
class	ObjectAccessControlPatchBuilder
	Prepares a patch for an ObjectAccessControl resource. More...
class	MaxStreams
	A parameter type indicating the maximum number of streams to ParallelUploadFile. More...
class	MinStreamSize
	A parameter type indicating the minimum stream size to ParallelUploadFile. More...
class	IdempotencyPolicy
	Define the interface for the idempotency policy. More...
class	AlwaysRetryIdempotencyPolicy
	A IdempotencyPolicy that always retries all requests. More...
class	StrictIdempotencyPolicy
	A IdempotencyPolicy that only retries strictly idempotent requests. More...
class	BucketAccessControl
	Wraps the bucketAccessControl resource in Google Cloud Storage. More...
class	BucketAccessControlPatchBuilder
	Prepares a patch for a BucketAccessControl resource. More...
struct	BucketBilling
	The billing configuration for a Bucket. More...
struct	CorsEntry
	An entry in the CORS list. More...
struct	UniformBucketLevelAccess
	Configure if only the IAM policies are used for access control. More...
struct	BucketIamConfiguration
	The IAM configuration for a Bucket. More...
struct	BucketLifecycle
	The Object Lifecycle configuration for a Bucket. More...
struct	BucketLogging
	The Logging configuration for a Bucket. More...
struct	BucketEncryption
	Describes the default customer managed encryption key for a bucket. More...
struct	BucketRetentionPolicy
	The retention policy for a bucket. More...
struct	BucketVersioning
	The versioning configuration for a Bucket. More...
struct	BucketWebsite
	The website configuration for a Bucket. More...
class	BucketMetadata
	Represents a Google Cloud Storage Bucket Metadata object. More...
class	BucketMetadataPatchBuilder
	Prepares a patch for the Bucket resource. More...
struct	ContentEncoding
	Sets the contentEncoding option for object uploads. More...
struct	Deleted
	Included deleted HMAC keys in list requests. More...
struct	DestinationKmsKeyName
	Configure the Customer-Managed Encryption Key (CMEK) for an rewrite. More...
struct	Fields
	Defines the fields query parameter. More...
struct	Generation
	Set the version of an object to operate on. More...
struct	IfGenerationMatch
	A pre-condition: the request succeeds only if the object generation matches. More...
struct	IfGenerationNotMatch
	A pre-condition: the request succeeds unless the object generation matches. More...
struct	IfMetagenerationMatch
	A pre-condition: the request succeeds if the metadata generation matches. More...
struct	IfMetagenerationNotMatch
	A pre-condition: the request succeeds unless the metadata generation matches. More...
struct	IfSourceGenerationMatch
	A pre-condition: the request succeeds if the source object generation matches. More...
struct	IfSourceGenerationNotMatch
	A pre-condition: the request succeeds unless the source object generation matches. More...
struct	IfSourceMetagenerationMatch
	A pre-condition: the request succeeds if the source object metadata generation matches. More...
struct	IfSourceMetagenerationNotMatch
	A pre-condition: the request succeeds unless the source object metadata generation matches. More...
struct	KmsKeyName
	Configure the Customer-Managed Encryption Key (CMEK) for an upload. More...
struct	MaxResults
	Limit the number of results per page when listing Buckets and Objects. More...
struct	MaxBytesRewrittenPerCall
	Limit the number of bytes rewritten in a Objects: rewrite step. More...
struct	PredefinedAcl
	Set the ACL to predefined values when creating Buckets or Objects. More...
struct	DestinationPredefinedAcl
	Set the ACL to a predefined value when copying Objects. More...
struct	PredefinedDefaultObjectAcl
	Set the default object ACL to a predefined value in a Bucket. More...
struct	Prefix
	Restrict list operations to entries starting with this value. More...
struct	Delimiter
	Returns results in a directory-like mode. More...
struct	IncludeTrailingDelimiter
	If true, objects that end in exactly one instance of delimiter have their metadata included in items[] in addition to the relevant part of the object name appearing in prefixes[]. More...
struct	StartOffset
	Filter results to objects whose names are lexicographically equal to or after StartOffset. More...
struct	EndOffset
	Filter results to objects whose names are lexicographically before EndOffset. More...
struct	Projection
	Controls what metadata fields are included in the response. More...
struct	QuotaUser
	Sets the user for this operation for quota enforcement purposes. More...
struct	ServiceAccountFilter
	Only list HMAC keys belonging to a specific Service Account. More...
struct	SourceGeneration
	Set the generation for the source object in copy operations. More...
struct	UserProject
	Set the project used for billing in "requester pays" Buckets. More...
struct	Versions
	Control if all versions of an object should be included when listing objects. More...
struct	RequestedPolicyVersion
	Controls the IAM policy version returned by IAM queries. More...
struct	MD5HashValue
	Provide a pre-computed MD5 hash value to an upload or download request. More...
struct	DisableMD5Hash
	Disable or enable MD5 Hashing computations. More...
struct	Crc32cChecksumValue
	Provide a pre-computed MD5 hash value to an upload or download request. More...
struct	DisableCrc32cChecksum
	Disable MD5 Hashing computations. More...
class	NativeExpression
	Represents a google::type::Expr. More...
class	NativeIamBinding
	Represents a Binding which associates a member with a particular role which can be used for Identity and Access management for Cloud Platform Resources. More...
class	NativeIamPolicy
	Represent the result of a GetIamPolicy or SetIamPolicy request. More...
struct	LifecycleRuleAction
	Implement a wrapper for Lifecycle Rules actions. More...
struct	LifecycleRuleCondition
	Implement a wrapper for Lifecycle Conditions. More...
class	LifecycleRule
	Defines objects to read, create, and modify Object Lifecycle Rules. More...
class	NotificationMetadata
	Represents the metadata for a Google Cloud Storage Notification resource. More...
class	PolicyDocumentCondition
	Define a condition for a policy document. More...
struct	PolicyDocument
	Define a policy document. More...
struct	PolicyDocumentV4
	Define a policy document V4. More...
struct	PolicyDocumentResult
	Define a policy document result. More...
struct	PolicyDocumentV4Result
	Define a policy document result V4. More...
class	ServiceAccount
	Represents the metadata for a Google Cloud Storage service account. More...
struct	ReadRangeData
struct	ReadRange
	Request only a portion of the GCS object in a ReadObject operation. More...
struct	ReadFromOffset
	Download all the data from the GCS object starting at the given offset. More...
struct	ReadLast
	Read last N bytes from the GCS object. More...
struct	OverrideDefaultProject
	Override the default project. More...

Typedefs
using	ListBucketsReader = google::cloud::internal::PaginationRange< BucketMetadata >
using	ListBucketsIterator = ListBucketsReader::iterator
using	ListHmacKeysReader = google::cloud::internal::PaginationRange< HmacKeyMetadata >
	A range to paginate over the HmacKeys for a project. More...
using	ListHmacKeysIterator = ListHmacKeysReader::iterator
using	ObjectOrPrefix = absl::variant< ObjectMetadata, std::string >
using	ListObjectsAndPrefixesReader = google::cloud::internal::PaginationRange< ObjectOrPrefix >
using	ListObjectsAndPrefixesIterator = ListObjectsAndPrefixesReader::iterator
using	ListObjectsReader = google::cloud::internal::PaginationRange< ObjectMetadata >
using	ListObjectsIterator = ListObjectsReader::iterator
using	HeadersMap = std::multimap< std::string, std::string >
	Represents the headers returned in a streaming upload or download operation. More...
using	RetryPolicy = google::cloud::internal::TraitBasedRetryPolicy< internal::StatusTraits >
	The retry policy base class. More...
using	LimitedTimeRetryPolicy = google::cloud::internal::LimitedTimeRetryPolicy< internal::StatusTraits >
	Keep retrying until some time has expired. More...
using	LimitedErrorCountRetryPolicy = google::cloud::internal::LimitedErrorCountRetryPolicy< internal::StatusTraits >
	Keep retrying until the error count has been exceeded. More...
using	BackoffPolicy = google::cloud::internal::BackoffPolicy
	The backoff policy base class. More...
using	ExponentialBackoffPolicy = google::cloud::internal::ExponentialBackoffPolicy
	Implement truncated exponential backoff with randomization. More...
using	ClientOptionList = ::google::cloud::OptionList< RestEndpointOption, IamEndpointOption, Oauth2CredentialsOption, ProjectIdOption, ProjectIdOption, ConnectionPoolSizeOption, DownloadBufferSizeOption, UploadBufferSizeOption, EnableCurlSslLockingOption, EnableCurlSigpipeHandlerOption, MaximumCurlSocketRecvSizeOption, MaximumCurlSocketSendSizeOption, DownloadStallTimeoutOption, RetryPolicyOption, BackoffPolicyOption, IdempotencyPolicyOption, CARootsFilePathOption >
	The complete list of options accepted by storage::Client. More...

Enumerations
enum class	AutoFinalizeConfig { kDisabled , kEnabled }

Functions
std::ostream &	operator<< (std::ostream &os, AutoFinalize const &rhs)
AutoFinalize	AutoFinalizeEnabled ()
	Configure a stream to automatically finalize an upload on destruction. More...
AutoFinalize	AutoFinalizeDisabled ()
	Configure a stream to leave uploads pending (not finalized) on destruction. More...
std::string	CreateRandomPrefixName (std::string const &prefix="")
	Create a random prefix for object names. More...
template<typename... Options>
Status	DeleteByPrefix (Client &client, std::string const &bucket_name, std::string const &prefix, Options &&... options)
	Delete objects whose names match a given prefix. More...
template<typename... Options>
StatusOr< ObjectMetadata >	ComposeMany (Client &client, std::string const &bucket_name, std::vector< ComposeSourceObject > source_objects, std::string const &prefix, std::string destination_object_name, bool ignore_cleanup_failures, Options &&... options)
	Compose existing objects into a new object in the same bucket. More...
bool	operator== (HmacKeyMetadata const &lhs, HmacKeyMetadata const &rhs)
bool	operator!= (HmacKeyMetadata const &lhs, HmacKeyMetadata const &rhs)
std::ostream &	operator<< (std::ostream &os, HmacKeyMetadata const &rhs)
UseResumableUploadSession	RestoreResumableUploadSession (std::string session_id)
	Create a UseResumableUploadSession option that restores previous sessions. More...
UseResumableUploadSession	NewResumableUploadSession ()
	Create a UseResumableUploadSession option that requests new sessions. More...
constexpr int	version_major ()
	Returns the Google Cloud Storage C++ Client major version. More...
constexpr int	version_minor ()
	Returns the Google Cloud Storage C++ Client minor version. More...
constexpr int	version_patch ()
	Returns the Google Cloud Storage C++ Client patch version. More...
constexpr int	version ()
	Returns a single integer representing the Major/Minor/Patch version. More...
std::string	version_string ()
	Returns the version as a string, in MAJOR.MINOR.PATCH+gitrev format. More...
std::string	x_goog_api_client ()
	Returns the value for x-goog-api-client header. More...
std::ostream &	operator<< (std::ostream &os, ComposeSourceObject const &r)
bool	operator== (CustomerEncryption const &lhs, CustomerEncryption const &rhs)
bool	operator< (CustomerEncryption const &lhs, CustomerEncryption const &rhs)
bool	operator!= (CustomerEncryption const &lhs, CustomerEncryption const &rhs)
bool	operator> (CustomerEncryption const &lhs, CustomerEncryption const &rhs)
bool	operator<= (CustomerEncryption const &lhs, CustomerEncryption const &rhs)
bool	operator>= (CustomerEncryption const &lhs, CustomerEncryption const &rhs)
std::ostream &	operator<< (std::ostream &os, ObjectMetadata const &rhs)
std::ostream &	operator<< (std::ostream &os, CustomHeader const &rhs)
EncryptionKeyData	EncryptionDataFromBinaryKey (std::string const &key)
	Formats a (potentially binary) encryption key in the format required by the Google Cloud Storage API. More...
EncryptionKeyData	EncryptionDataFromBase64Key (std::string const &key)
	Formats an encryption key in base64 format to the data structure required by the Google Cloud Storage API. More...
std::ostream &	operator<< (std::ostream &os, EncryptionKey const &rhs)
std::ostream &	operator<< (std::ostream &os, SourceEncryptionKey const &rhs)
template<typename Generator >
EncryptionKeyData	CreateKeyFromGenerator (Generator &gen)
	Creates an encryption key parameter from a pseudo-random number generator. More...
AddExtensionHeaderOption	AddExtensionHeader (std::string header, std::string value)
AddQueryParameterOption	WithGeneration (std::uint64_t generation)
AddQueryParameterOption	WithGenerationMarker (std::uint64_t generation)
AddQueryParameterOption	WithUserProject (std::string user_project)
AddQueryParameterOption	WithMarker (std::string marker)
AddQueryParameterOption	WithResponseContentDisposition (std::string disposition)
AddQueryParameterOption	WithResponseContentType (std::string const &type)
SubResourceOption	WithAcl ()
SubResourceOption	WithBilling ()
SubResourceOption	WithCompose ()
SubResourceOption	WithCors ()
SubResourceOption	WithEncryption ()
SubResourceOption	WithEncryptionConfig ()
SubResourceOption	WithLifecycle ()
SubResourceOption	WithLocation ()
SubResourceOption	WithLogging ()
SubResourceOption	WithStorageClass ()
SubResourceOption	WithTagging ()
AddExtensionFieldOption	AddExtensionField (std::string field, std::string value)
std::ostream &	operator<< (std::ostream &os, ObjectAccessControl const &rhs)
template<typename... Options>
StatusOr< ObjectMetadata >	ParallelUploadFile (Client client, std::string file_name, std::string bucket_name, std::string object_name, std::string prefix, bool ignore_cleanup_failures, Options &&... options)
	Perform a parallel upload of a given file. More...
bool	operator== (BucketAccessControl const &lhs, BucketAccessControl const &rhs)
std::ostream &	operator<< (std::ostream &os, BucketAccessControl const &rhs)
bool	operator== (BucketMetadata const &lhs, BucketMetadata const &rhs)
bool	operator== (BucketBilling const &lhs, BucketBilling const &rhs)
bool	operator< (BucketBilling const &lhs, BucketBilling const &rhs)
bool	operator!= (BucketBilling const &lhs, BucketBilling const &rhs)
bool	operator> (BucketBilling const &lhs, BucketBilling const &rhs)
bool	operator<= (BucketBilling const &lhs, BucketBilling const &rhs)
bool	operator>= (BucketBilling const &lhs, BucketBilling const &rhs)
std::string	ComputeMD5Hash (std::string const &payload)
	Compute the MD5 Hash of a string in the format preferred by GCS. More...
std::string	ComputeCrc32cChecksum (std::string const &payload)
	Compute the MD5 Hash of a string in the format preferred by GCS. More...
DisableMD5Hash	EnableMD5Hash ()
	Enable MD5 Hashing computations. More...
std::ostream &	operator<< (std::ostream &stream, NativeExpression const &e)
std::ostream &	operator<< (std::ostream &os, NativeIamBinding const &binding)
std::ostream &	operator<< (std::ostream &os, NativeIamPolicy const &rhs)
std::ostream &	operator<< (std::ostream &os, LifecycleRuleAction const &rhs)
std::ostream &	operator<< (std::ostream &os, LifecycleRuleCondition const &rhs)
std::ostream &	operator<< (std::ostream &os, LifecycleRule const &rhs)
bool	operator== (LifecycleRuleAction const &lhs, LifecycleRuleAction const &rhs)
bool	operator< (LifecycleRuleAction const &lhs, LifecycleRuleAction const &rhs)
bool	operator!= (LifecycleRuleAction const &lhs, LifecycleRuleAction const &rhs)
bool	operator> (LifecycleRuleAction const &lhs, LifecycleRuleAction const &rhs)
bool	operator<= (LifecycleRuleAction const &lhs, LifecycleRuleAction const &rhs)
bool	operator>= (LifecycleRuleAction const &lhs, LifecycleRuleAction const &rhs)
bool	operator== (LifecycleRuleCondition const &lhs, LifecycleRuleCondition const &rhs)
bool	operator< (LifecycleRuleCondition const &lhs, LifecycleRuleCondition const &rhs)
bool	operator!= (LifecycleRuleCondition const &lhs, LifecycleRuleCondition const &rhs)
bool	operator> (LifecycleRuleCondition const &lhs, LifecycleRuleCondition const &rhs)
bool	operator<= (LifecycleRuleCondition const &lhs, LifecycleRuleCondition const &rhs)
bool	operator>= (LifecycleRuleCondition const &lhs, LifecycleRuleCondition const &rhs)
bool	operator== (LifecycleRule const &lhs, LifecycleRule const &rhs)
bool	operator< (LifecycleRule const &lhs, LifecycleRule const &rhs)
bool	operator!= (LifecycleRule const &lhs, LifecycleRule const &rhs)
bool	operator> (LifecycleRule const &lhs, LifecycleRule const &rhs)
bool	operator<= (LifecycleRule const &lhs, LifecycleRule const &rhs)
bool	operator>= (LifecycleRule const &lhs, LifecycleRule const &rhs)
std::ostream &	operator<< (std::ostream &os, NotificationMetadata const &rhs)
bool	operator== (NotificationMetadata const &lhs, NotificationMetadata const &rhs)
bool	operator< (NotificationMetadata const &lhs, NotificationMetadata const &rhs)
bool	operator!= (NotificationMetadata const &lhs, NotificationMetadata const &rhs)
bool	operator> (NotificationMetadata const &lhs, NotificationMetadata const &rhs)
bool	operator<= (NotificationMetadata const &lhs, NotificationMetadata const &rhs)
bool	operator>= (NotificationMetadata const &lhs, NotificationMetadata const &rhs)
bool	operator== (ObjectAccessControl const &lhs, ObjectAccessControl const &rhs)
bool	operator== (ObjectMetadata const &lhs, ObjectMetadata const &rhs)
std::ostream &	operator<< (std::ostream &os, PolicyDocumentCondition const &rhs)
std::ostream &	operator<< (std::ostream &os, PolicyDocument const &rhs)
std::ostream &	operator<< (std::ostream &os, PolicyDocumentV4 const &rhs)
std::ostream &	operator<< (std::ostream &os, PolicyDocumentResult const &rhs)
std::string	FormatDateForForm (PolicyDocumentV4Result const &)
	Format the current date in the format expected by a POST form. More...
std::ostream &	operator<< (std::ostream &os, PolicyDocumentV4Result const &rhs)
bool	operator== (PolicyDocumentCondition const &lhs, PolicyDocumentCondition const &rhs)
bool	operator< (PolicyDocumentCondition const &lhs, PolicyDocumentCondition const &rhs)
bool	operator!= (PolicyDocumentCondition const &lhs, PolicyDocumentCondition const &rhs)
bool	operator> (PolicyDocumentCondition const &lhs, PolicyDocumentCondition const &rhs)
bool	operator<= (PolicyDocumentCondition const &lhs, PolicyDocumentCondition const &rhs)
bool	operator>= (PolicyDocumentCondition const &lhs, PolicyDocumentCondition const &rhs)
std::ostream &	operator<< (std::ostream &os, ServiceAccount const &rhs)
bool	operator== (ServiceAccount const &lhs, ServiceAccount const &rhs)
bool	operator< (ServiceAccount const &lhs, ServiceAccount const &rhs)
bool	operator!= (ServiceAccount const &lhs, ServiceAccount const &rhs)
bool	operator> (ServiceAccount const &lhs, ServiceAccount const &rhs)
bool	operator<= (ServiceAccount const &lhs, ServiceAccount const &rhs)
bool	operator>= (ServiceAccount const &lhs, ServiceAccount const &rhs)
std::ostream &	operator<< (std::ostream &os, ReadRangeData const &rhs)

Variables
constexpr auto	kExpectedCharDigits = 8

Detailed Description

Contains all the Google Cloud Storage C++ client APIs.