Google Cloud Storage C++ Client  1.27.0
A C++ Client Library for Google Cloud Storage
Namespaces | Classes | Typedefs | Functions | Variables
google::cloud::storage::v1 Namespace Reference

The Google Cloud Storage C++ client APIs inlined, versioned namespace. More...

Namespaces

 event_type
 Contains functions to return well-known notification event type names.
 
 oauth2
 
 payload_format
 Contains functions to return well-known notification payload format names.
 
 storage_class
 Contains functions to return well-known storage class names.
 

Classes

struct  AddExtensionFieldOption
 Add a extension header to a POST policy. More...
 
struct  AddExtensionHeaderOption
 Add a extension header to a signed URL. More...
 
struct  AddQueryParameterOption
 Add a extension header to a signed URL. More...
 
class  AlwaysRetryIdempotencyPolicy
 A IdempotencyPolicy that always retries all 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  BucketBoundHostname
 Use domain-named bucket in a V4 signed URL. More...
 
struct  BucketEncryption
 Describes the default customer managed encryption key for a bucket. 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...
 
class  BucketMetadata
 Represents a Google Cloud Storage Bucket Metadata object. More...
 
class  BucketMetadataPatchBuilder
 Prepares a patch for the Bucket resource. 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  ChannelOptions
 Describes the configuration for low-level connection features. More...
 
class  Client
 The Google Cloud Storage (GCS) Client. More...
 
class  ClientOptions
 Describes the configuration for a storage::Client object. More...
 
struct  ComposeSourceObject
 Defines one of the source objects for a compose operation. More...
 
struct  ContentEncoding
 Sets the contentEncoding option for object uploads. More...
 
struct  ContentType
 Set the MIME content type of an object. More...
 
struct  CorsEntry
 An entry in the CORS list. More...
 
struct  Crc32cChecksumValue
 Provide a pre-computed MD5 hash value to an upload or download request. More...
 
struct  CustomerEncryption
 A simple representation for the customerEncryption field. More...
 
class  CustomHeader
 An option to inject custom headers into the request. More...
 
struct  Deleted
 Included deleted HMAC keys in list requests. More...
 
struct  Delimiter
 Returns results in a directory-like mode. More...
 
struct  DestinationKmsKeyName
 Configure the Customer-Managed Encryption Key (CMEK) for an rewrite. More...
 
struct  DestinationPredefinedAcl
 Set the ACL to a predefined value when copying Objects. More...
 
struct  DisableCrc32cChecksum
 Disable MD5 Hashing computations. More...
 
struct  DisableMD5Hash
 Disable or enable MD5 Hashing computations. More...
 
struct  EncryptionKey
 An optional parameter to set the Customer-Supplied Encryption key. More...
 
struct  EncryptionKeyData
 A simple wrapper for the encryption key attributes. More...
 
struct  EndOffset
 Filter results to objects whose names are lexicographically before EndOffset. More...
 
struct  ExpirationTime
 Define the expiration time for a signed URL. More...
 
struct  Fields
 Defines the fields query parameter. More...
 
struct  Generation
 Set the version of an object to operate on. More...
 
class  HashMismatchError
 Report checksum mismatches as exceptions. More...
 
class  HmacKeyMetadata
 Represents the metadata for a Google Cloud Storage HmacKeyResource. More...
 
class  IdempotencyPolicy
 Define the interface for the idempotency policy. 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  IfMatchEtag
 A pre-condition: apply this operation only if the HTTP Entity Tag 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  IfNoneMatchEtag
 A pre-condition: apply this operation only if the HTTP Entity Tag does not match. 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  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  KmsKeyName
 Configure the Customer-Managed Encryption Key (CMEK) for an upload. More...
 
class  LifecycleRule
 Defines objects to read, create, and modify Object Lifecycle Rules. More...
 
struct  LifecycleRuleAction
 Implement a wrapper for Lifecycle Rules actions. More...
 
struct  LifecycleRuleCondition
 Implement a wrapper for Lifecycle Conditions. More...
 
struct  MaxBytesRewrittenPerCall
 Limit the number of bytes rewritten in a Objects: rewrite step. More...
 
struct  MaxResults
 Limit the number of results per page when listing Buckets and Objects. More...
 
class  MaxStreams
 A parameter type indicating the maximum number of streams to ParallelUploadFile. More...
 
struct  MD5HashValue
 Provide a pre-computed MD5 hash value to an upload or download request. More...
 
class  MinStreamSize
 A parameter type indicating the minimum stream size to ParallelUploadFile. 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...
 
class  NotificationMetadata
 Represents the metadata for a Google Cloud Storage Notification resource. More...
 
class  ObjectAccessControl
 Wraps the objectAccessControl resource in Google Cloud Storage. More...
 
class  ObjectAccessControlPatchBuilder
 Prepares a patch for an ObjectAccessControl resource. More...
 
class  ObjectMetadata
 Represents the metadata for a Google Cloud Storage Object. More...
 
class  ObjectMetadataPatchBuilder
 Prepares a patch for the Bucket resource. More...
 
class  ObjectReadStream
 Defines a std::basic_istream<char> to read from a GCS Object. More...
 
class  ObjectRewriter
 Complete long running object rewrite operations. More...
 
class  ObjectWriteStream
 Defines a std::basic_ostream<char> to write to a GCS object. More...
 
struct  OverrideDefaultProject
 Override the default project. More...
 
struct  PolicyDocument
 Define a policy document. More...
 
class  PolicyDocumentCondition
 Define a condition for a policy document. More...
 
struct  PolicyDocumentResult
 Define a policy document result. More...
 
struct  PolicyDocumentV4
 Define a policy document V4. More...
 
struct  PolicyDocumentV4Result
 Define a policy document result V4. More...
 
struct  PredefinedAcl
 Set the ACL to predefined values when creating Buckets or 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  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  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  ReadRange
 Request only a portion of the GCS object in a ReadObject operation. More...
 
struct  ReadRangeData
 
struct  RequestedPolicyVersion
 Controls the IAM policy version returned by IAM queries. More...
 
struct  RewriteProgress
 Represents the status of a rewrite operation. More...
 
struct  Scheme
 Use the specified scheme (e.g. "http") in a V4 signed URL. More...
 
class  ServiceAccount
 Represents the metadata for a Google Cloud Storage service account. More...
 
struct  ServiceAccountFilter
 Only list HMAC keys belonging to a specific Service Account. More...
 
struct  SignedUrlDuration
 Define the duration for a V4 signed URL. More...
 
struct  SignedUrlTimestamp
 Define the timestamp 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  SourceEncryptionKey
 An optional parameter to set the Customer-Supplied Encryption key for rewrite source object. More...
 
struct  SourceGeneration
 Set the generation for the source object in copy operations. More...
 
struct  StartOffset
 Filter results to objects whose names are lexicographically equal to or after StartOffset. More...
 
class  StrictIdempotencyPolicy
 A IdempotencyPolicy that only retries strictly idempotent requests. More...
 
struct  SubResourceOption
 Specify a sub-resource in a signed URL. More...
 
struct  UniformBucketLevelAccess
 Configure if only the IAM policies are used for access control. 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...
 
struct  UseResumableUploadSession
 Request a resumable upload, restoring a previous session if necessary. 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  VirtualHostname
 Indicate that the bucket should be a part of hostname in the URL. More...
 
struct  WithObjectMetadata
 A request option to define the object metadata attributes. 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 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...
 

Functions

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 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< ObjectMetadataComposeMany (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...
 
std::ostream & operator<< (std::ostream &os, ReadRangeData 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 &os, HmacKeyMetadata const &rhs)
 
bool operator== (HmacKeyMetadata const &lhs, HmacKeyMetadata const &rhs)
 
bool operator!= (HmacKeyMetadata const &lhs, HmacKeyMetadata const &rhs)
 
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)
 
std::ostream & operator<< (std::ostream &os, ObjectAccessControl const &rhs)
 
bool operator== (ObjectMetadata const &lhs, ObjectMetadata const &rhs)
 
