Interface StorageObjectDataOrBuilder (0.16.0)

Version latest

• 0.16.0 (latest)
• 0.15.0
• 0.14.1

public interface StorageObjectDataOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsMetadata(String key)

public abstract boolean containsMetadata(String key)

User-provided metadata, in key/value pairs.

map<string, string> metadata = 21;

Parameter
Name	Description
key	String

Returns
Type	Description
boolean

getBucket()

public abstract String getBucket()

The name of the bucket containing this object.

string bucket = 25;

Returns
Type	Description
String	The bucket.

getBucketBytes()

public abstract ByteString getBucketBytes()

The name of the bucket containing this object.

string bucket = 25;

Returns
Type	Description
ByteString	The bytes for bucket.

getCacheControl()

public abstract String getCacheControl()

Cache-Control directive for the object data, matching https://tools.ietf.org/html/rfc7234#section-5.2".

string cache_control = 3;

Returns
Type	Description
String	The cacheControl.

getCacheControlBytes()

public abstract ByteString getCacheControlBytes()

Cache-Control directive for the object data, matching https://tools.ietf.org/html/rfc7234#section-5.2".

string cache_control = 3;

Returns
Type	Description
ByteString	The bytes for cacheControl.

getComponentCount()

public abstract int getComponentCount()

Number of underlying components that make up this object. Components are accumulated by compose operations. Attempting to set this field will result in an error.

int32 component_count = 12;

Returns
Type	Description
int	The componentCount.

getContentDisposition()

public abstract String getContentDisposition()

Content-Disposition of the object data, matching https://tools.ietf.org/html/rfc6266.

string content_disposition = 2;

Returns
Type	Description
String	The contentDisposition.

getContentDispositionBytes()

public abstract ByteString getContentDispositionBytes()

Content-Disposition of the object data, matching https://tools.ietf.org/html/rfc6266.

string content_disposition = 2;

Returns
Type	Description
ByteString	The bytes for contentDisposition.

getContentEncoding()

public abstract String getContentEncoding()

Content-Encoding of the object data, matching https://tools.ietf.org/html/rfc7231#section-3.1.2.2

string content_encoding = 1;

Returns
Type	Description
String	The contentEncoding.

getContentEncodingBytes()

public abstract ByteString getContentEncodingBytes()

Content-Encoding of the object data, matching https://tools.ietf.org/html/rfc7231#section-3.1.2.2

string content_encoding = 1;

Returns
Type	Description
ByteString	The bytes for contentEncoding.

getContentLanguage()

public abstract String getContentLanguage()

Content-Language of the object data, matching https://tools.ietf.org/html/rfc7231#section-3.1.3.2.

string content_language = 5;

Returns
Type	Description
String	The contentLanguage.

getContentLanguageBytes()

public abstract ByteString getContentLanguageBytes()

Content-Language of the object data, matching https://tools.ietf.org/html/rfc7231#section-3.1.3.2.

string content_language = 5;

Returns
Type	Description
ByteString	The bytes for contentLanguage.

getContentType()

public abstract String getContentType()

Content-Type of the object data, matching https://tools.ietf.org/html/rfc7231#section-3.1.1.5. If an object is stored without a Content-Type, it is served as application/octet-stream.

string content_type = 8;

Returns
Type	Description
String	The contentType.

getContentTypeBytes()

public abstract ByteString getContentTypeBytes()

Content-Type of the object data, matching https://tools.ietf.org/html/rfc7231#section-3.1.1.5. If an object is stored without a Content-Type, it is served as application/octet-stream.

string content_type = 8;

Returns
Type	Description
ByteString	The bytes for contentType.

getCrc32C()

public abstract String getCrc32C()

CRC32c checksum. For more information about using the CRC32c checksum, see https://cloud.google.com/storage/docs/hashes-etags#_JSONAPI.

string crc32c = 11;

Returns
Type	Description
String	The crc32c.

getCrc32CBytes()

public abstract ByteString getCrc32CBytes()

CRC32c checksum. For more information about using the CRC32c checksum, see https://cloud.google.com/storage/docs/hashes-etags#_JSONAPI.

string crc32c = 11;

Returns
Type	Description
ByteString	The bytes for crc32c.

getCustomerEncryption()

public abstract StorageObjectData.CustomerEncryption getCustomerEncryption()

Metadata of customer-supplied encryption key, if the object is encrypted by such a key.

.google.events.cloud.storage.v1.StorageObjectData.CustomerEncryption customer_encryption = 28;

Returns
Type	Description
StorageObjectData.CustomerEncryption	The customerEncryption.

getCustomerEncryptionOrBuilder()

public abstract StorageObjectData.CustomerEncryptionOrBuilder getCustomerEncryptionOrBuilder()

Metadata of customer-supplied encryption key, if the object is encrypted by such a key.

.google.events.cloud.storage.v1.StorageObjectData.CustomerEncryption customer_encryption = 28;

Returns
Type	Description
StorageObjectData.CustomerEncryptionOrBuilder

getEtag()

