| Package | Description |
|---|---|
| com.google.cloud.storage |
A client for Cloud Storage - Unified object storage.
|
| Modifier and Type | Class and Description |
|---|---|
class |
Blob
An object in Google Cloud Storage.
|
class |
BlobInfo
Information about an object in Google Cloud Storage.
|
class |
Bucket
A Google cloud storage bucket.
|
static class |
Bucket.BucketSourceOption
Class for specifying bucket source options when
Bucket methods are used. |
class |
BucketInfo
Google Storage bucket metadata;
|
class |
GrpcStorageOptions |
class |
HttpStorageOptions |
static class |
Storage.ComposeRequest
A class to contain all information needed for a Google Cloud Storage Compose operation.
|
static class |
Storage.ComposeRequest.SourceBlob
Class for Compose source blobs.
|
static class |
Storage.CopyRequest
A class to contain all information needed for a Google Cloud Storage Copy operation.
|
static class |
Storage.PredefinedAcl |
| Modifier and Type | Method and Description |
|---|---|
StorageBatch |
Storage.batch()
Creates a new empty batch for grouping multiple service calls in one underlying RPC call.
|
Blob |
Storage.compose(Storage.ComposeRequest composeRequest)
Sends a compose request.
|
CopyWriter |
Storage.copy(Storage.CopyRequest copyRequest)
Sends a copy request.
|
CopyWriter |
Blob.copyTo(BlobId targetBlob,
Blob.BlobSourceOption... options)
Sends a copy request for the current blob to the target blob.
|
CopyWriter |
Blob.copyTo(String targetBucket,
Blob.BlobSourceOption... options)
Sends a copy request for the current blob to the target bucket, preserving its name.
|
CopyWriter |
Blob.copyTo(String targetBucket,
String targetBlob,
Blob.BlobSourceOption... options)
Sends a copy request for the current blob to the target blob.
|
static Storage.BlobWriteOption |
Storage.BlobWriteOption.crc32cMatch()
Returns an option for blob's data CRC32C checksum match.
|
static Bucket.BlobWriteOption |
Bucket.BlobWriteOption.crc32cMatch(@NonNull String crc32c)
Returns an option for blob's data CRC32C checksum match.
|
Blob |
Storage.create(BlobInfo blobInfo,
byte[] content,
int offset,
int length,
Storage.BlobTargetOption... options)
Creates a new blob with the sub array of the given byte array.
|
Blob |
Storage.create(BlobInfo blobInfo,
byte[] content,
Storage.BlobTargetOption... options)
Creates a new blob.
|
Blob |
Storage.create(BlobInfo blobInfo,
InputStream content,
Storage.BlobWriteOption... options)
Deprecated.
|
Blob |
Storage.create(BlobInfo blobInfo,
Storage.BlobTargetOption... options)
Creates a new blob with no content.
|
Bucket |
Storage.create(BucketInfo bucketInfo,
Storage.BucketTargetOption... options)
Creates a new bucket.
|
Blob |
Bucket.create(String blob,
byte[] content,
Bucket.BlobTargetOption... options)
Creates a new blob in this bucket.
|
Blob |
Bucket.create(String blob,
byte[] content,
String contentType,
Bucket.BlobTargetOption... options)
Creates a new blob in this bucket.
|
Blob |
Bucket.create(String blob,
InputStream content,
Bucket.BlobWriteOption... options)
Creates a new blob in this bucket.
|
Blob |
Bucket.create(String blob,
InputStream content,
String contentType,
Bucket.BlobWriteOption... options)
Creates a new blob in this bucket.
|
Acl |
Blob.createAcl(Acl acl)
Creates a new ACL entry on this blob.
|
Acl |
Bucket.createAcl(Acl acl)
Creates a new ACL entry on this bucket.
|
Acl |
Storage.createAcl(BlobId blob,
Acl acl)
Creates a new ACL entry on the specified blob.
|
Acl |
Storage.createAcl(String bucket,
Acl acl) |
Acl |
Storage.createAcl(String bucket,
Acl acl,
Storage.BucketSourceOption... options)
Creates a new ACL entry on the specified bucket.
|
Acl |
Bucket.createDefaultAcl(Acl acl)
Creates a new default blob ACL entry on this bucket.
|
Acl |
Storage.createDefaultAcl(String bucket,
Acl acl)
Creates a new default blob ACL entry on the specified bucket.
|
Blob |
Storage.createFrom(BlobInfo blobInfo,
InputStream content,
int bufferSize,
Storage.BlobWriteOption... options)
Reads bytes from an input stream and uploads those bytes to the blob using
Storage.writer(com.google.cloud.storage.BlobInfo, com.google.cloud.storage.Storage.BlobWriteOption...) and
bufferSize. |
Blob |
Storage.createFrom(BlobInfo blobInfo,
InputStream content,
Storage.BlobWriteOption... options)
Reads bytes from an input stream and uploads those bytes to the blob using
Storage.writer(com.google.cloud.storage.BlobInfo, com.google.cloud.storage.Storage.BlobWriteOption...). |
Blob |
Storage.createFrom(BlobInfo blobInfo,
Path path,
int bufferSize,
Storage.BlobWriteOption... options)
Uploads
path to the blob using Storage.writer(com.google.cloud.storage.BlobInfo, com.google.cloud.storage.Storage.BlobWriteOption...) and bufferSize. |
Blob |
Storage.createFrom(BlobInfo blobInfo,
Path path,
Storage.BlobWriteOption... options)
Uploads
path to the blob using Storage.writer(com.google.cloud.storage.BlobInfo, com.google.cloud.storage.Storage.BlobWriteOption...). |
HmacKey |
Storage.createHmacKey(ServiceAccount serviceAccount,
Storage.CreateHmacKeyOption... options)
Creates a new HMAC Key for the provided service account, including the secret key.
|
Notification |
Storage.createNotification(String bucket,
NotificationInfo notificationInfo)
Creates the notification for a given bucket.
|
static Storage.BlobListOption |
Storage.BlobListOption.currentDirectory()
If specified, results are returned in a directory-like mode.
|
static Blob.BlobSourceOption |
Blob.BlobSourceOption.decryptionKey(@NonNull Key key)
Returns an option to set a customer-supplied AES256 key for server-side encryption of the
blob.
|
static Storage.BlobSourceOption |
Storage.BlobSourceOption.decryptionKey(@NonNull Key key)
Returns an option to set a customer-supplied AES256 key for server-side encryption of the
blob.
|
static Storage.BlobGetOption |
Storage.BlobGetOption.decryptionKey(@NonNull Key key)
Returns an option to set a customer-supplied AES256 key for server-side decryption of the
blob.
|
static Blob.BlobSourceOption |
Blob.BlobSourceOption.decryptionKey(@NonNull String key)
Returns an option to set a customer-supplied AES256 key for server-side encryption of the
blob.
|
static Storage.BlobSourceOption |
Storage.BlobSourceOption.decryptionKey(@NonNull String key)
Returns an option to set a customer-supplied AES256 key for server-side encryption of the
blob.
|
static Storage.BlobGetOption |
Storage.BlobGetOption.decryptionKey(@NonNull String key)
Returns an option to set a customer-supplied AES256 key for server-side decryption of the
blob.
|
boolean |
Blob.delete(Blob.BlobSourceOption... options)
Deletes this blob.
|
List<Boolean> |
Storage.delete(BlobId... blobIds)
Deletes the requested blobs.
|
boolean |
Storage.delete(BlobId blob)
Deletes the requested blob.
|
boolean |
Storage.delete(BlobId blob,
Storage.BlobSourceOption... options)
Deletes the requested blob.
|
boolean |
Bucket.delete(Bucket.BucketSourceOption... options)
Deletes this bucket.
|
List<Boolean> |
Storage.delete(Iterable<BlobId> blobIds)
Deletes the requested blobs.
|
boolean |
Storage.delete(String bucket,
Storage.BucketSourceOption... options)
Deletes the requested bucket.
|
boolean |
Storage.delete(String bucket,
String blob,
Storage.BlobSourceOption... options)
Deletes the requested blob.
|
boolean |
Blob.deleteAcl(Acl.Entity entity)
Deletes the ACL entry for the specified entity on this blob.
|
boolean |
Bucket.deleteAcl(Acl.Entity entity)
Deletes the ACL entry for the specified entity on this bucket.
|
boolean |
Storage.deleteAcl(BlobId blob,
Acl.Entity entity)
Deletes the ACL entry for the specified entity on the specified blob.
|
boolean |
Storage.deleteAcl(String bucket,
Acl.Entity entity) |
boolean |
Storage.deleteAcl(String bucket,
Acl.Entity entity,
Storage.BucketSourceOption... options)
Deletes the ACL entry for the specified entity on the specified bucket.
|
boolean |
Bucket.deleteDefaultAcl(Acl.Entity entity)
Deletes the default object ACL entry for the specified entity on this bucket.
|
boolean |
Storage.deleteDefaultAcl(String bucket,
Acl.Entity entity)
Deletes the default object ACL entry for the specified entity on the specified bucket.
|
void |
Storage.deleteHmacKey(HmacKey.HmacKeyMetadata hmacKeyMetadata,
Storage.DeleteHmacKeyOption... options)
Deletes an HMAC key.
|
boolean |
Storage.deleteNotification(String bucket,
String notificationId)
Deletes the notification with the specified id.
|
static Storage.BlobListOption |
Storage.BlobListOption.delimiter(@NonNull String delimiter)
Returns an option to set a delimiter.
|
static Storage.BlobTargetOption |
Storage.BlobTargetOption.detectContentType()
Returns an option for detecting content type.
|
static Storage.BlobWriteOption |
Storage.BlobWriteOption.detectContentType()
Returns an option for detecting content type.
|
static Storage.BlobTargetOption |
Storage.BlobTargetOption.disableGzipContent()
Returns an option for blob's data disabledGzipContent.
|
static Storage.BlobWriteOption |
Storage.BlobWriteOption.disableGzipContent()
Returns an option that signals automatic gzip compression should not be performed en route to
the bucket.
|
static Storage.BlobTargetOption |
Storage.BlobTargetOption.doesNotExist()
Returns an option that causes an operation to succeed only if the target blob does not exist.
|
static Storage.BlobWriteOption |
Storage.BlobWriteOption.doesNotExist()
Returns an option that causes an operation to succeed only if the target blob does not exist.
|
static Bucket.BlobTargetOption |
Bucket.BlobTargetOption.doesNotExist()
Returns an option that causes an operation to succeed only if the target blob does not exist.
|
static Bucket.BlobWriteOption |
Bucket.BlobWriteOption.doesNotExist()
Returns an option that causes an operation to succeed only if the target blob does not exist.
|
void |
Storage.downloadTo(BlobId blob,
OutputStream outputStream,
Storage.BlobSourceOption... options)
Downloads the given blob to the given output stream using specified blob read options.
|
void |
Storage.downloadTo(BlobId blob,
Path path,
Storage.BlobSourceOption... options)
Downloads the given blob to the given path using specified blob read options.
|
void |
Blob.downloadTo(OutputStream outputStream,
Blob.BlobSourceOption... options)
Downloads this blob to the given output stream using specified blob read options.
|
void |
Blob.downloadTo(Path path)
Downloads this blob to the given file path.
|
void |
Blob.downloadTo(Path path,
Blob.BlobSourceOption... options)
Downloads this blob to the given file path using specified blob read options.
|
static Storage.BlobTargetOption |
Storage.BlobTargetOption.encryptionKey(@NonNull Key key)
Returns an option to set a customer-supplied AES256 key for server-side encryption of the
blob.
|
static Storage.BlobWriteOption |
Storage.BlobWriteOption.encryptionKey(@NonNull Key key)
Returns an option to set a customer-supplied AES256 key for server-side encryption of the
blob.
|
static Bucket.BlobTargetOption |
Bucket.BlobTargetOption.encryptionKey(@NonNull Key key)
Returns an option to set a customer-supplied AES256 key for server-side encryption of the
blob.
|
static Bucket.BlobWriteOption |
Bucket.BlobWriteOption.encryptionKey(@NonNull Key key)
Returns an option to set a customer-supplied AES256 key for server-side encryption of the
blob.
|
static Storage.BlobTargetOption |
Storage.BlobTargetOption.encryptionKey(@NonNull String key)
Returns an option to set a customer-supplied AES256 key for server-side encryption of the
blob.
|
static Storage.BlobWriteOption |
Storage.BlobWriteOption.encryptionKey(@NonNull String key)
Returns an option to set a customer-supplied AES256 key for server-side encryption of the
blob.
|
static Bucket.BlobTargetOption |
Bucket.BlobTargetOption.encryptionKey(@NonNull String key)
Returns an option to set a customer-supplied AES256 key for server-side encryption of the
blob.
|
static Bucket.BlobWriteOption |
Bucket.BlobWriteOption.encryptionKey(@NonNull String key)
Returns an option to set a customer-supplied AES256 key for server-side encryption of the
blob.
|
static Storage.BlobListOption |
Storage.BlobListOption.endOffset(@NonNull String endOffset)
Returns an option to set a endOffset to filter results to objects whose names are
lexicographically before endOffset.
|
boolean |
Blob.exists(Blob.BlobSourceOption... options)
Checks if this blob exists.
|
boolean |
Bucket.exists(Bucket.BucketSourceOption... options)
Checks if this bucket exists.
|
static Storage.BlobGetOption |
Storage.BlobGetOption.fields(Storage.BlobField... fields)
Returns an option to specify the blob's fields to be returned by the RPC call.
|
static Storage.BlobListOption |
Storage.BlobListOption.fields(Storage.BlobField... fields)
Returns an option to specify the blob's fields to be returned by the RPC call.
|
static Storage.BucketGetOption |
Storage.BucketGetOption.fields(Storage.BucketField... fields)
Returns an option to specify the bucket's fields to be returned by the RPC call.
|
static Storage.BucketListOption |
Storage.BucketListOption.fields(Storage.BucketField... fields)
Returns an option to specify the bucket's fields to be returned by the RPC call.
|
PostPolicyV4 |
Storage.generateSignedPostPolicyV4(BlobInfo blobInfo,
long duration,
TimeUnit unit,
PostPolicyV4.PostConditionsV4 conditions,
Storage.PostPolicyV4Option... options)
Generates a presigned post policy without any fields.
|
PostPolicyV4 |
Storage.generateSignedPostPolicyV4(BlobInfo blobInfo,
long duration,
TimeUnit unit,
PostPolicyV4.PostFieldsV4 fields,
PostPolicyV4.PostConditionsV4 conditions,
Storage.PostPolicyV4Option... options)
Generates a URL and a map of fields that can be specified in an HTML form to submit a POST
request.
|
PostPolicyV4 |
Storage.generateSignedPostPolicyV4(BlobInfo blobInfo,
long duration,
TimeUnit unit,
PostPolicyV4.PostFieldsV4 fields,
Storage.PostPolicyV4Option... options)
Generates a presigned post policy without any conditions.
|
PostPolicyV4 |
Storage.generateSignedPostPolicyV4(BlobInfo blobInfo,
long duration,
TimeUnit unit,
Storage.PostPolicyV4Option... options)
Generates a presigned post policy without any fields or conditions.
|
static Blob.BlobSourceOption |
Blob.BlobSourceOption.generationMatch()
Returns an option for blob's generation match.
|
static Storage.BlobTargetOption |
Storage.BlobTargetOption.generationMatch()
Returns an option for blob's data generation match.
|
static Storage.BlobWriteOption |
Storage.BlobWriteOption.generationMatch()
Returns an option for blob's data generation match.
|
static Storage.BlobSourceOption |
Storage.BlobSourceOption.generationMatch()
Returns an option for blob's data generation match.
|
static Storage.BlobGetOption |
Storage.BlobGetOption.generationMatch()
Returns an option for blob's data generation match.
|
static Storage.BlobTargetOption |
Storage.BlobTargetOption.generationMatch(long generation)
Returns an option for blob's data generation match.
|
static Storage.BlobWriteOption |
Storage.BlobWriteOption.generationMatch(long generation)
Returns an option for blob's data generation match.
|
static Storage.BlobSourceOption |
Storage.BlobSourceOption.generationMatch(long generation)
Returns an option for blob's data generation match.
|
static Storage.BlobGetOption |
Storage.BlobGetOption.generationMatch(long generation)
Returns an option for blob's data generation match.
|
static Bucket.BlobTargetOption |
Bucket.BlobTargetOption.generationMatch(long generation)
Returns an option for blob's data generation match.
|
static Bucket.BlobWriteOption |
Bucket.BlobWriteOption.generationMatch(long generation)
Returns an option for blob's data generation match.
|
static Blob.BlobSourceOption |
Blob.BlobSourceOption.generationNotMatch()
Deprecated.
This option is invalid, and can never result in a valid response from the server.
|
static Storage.BlobTargetOption |
Storage.BlobTargetOption.generationNotMatch()
Returns an option for blob's data generation mismatch.
|
static Storage.BlobWriteOption |
Storage.BlobWriteOption.generationNotMatch()
Returns an option for blob's data generation mismatch.
|
static Storage.BlobSourceOption |
Storage.BlobSourceOption.generationNotMatch()
Deprecated.
This option is invalid, and can never result in a valid response from the server.
use
Storage.BlobSourceOption.generationNotMatch(long) instead. |
static Storage.BlobGetOption |
Storage.BlobGetOption.generationNotMatch()
Deprecated.
This option is invalid, and can never result in a valid response from the server.
use
Storage.BlobGetOption.generationNotMatch(long) instead. |
static Storage.BlobTargetOption |
Storage.BlobTargetOption.generationNotMatch(long generation)
Returns an option for blob's data generation mismatch.
|
static Storage.BlobWriteOption |
Storage.BlobWriteOption.generationNotMatch(long generation)
Returns an option for blob's data generation mismatch.
|
static Storage.BlobSourceOption |
Storage.BlobSourceOption.generationNotMatch(long generation)
Returns an option for blob's data generation mismatch.
|
static Storage.BlobGetOption |
Storage.BlobGetOption.generationNotMatch(long generation)
Returns an option for blob's data generation mismatch.
|
static Bucket.BlobTargetOption |
Bucket.BlobTargetOption.generationNotMatch(long generation)
Returns an option for blob's data generation mismatch.
|
static Bucket.BlobWriteOption |
Bucket.BlobWriteOption.generationNotMatch(long generation)
Returns an option for blob's data generation mismatch.
|
List<Blob> |
Storage.get(BlobId... blobIds)
Gets the requested blobs.
|
Blob |
Storage.get(BlobId blob)
Returns the requested blob or
null if not found. |
Blob |
Storage.get(BlobId blob,
Storage.BlobGetOption... options)
Returns the requested blob or
null if not found. |
List<Blob> |
Storage.get(Iterable<BlobId> blobIds)
Gets the requested blobs.
|
List<Blob> |
Bucket.get(Iterable<String> blobNames)
Returns a list of requested blobs in this bucket.
|
Blob |
Bucket.get(String blob,
Storage.BlobGetOption... options)
Returns the requested blob in this bucket or
null if not found. |
Bucket |
Storage.get(String bucket,
Storage.BucketGetOption... options)
Returns the requested bucket or
null if not found. |
Blob |
Storage.get(String bucket,
String blob,
Storage.BlobGetOption... options)
Returns the requested blob or
null if not found. |
List<Blob> |
Bucket.get(String blobName1,
String blobName2,
String... blobNames)
Returns a list of requested blobs in this bucket.
|
Acl |
Blob.getAcl(Acl.Entity entity)
Returns the ACL entry for the specified entity on this blob or
null if not found. |
Acl |
Bucket.getAcl(Acl.Entity entity)
Returns the ACL entry for the specified entity on this bucket or
null if not found. |
Acl |
Storage.getAcl(BlobId blob,
Acl.Entity entity)
Returns the ACL entry for the specified entity on the specified blob or
null if not
found. |
Acl |
Storage.getAcl(String bucket,
Acl.Entity entity) |
Acl |
Storage.getAcl(String bucket,
Acl.Entity entity,
Storage.BucketSourceOption... options)
Returns the ACL entry for the specified entity on the specified bucket or
null if not
found. |
byte[] |
Blob.getContent(Blob.BlobSourceOption... options)
Returns this blob's content.
|
Acl |
Bucket.getDefaultAcl(Acl.Entity entity)
Returns the default object ACL entry for the specified entity on this bucket or
null if
not found. |
Acl |
Storage.getDefaultAcl(String bucket,
Acl.Entity entity)
Returns the default object ACL entry for the specified entity on the specified bucket or
null if not found. |
static StorageOptions |
StorageOptions.getDefaultInstance()
Returns a default
StorageOptions instance. |
HmacKey.HmacKeyMetadata |
Storage.getHmacKey(String accessId,
Storage.GetHmacKeyOption... options)
Gets an HMAC key given its access id.
|
com.google.cloud.Policy |
Storage.getIamPolicy(String bucket,
Storage.BucketSourceOption... options)
Gets the IAM policy for the provided bucket.
|
Notification |
Storage.getNotification(String bucket,
String notificationId)
Gets the notification with the specified id.
|
ServiceAccount |
Storage.getServiceAccount(String projectId)
Returns the service account associated with the given project.
|
static StorageOptions |
StorageOptions.getUnauthenticatedInstance()
Returns a unauthenticated
StorageOptions instance. |
static GrpcStorageOptions.Builder |
StorageOptions.grpc()
Builder factory method which will create a gRPC specific instance of storage options.
|
static HttpStorageOptions.Builder |
StorageOptions.http()
Builder factory method which will create a JSON over HTTP specific instance of storage options.
|
static Storage.SignUrlOption |
Storage.SignUrlOption.httpMethod(HttpMethod httpMethod)
The HTTP method to be used with the signed URL.
|
static Storage.BlobTargetOption |
Storage.BlobTargetOption.kmsKeyName(@NonNull String kmsKeyName)
Returns an option to set a customer-managed key for server-side encryption of the blob.
|
static Storage.BlobWriteOption |
Storage.BlobWriteOption.kmsKeyName(@NonNull String kmsKeyName)
Returns an option to set a customer-managed KMS key for server-side encryption of the blob.
|
static Bucket.BlobTargetOption |
Bucket.BlobTargetOption.kmsKeyName(@NonNull String kmsKeyName)
Returns an option to set a customer-managed KMS key for server-side encryption of the blob.
|
com.google.api.gax.paging.Page<Blob> |
Bucket.list(Storage.BlobListOption... options)
Returns the paginated list of
Blob in this bucket. |
com.google.api.gax.paging.Page<Bucket> |
Storage.list(Storage.BucketListOption... options)
Lists the project's buckets.
|
com.google.api.gax.paging.Page<Blob> |
Storage.list(String bucket,
Storage.BlobListOption... options)
Lists the bucket's blobs.
|
List<Acl> |
Blob.listAcls()
Lists the ACL entries for this blob.
|
List<Acl> |
Bucket.listAcls()
Lists the ACL entries for this bucket.
|
List<Acl> |
Storage.listAcls(BlobId blob)
Lists the ACL entries for the provided blob.
|
List<Acl> |
Storage.listAcls(String bucket) |
List<Acl> |
Storage.listAcls(String bucket,
Storage.BucketSourceOption... options)
Lists the ACL entries for the provided bucket.
|
List<Acl> |
Bucket.listDefaultAcls()
Lists the default blob ACL entries for this bucket.
|
List<Acl> |
Storage.listDefaultAcls(String bucket)
Lists the default blob ACL entries for the provided bucket.
|
com.google.api.gax.paging.Page<HmacKey.HmacKeyMetadata> |
Storage.listHmacKeys(Storage.ListHmacKeysOption... options)
Lists HMAC keys for a given service account.
|
List<Notification> |
Storage.listNotifications(String bucket)
Retrieves the list of notifications associated with the bucket.
|
Bucket |
Storage.lockRetentionPolicy(BucketInfo bucket,
Storage.BucketTargetOption... options)
Locks bucket retention policy.
|
Bucket |
Bucket.lockRetentionPolicy(Storage.BucketTargetOption... options)
Locks bucket retention policy.
|
static Storage.BlobListOption |
Storage.BlobListOption.matchGlob(@NonNull String glob)
Returns an option to set a glob pattern to filter results to blobs that match the pattern.
|
static Storage.ListHmacKeysOption |
Storage.ListHmacKeysOption.maxResults(long pageSize)
Returns an option for the maximum amount of HMAC keys returned per page.
|
static Storage.BlobWriteOption |
Storage.BlobWriteOption.md5Match()
Deprecated.
Please compute and use a crc32c checksum instead.
Storage.BlobWriteOption.crc32cMatch() |
static Bucket.BlobWriteOption |
Bucket.BlobWriteOption.md5Match(@NonNull String md5)
Returns an option for blob's data MD5 hash match.
|
static Blob.BlobSourceOption |
Blob.BlobSourceOption.metagenerationMatch()
Returns an option for blob's metageneration match.
|
static Storage.BucketTargetOption |
Storage.BucketTargetOption.metagenerationMatch()
Returns an option for bucket's metageneration match.
|
static Storage.BlobTargetOption |
Storage.BlobTargetOption.metagenerationMatch()
Returns an option for blob's metageneration match.
|
static Storage.BlobWriteOption |
Storage.BlobWriteOption.metagenerationMatch()
Returns an option for blob's metageneration match.
|
static Bucket.BucketSourceOption |
Bucket.BucketSourceOption.metagenerationMatch()
Returns an option for bucket's metageneration match.
|
static Storage.BucketSourceOption |
Storage.BucketSourceOption.metagenerationMatch(long metageneration)
Returns an option for bucket's metageneration match.
|
static Storage.BucketGetOption |
Storage.BucketGetOption.metagenerationMatch(long metageneration)
Returns an option for bucket's metageneration match.
|
static Storage.BlobTargetOption |
Storage.BlobTargetOption.metagenerationMatch(long metageneration)
Returns an option for blob's metageneration match.
|
static Storage.BlobWriteOption |
Storage.BlobWriteOption.metagenerationMatch(long metageneration)
Returns an option for blob's metageneration match.
|
static Storage.BlobSourceOption |
Storage.BlobSourceOption.metagenerationMatch(long metageneration)
Returns an option for blob's metageneration match.
|
static Storage.BlobGetOption |
Storage.BlobGetOption.metagenerationMatch(long metageneration)
Returns an option for blob's metageneration match.
|
static Bucket.BlobTargetOption |
Bucket.BlobTargetOption.metagenerationMatch(long metageneration)
Returns an option for blob's metageneration match.
|
static Bucket.BlobWriteOption |
Bucket.BlobWriteOption.metagenerationMatch(long metageneration)
Returns an option for blob's metageneration match.
|
static Blob.BlobSourceOption |
Blob.BlobSourceOption.metagenerationNotMatch()
Returns an option for blob's metageneration mismatch.
|
static Storage.BucketTargetOption |
Storage.BucketTargetOption.metagenerationNotMatch()
Returns an option for bucket's metageneration mismatch.
|
static Storage.BlobTargetOption |
Storage.BlobTargetOption.metagenerationNotMatch()
Returns an option for blob's metageneration mismatch.
|
static Storage.BlobWriteOption |
Storage.BlobWriteOption.metagenerationNotMatch()
Returns an option for blob's metageneration mismatch.
|
static Bucket.BucketSourceOption |
Bucket.BucketSourceOption.metagenerationNotMatch()
Returns an option for bucket's metageneration mismatch.
|
static Storage.BucketSourceOption |
Storage.BucketSourceOption.metagenerationNotMatch(long metageneration)
Returns an option for bucket's metageneration mismatch.
|
static Storage.BucketGetOption |
Storage.BucketGetOption.metagenerationNotMatch(long metageneration)
Returns an option for bucket's metageneration mismatch.
|
static Storage.BlobTargetOption |
Storage.BlobTargetOption.metagenerationNotMatch(long metageneration)
Returns an option for blob's metageneration mismatch.
|
static Storage.BlobWriteOption |
Storage.BlobWriteOption.metagenerationNotMatch(long metageneration)
Returns an option for blob's metageneration mismatch.
|
static Storage.BlobSourceOption |
Storage.BlobSourceOption.metagenerationNotMatch(long metageneration)
Returns an option for blob's metageneration mismatch.
|
static Storage.BlobGetOption |
Storage.BlobGetOption.metagenerationNotMatch(long metageneration)
Returns an option for blob's metageneration mismatch.
|
static Bucket.BlobTargetOption |
Bucket.BlobTargetOption.metagenerationNotMatch(long metageneration)
Returns an option for blob's metageneration mismatch.
|
static Bucket.BlobWriteOption |
Bucket.BlobWriteOption.metagenerationNotMatch(long metageneration)
Returns an option for blob's metageneration mismatch.
|
static StorageOptions.Builder |
StorageOptions.newBuilder()
The returned instance will use JSON over HTTP for its transport.
|
static Storage.BucketListOption |
Storage.BucketListOption.pageSize(long pageSize)
Returns an option to specify the maximum number of buckets returned per page.
|
static Storage.BlobListOption |
Storage.BlobListOption.pageSize(long pageSize)
Returns an option to specify the maximum number of blobs returned per page.
|
static Storage.ListHmacKeysOption |
Storage.ListHmacKeysOption.pageToken(@NonNull String pageToken)
Returns an option to specify the page token from which to start listing HMAC keys.
|
static Storage.BucketListOption |
Storage.BucketListOption.pageToken(@NonNull String pageToken)
Returns an option to specify the page token from which to start listing buckets.
|
static Storage.BlobListOption |
Storage.BlobListOption.pageToken(@NonNull String pageToken)
Returns an option to specify the page token from which to start listing blobs.
|
static Storage.BucketTargetOption |
Storage.BucketTargetOption.predefinedAcl(@NonNull Storage.PredefinedAcl acl)
Returns an option for specifying bucket's predefined ACL configuration.
|
static Storage.BlobTargetOption |
Storage.BlobTargetOption.predefinedAcl(@NonNull Storage.PredefinedAcl acl)
Returns an option for specifying blob's predefined ACL configuration.
|
static Storage.BlobWriteOption |
Storage.BlobWriteOption.predefinedAcl(@NonNull Storage.PredefinedAcl acl)
Returns an option for specifying blob's predefined ACL configuration.
|
static Bucket.BlobTargetOption |
Bucket.BlobTargetOption.predefinedAcl(Storage.PredefinedAcl acl)
Returns an option for specifying blob's predefined ACL configuration.
|
static Bucket.BlobWriteOption |
Bucket.BlobWriteOption.predefinedAcl(Storage.PredefinedAcl acl)
Returns an option for specifying blob's predefined ACL configuration.
|
static Storage.BucketTargetOption |
Storage.BucketTargetOption.predefinedDefaultObjectAcl(@NonNull Storage.PredefinedAcl acl)
Returns an option for specifying bucket's default ACL configuration for blobs.
|
static Storage.BucketListOption |
Storage.BucketListOption.prefix(@NonNull String prefix)
Returns an option to set a prefix to filter results to buckets whose names begin with this
prefix.
|
static Storage.BlobListOption |
Storage.BlobListOption.prefix(@NonNull String prefix)
Returns an option to set a prefix to filter results to blobs whose names begin with this
prefix.
|
static Storage.ListHmacKeysOption |
Storage.ListHmacKeysOption.projectId(@NonNull String projectId)
Returns an option to specify the Project ID for this request.
|
static Storage.CreateHmacKeyOption |
Storage.CreateHmacKeyOption.projectId(@NonNull String projectId)
Returns an option to specify the Project ID for this request.
|
static Storage.GetHmacKeyOption |
Storage.GetHmacKeyOption.projectId(@NonNull String projectId)
Returns an option to specify the Project ID for this request.
|
static Storage.BucketTargetOption |
Storage.BucketTargetOption.projection(@NonNull String projection)
Returns an option to define the projection in the API request.
|
byte[] |
Storage.readAllBytes(BlobId blob,
Storage.BlobSourceOption... options)
Reads all the bytes from a blob.
|
byte[] |
Storage.readAllBytes(String bucket,
String blob,
Storage.BlobSourceOption... options)
Reads all the bytes from a blob.
|
com.google.cloud.ReadChannel |
Blob.reader(Blob.BlobSourceOption... options)
Returns a
ReadChannel object for reading this blob's content. |
com.google.cloud.ReadChannel |
Storage.reader(BlobId blob,
Storage.BlobSourceOption... options)
Returns a channel for reading the blob's content.
|
com.google.cloud.ReadChannel |
Storage.reader(String bucket,
String blob,
Storage.BlobSourceOption... options)
Returns a channel for reading the blob's content.
|
Blob |
Blob.reload(Blob.BlobSourceOption... options)
Fetches the latest blob properties.
|
Bucket |
Bucket.reload(Bucket.BucketSourceOption... options)
Fetches current bucket's latest information.
|
static Storage.BucketSourceOption |
Storage.BucketSourceOption.requestedPolicyVersion(long version) |
static Storage.ListHmacKeysOption |
Storage.ListHmacKeysOption.serviceAccount(@NonNull ServiceAccount serviceAccount)
Returns an option for the Service Account whose keys to list.
|
com.google.cloud.Policy |
Storage.setIamPolicy(String bucket,
com.google.cloud.Policy policy,
Storage.BucketSourceOption... options)
Updates the IAM policy on the specified bucket.
|
static Blob.BlobSourceOption |
Blob.BlobSourceOption.shouldReturnRawInputStream(boolean shouldReturnRawInputStream)
Returns an option for whether the request should return the raw input stream, instead of
automatically decompressing the content.
|
static Storage.BlobSourceOption |
Storage.BlobSourceOption.shouldReturnRawInputStream(boolean shouldReturnRawInputStream)
Returns an option for whether the request should return the raw input stream, instead of
automatically decompressing the content.
|
static Storage.BlobGetOption |
Storage.BlobGetOption.shouldReturnRawInputStream(boolean shouldReturnRawInputStream)
Returns an option for whether the request should return the raw input stream, instead of
automatically decompressing the content.
|
static Storage.ListHmacKeysOption |
Storage.ListHmacKeysOption.showDeletedKeys(boolean showDeletedKeys)
Returns an option to specify whether to show deleted keys in the result.
|
URL |
Storage.signUrl(BlobInfo blobInfo,
long duration,
TimeUnit unit,
Storage.SignUrlOption... options)
Generates a signed URL for a blob.
|
URL |
Blob.signUrl(long duration,
TimeUnit unit,
Storage.SignUrlOption... options)
Generates a signed URL for this blob.
|
static Storage.PostPolicyV4Option |
Storage.PostPolicyV4Option.signWith(com.google.auth.ServiceAccountSigner signer)
Provides a service account signer to sign the policy.
|
static Storage.SignUrlOption |
Storage.SignUrlOption.signWith(com.google.auth.ServiceAccountSigner signer)
Provides a service account signer to sign the URL.
|
static Storage.BlobListOption |
Storage.BlobListOption.startOffset(@NonNull String startOffset)
Returns an option to set a startOffset to filter results to objects whose names are
lexicographically equal to or after startOffset.
|
List<Boolean> |
Storage.testIamPermissions(String bucket,
List<String> permissions,
Storage.BucketSourceOption... options)
Tests whether the caller holds the permissions on the specified bucket.
|
List<Blob> |
Storage.update(BlobInfo... blobInfos)
Updates the requested blobs.
|
Blob |
Storage.update(BlobInfo blobInfo)
Updates the properties of the blob.
|
Blob |
Storage.update(BlobInfo blobInfo,
Storage.BlobTargetOption... options)
Updates the blob properties if the preconditions specified by
options are met. |
Bucket |
Storage.update(BucketInfo bucketInfo,
Storage.BucketTargetOption... options)
Updates bucket information.
|
List<Blob> |
Storage.update(Iterable<BlobInfo> blobInfos)
Updates the requested blobs.
|
Blob |
Blob.update(Storage.BlobTargetOption... options)
Updates the blob properties.
|
Bucket |
Bucket.update(Storage.BucketTargetOption... options)
Updates the bucket's information.
|
Acl |
Blob.updateAcl(Acl acl)
Updates an ACL entry on this blob.
|
Acl |
Bucket.updateAcl(Acl acl)
Updates an ACL entry on this bucket.
|
Acl |
Storage.updateAcl(BlobId blob,
Acl acl)
Updates an ACL entry on the specified blob.
|
Acl |
Storage.updateAcl(String bucket,
Acl acl) |
Acl |
Storage.updateAcl(String bucket,
Acl acl,
Storage.BucketSourceOption... options)
Updates an ACL entry on the specified bucket.
|
Acl |
Bucket.updateDefaultAcl(Acl acl)
Updates a default blob ACL entry on this bucket.
|
Acl |
Storage.updateDefaultAcl(String bucket,
Acl acl)
Updates a default blob ACL entry on the specified bucket.
|
HmacKey.HmacKeyMetadata |
Storage.updateHmacKeyState(HmacKey.HmacKeyMetadata hmacKeyMetadata,
HmacKey.HmacKeyState state,
Storage.UpdateHmacKeyOption... options)
Updates the state of an HMAC key and returns the updated metadata.
|
static Blob.BlobSourceOption |
Blob.BlobSourceOption.userProject(@NonNull String userProject)
Returns an option for blob's billing user project.
|
static Storage.BucketTargetOption |
Storage.BucketTargetOption.userProject(@NonNull String userProject)
Returns an option to define the billing user project.
|
static Storage.BucketSourceOption |
Storage.BucketSourceOption.userProject(@NonNull String userProject)
Returns an option for bucket's billing user project.
|
static Storage.ListHmacKeysOption |
Storage.ListHmacKeysOption.userProject(@NonNull String userProject)
Returns an option to specify the project to be billed for this request.
|
static Storage.CreateHmacKeyOption |
Storage.CreateHmacKeyOption.userProject(@NonNull String userProject)
Returns an option to specify the project to be billed for this request.
|
static Storage.GetHmacKeyOption |
Storage.GetHmacKeyOption.userProject(@NonNull String userProject)
Returns an option to specify the project to be billed for this request.
|
static Storage.DeleteHmacKeyOption |
Storage.DeleteHmacKeyOption.userProject(@NonNull String userProject)
Returns an option to specify the project to be billed for this request.
|
static Storage.UpdateHmacKeyOption |
Storage.UpdateHmacKeyOption.userProject(@NonNull String userProject)
Returns an option to specify the project to be billed for this request.
|
static Storage.BucketGetOption |
Storage.BucketGetOption.userProject(@NonNull String userProject)
Returns an option for bucket's billing user project.
|
static Storage.BlobTargetOption |
Storage.BlobTargetOption.userProject(@NonNull String userProject)
Returns an option for blob's billing user project.
|
static Storage.BlobWriteOption |
Storage.BlobWriteOption.userProject(@NonNull String userProject)
Returns an option for blob's billing user project.
|
static Storage.BlobSourceOption |
Storage.BlobSourceOption.userProject(@NonNull String userProject)
Returns an option for blob's billing user project.
|
static Storage.BlobGetOption |
Storage.BlobGetOption.userProject(@NonNull String userProject)
Returns an option for blob's billing user project.
|
static Storage.BucketListOption |
Storage.BucketListOption.userProject(@NonNull String userProject)
Returns an option for bucket's billing user project.
|
static Storage.BlobListOption |
Storage.BlobListOption.userProject(@NonNull String userProject)
Returns an option to define the billing user project.
|
static Bucket.BucketSourceOption |
Bucket.BucketSourceOption.userProject(@NonNull String userProject)
Returns an option for blob's billing user project.
|
static Bucket.BlobTargetOption |
Bucket.BlobTargetOption.userProject(@NonNull String userProject)
Returns an option for blob's billing user project.
|
static Bucket.BlobWriteOption |
Bucket.BlobWriteOption.userProject(@NonNull String userProject)
Returns an option for blob's billing user project.
|
static Storage.BlobListOption |
Storage.BlobListOption.versions(boolean versions)
If set to
true, lists all versions of a blob. |
static Storage.PostPolicyV4Option |
Storage.PostPolicyV4Option.withBucketBoundHostname(String bucketBoundHostname)
Use a bucket-bound hostname, which replaces the storage.googleapis.com host with the name of
a CNAME bucket, e.g.
|
static Storage.SignUrlOption |
Storage.SignUrlOption.withBucketBoundHostname(String bucketBoundHostname)
Use a bucket-bound hostname, which replaces the storage.googleapis.com host with the name of
a CNAME bucket, e.g.
|
static Storage.PostPolicyV4Option |
Storage.PostPolicyV4Option.withBucketBoundHostname(String bucketBoundHostname,
Storage.UriScheme uriScheme)
Use a bucket-bound hostname, which replaces the storage.googleapis.com host with the name of
a CNAME bucket, e.g.
|
static Storage.SignUrlOption |
Storage.SignUrlOption.withBucketBoundHostname(String bucketBoundHostname,
Storage.UriScheme uriScheme)
Use a bucket-bound hostname, which replaces the storage.googleapis.com host with the name of
a CNAME bucket, e.g.
|
static Storage.SignUrlOption |
Storage.SignUrlOption.withContentType()
Use it if signature should include the blob's content-type.
|
static Storage.SignUrlOption |
Storage.SignUrlOption.withExtHeaders(Map<String,String> extHeaders)
Use it if signature should include the blob's canonicalized extended headers.
|
static Storage.SignUrlOption |
Storage.SignUrlOption.withHostName(String hostName)
Use a different host name than the default host name 'storage.googleapis.com'.
|
static Storage.SignUrlOption |
Storage.SignUrlOption.withMd5()
Use it if signature should include the blob's md5.
|
static Storage.PostPolicyV4Option |
Storage.PostPolicyV4Option.withPathStyle()
Generates a path-style URL, which places the bucket name in the path portion of the URL
instead of in the hostname, e.g 'https://storage.googleapis.com/mybucket/...'.
|
static Storage.SignUrlOption |
Storage.SignUrlOption.withPathStyle()
Generates a path-style URL, which places the bucket name in the path portion of the URL
instead of in the hostname, e.g 'https://storage.googleapis.com/mybucket/...'.
|
static Storage.SignUrlOption |
Storage.SignUrlOption.withQueryParams(Map<String,String> queryParams)
Use if the URL should contain additional query parameters.
|
static Storage.SignUrlOption |
Storage.SignUrlOption.withV2Signature()
Use if signature version should be V2.
|
static Storage.SignUrlOption |
Storage.SignUrlOption.withV4Signature()
Use if signature version should be V4.
|
static Storage.PostPolicyV4Option |
Storage.PostPolicyV4Option.withVirtualHostedStyle()
Use a virtual hosted-style hostname, which adds the bucket into the host portion of the URI
rather than the path, e.g.
|
static Storage.SignUrlOption |
Storage.SignUrlOption.withVirtualHostedStyle()
Use a virtual hosted-style hostname, which adds the bucket into the host portion of the URI
rather than the path, e.g.
|
com.google.cloud.WriteChannel |
Storage.writer(BlobInfo blobInfo,
Storage.BlobWriteOption... options)
Creates a blob and returns a channel for writing its content.
|
com.google.cloud.WriteChannel |
Blob.writer(Storage.BlobWriteOption... options)
Returns a
WriteChannel object for writing to this blob. |
com.google.cloud.WriteChannel |
Storage.writer(URL signedURL)
Accepts signed URL and return a channel for writing content.
|
Copyright © 2023 Google LLC. All rights reserved.