std::ostream & operator<< (std::ostream &os, ObjectMetadata const &rhs)
 
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)
 
template<typename... Options>
StatusOr< ObjectMetadataParallelUploadFile (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...
 
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)
 
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)
 
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...
 
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...
 
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::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...
 
Comparison operators For UniformBucketLevelAccess
std::ostream & operator<< (std::ostream &os, UniformBucketLevelAccess const &rhs)
 
bool operator== (UniformBucketLevelAccess const &lhs, UniformBucketLevelAccess const &rhs)
 
bool operator< (UniformBucketLevelAccess const &lhs, UniformBucketLevelAccess const &rhs)
 
bool operator!= (UniformBucketLevelAccess const &lhs, UniformBucketLevelAccess const &rhs)
 
bool operator> (UniformBucketLevelAccess const &lhs, UniformBucketLevelAccess const &rhs)
 
bool operator<= (UniformBucketLevelAccess const &lhs, UniformBucketLevelAccess const &rhs)
 
bool operator>= (UniformBucketLevelAccess const &lhs, UniformBucketLevelAccess const &rhs)
 
Comparison operators for BucketIamConfiguration.
std::ostream & operator<< (std::ostream &os, BucketIamConfiguration const &rhs)
 
bool operator== (BucketIamConfiguration const &lhs, BucketIamConfiguration const &rhs)
 
bool operator< (BucketIamConfiguration const &lhs, BucketIamConfiguration const &rhs)
 
bool operator!= (BucketIamConfiguration const &lhs, BucketIamConfiguration const &rhs)
 
bool operator> (BucketIamConfiguration const &lhs, BucketIamConfiguration const &rhs)
 
bool operator<= (BucketIamConfiguration const &lhs, BucketIamConfiguration const &rhs)
 
bool operator>= (BucketIamConfiguration const &lhs, BucketIamConfiguration const &rhs)
 
Comparison operators for BucketLifecycle.
std::ostream & operator<< (std::ostream &os, BucketLogging const &rhs)
 
std::ostream & operator<< (std::ostream &os, BucketRetentionPolicy const &rhs)
 
std::ostream & operator<< (std::ostream &os, BucketMetadata const &rhs)
 
bool operator== (BucketLifecycle const &lhs, BucketLifecycle const &rhs)
 
bool operator< (BucketLifecycle const &lhs, BucketLifecycle const &rhs)
 
bool operator!= (BucketLifecycle const &lhs, BucketLifecycle const &rhs)
 
bool operator> (BucketLifecycle const &lhs, BucketLifecycle const &rhs)
 
bool operator<= (BucketLifecycle const &lhs, BucketLifecycle const &rhs)
 
bool operator>= (BucketLifecycle const &lhs, BucketLifecycle const &rhs)
 
bool operator== (BucketLogging const &lhs, BucketLogging const &rhs)
 
bool operator< (BucketLogging const &lhs, BucketLogging const &rhs)
 
bool operator!= (BucketLogging const &lhs, BucketLogging const &rhs)
 
bool operator> (BucketLogging const &lhs, BucketLogging const &rhs)
 
bool operator<= (BucketLogging const &lhs, BucketLogging const &rhs)
 
bool operator>= (BucketLogging const &lhs, BucketLogging const &rhs)
 
bool operator== (BucketEncryption const &lhs, BucketEncryption const &rhs)
 
bool operator< (BucketEncryption const &lhs, BucketEncryption const &rhs)
 
bool operator!= (BucketEncryption const &lhs, BucketEncryption const &rhs)
 
bool operator> (BucketEncryption const &lhs, BucketEncryption const &rhs)
 
bool operator<= (BucketEncryption const &lhs, BucketEncryption const &rhs)
 
bool operator>= (BucketEncryption const &lhs, BucketEncryption const &rhs)
 
bool operator== (BucketRetentionPolicy const &lhs, BucketRetentionPolicy const &rhs)
 
bool operator< (BucketRetentionPolicy const &lhs, BucketRetentionPolicy const &rhs)
 
bool operator!= (BucketRetentionPolicy const &lhs, BucketRetentionPolicy const &rhs)
 
bool operator> (BucketRetentionPolicy const &lhs, BucketRetentionPolicy const &rhs)
 
bool operator<= (BucketRetentionPolicy const &lhs, BucketRetentionPolicy const &rhs)
 
bool operator>= (BucketRetentionPolicy const &lhs, BucketRetentionPolicy const &rhs)
 
bool operator== (BucketVersioning const &lhs, BucketVersioning const &rhs)
 
bool operator< (BucketVersioning const &lhs, BucketVersioning const &rhs)
 
bool operator!= (BucketVersioning const &lhs, BucketVersioning const &rhs)
 
bool operator> (BucketVersioning const &lhs, BucketVersioning const &rhs)
 
bool operator<= (BucketVersioning const &lhs, BucketVersioning const &rhs)
 
bool operator>= (BucketVersioning const &lhs, BucketVersioning const &rhs)
 
bool operator== (BucketWebsite const &lhs, BucketWebsite const &rhs)
 
bool operator< (BucketWebsite const &lhs, BucketWebsite const &rhs)
 
bool operator!= (BucketWebsite const &lhs, BucketWebsite const &rhs)
 
bool operator> (BucketWebsite const &lhs, BucketWebsite const &rhs)
 
bool operator<= (BucketWebsite const &lhs, BucketWebsite const &rhs)
 
bool operator>= (BucketWebsite const &lhs, BucketWebsite const &rhs)
 

Variables

constexpr auto kExpectedCharDigits = 8
 

Comparison operators for CorsEntry.

using BucketPolicyOnly = UniformBucketLevelAccess
 
std::ostream & operator<< (std::ostream &os, CorsEntry const &rhs)
 
bool operator== (CorsEntry const &lhs, CorsEntry const &rhs)
 
bool operator< (CorsEntry const &lhs, CorsEntry const &rhs)
 
bool operator!= (CorsEntry const &lhs, CorsEntry const &rhs)
 
bool operator> (CorsEntry const &lhs, CorsEntry const &rhs)
 
bool operator<= (CorsEntry const &lhs, CorsEntry const &rhs)
 
bool operator>= (CorsEntry const &lhs, CorsEntry const &rhs)
 

Detailed Description

The Google Cloud Storage C++ client APIs inlined, versioned namespace.

Applications may need to link multiple versions of the Google Cloud Storage C++ client, for example, if they link a library that uses an older version of the client than they do. This namespace is inlined, so applications can use storage::Foo in their source, but the symbols are versioned, i.e., the symbol becomes storage::v1::Foo.

Note that, consistent with the semver.org guidelines, the v0 version makes no guarantees with respect to backwards compatibility.

Typedef Documentation

◆ BackoffPolicy

using google::cloud::storage::v1::BackoffPolicy = typedef google::cloud::internal::BackoffPolicy

The backoff policy base class.

Definition at line 53 of file retry_policy.h.

◆ BucketPolicyOnly

Definition at line 155 of file bucket_metadata.h.

◆ ExponentialBackoffPolicy

using google::cloud::storage::v1::ExponentialBackoffPolicy = typedef google::cloud::internal::ExponentialBackoffPolicy

Implement truncated exponential backoff with randomization.

Definition at line 56 of file retry_policy.h.

◆ LimitedErrorCountRetryPolicy

using google::cloud::storage::v1::LimitedErrorCountRetryPolicy = typedef google::cloud::internal::LimitedErrorCountRetryPolicy< internal::StatusTraits>

Keep retrying until the error count has been exceeded.

Definition at line 48 of file retry_policy.h.

◆ LimitedTimeRetryPolicy

using google::cloud::storage::v1::LimitedTimeRetryPolicy = typedef google::cloud::internal::LimitedTimeRetryPolicy<internal::StatusTraits>

Keep retrying until some time has expired.

Definition at line 44 of file retry_policy.h.

◆ ListBucketsIterator

using google::cloud::storage::v1::ListBucketsIterator = typedef ListBucketsReader::iterator

Definition at line 31 of file list_buckets_reader.h.

◆ ListBucketsReader

