Package com.google.cloud.storage

Class BlobInfo

java.lang.Object

com.google.cloud.storage.BlobInfo

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

Blob

@TransportCompatibility({HTTP,GRPC})
public class BlobInfo
extends Object
implements Serializable

Information about an object in Google Cloud Storage. A BlobInfo object includes the BlobId instance and the set of properties, such as the blob's access control configuration, user provided metadata, the CRC32C checksum, etc. Instances of this class are used to create a new object in Google Cloud Storage or update the properties of an existing object. To deal with existing Storage objects the API includes the Blob class which extends BlobInfo and declares methods to perform operations on the object. Neither BlobInfo nor Blob instances keep the object content, just the object properties.

Example of usage BlobInfo to create an object in Google Cloud Storage:

 BlobId blobId = BlobId.of(bucketName, blobName);
 BlobInfo blobInfo = BlobInfo.newBuilder(blobId).setContentType("text/plain").build();
 Blob blob = storage.create(blobInfo, "Hello, world".getBytes(StandardCharsets.UTF_8));
 

See Also:

• Concepts and Terminology
• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BlobInfo.Builder	Builder for BlobInfo.
static class	BlobInfo.CustomerEncryption	Objects of this class hold information on the customer-supplied encryption key, if the blob is encrypted using such a key.
static final class	BlobInfo.ImmutableEmptyMap<K,V>	This class is meant for internal use only.
static final class	BlobInfo.Retention	Defines a blob's Retention policy.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
List<Acl>	getAcl()	Returns the blob's access control configuration.
BlobId	getBlobId()	Returns the blob's identity.
String	getBucket()	Returns the name of the containing bucket.
String	getCacheControl()	Returns the blob's data cache control.
Integer	getComponentCount()	Returns the number of components that make up this blob.
String	getContentDisposition()	Returns the blob's data content disposition.
String	getContentEncoding()	Returns the blob's data content encoding.
String	getContentLanguage()	Returns the blob's data content language.
String	getContentType()	Returns the blob's data content type.
String	getCrc32c()	Returns the CRC32C checksum of blob's data as described in RFC 4960, Appendix B; encoded in base64 in big-endian order.
String	getCrc32cToHexString()	Returns the CRC32C checksum of blob's data as described in RFC 4960, Appendix B; decoded to string.
Long	getCreateTime()	Deprecated. Use getCreateTimeOffsetDateTime()
OffsetDateTime	getCreateTimeOffsetDateTime()	Returns the creation time of the blob.
BlobInfo.CustomerEncryption	getCustomerEncryption()	Returns information on the customer-supplied encryption key, if the blob is encrypted using such a key.
Long	getCustomTime()	Deprecated. Use getCustomTimeOffsetDateTime()
OffsetDateTime	getCustomTimeOffsetDateTime()	Returns the custom time specified by the user for an object.
Long	getDeleteTime()	Deprecated. Use getDeleteTimeOffsetDateTime()
OffsetDateTime	getDeleteTimeOffsetDateTime()	Returns the deletion time of the blob.
String	getEtag()	Returns HTTP 1.1 Entity tag for the blob.
Boolean	getEventBasedHold()	Returns a Boolean with either true, null and in certain cases false.
String	getGeneratedId()	Returns the service-generated for the blob.
Long	getGeneration()	Returns blob's data generation.
String	getKmsKeyName()	Returns the Cloud KMS key used to encrypt the blob, if any.
String	getMd5()	Returns the MD5 hash of blob's data encoded in base64.
String	getMd5ToHexString()	Returns the MD5 hash of blob's data decoded to string.
String	getMediaLink()	Returns the blob's media download link.
@Nullable Map<@NonNull String,@Nullable String>	getMetadata()	Returns blob's user provided metadata.
Long	getMetageneration()	Returns blob's metageneration.
String	getName()	Returns the blob's name.
Acl.Entity	getOwner()	Returns the blob's owner.
BlobInfo.Retention	getRetention()	Returns the object's Retention policy.
Long	getRetentionExpirationTime()	Deprecated. Use getRetentionExpirationTimeOffsetDateTime()
OffsetDateTime	getRetentionExpirationTimeOffsetDateTime()	Returns the retention expiration time of the blob, if a retention period is defined.
String	getSelfLink()	Returns the URI of this blob as a string.
Long	getSize()	Returns the content length of the data in bytes.
StorageClass	getStorageClass()	Returns the storage class of the blob.
Boolean	getTemporaryHold()	Returns a Boolean with either true, null and in certain cases false.
Long	getTimeStorageClassUpdated()	Deprecated. Use getTimeStorageClassUpdatedOffsetDateTime()
OffsetDateTime	getTimeStorageClassUpdatedOffsetDateTime()	Returns the time that the object's storage class was last changed or the time of the object creation.
Long	getUpdateTime()	Deprecated. Use getUpdateTimeOffsetDateTime()
OffsetDateTime	getUpdateTimeOffsetDateTime()	Returns the last modification time of the blob's metadata.
int	hashCode()
boolean	isDirectory()	Returns true if the current blob represents a directory.
static BlobInfo.Builder	newBuilder(BlobId blobId)	Returns a BlobInfo builder where blob identity is set using the provided value.
static BlobInfo.Builder	newBuilder(BucketInfo bucketInfo, String name)	Returns a BlobInfo builder where blob identity is set using the provided values.
static BlobInfo.Builder	newBuilder(BucketInfo bucketInfo, String name, Long generation)	Returns a BlobInfo builder where blob identity is set using the provided values.
static BlobInfo.Builder	newBuilder(String bucket, String name)	Returns a BlobInfo builder where blob identity is set using the provided values.
static BlobInfo.Builder	newBuilder(String bucket, String name, Long generation)	Returns a BlobInfo builder where blob identity is set using the provided values.
BlobInfo.Builder	toBuilder()	Returns a builder for the current blob.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