public abstract String getEtag()

HTTP 1.1 Entity tag for the object. See https://tools.ietf.org/html/rfc7232#section-2.3.

string etag = 14;

Returns
Type	Description
String	The etag.

getEtagBytes()

public abstract ByteString getEtagBytes()

HTTP 1.1 Entity tag for the object. See https://tools.ietf.org/html/rfc7232#section-2.3.

string etag = 14;

Returns
Type	Description
ByteString	The bytes for etag.

getEventBasedHold()

public abstract boolean getEventBasedHold()

Whether an object is under event-based hold.

bool event_based_hold = 29;

Returns
Type	Description
boolean	The eventBasedHold.

getGeneration()

public abstract long getGeneration()

The content generation of this object. Used for object versioning. Attempting to set this field will result in an error.

int64 generation = 26;

Returns
Type	Description
long	The generation.

getId()

public abstract String getId()

The ID of the object, including the bucket name, object name, and generation number.

string id = 24;

Returns
Type	Description
String	The id.

getIdBytes()

public abstract ByteString getIdBytes()

The ID of the object, including the bucket name, object name, and generation number.

string id = 24;

Returns
Type	Description
ByteString	The bytes for id.

getKind()

public abstract String getKind()

The kind of item this is. For objects, this is always "storage#object".

string kind = 102;

Returns
Type	Description
String	The kind.

getKindBytes()

public abstract ByteString getKindBytes()

The kind of item this is. For objects, this is always "storage#object".

string kind = 102;

Returns
Type	Description
ByteString	The bytes for kind.

getKmsKeyName()

public abstract String getKmsKeyName()

Cloud KMS Key used to encrypt this object, if the object is encrypted by such a key.

string kms_key_name = 17;

Returns
Type	Description
String	The kmsKeyName.

getKmsKeyNameBytes()

public abstract ByteString getKmsKeyNameBytes()

Cloud KMS Key used to encrypt this object, if the object is encrypted by such a key.

string kms_key_name = 17;

Returns
Type	Description
ByteString	The bytes for kmsKeyName.

getMd5Hash()

public abstract String getMd5Hash()

MD5 hash of the data; encoded using base64 as per https://tools.ietf.org/html/rfc4648#section-4. For more information about using the MD5 hash, see https://cloud.google.com/storage/docs/hashes-etags#_JSONAPI.

string md5_hash = 13;

Returns
Type	Description
String	The md5Hash.

getMd5HashBytes()

public abstract ByteString getMd5HashBytes()

MD5 hash of the data; encoded using base64 as per https://tools.ietf.org/html/rfc4648#section-4. For more information about using the MD5 hash, see https://cloud.google.com/storage/docs/hashes-etags#_JSONAPI.

string md5_hash = 13;

Returns
Type	Description
ByteString	The bytes for md5Hash.

getMediaLink()

public abstract String getMediaLink()

Media download link.

string media_link = 100;

Returns
Type	Description
String	The mediaLink.

getMediaLinkBytes()

public abstract ByteString getMediaLinkBytes()

Media download link.

string media_link = 100;

Returns
Type	Description
ByteString	The bytes for mediaLink.

getMetadata()

public abstract Map<String,String> getMetadata()

Use #getMetadataMap() instead.

Returns
Type	Description
Map<String,String>

getMetadataCount()

public abstract int getMetadataCount()

User-provided metadata, in key/value pairs.

map<string, string> metadata = 21;

Returns
Type	Description
int

getMetadataMap()

public abstract Map<String,String> getMetadataMap()

User-provided metadata, in key/value pairs.

map<string, string> metadata = 21;

Returns
Type	Description
Map<String,String>

getMetadataOrDefault(String key, String defaultValue)

public abstract String getMetadataOrDefault(String key, String defaultValue)

User-provided metadata, in key/value pairs.

map<string, string> metadata = 21;

Parameters
Name	Description
key	String
defaultValue	String

Returns
Type	Description
String

getMetadataOrThrow(String key)

public abstract String getMetadataOrThrow(String key)

User-provided metadata, in key/value pairs.

map<string, string> metadata = 21;

Parameter
Name	Description
key	String

Returns
Type	Description
String

getMetageneration()

public abstract long getMetageneration()

The version of the metadata for this object at this generation. 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 object.

int64 metageneration = 6;

Returns
Type	Description
long	The metageneration.

getName()

public abstract String getName()

The name of the object.

string name = 23;

Returns
Type	Description
String	The name.

getNameBytes()

public abstract ByteString getNameBytes()

The name of the object.

string name = 23;

Returns
Type	Description
ByteString	The bytes for name.

getRetentionExpirationTime()

public abstract Timestamp getRetentionExpirationTime()

A server-determined value that specifies the earliest time that the object's retention period expires.

.google.protobuf.Timestamp retention_expiration_time = 20;

Returns
Type	Description
Timestamp	The retentionExpirationTime.

getRetentionExpirationTimeOrBuilder()

public abstract TimestampOrBuilder getRetentionExpirationTimeOrBuilder()