using google::cloud::storage::v1::ListBucketsReader = typedef google::cloud::internal::PaginationRange<BucketMetadata>

Definition at line 28 of file list_buckets_reader.h.

◆ ListHmacKeysIterator

using google::cloud::storage::v1::ListHmacKeysIterator = typedef ListHmacKeysReader::iterator

Definition at line 36 of file list_hmac_keys_reader.h.

◆ ListHmacKeysReader

using google::cloud::storage::v1::ListHmacKeysReader = typedef google::cloud::internal::PaginationRange<HmacKeyMetadata>

A range to paginate over the HmacKeys for a project.

Definition at line 33 of file list_hmac_keys_reader.h.

◆ ListObjectsAndPrefixesIterator

using google::cloud::storage::v1::ListObjectsAndPrefixesIterator = typedef ListObjectsAndPrefixesReader::iterator

Definition at line 34 of file list_objects_and_prefixes_reader.h.

◆ ListObjectsAndPrefixesReader

using google::cloud::storage::v1::ListObjectsAndPrefixesReader = typedef google::cloud::internal::PaginationRange<ObjectOrPrefix>

Definition at line 31 of file list_objects_and_prefixes_reader.h.

◆ ListObjectsIterator

using google::cloud::storage::v1::ListObjectsIterator = typedef ListObjectsReader::iterator

Definition at line 33 of file list_objects_reader.h.

◆ ListObjectsReader

using google::cloud::storage::v1::ListObjectsReader = typedef google::cloud::internal::PaginationRange<ObjectMetadata>

Definition at line 30 of file list_objects_reader.h.

◆ ObjectOrPrefix

using google::cloud::storage::v1::ObjectOrPrefix = typedef absl::variant<ObjectMetadata, std::string>

Definition at line 29 of file list_objects_and_prefixes_reader.h.

◆ RetryPolicy

using google::cloud::storage::v1::RetryPolicy = typedef google::cloud::internal::TraitBasedRetryPolicy<internal::StatusTraits>

The retry policy base class.

Definition at line 40 of file retry_policy.h.

Function Documentation

◆ AddExtensionField()

AddExtensionFieldOption google::cloud::storage::v1::AddExtensionField ( std::string  field,
std::string  value 
)
inline

Definition at line 267 of file signed_url_options.h.

◆ AddExtensionHeader()

AddExtensionHeaderOption google::cloud::storage::v1::AddExtensionHeader ( std::string  header,
std::string  value 
)
inline

Definition at line 58 of file signed_url_options.h.

◆ ComposeMany()

template<typename... Options>
StatusOr<ObjectMetadata> google::cloud::storage::v1::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.

Contrary to Client::ComposeObject, this function doesn't have a limit on the number of source objects.

The implementation may need to perform multiple Client::ComposeObject calls to create intermediate, temporary objects which are then further composed. Due to the lack of atomicity of this series of operations, stray temporary objects might be left over if there are transient failures. In order to allow the user to easily control for such situations, the user is expected to provide a unique prefix parameter, which will become the prefix of all the temporary objects created by this function. Once this function finishes, the user may safely remove all objects with the provided prefix (e.g. via DeleteByPrefix()). We recommend using CreateRandomPrefixName() for selecting a random prefix within a bucket.

Parameters
clientthe client on which to perform the operations needed by this function
bucket_namethe name of the bucket used for source object and destination object.
source_objectsobjects used to compose destination_object_name.
destination_object_namethe composed object name.
prefixprefix for temporary objects created by this function; there should not be any objects with this prefix; in order to avoid race conditions, this function will create an object with this name
ignore_cleanup_failuresif the composition succeeds but cleanup of temporary objects fails, depending on this parameter either a success will be returned (true) or the relevant cleanup error (false)
optionsa list of optional query parameters and/or request headers. Valid types for this operation include DestinationPredefinedAcl, EncryptionKey, IfGenerationMatch, IfMetagenerationMatch KmsKeyName, QuotaUser, UserIp, UserProject and WithObjectMetadata.
Idempotency
This operation is not idempotent. While each request performed by this function is retried based on the client policies, the operation itself stops on the first request that fails.
Example
using ::google::cloud::StatusOr;
[](gcs::Client client, std::string const& bucket_name,
std::string const& destination_object_name,
std::vector<gcs::ComposeSourceObject> const& compose_objects) {
std::string prefix = gcs::CreateRandomPrefixName(".tmpfiles");
StatusOr<gcs::ObjectMetadata> composed_object =
ComposeMany(client, bucket_name, compose_objects, prefix,
destination_object_name, false);
if (!composed_object) {
// If this is an effect of some transient unavailability, stray temporary
// might be left over. You can use `DeleteByPrefix()` with `prefix` as
// argument to delete them.
throw std::runtime_error(composed_object.status().message());
}
std::cout << "Composed new object " << composed_object->name()
<< " in bucket " << composed_object->bucket()
<< "\nFull metadata: " << *composed_object << "\n";
}

Definition at line 3478 of file client.h.

◆ ComputeCrc32cChecksum()

std::string google::cloud::storage::v1::ComputeCrc32cChecksum ( std::string const &  payload)

Compute the MD5 Hash of a string in the format preferred by GCS.

Definition at line 36 of file hashing_options.cc.

◆ ComputeMD5Hash()

std::string google::cloud::storage::v1::ComputeMD5Hash ( std::string const &  payload)

Compute the MD5 Hash of a string in the format preferred by GCS.

Definition at line 26 of file hashing_options.cc.

◆ CreateKeyFromGenerator()

template<typename Generator >
EncryptionKeyData google::cloud::storage::v1::CreateKeyFromGenerator ( Generator &  gen)

Creates an encryption key parameter from a pseudo-random number generator.

Template Parameters
Generatorthe pseudo-random number generator type, it must meet the UniformRandomBitGenerator requirements.
Parameters
genthe pseudo-random number generator.
Example
// Create a pseudo-random number generator (PRNG), this is included for
// demonstration purposes only. You should consult your security team about
// best practices to initialize PRNG. In particular, you should verify that
// the C++ library and operating system provide enough entropy to meet the
// security policies in your organization.
// Use the Mersenne-Twister Engine in this example:
// https://en.cppreference.com/w/cpp/numeric/random/mersenne_twister_engine
// Any C++ PRNG can be used below, the choice is arbitrary.
using GeneratorType = std::mt19937_64;
// Create the default random device to fetch entropy.
std::random_device rd;
// Compute how much entropy we need to initialize the GeneratorType:
constexpr auto kRequiredEntropyWords =
GeneratorType::state_size *
(GeneratorType::word_size / std::numeric_limits<unsigned int>::digits);
// Capture the entropy bits into a vector.
std::vector<std::uint64_t> entropy(kRequiredEntropyWords);
std::generate(entropy.begin(), entropy.end(), [&rd] { return rd(); });
// Create the PRNG with the fetched entropy.
std::seed_seq seed(entropy.begin(), entropy.end());
// initialized with enough entropy such that the encryption keys are not
// predictable. Note that the default constructor for all the generators in
// the C++ standard library produce predictable keys.
std::mt19937_64 gen(seed);
std::cout << "Base64 encoded key = " << data.key << "\n"
<< "Base64 encoded SHA256 of key = " << data.sha256 << "\n";
See also
https://en.cppreference.com/w/cpp/numeric/random for a general overview of C++ pseudo-random number support.
https://en.cppreference.com/w/cpp/numeric/random/UniformRandomBitGenerator for a more detailed overview of the requirements for generators.

Definition at line 269 of file well_known_headers.h.

◆ CreateRandomPrefixName()

std::string google::cloud::storage::v1::CreateRandomPrefixName ( std::string const &  prefix = "")

Create a random prefix for object names.

This is useful for operations which require a unique prefix for temporary files.

This is a helper function and it doesn't communicate with GCS, so there is a very small chance that names generated this way aren't unique. The chance should be small enough to fit any error budget.

Given the same prefix, the randomly generated names will have the same length.

Parameters
prefixthe prefix of the prefix to be created.
Returns
the random prefix name