getBlobId

public BlobId getBlobId()

Returns the blob's identity.

getBucket

public String getBucket()

Returns the name of the containing bucket.

getGeneratedId

public String getGeneratedId()

Returns the service-generated for the blob.

getName

public String getName()

Returns the blob's name.

getCacheControl

public String getCacheControl()

Returns the blob's data cache control.

See Also:

• Cache-Control

getAcl

public List<Acl> getAcl()

Returns the blob's access control configuration.

See Also:

• About Access Control Lists

getOwner

public Acl.Entity getOwner()

Returns the blob's owner. This will always be the uploader of the blob.

getSize

public Long getSize()

Returns the content length of the data in bytes.

See Also:

• Content-Length

getContentType

public String getContentType()

Returns the blob's data content type.

See Also:

• Content-Type

getContentEncoding

public String getContentEncoding()

Returns the blob's data content encoding.

See Also:

• Content-Encoding

getContentDisposition

public String getContentDisposition()

Returns the blob's data content disposition.

See Also:

• Content-Disposition

getContentLanguage

public String getContentLanguage()

Returns the blob's data content language.

See Also:

• Content-Language

getComponentCount

public Integer getComponentCount()

Returns the number of components that make up this blob. Components are accumulated through the Storage.compose(Storage.ComposeRequest) operation and are limited to a count of 1024, counting 1 for each non-composite component blob and componentCount for each composite component blob. This value is set only for composite blobs.

See Also:

• Component Count Property

getEtag

public String getEtag()

Returns HTTP 1.1 Entity tag for the blob.

See Also:

• Entity Tags

getSelfLink

public String getSelfLink()

Returns the URI of this blob as a string.

getMd5

public String getMd5()

Returns the MD5 hash of blob's data encoded in base64.

See Also:

• Hashes and ETags: Best Practices

getMd5ToHexString

public String getMd5ToHexString()

Returns the MD5 hash of blob's data decoded to string.

See Also:

• Hashes and ETags: Best Practices

getCrc32c

public String getCrc32c()

Returns the CRC32C checksum of blob's data as described in RFC 4960, Appendix B; encoded in base64 in big-endian order.

See Also:

• Hashes and ETags: Best Practices

getCrc32cToHexString

public String getCrc32cToHexString()

Returns the CRC32C checksum of blob's data as described in RFC 4960, Appendix B; decoded to string.

See Also:

• Hashes and ETags: Best Practices

getMediaLink

public String getMediaLink()

Returns the blob's media download link.

getMetadata

public @Nullable Map<@NonNull String,@Nullable String> getMetadata()

Returns blob's user provided metadata.

getGeneration

public Long getGeneration()

Returns blob's data generation. Used for blob versioning.

getMetageneration

public Long getMetageneration()

Returns blob's metageneration. Used for preconditions and for detecting changes in metadata. A metageneration number is only meaningful in the context of a particular generation of a particular blob.

getDeleteTime

@Deprecated
public Long getDeleteTime()

Deprecated.

Use getDeleteTimeOffsetDateTime()

Returns the deletion time of the blob expressed as the number of milliseconds since the Unix epoch.

getDeleteTimeOffsetDateTime

public OffsetDateTime getDeleteTimeOffsetDateTime()

Returns the deletion time of the blob.

getUpdateTime

@Deprecated
public Long getUpdateTime()

Deprecated.

Use getUpdateTimeOffsetDateTime()

Returns the last modification time of the blob's metadata expressed as the number of milliseconds since the Unix epoch.

getUpdateTimeOffsetDateTime

public OffsetDateTime getUpdateTimeOffsetDateTime()

Returns the last modification time of the blob's metadata.

getCreateTime

@Deprecated
public Long getCreateTime()

Deprecated.

Use getCreateTimeOffsetDateTime()

Returns the creation time of the blob expressed as the number of milliseconds since the Unix epoch.

getCreateTimeOffsetDateTime

public OffsetDateTime getCreateTimeOffsetDateTime()

Returns the creation time of the blob.

getCustomTime

@Deprecated
public Long getCustomTime()

Deprecated.