A server-determined value that specifies the earliest time that the object's retention period expires.

.google.protobuf.Timestamp retention_expiration_time = 20;

Returns
Type	Description
TimestampOrBuilder

getSelfLink()

public abstract String getSelfLink()

The link to this object.

string self_link = 101;

Returns
Type	Description
String	The selfLink.

getSelfLinkBytes()

public abstract ByteString getSelfLinkBytes()

The link to this object.

string self_link = 101;

Returns
Type	Description
ByteString	The bytes for selfLink.

getSize()

public abstract long getSize()

Content-Length of the object data in bytes, matching https://tools.ietf.org/html/rfc7230#section-3.3.2.

int64 size = 9;

Returns
Type	Description
long	The size.

getStorageClass()

public abstract String getStorageClass()

Storage class of the object.

string storage_class = 16;

Returns
Type	Description
String	The storageClass.

getStorageClassBytes()

public abstract ByteString getStorageClassBytes()

Storage class of the object.

string storage_class = 16;

Returns
Type	Description
ByteString	The bytes for storageClass.

getTemporaryHold()

public abstract boolean getTemporaryHold()

Whether an object is under temporary hold.

bool temporary_hold = 19;

Returns
Type	Description
boolean	The temporaryHold.

getTimeCreated()

public abstract Timestamp getTimeCreated()

The creation time of the object. Attempting to set this field will result in an error.

.google.protobuf.Timestamp time_created = 10;

Returns
Type	Description
Timestamp	The timeCreated.

getTimeCreatedOrBuilder()

public abstract TimestampOrBuilder getTimeCreatedOrBuilder()

The creation time of the object. Attempting to set this field will result in an error.

.google.protobuf.Timestamp time_created = 10;

Returns
Type	Description
TimestampOrBuilder

getTimeDeleted()

public abstract Timestamp getTimeDeleted()

The deletion time of the object. Will be returned if and only if this version of the object has been deleted.

.google.protobuf.Timestamp time_deleted = 7;

Returns
Type	Description
Timestamp	The timeDeleted.

getTimeDeletedOrBuilder()

public abstract TimestampOrBuilder getTimeDeletedOrBuilder()

The deletion time of the object. Will be returned if and only if this version of the object has been deleted.

.google.protobuf.Timestamp time_deleted = 7;

Returns
Type	Description
TimestampOrBuilder

getTimeStorageClassUpdated()

public abstract Timestamp getTimeStorageClassUpdated()

The time at which the object's storage class was last changed.

.google.protobuf.Timestamp time_storage_class_updated = 18;

Returns
Type	Description
Timestamp	The timeStorageClassUpdated.

getTimeStorageClassUpdatedOrBuilder()

public abstract TimestampOrBuilder getTimeStorageClassUpdatedOrBuilder()

The time at which the object's storage class was last changed.

.google.protobuf.Timestamp time_storage_class_updated = 18;

Returns
Type	Description
TimestampOrBuilder

getUpdated()

public abstract Timestamp getUpdated()

The modification time of the object metadata.

.google.protobuf.Timestamp updated = 15;

Returns
Type	Description
Timestamp	The updated.

getUpdatedOrBuilder()

public abstract TimestampOrBuilder getUpdatedOrBuilder()

The modification time of the object metadata.

.google.protobuf.Timestamp updated = 15;

Returns
Type	Description
TimestampOrBuilder

hasCustomerEncryption()

public abstract boolean hasCustomerEncryption()

Metadata of customer-supplied encryption key, if the object is encrypted by such a key.

.google.events.cloud.storage.v1.StorageObjectData.CustomerEncryption customer_encryption = 28;

Returns
Type	Description
boolean	Whether the customerEncryption field is set.

hasRetentionExpirationTime()

public abstract boolean hasRetentionExpirationTime()

A server-determined value that specifies the earliest time that the object's retention period expires.

.google.protobuf.Timestamp retention_expiration_time = 20;

Returns
Type	Description
boolean	Whether the retentionExpirationTime field is set.

hasTimeCreated()

public abstract boolean hasTimeCreated()

The creation time of the object. Attempting to set this field will result in an error.

.google.protobuf.Timestamp time_created = 10;

Returns
Type	Description
boolean	Whether the timeCreated field is set.

hasTimeDeleted()

public abstract boolean hasTimeDeleted()

The deletion time of the object. Will be returned if and only if this version of the object has been deleted.

.google.protobuf.Timestamp time_deleted = 7;

Returns
Type	Description
boolean	Whether the timeDeleted field is set.

hasTimeStorageClassUpdated()

public abstract boolean hasTimeStorageClassUpdated()

The time at which the object's storage class was last changed.

.google.protobuf.Timestamp time_storage_class_updated = 18;

Returns
Type	Description
boolean	Whether the timeStorageClassUpdated field is set.

hasUpdated()

public abstract boolean hasUpdated()

The modification time of the object metadata.

.google.protobuf.Timestamp updated = 15;

Returns
Type	Description
boolean	Whether the updated field is set.