Definition at line 449 of file client.cc.

◆ DeleteByPrefix()

template<typename... Options>
Status google::cloud::storage::v1::DeleteByPrefix ( Client client,
std::string const &  bucket_name,
std::string const &  prefix,
Options &&...  options 
)

Delete objects whose names match a given prefix.

Parameters
clientthe client on which to perform the operation.
bucket_namethe name of the bucket that will contain the object.
prefixthe prefix of the objects to be deleted.
optionsa list of optional query parameters and/or request headers. Valid types for this operation include QuotaUser, UserIp, UserProject and Versions.

Definition at line 3353 of file client.h.

◆ EnableMD5Hash()

DisableMD5Hash google::cloud::storage::v1::EnableMD5Hash ( )
inline

Enable MD5 Hashing computations.

Use this function where the option DisableMD5Hash is expected to enable MD5 Hashing computations.

Definition at line 73 of file hashing_options.h.

◆ EncryptionDataFromBase64Key()

EncryptionKeyData google::cloud::storage::v1::EncryptionDataFromBase64Key ( std::string const &  key)

Formats an encryption key in base64 format to the data structure required by the Google Cloud Storage API.

Parameters
keya base64-encoded key, must have exactly 32 bytes when decoded.

Definition at line 38 of file well_known_headers.cc.

◆ EncryptionDataFromBinaryKey()

EncryptionKeyData google::cloud::storage::v1::EncryptionDataFromBinaryKey ( std::string const &  key)

Formats a (potentially binary) encryption key in the format required by the Google Cloud Storage API.

Parameters
keya binary key, must have exactly 32 bytes.

Definition at line 33 of file well_known_headers.cc.

◆ FormatDateForForm()

std::string google::cloud::storage::v1::FormatDateForForm ( PolicyDocumentV4Result const &  )

Format the current date in the format expected by a POST form.

Definition at line 60 of file policy_document.cc.

◆ NewResumableUploadSession()

UseResumableUploadSession google::cloud::storage::v1::NewResumableUploadSession ( )
inline

Create a UseResumableUploadSession option that requests new sessions.

Definition at line 54 of file upload_options.h.

◆ operator!=() [1/18]

bool google::cloud::storage::v1::operator!= ( BucketBilling const &  lhs,
BucketBilling const &  rhs 
)
inline

Definition at line 64 of file bucket_metadata.h.

◆ operator!=() [2/18]

bool google::cloud::storage::v1::operator!= ( BucketEncryption const &  lhs,
BucketEncryption const &  rhs 
)
inline

Definition at line 350 of file bucket_metadata.h.

◆ operator!=() [3/18]

bool google::cloud::storage::v1::operator!= ( BucketIamConfiguration const &  lhs,
BucketIamConfiguration const &  rhs 
)
inline

Definition at line 225 of file bucket_metadata.h.

◆ operator!=() [4/18]

bool google::cloud::storage::v1::operator!= ( BucketLifecycle const &  lhs,
BucketLifecycle const &  rhs 
)
inline

Definition at line 268 of file bucket_metadata.h.

◆ operator!=() [5/18]

bool google::cloud::storage::v1::operator!= ( BucketLogging const &  lhs,
BucketLogging const &  rhs 
)
inline

Definition at line 306 of file bucket_metadata.h.

◆ operator!=() [6/18]

bool google::cloud::storage::v1::operator!= ( BucketRetentionPolicy const &  lhs,
BucketRetentionPolicy const &  rhs 
)
inline

Definition at line 400 of file bucket_metadata.h.

◆ operator!=() [7/18]

bool google::cloud::storage::v1::operator!= ( BucketVersioning const &  lhs,
BucketVersioning const &  rhs 
)
inline

Definition at line 445 of file bucket_metadata.h.

◆ operator!=() [8/18]

bool google::cloud::storage::v1::operator!= ( BucketWebsite const &  lhs,
BucketWebsite const &  rhs 
)
inline

Definition at line 486 of file bucket_metadata.h.

◆ operator!=() [9/18]

bool google::cloud::storage::v1::operator!= ( CorsEntry const &  lhs,
CorsEntry const &  rhs 
)
inline

Definition at line 120 of file bucket_metadata.h.

◆ operator!=() [10/18]

bool google::cloud::storage::v1::operator!= ( CustomerEncryption const &  lhs,
CustomerEncryption const &  rhs 
)
inline

Definition at line 68 of file object_metadata.h.

◆ operator!=() [11/18]

bool google::cloud::storage::v1::operator!= ( HmacKeyMetadata const &  lhs,
HmacKeyMetadata const &  rhs 
)
inline

Definition at line 109 of file hmac_key_metadata.h.

◆ operator!=() [12/18]

bool google::cloud::storage::v1::operator!= ( LifecycleRule const &  lhs,
LifecycleRule const &  rhs 
)
inline

Definition at line 341 of file lifecycle_rule.h.

◆ operator!=() [13/18]

bool google::cloud::storage::v1::operator!= ( LifecycleRuleAction const &  lhs,
LifecycleRuleAction const &  rhs 
)
inline

Definition at line 57 of file lifecycle_rule.h.

◆ operator!=() [14/18]

bool google::cloud::storage::v1::operator!= ( LifecycleRuleCondition const &  lhs,
LifecycleRuleCondition const &  rhs 
)
inline

Definition at line 116 of file lifecycle_rule.h.

◆ operator!=() [15/18]

bool google::cloud::storage::v1::operator!= ( NotificationMetadata const &  lhs,
NotificationMetadata const &  rhs 
)
inline

Definition at line 181 of file notification_metadata.h.

◆ operator!=() [16/18]

bool google::cloud::storage::v1::operator!= ( PolicyDocumentCondition const &  lhs,
PolicyDocumentCondition const &  rhs 
)
inline

Definition at line 98 of file policy_document.h.

◆ operator!=() [17/18]

bool google::cloud::storage::v1::operator!= ( ServiceAccount const &  lhs,
ServiceAccount const &  rhs 
)
inline

Definition at line 57 of file service_account.h.

◆ operator!=() [18/18]

bool google::cloud::storage::v1::operator!= ( UniformBucketLevelAccess const &  lhs,
UniformBucketLevelAccess const &  rhs 
)
inline

Definition at line 171 of file bucket_metadata.h.

◆ operator<() [1/17]

bool google::cloud::storage::v1::operator< ( BucketBilling const &  lhs,
BucketBilling const &  rhs 
)
inline

Definition at line 60 of file bucket_metadata.h.

◆ operator<() [2/17]

bool google::cloud::storage::v1::operator< ( BucketEncryption const &  lhs,
BucketEncryption const &  rhs 
)
inline

Definition at line 345 of file bucket_metadata.h.

◆ operator<() [3/17]

bool google::cloud::storage::v1::operator< ( BucketIamConfiguration const &  lhs,
BucketIamConfiguration const &  rhs 
)
inline

Definition at line 220 of file bucket_metadata.h.

◆ operator<() [4/17]

bool google::cloud::storage::v1::operator< ( BucketLifecycle const &  lhs,
BucketLifecycle const &  rhs 
)
inline

Definition at line 264 of file bucket_metadata.h.

◆ operator<() [5/17]

bool google::cloud::storage::v1::operator< ( BucketLogging const &  lhs,
BucketLogging const &  rhs 
)
inline

Definition at line 301 of file bucket_metadata.h.

◆ operator<() [6/17]

bool google::cloud::storage::v1::operator< ( BucketRetentionPolicy const &  lhs,
BucketRetentionPolicy const &  rhs 
)
inline

Definition at line 394 of file bucket_metadata.h.

◆ operator<() [7/17]

bool google::cloud::storage::v1::operator< ( BucketVersioning const &  lhs,
BucketVersioning const &  rhs 
)
inline

Definition at line 440 of file bucket_metadata.h.

◆ operator<() [8/17]

bool google::cloud::storage::v1::operator< ( BucketWebsite const &  lhs,
BucketWebsite const &  rhs 
)
inline

Definition at line 481 of file bucket_metadata.h.