Use getCustomTimeOffsetDateTime()

Returns the custom time specified by the user for an object.

getCustomTimeOffsetDateTime

public OffsetDateTime getCustomTimeOffsetDateTime()

Returns the custom time specified by the user for an object.

isDirectory

public boolean isDirectory()

Returns true if the current blob represents a directory. This can only happen if the blob is returned by Storage.list(String, Storage.BlobListOption...) when the Storage.BlobListOption.currentDirectory() option is used. When this is the case only getBlobId() and getSize() are set for the current blob: BlobId.getName() ends with the '/' character, BlobId.getGeneration() returns null and getSize() is 0.

getCustomerEncryption

public BlobInfo.CustomerEncryption getCustomerEncryption()

Returns information on the customer-supplied encryption key, if the blob is encrypted using such a key.

getStorageClass

public StorageClass getStorageClass()

Returns the storage class of the blob.

getTimeStorageClassUpdated

@Deprecated
public Long getTimeStorageClassUpdated()

Deprecated.

Use getTimeStorageClassUpdatedOffsetDateTime()

Returns the time that the object's storage class was last changed or the time of the object creation.

getTimeStorageClassUpdatedOffsetDateTime

public OffsetDateTime getTimeStorageClassUpdatedOffsetDateTime()

Returns the time that the object's storage class was last changed or the time of the object creation.

getKmsKeyName

public String getKmsKeyName()

Returns the Cloud KMS key used to encrypt the blob, if any.

getEventBasedHold

@BetaApi
public Boolean getEventBasedHold()

Returns a Boolean with either true, null and in certain cases false.

Case 1: true the field Storage.BlobField.EVENT_BASED_HOLD is selected in a Storage.get(BlobId, Storage.BlobGetOption...) and event-based hold for the blob is enabled.

Case 2.1: null the field Storage.BlobField.EVENT_BASED_HOLD is selected in a Storage.get(BlobId, Storage.BlobGetOption...), but event-based hold for the blob is not enabled. This case can be considered implicitly false.

Case 2.2: null the field Storage.BlobField.EVENT_BASED_HOLD is not selected in a Storage.get(BlobId, Storage.BlobGetOption...), and the state for this field is unknown.

Case 3: false event-based hold is explicitly set to false using in a BlobInfo.Builder.setEventBasedHold(Boolean) client side for a follow-up request e.g. Storage.update(BlobInfo, Storage.BlobTargetOption...) in which case the value of event-based hold will remain false for the given instance.

getTemporaryHold

@BetaApi
public Boolean getTemporaryHold()

Returns a Boolean with either true, null and in certain cases false.

Case 1: true the field Storage.BlobField.TEMPORARY_HOLD is selected in a Storage.get(BlobId, Storage.BlobGetOption...) and temporary hold for the blob is enabled.

Case 2.1: null the field Storage.BlobField.TEMPORARY_HOLD is selected in a Storage.get(BlobId, Storage.BlobGetOption...), but temporary hold for the blob is not enabled. This case can be considered implicitly false.

Case 2.2: null the field Storage.BlobField.TEMPORARY_HOLD is not selected in a Storage.get(BlobId, Storage.BlobGetOption...), and the state for this field is unknown.

Case 3: false event-based hold is explicitly set to false using in a BlobInfo.Builder.setEventBasedHold(Boolean) client side for a follow-up request e.g. Storage.update(BlobInfo, Storage.BlobTargetOption...) in which case the value of temporary hold will remain false for the given instance.

getRetentionExpirationTime

@BetaApi
@Deprecated
public Long getRetentionExpirationTime()

Deprecated.

Use getRetentionExpirationTimeOffsetDateTime()

Returns the retention expiration time of the blob as Long, if a retention period is defined. If retention period is not defined this value returns null

getRetentionExpirationTimeOffsetDateTime

@BetaApi
public OffsetDateTime getRetentionExpirationTimeOffsetDateTime()

Returns the retention expiration time of the blob, if a retention period is defined. If retention period is not defined this value returns null

getRetention

public BlobInfo.Retention getRetention()

Returns the object's Retention policy.

toBuilder

public BlobInfo.Builder toBuilder()

Returns a builder for the current blob.

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

newBuilder

public static BlobInfo.Builder newBuilder(BucketInfo bucketInfo,
 String name)

Returns a BlobInfo builder where blob identity is set using the provided values.

newBuilder

public static BlobInfo.Builder newBuilder(String bucket,
 String name)

Returns a BlobInfo builder where blob identity is set using the provided values.

newBuilder

public static BlobInfo.Builder newBuilder(BucketInfo bucketInfo,
 String name,
 Long generation)

Returns a BlobInfo builder where blob identity is set using the provided values.

newBuilder

public static BlobInfo.Builder newBuilder(String bucket,
 String name,
 Long generation)

Returns a BlobInfo builder where blob identity is set using the provided values.

newBuilder

public static BlobInfo.Builder newBuilder(BlobId blobId)

Returns a BlobInfo builder where blob identity is set using the provided value.