◆ operator<() [9/17]

bool google::cloud::storage::v1::operator< ( CorsEntry const &  lhs,
CorsEntry const &  rhs 
)
inline

Definition at line 113 of file bucket_metadata.h.

◆ operator<() [10/17]

bool google::cloud::storage::v1::operator< ( CustomerEncryption const &  lhs,
CustomerEncryption const &  rhs 
)
inline

Definition at line 62 of file object_metadata.h.

◆ operator<() [11/17]

bool google::cloud::storage::v1::operator< ( LifecycleRule const &  lhs,
LifecycleRule const &  rhs 
)
inline

Definition at line 336 of file lifecycle_rule.h.

◆ operator<() [12/17]

bool google::cloud::storage::v1::operator< ( LifecycleRuleAction const &  lhs,
LifecycleRuleAction const &  rhs 
)
inline

Definition at line 51 of file lifecycle_rule.h.

◆ operator<() [13/17]

bool google::cloud::storage::v1::operator< ( LifecycleRuleCondition const &  lhs,
LifecycleRuleCondition const &  rhs 
)
inline

Definition at line 104 of file lifecycle_rule.h.

◆ operator<() [14/17]

bool google::cloud::storage::v1::operator< ( NotificationMetadata const &  lhs,
NotificationMetadata const &  rhs 
)
inline

Definition at line 171 of file notification_metadata.h.

◆ operator<() [15/17]

bool google::cloud::storage::v1::operator< ( PolicyDocumentCondition const &  lhs,
PolicyDocumentCondition const &  rhs 
)
inline

Definition at line 93 of file policy_document.h.

◆ operator<() [16/17]

bool google::cloud::storage::v1::operator< ( ServiceAccount const &  lhs,
ServiceAccount const &  rhs 
)
inline

Definition at line 52 of file service_account.h.

◆ operator<() [17/17]

bool google::cloud::storage::v1::operator< ( UniformBucketLevelAccess const &  lhs,
UniformBucketLevelAccess const &  rhs 
)
inline

Definition at line 165 of file bucket_metadata.h.

◆ operator<<() [1/28]

std::ostream & google::cloud::storage::v1::operator<< ( std::ostream &  os,
BucketAccessControl const &  rhs 
)

Definition at line 27 of file bucket_access_control.cc.

◆ operator<<() [2/28]

std::ostream & google::cloud::storage::v1::operator<< ( std::ostream &  os,
BucketIamConfiguration const &  rhs 
)

Definition at line 53 of file bucket_metadata.cc.

◆ operator<<() [3/28]

std::ostream & google::cloud::storage::v1::operator<< ( std::ostream &  os,
BucketLogging const &  rhs 
)

Definition at line 62 of file bucket_metadata.cc.

◆ operator<<() [4/28]

std::ostream & google::cloud::storage::v1::operator<< ( std::ostream &  os,
BucketMetadata const &  rhs 
)

Definition at line 91 of file bucket_metadata.cc.

◆ operator<<() [5/28]

std::ostream & google::cloud::storage::v1::operator<< ( std::ostream &  os,
BucketRetentionPolicy const &  rhs 
)

Definition at line 67 of file bucket_metadata.cc.

◆ operator<<() [6/28]

std::ostream& google::cloud::storage::v1::operator<< ( std::ostream &  os,
ComposeSourceObject const &  r 
)

◆ operator<<() [7/28]

std::ostream & google::cloud::storage::v1::operator<< ( std::ostream &  os,
CorsEntry const &  rhs 
)

Definition at line 32 of file bucket_metadata.cc.

◆ operator<<() [8/28]

std::ostream & google::cloud::storage::v1::operator<< ( std::ostream &  os,
CustomHeader const &  rhs 
)

Definition at line 26 of file well_known_headers.cc.

◆ operator<<() [9/28]

std::ostream & google::cloud::storage::v1::operator<< ( std::ostream &  os,
EncryptionKey const &  rhs 
)

Definition at line 52 of file well_known_headers.cc.

◆ operator<<() [10/28]

std::ostream & google::cloud::storage::v1::operator<< ( std::ostream &  os,
HmacKeyMetadata const &  rhs 
)

Definition at line 22 of file hmac_key_metadata.cc.

◆ operator<<() [11/28]

std::ostream & google::cloud::storage::v1::operator<< ( std::ostream &  os,
LifecycleRule const &  rhs 
)

Definition at line 200 of file lifecycle_rule.cc.

◆ operator<<() [12/28]

std::ostream & google::cloud::storage::v1::operator<< ( std::ostream &  os,
LifecycleRuleAction const &  rhs 
)

Definition at line 24 of file lifecycle_rule.cc.

◆ operator<<() [13/28]

std::ostream & google::cloud::storage::v1::operator<< ( std::ostream &  os,
LifecycleRuleCondition const &  rhs 
)

Definition at line 65 of file lifecycle_rule.cc.

◆ operator<<() [14/28]

std::ostream & google::cloud::storage::v1::operator<< ( std::ostream &  os,
NativeIamBinding const &  binding 
)

Definition at line 327 of file iam_policy.cc.

◆ operator<<() [15/28]

std::ostream & google::cloud::storage::v1::operator<< ( std::ostream &  os,
NativeIamPolicy const &  rhs 
)

Definition at line 461 of file iam_policy.cc.

◆ operator<<() [16/28]

std::ostream & google::cloud::storage::v1::operator<< ( std::ostream &  os,
NotificationMetadata const &  rhs 
)

Definition at line 56 of file notification_metadata.cc.

◆ operator<<() [17/28]

std::ostream & google::cloud::storage::v1::operator<< ( std::ostream &  os,
ObjectAccessControl const &  rhs 
)

Definition at line 31 of file object_access_control.cc.

◆ operator<<() [18/28]

std::ostream & google::cloud::storage::v1::operator<< ( std::ostream &  os,
ObjectMetadata const &  rhs 
)

Definition at line 52 of file object_metadata.cc.

◆ operator<<() [19/28]

std::ostream & google::cloud::storage::v1::operator<< ( std::ostream &  os,
PolicyDocument const &  rhs 
)

Definition at line 31 of file policy_document.cc.

◆ operator<<() [20/28]

std::ostream & google::cloud::storage::v1::operator<< ( std::ostream &  os,
PolicyDocumentCondition const &  rhs 
)

Definition at line 26 of file policy_document.cc.

◆ operator<<() [21/28]

std::ostream & google::cloud::storage::v1::operator<< ( std::ostream &  os,
PolicyDocumentResult const &  rhs 
)

Definition at line 52 of file policy_document.cc.

◆ operator<<() [22/28]

std::ostream & google::cloud::storage::v1::operator<< ( std::ostream &  os,
PolicyDocumentV4 const &  rhs 
)

Definition at line 40 of file policy_document.cc.

◆ operator<<() [23/28]

std::ostream & google::cloud::storage::v1::operator<< ( std::ostream &  os,
PolicyDocumentV4Result const &  rhs 
)

Definition at line 70 of file policy_document.cc.

◆ operator<<() [24/28]

std::ostream& google::cloud::storage::v1::operator<< ( std::ostream &  os,
ReadRangeData const &  rhs 
)
inline

Definition at line 45 of file download_options.h.

◆ operator<<() [25/28]

std::ostream & google::cloud::storage::v1::operator<< ( std::ostream &  os,
ServiceAccount const &  rhs 
)

Definition at line 21 of file service_account.cc.

◆ operator<<() [26/28]

std::ostream & google::cloud::storage::v1::operator<< ( std::ostream &  os,
SourceEncryptionKey const &  rhs 
)

Definition at line 70 of file well_known_headers.cc.

◆ operator<<() [27/28]

std::ostream & google::cloud::storage::v1::operator<< ( std::ostream &  os,
UniformBucketLevelAccess const &  rhs 
)

Definition at line 45 of file bucket_metadata.cc.

◆ operator<<() [28/28]

std::ostream & google::cloud::storage::v1::operator<< ( std::ostream &  stream,
NativeExpression const &  e 
)

Definition at line 178 of file iam_policy.cc.

◆ operator<=() [1/17]

bool google::cloud::storage::v1::operator<= ( BucketBilling const &  lhs,
BucketBilling const &  rhs 
)
inline

Definition at line 72 of file bucket_metadata.h.

◆ operator<=() [2/17]

bool google::cloud::storage::v1::operator<= ( BucketEncryption const &  lhs,
BucketEncryption const &  rhs 
)
inline

Definition at line 360 of file bucket_metadata.h.

◆ operator<=() [3/17]

bool google::cloud::storage::v1::operator<= ( BucketIamConfiguration const &  lhs,
BucketIamConfiguration const &  rhs 
)
inline

Definition at line 235 of file bucket_metadata.h.

◆ operator<=() [4/17]

bool google::cloud::storage::v1::operator<= ( BucketLifecycle const &  lhs,
BucketLifecycle const &  rhs 
)
inline

Definition at line 276 of file bucket_metadata.h.

◆ operator<=() [5/17]

bool google::cloud::storage::v1::operator<= ( BucketLogging const &  lhs,
BucketLogging const &  rhs 
)
inline

Definition at line 314 of file bucket_metadata.h.

◆ operator<=() [6/17]

bool google::cloud::storage::v1::operator<= ( BucketRetentionPolicy const &  lhs,
BucketRetentionPolicy const &  rhs 
)
inline

Definition at line 410 of file bucket_metadata.h.

◆ operator<=() [7/17]

bool google::cloud::storage::v1::operator<= ( BucketVersioning const &  lhs,
BucketVersioning const &  rhs 
)
inline

Definition at line 455 of file bucket_metadata.h.

◆ operator<=() [8/17]

bool google::cloud::storage::v1::operator<= ( BucketWebsite const &  lhs,
BucketWebsite const &  rhs 
)
inline

Definition at line 494 of file bucket_metadata.h.

◆ operator<=() [9/17]

bool google::cloud::storage::v1::operator<= ( CorsEntry const &  lhs,
CorsEntry const &  rhs 
)
inline

Definition at line 128 of file bucket_metadata.h.

◆ operator<=() [10/17]

bool google::cloud::storage::v1::operator<= ( CustomerEncryption const &  lhs,
CustomerEncryption const &  rhs 
)
inline

Definition at line 78 of file object_metadata.h.

◆ operator<=() [11/17]

bool google::cloud::storage::v1::operator<= ( LifecycleRule const &  lhs,
LifecycleRule const &  rhs 
)
inline

Definition at line 349 of file lifecycle_rule.h.

◆ operator<=() [12/17]

bool google::cloud::storage::v1::operator<= ( LifecycleRuleAction const &  lhs,
LifecycleRuleAction const &  rhs 
)
inline

Definition at line 67 of file lifecycle_rule.h.

◆ operator<=() [13/17]

bool google::cloud::storage::v1::operator<= ( LifecycleRuleCondition const &  lhs,
LifecycleRuleCondition const &  rhs 
)
inline

Definition at line 126 of file lifecycle_rule.h.

◆ operator<=() [14/17]

bool google::cloud::storage::v1::operator<= ( NotificationMetadata const &  lhs,
NotificationMetadata const &  rhs 
)
inline

Definition at line 191 of file notification_metadata.h.

◆ operator<=() [15/17]

bool google::cloud::storage::v1::operator<= ( PolicyDocumentCondition const &  lhs,
PolicyDocumentCondition const &  rhs 
)
inline

Definition at line 108 of file policy_document.h.

◆ operator<=() [16/17]

bool google::cloud::storage::v1::operator<= ( ServiceAccount const &  lhs,
ServiceAccount const &  rhs 
)
inline

Definition at line 65 of file service_account.h.

◆ operator<=() [17/17]

bool google::cloud::storage::v1::operator<= ( UniformBucketLevelAccess const &  lhs,
UniformBucketLevelAccess const &  rhs 
)
inline

Definition at line 181 of file bucket_metadata.h.

◆ operator==() [1/22]

bool google::cloud::storage::v1::operator== ( BucketAccessControl const &  lhs,
BucketAccessControl const &  rhs 
)

Definition at line 22 of file bucket_access_control.cc.

◆ operator==() [2/22]

bool google::cloud::storage::v1::operator== ( BucketBilling const &  lhs,
BucketBilling const &  rhs 
)
inline

Definition at line 56 of file bucket_metadata.h.

◆ operator==() [3/22]

bool google::cloud::storage::v1::operator== ( BucketEncryption const &  lhs,
BucketEncryption const &  rhs 
)
inline

Definition at line 340 of file bucket_metadata.h.

◆ operator==() [4/22]

bool google::cloud::storage::v1::operator== ( BucketIamConfiguration const &  lhs,
BucketIamConfiguration const &  rhs 
)
inline

Definition at line 215 of file bucket_metadata.h.

◆ operator==() [5/22]

bool google::cloud::storage::v1::operator== ( BucketLifecycle const &  lhs,
BucketLifecycle const &  rhs 
)
inline

Definition at line 260 of file bucket_metadata.h.

◆ operator==() [6/22]

bool google::cloud::storage::v1::operator== ( BucketLogging const &  lhs,
BucketLogging const &  rhs 
)
inline

Definition at line 296 of file bucket_metadata.h.

◆ operator==() [7/22]

bool google::cloud::storage::v1::operator== ( BucketMetadata const &  lhs,
BucketMetadata const &  rhs 
)

Definition at line 74 of file bucket_metadata.cc.

◆ operator==() [8/22]

bool google::cloud::storage::v1::operator== ( BucketRetentionPolicy const &  lhs,
BucketRetentionPolicy const &  rhs 
)
inline

Definition at line 388 of file bucket_metadata.h.

◆ operator==() [9/22]

bool google::cloud::storage::v1::operator== ( BucketVersioning const &  lhs,
BucketVersioning const &  rhs 
)
inline

Definition at line 435 of file bucket_metadata.h.

◆ operator==() [10/22]

bool google::cloud::storage::v1::operator== ( BucketWebsite const &  lhs,
BucketWebsite const &  rhs 
)
inline

Definition at line 476 of file bucket_metadata.h.

◆ operator==() [11/22]

bool google::cloud::storage::v1::operator== ( CorsEntry const &  lhs,
CorsEntry const &  rhs 
)
inline

Definition at line 106 of file bucket_metadata.h.

◆ operator==() [12/22]

bool google::cloud::storage::v1::operator== ( CustomerEncryption const &  lhs,
CustomerEncryption const &  rhs 
)
inline

Definition at line 56 of file object_metadata.h.

◆ operator==() [13/22]

bool google::cloud::storage::v1::operator== ( HmacKeyMetadata const &  lhs,
HmacKeyMetadata const &  rhs 
)
inline

Definition at line 96 of file hmac_key_metadata.h.

◆ operator==() [14/22]

bool google::cloud::storage::v1::operator== ( LifecycleRule const &  lhs,
LifecycleRule const &  rhs 
)
inline

Definition at line 331 of file lifecycle_rule.h.

◆ operator==() [15/22]

bool google::cloud::storage::v1::operator== ( LifecycleRuleAction const &  lhs,
LifecycleRuleAction const &  rhs 
)
inline

Definition at line 45 of file lifecycle_rule.h.

◆ operator==() [16/22]

bool google::cloud::storage::v1::operator== ( LifecycleRuleCondition const &  lhs,
LifecycleRuleCondition const &  rhs 
)
inline

Definition at line 92 of file lifecycle_rule.h.

◆ operator==() [17/22]

bool google::cloud::storage::v1::operator== ( NotificationMetadata const &  lhs,
NotificationMetadata const &  rhs 
)
inline

Definition at line 161 of file notification_metadata.h.

◆ operator==() [18/22]

bool google::cloud::storage::v1::operator== ( ObjectAccessControl const &  lhs,
ObjectAccessControl const &  rhs 
)

Definition at line 23 of file object_access_control.cc.

◆ operator==() [19/22]

bool google::cloud::storage::v1::operator== ( ObjectMetadata const &  lhs,
ObjectMetadata const &  rhs 
)

Definition at line 29 of file object_metadata.cc.

◆ operator==() [20/22]

bool google::cloud::storage::v1::operator== ( PolicyDocumentCondition const &  lhs,
PolicyDocumentCondition const &  rhs 
)
inline

Definition at line 88 of file policy_document.h.

◆ operator==() [21/22]

bool google::cloud::storage::v1::operator== ( ServiceAccount const &  lhs,
ServiceAccount const &  rhs 
)
inline

Definition at line 47 of file service_account.h.

◆ operator==() [22/22]

bool google::cloud::storage::v1::operator== ( UniformBucketLevelAccess const &  lhs,
UniformBucketLevelAccess const &  rhs 
)
inline

Definition at line 159 of file bucket_metadata.h.

◆ operator>() [1/17]

bool google::cloud::storage::v1::operator> ( BucketBilling const &  lhs,
BucketBilling const &  rhs 
)
inline

Definition at line 68 of file bucket_metadata.h.

◆ operator>() [2/17]

bool google::cloud::storage::v1::operator> ( BucketEncryption const &  lhs,
BucketEncryption const &  rhs 
)
inline

Definition at line 355 of file bucket_metadata.h.

◆ operator>() [3/17]

bool google::cloud::storage::v1::operator> ( BucketIamConfiguration const &  lhs,
BucketIamConfiguration const &  rhs 
)
inline

Definition at line 230 of file bucket_metadata.h.

◆ operator>() [4/17]

bool google::cloud::storage::v1::operator> ( BucketLifecycle const &  lhs,
BucketLifecycle const &  rhs 
)
inline

Definition at line 272 of file bucket_metadata.h.

◆ operator>() [5/17]

bool google::cloud::storage::v1::operator> ( BucketLogging const &  lhs,
BucketLogging const &  rhs 
)
inline

Definition at line 310 of file bucket_metadata.h.

◆ operator>() [6/17]

bool google::cloud::storage::v1::operator> ( BucketRetentionPolicy const &  lhs,
BucketRetentionPolicy const &  rhs 
)
inline

Definition at line 405 of file bucket_metadata.h.

◆ operator>() [7/17]

bool google::cloud::storage::v1::operator> ( BucketVersioning const &  lhs,
BucketVersioning const &  rhs 
)
inline

Definition at line 450 of file bucket_metadata.h.

◆ operator>() [8/17]

bool google::cloud::storage::v1::operator> ( BucketWebsite const &  lhs,
BucketWebsite const &  rhs 
)
inline

Definition at line 490 of file bucket_metadata.h.

◆ operator>() [9/17]

bool google::cloud::storage::v1::operator> ( CorsEntry const &  lhs,
CorsEntry const &  rhs 
)
inline

Definition at line 124 of file bucket_metadata.h.

◆ operator>() [10/17]

bool google::cloud::storage::v1::operator> ( CustomerEncryption const &  lhs,
CustomerEncryption const &  rhs 
)
inline

Definition at line 73 of file object_metadata.h.

◆ operator>() [11/17]

bool google::cloud::storage::v1::operator> ( LifecycleRule const &  lhs,
LifecycleRule const &  rhs 
)
inline

Definition at line 345 of file lifecycle_rule.h.

◆ operator>() [12/17]

bool google::cloud::storage::v1::operator> ( LifecycleRuleAction const &  lhs,
LifecycleRuleAction const &  rhs 
)
inline

Definition at line 62 of file lifecycle_rule.h.

◆ operator>() [13/17]

bool google::cloud::storage::v1::operator> ( LifecycleRuleCondition const &  lhs,
LifecycleRuleCondition const &  rhs 
)
inline

Definition at line 121 of file lifecycle_rule.h.

◆ operator>() [14/17]

bool google::cloud::storage::v1::operator> ( NotificationMetadata const &  lhs,
NotificationMetadata const &  rhs 
)
inline

Definition at line 186 of file notification_metadata.h.

◆ operator>() [15/17]

bool google::cloud::storage::v1::operator> ( PolicyDocumentCondition const &  lhs,
PolicyDocumentCondition const &  rhs 
)
inline

Definition at line 103 of file policy_document.h.

◆ operator>() [16/17]

bool google::cloud::storage::v1::operator> ( ServiceAccount const &  lhs,
ServiceAccount const &  rhs 
)
inline

Definition at line 61 of file service_account.h.

◆ operator>() [17/17]

bool google::cloud::storage::v1::operator> ( UniformBucketLevelAccess const &  lhs,
UniformBucketLevelAccess const &  rhs 
)
inline

Definition at line 176 of file bucket_metadata.h.

◆ operator>=() [1/17]

bool google::cloud::storage::v1::operator>= ( BucketBilling const &  lhs,
BucketBilling const &  rhs 
)
inline

Definition at line 76 of file bucket_metadata.h.

◆ operator>=() [2/17]

bool google::cloud::storage::v1::operator>= ( BucketEncryption const &  lhs,
BucketEncryption const &  rhs 
)
inline

Definition at line 365 of file bucket_metadata.h.

◆ operator>=() [3/17]

bool google::cloud::storage::v1::operator>= ( BucketIamConfiguration const &  lhs,
BucketIamConfiguration const &  rhs 
)
inline

Definition at line 240 of file bucket_metadata.h.

◆ operator>=() [4/17]

bool google::cloud::storage::v1::operator>= ( BucketLifecycle const &  lhs,
BucketLifecycle const &  rhs 
)
inline

Definition at line 280 of file bucket_metadata.h.

◆ operator>=() [5/17]

bool google::cloud::storage::v1::operator>= ( BucketLogging const &  lhs,
BucketLogging const &  rhs 
)
inline

Definition at line 318 of file bucket_metadata.h.

◆ operator>=() [6/17]

bool google::cloud::storage::v1::operator>= ( BucketRetentionPolicy const &  lhs,
BucketRetentionPolicy const &  rhs 
)
inline

Definition at line 415 of file bucket_metadata.h.

◆ operator>=() [7/17]

bool google::cloud::storage::v1::operator>= ( BucketVersioning const &  lhs,
BucketVersioning const &  rhs 
)
inline

Definition at line 460 of file bucket_metadata.h.

◆ operator>=() [8/17]

bool google::cloud::storage::v1::operator>= ( BucketWebsite const &  lhs,
BucketWebsite const &  rhs 
)
inline

Definition at line 498 of file bucket_metadata.h.

◆ operator>=() [9/17]

bool google::cloud::storage::v1::operator>= ( CorsEntry const &  lhs,
CorsEntry const &  rhs 
)
inline

Definition at line 132 of file bucket_metadata.h.

◆ operator>=() [10/17]

bool google::cloud::storage::v1::operator>= ( CustomerEncryption const &  lhs,
CustomerEncryption const &  rhs 
)
inline

Definition at line 83 of file object_metadata.h.

◆ operator>=() [11/17]

bool google::cloud::storage::v1::operator>= ( LifecycleRule const &  lhs,
LifecycleRule const &  rhs 
)
inline

Definition at line 353 of file lifecycle_rule.h.

◆ operator>=() [12/17]

bool google::cloud::storage::v1::operator>= ( LifecycleRuleAction const &  lhs,
LifecycleRuleAction const &  rhs 
)
inline

Definition at line 72 of file lifecycle_rule.h.

◆ operator>=() [13/17]

bool google::cloud::storage::v1::operator>= ( LifecycleRuleCondition const &  lhs,
LifecycleRuleCondition const &  rhs 
)
inline

Definition at line 131 of file lifecycle_rule.h.

◆ operator>=() [14/17]

bool google::cloud::storage::v1::operator>= ( NotificationMetadata const &  lhs,
NotificationMetadata const &  rhs 
)
inline

Definition at line 196 of file notification_metadata.h.

◆ operator>=() [15/17]

bool google::cloud::storage::v1::operator>= ( PolicyDocumentCondition const &  lhs,
PolicyDocumentCondition const &  rhs 
)
inline

Definition at line 113 of file policy_document.h.

◆ operator>=() [16/17]

bool google::cloud::storage::v1::operator>= ( ServiceAccount const &  lhs,
ServiceAccount const &  rhs 
)
inline

Definition at line 69 of file service_account.h.

◆ operator>=() [17/17]

bool google::cloud::storage::v1::operator>= ( UniformBucketLevelAccess const &  lhs,
UniformBucketLevelAccess const &  rhs 
)
inline

Definition at line 186 of file bucket_metadata.h.

◆ ParallelUploadFile()

template<typename... Options>
StatusOr<ObjectMetadata> google::cloud::storage::v1::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.

You can affect how many shards will be created by using the MaxStreams and MinStreamSize options.

Parameters
clientthe client on which to perform the operation.
file_namethe path to the file to be uploaded
bucket_namethe name of the bucket that will contain the object.
object_namethe uploaded object name.
prefixthe prefix with which temporary objects will be created.
ignore_cleanup_failurestreat failures to cleanup the temporary objects as not fatal.
optionsa list of optional query parameters and/or request headers. Valid types for this operation include DestinationPredefinedAcl, EncryptionKey, IfGenerationMatch, IfMetagenerationMatch, KmsKeyName, MaxStreams,MinStreamSize,QuotaUser,UserIp, UserProject,WithObjectMetadata,UseResumableUploadSession`.
Returns
the metadata of the object created by the upload.
Idempotency
This operation is not idempotent. While each request performed by this function is retried based on the client policies, the operation itself stops on the first request that fails.
Example
using ::google::cloud::StatusOr;
[](gcs::Client client, std::string const& file_name,
std::string const& bucket_name, std::string const& object_name) {
// Pick a unique random prefix for the temporary objects created by the
// parallel upload.
auto prefix = gcs::CreateRandomPrefixName("");
auto metadata = gcs::ParallelUploadFile(
std::move(client), file_name, bucket_name, object_name, prefix, false);
if (!metadata) throw std::runtime_error(metadata.status().message());
std::cout << "Uploaded " << file_name << " to object " << metadata->name()
<< " in bucket " << metadata->bucket()
<< "\nFull metadata: " << *metadata << "\n";
}

Definition at line 1166 of file parallel_upload.h.

◆ RestoreResumableUploadSession()

UseResumableUploadSession google::cloud::storage::v1::RestoreResumableUploadSession ( std::string  session_id)
inline

Create a UseResumableUploadSession option that restores previous sessions.

Definition at line 48 of file upload_options.h.

◆ version()

constexpr int google::cloud::storage::v1::version ( )
constexpr

Returns a single integer representing the Major/Minor/Patch version.

Definition at line 75 of file version.h.

◆ version_major()

constexpr int google::cloud::storage::v1::version_major ( )
constexpr

Returns the Google Cloud Storage C++ Client major version.

See also
https://semver.org/spec/v2.0.0.html for details.

Definition at line 58 of file version.h.

◆ version_minor()

constexpr int google::cloud::storage::v1::version_minor ( )
constexpr

Returns the Google Cloud Storage C++ Client minor version.

See also
https://semver.org/spec/v2.0.0.html for details.

Definition at line 65 of file version.h.

◆ version_patch()

constexpr int google::cloud::storage::v1::version_patch ( )
constexpr

Returns the Google Cloud Storage C++ Client patch version.

See also
https://semver.org/spec/v2.0.0.html for details.

Definition at line 72 of file version.h.

◆ version_string()

std::string google::cloud::storage::v1::version_string ( )

Returns the version as a string, in MAJOR.MINOR.PATCH+gitrev format.

Definition at line 23 of file version.cc.

◆ WithAcl()

SubResourceOption google::cloud::storage::v1::WithAcl ( )
inline

Definition at line 121 of file signed_url_options.h.

◆ WithBilling()

SubResourceOption google::cloud::storage::v1::WithBilling ( )
inline

Definition at line 123 of file signed_url_options.h.

◆ WithCompose()

SubResourceOption google::cloud::storage::v1::WithCompose ( )
inline

Definition at line 125 of file signed_url_options.h.

◆ WithCors()

SubResourceOption google::cloud::storage::v1::WithCors ( )
inline

Definition at line 127 of file signed_url_options.h.

◆ WithEncryption()

SubResourceOption google::cloud::storage::v1::WithEncryption ( )
inline

Definition at line 129 of file signed_url_options.h.

◆ WithEncryptionConfig()

SubResourceOption google::cloud::storage::v1::WithEncryptionConfig ( )
inline

Definition at line 133 of file signed_url_options.h.

◆ WithGeneration()

AddQueryParameterOption google::cloud::storage::v1::WithGeneration ( std::uint64_t  generation)
inline

Definition at line 81 of file signed_url_options.h.

◆ WithGenerationMarker()

AddQueryParameterOption google::cloud::storage::v1::WithGenerationMarker ( std::uint64_t  generation)
inline

Definition at line 85 of file signed_url_options.h.

◆ WithLifecycle()

SubResourceOption google::cloud::storage::v1::WithLifecycle ( )
inline

Definition at line 137 of file signed_url_options.h.

◆ WithLocation()

SubResourceOption google::cloud::storage::v1::WithLocation ( )
inline

Definition at line 141 of file signed_url_options.h.

◆ WithLogging()

SubResourceOption google::cloud::storage::v1::WithLogging ( )
inline

Definition at line 145 of file signed_url_options.h.

◆ WithMarker()

AddQueryParameterOption google::cloud::storage::v1::WithMarker ( std::string  marker)
inline

Definition at line 94 of file signed_url_options.h.

◆ WithResponseContentDisposition()

AddQueryParameterOption google::cloud::storage::v1::WithResponseContentDisposition ( std::string  disposition)
inline

Definition at line 98 of file signed_url_options.h.

◆ WithResponseContentType()

AddQueryParameterOption google::cloud::storage::v1::WithResponseContentType ( std::string const &  type)
inline

Definition at line 104 of file signed_url_options.h.

◆ WithStorageClass()

SubResourceOption google::cloud::storage::v1::WithStorageClass ( )
inline

Definition at line 147 of file signed_url_options.h.

◆ WithTagging()

SubResourceOption google::cloud::storage::v1::WithTagging ( )
inline

Definition at line 151 of file signed_url_options.h.

◆ WithUserProject()

AddQueryParameterOption google::cloud::storage::v1::WithUserProject ( std::string  user_project)
inline

Definition at line 90 of file signed_url_options.h.

◆ x_goog_api_client()

std::string google::cloud::storage::v1::x_goog_api_client ( )

Returns the value for x-goog-api-client header.

Definition at line 25 of file version.cc.

Variable Documentation

◆ kExpectedCharDigits

constexpr auto google::cloud::storage::v1::kExpectedCharDigits = 8
constexpr

Definition at line 31 of file version.cc.

google::cloud::storage::v1::Client
The Google Cloud Storage (GCS) Client.
Definition: client.h:208
google::cloud::storage::v1::CreateRandomPrefixName
std::string CreateRandomPrefixName(std::string const &prefix)
Create a random prefix for object names.
Definition: client.cc:449
google::cloud::storage::v1::EncryptionKeyData
A simple wrapper for the encryption key attributes.
Definition: well_known_headers.h:138
google::cloud::storage::v1::ParallelUploadFile
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.
Definition: parallel_upload.h:1166
google::cloud::storage
Contains all the Google Cloud Storage C++ client APIs.
Definition: bucket_access_control.cc:20
google::cloud::storage::v1::ComposeMany
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.
Definition: client.h:3478
google::cloud::storage::v1::EncryptionKeyData::key
std::string key
Definition: well_known_headers.h:140
google::cloud::storage::v1::EncryptionKeyData::sha256
std::string sha256
Definition: well_known_headers.h:141
google::cloud::storage::v1::CreateKeyFromGenerator
EncryptionKeyData CreateKeyFromGenerator(Generator &gen)
Creates an encryption key parameter from a pseudo-random number generator.
Definition: well_known_headers.h:269