com.google.api.services.storage.model

Class StorageObject

java.lang.Object

java.util.AbstractMap<java.lang.String,java.lang.Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.storage.model.StorageObject

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

public final class StorageObject
extends com.google.api.client.json.GenericJson

An object.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud Storage JSON API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StorageObject.CustomerEncryption Metadata of customer-supplied encryption key, if the object is encrypted by such a key.
static class	StorageObject.Owner The owner of the object.

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
StorageObject()

Method Summary

Methods

Modifier and Type	Method and Description
StorageObject	clone()
java.util.List<ObjectAccessControl>	getAcl() Access controls on the object.
java.lang.String	getBucket() The name of the bucket containing this object.
java.lang.String	getCacheControl() Cache-Control directive for the object data.
java.lang.Integer	getComponentCount() Number of underlying components that make up this object.
java.lang.String	getContentDisposition() Content-Disposition of the object data.
java.lang.String	getContentEncoding() Content-Encoding of the object data.
java.lang.String	getContentLanguage() Content-Language of the object data.
java.lang.String	getContentType() Content-Type of the object data.
java.lang.String	getCrc32c() CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order.
StorageObject.CustomerEncryption	getCustomerEncryption() Metadata of customer-supplied encryption key, if the object is encrypted by such a key.
java.lang.String	getEtag() HTTP 1.1 Entity tag for the object.
java.lang.Long	getGeneration() The content generation of this object.
java.lang.String	getId() The ID of the object, including the bucket name, object name, and generation number.
java.lang.String	getKind() The kind of item this is.
java.lang.String	getKmsKeyName() Cloud KMS Key used to encrypt this object, if the object is encrypted by such a key.
java.lang.String	getMd5Hash() MD5 hash of the data; encoded using base64.
java.lang.String	getMediaLink() Media download link.
java.util.Map<java.lang.String,java.lang.String>	getMetadata() User-provided metadata, in key/value pairs.
java.lang.Long	getMetageneration() The version of the metadata for this object at this generation.
java.lang.String	getName() The name of the object.
StorageObject.Owner	getOwner() The owner of the object.
java.lang.String	getSelfLink() The link to this object.
java.math.BigInteger	getSize() Content-Length of the data in bytes.
java.lang.String	getStorageClass() Storage class of the object.
com.google.api.client.util.DateTime	getTimeCreated() The creation time of the object in RFC 3339 format.
com.google.api.client.util.DateTime	getTimeDeleted() The deletion time of the object in RFC 3339 format.
com.google.api.client.util.DateTime	getTimeStorageClassUpdated() The time at which the object's storage class was last changed.
com.google.api.client.util.DateTime	getUpdated() The modification time of the object metadata in RFC 3339 format.
StorageObject	set(java.lang.String fieldName, java.lang.Object value)
StorageObject	setAcl(java.util.List<ObjectAccessControl> acl) Access controls on the object.
StorageObject	setBucket(java.lang.String bucket) The name of the bucket containing this object.
StorageObject	setCacheControl(java.lang.String cacheControl) Cache-Control directive for the object data.
StorageObject	setComponentCount(java.lang.Integer componentCount) Number of underlying components that make up this object.
StorageObject	setContentDisposition(java.lang.String contentDisposition) Content-Disposition of the object data.
StorageObject	setContentEncoding(java.lang.String contentEncoding) Content-Encoding of the object data.
StorageObject	setContentLanguage(java.lang.String contentLanguage) Content-Language of the object data.
StorageObject	setContentType(java.lang.String contentType) Content-Type of the object data.
StorageObject	setCrc32c(java.lang.String crc32c) CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order.
StorageObject	setCustomerEncryption(StorageObject.CustomerEncryption customerEncryption) Metadata of customer-supplied encryption key, if the object is encrypted by such a key.
StorageObject	setEtag(java.lang.String etag) HTTP 1.1 Entity tag for the object.
StorageObject	setGeneration(java.lang.Long generation) The content generation of this object.
StorageObject	setId(java.lang.String id) The ID of the object, including the bucket name, object name, and generation number.
StorageObject	setKind(java.lang.String kind) The kind of item this is.
StorageObject	setKmsKeyName(java.lang.String kmsKeyName) Cloud KMS Key used to encrypt this object, if the object is encrypted by such a key.
StorageObject	setMd5Hash(java.lang.String md5Hash) MD5 hash of the data; encoded using base64.
StorageObject	setMediaLink(java.lang.String mediaLink) Media download link.
StorageObject	setMetadata(java.util.Map<java.lang.String,java.lang.String> metadata) User-provided metadata, in key/value pairs.
StorageObject	setMetageneration(java.lang.Long metageneration) The version of the metadata for this object at this generation.
StorageObject	setName(java.lang.String name) The name of the object.
StorageObject	setOwner(StorageObject.Owner owner) The owner of the object.
StorageObject	setSelfLink(java.lang.String selfLink) The link to this object.
StorageObject	setSize(java.math.BigInteger size) Content-Length of the data in bytes.
StorageObject	setStorageClass(java.lang.String storageClass) Storage class of the object.
StorageObject	setTimeCreated(com.google.api.client.util.DateTime timeCreated) The creation time of the object in RFC 3339 format.
StorageObject	setTimeDeleted(com.google.api.client.util.DateTime timeDeleted) The deletion time of the object in RFC 3339 format.
StorageObject	setTimeStorageClassUpdated(com.google.api.client.util.DateTime timeStorageClassUpdated) The time at which the object's storage class was last changed.
StorageObject	setUpdated(com.google.api.client.util.DateTime updated) The modification time of the object metadata in RFC 3339 format.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

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

Constructor Detail

StorageObject

public StorageObject()

Method Detail

getAcl

public java.util.List<ObjectAccessControl> getAcl()

Access controls on the object.

Returns:

value or null for none

setAcl

public StorageObject setAcl(java.util.List<ObjectAccessControl> acl)

Access controls on the object.

Parameters:

acl - acl or null for none

getBucket

public java.lang.String getBucket()

The name of the bucket containing this object.

Returns:

value or null for none

setBucket

public StorageObject setBucket(java.lang.String bucket)

The name of the bucket containing this object.

Parameters:

bucket - bucket or null for none

getCacheControl

public java.lang.String getCacheControl()

Cache-Control directive for the object data. If omitted, and the object is accessible to all anonymous users, the default will be public, max-age=3600.

Returns:

value or null for none

setCacheControl

public StorageObject setCacheControl(java.lang.String cacheControl)

Cache-Control directive for the object data. If omitted, and the object is accessible to all anonymous users, the default will be public, max-age=3600.

Parameters:

cacheControl - cacheControl or null for none

getComponentCount

public java.lang.Integer getComponentCount()

Number of underlying components that make up this object. Components are accumulated by compose operations.

Returns:

value or null for none

setComponentCount

public StorageObject setComponentCount(java.lang.Integer componentCount)

Number of underlying components that make up this object. Components are accumulated by compose operations.

Parameters:

componentCount - componentCount or null for none

getContentDisposition

public java.lang.String getContentDisposition()

Content-Disposition of the object data.

Returns:

value or null for none

setContentDisposition

public StorageObject setContentDisposition(java.lang.String contentDisposition)

Content-Disposition of the object data.

Parameters:

contentDisposition - contentDisposition or null for none

getContentEncoding

public java.lang.String getContentEncoding()

Content-Encoding of the object data.

Returns:

value or null for none

setContentEncoding

public StorageObject setContentEncoding(java.lang.String contentEncoding)

Content-Encoding of the object data.

Parameters:

contentEncoding - contentEncoding or null for none

getContentLanguage

public java.lang.String getContentLanguage()

Content-Language of the object data.

Returns:

value or null for none

setContentLanguage

public StorageObject setContentLanguage(java.lang.String contentLanguage)

Content-Language of the object data.

Parameters:

contentLanguage - contentLanguage or null for none

getContentType

public java.lang.String getContentType()

Content-Type of the object data. If contentType is not specified, object downloads will be served as application/octet-stream.

Returns:

value or null for none

setContentType

public StorageObject setContentType(java.lang.String contentType)

Content-Type of the object data. If contentType is not specified, object downloads will be served as application/octet-stream.

Parameters:

contentType - contentType or null for none

getCrc32c

public java.lang.String getCrc32c()

CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order. For more information about using the CRC32c checksum, see Hashes and ETags: Best Practices.

Returns:

value or null for none

setCrc32c

public StorageObject setCrc32c(java.lang.String crc32c)

CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order. For more information about using the CRC32c checksum, see Hashes and ETags: Best Practices.

Parameters:

crc32c - crc32c or null for none

getCustomerEncryption

public StorageObject.CustomerEncryption getCustomerEncryption()

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

Returns:

value or null for none

setCustomerEncryption

public StorageObject setCustomerEncryption(StorageObject.CustomerEncryption customerEncryption)

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

Parameters:

customerEncryption - customerEncryption or null for none

getEtag

public java.lang.String getEtag()

HTTP 1.1 Entity tag for the object.

Returns:

value or null for none

setEtag

public StorageObject setEtag(java.lang.String etag)

HTTP 1.1 Entity tag for the object.

Parameters:

etag - etag or null for none

getGeneration

public java.lang.Long getGeneration()

The content generation of this object. Used for object versioning.

Returns:

value or null for none

setGeneration

public StorageObject setGeneration(java.lang.Long generation)

The content generation of this object. Used for object versioning.

Parameters:

generation - generation or null for none

getId

public java.lang.String getId()

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

Returns:

value or null for none

setId

public StorageObject setId(java.lang.String id)

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

Parameters:

id - id or null for none

getKind

public java.lang.String getKind()

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

Returns:

value or null for none

setKind

public StorageObject setKind(java.lang.String kind)

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

Parameters:

kind - kind or null for none

getKmsKeyName

public java.lang.String getKmsKeyName()

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

Returns:

value or null for none

setKmsKeyName

public StorageObject setKmsKeyName(java.lang.String kmsKeyName)

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

Parameters:

kmsKeyName - kmsKeyName or null for none

getMd5Hash

public java.lang.String getMd5Hash()

MD5 hash of the data; encoded using base64. For more information about using the MD5 hash, see Hashes and ETags: Best Practices.

Returns:

value or null for none

setMd5Hash

public StorageObject setMd5Hash(java.lang.String md5Hash)

MD5 hash of the data; encoded using base64. For more information about using the MD5 hash, see Hashes and ETags: Best Practices.

Parameters:

md5Hash - md5Hash or null for none

getMediaLink

public java.lang.String getMediaLink()

Media download link.

Returns:

value or null for none

setMediaLink

public StorageObject setMediaLink(java.lang.String mediaLink)

Media download link.

Parameters:

mediaLink - mediaLink or null for none

getMetadata

public java.util.Map<java.lang.String,java.lang.String> getMetadata()

User-provided metadata, in key/value pairs.

Returns:

value or null for none

setMetadata

public StorageObject setMetadata(java.util.Map<java.lang.String,java.lang.String> metadata)

User-provided metadata, in key/value pairs.

Parameters:

metadata - metadata or null for none

getMetageneration

public java.lang.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.

Returns:

value or null for none

setMetageneration

public StorageObject setMetageneration(java.lang.Long metageneration)

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.

Parameters:

metageneration - metageneration or null for none

getName

public java.lang.String getName()

The name of the object. Required if not specified by URL parameter.

Returns:

value or null for none

setName

public StorageObject setName(java.lang.String name)

The name of the object. Required if not specified by URL parameter.

Parameters:

name - name or null for none

getOwner

public StorageObject.Owner getOwner()

The owner of the object. This will always be the uploader of the object.

Returns:

value or null for none

setOwner

public StorageObject setOwner(StorageObject.Owner owner)

The owner of the object. This will always be the uploader of the object.

Parameters:

owner - owner or null for none

getSelfLink

public java.lang.String getSelfLink()

The link to this object.

Returns:

value or null for none

setSelfLink

public StorageObject setSelfLink(java.lang.String selfLink)

The link to this object.

Parameters:

selfLink - selfLink or null for none

getSize

public java.math.BigInteger getSize()

Content-Length of the data in bytes.

Returns:

value or null for none

setSize

public StorageObject setSize(java.math.BigInteger size)

Content-Length of the data in bytes.

Parameters:

size - size or null for none

getStorageClass

public java.lang.String getStorageClass()

Storage class of the object.

Returns:

value or null for none

setStorageClass

public StorageObject setStorageClass(java.lang.String storageClass)

Storage class of the object.

Parameters:

storageClass - storageClass or null for none

getTimeCreated

public com.google.api.client.util.DateTime getTimeCreated()

The creation time of the object in RFC 3339 format.

Returns:

value or null for none

setTimeCreated

public StorageObject setTimeCreated(com.google.api.client.util.DateTime timeCreated)

The creation time of the object in RFC 3339 format.

Parameters:

timeCreated - timeCreated or null for none

getTimeDeleted

public com.google.api.client.util.DateTime getTimeDeleted()

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

Returns:

value or null for none

setTimeDeleted

public StorageObject setTimeDeleted(com.google.api.client.util.DateTime timeDeleted)

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

Parameters:

timeDeleted - timeDeleted or null for none

getTimeStorageClassUpdated

public com.google.api.client.util.DateTime getTimeStorageClassUpdated()

The time at which the object's storage class was last changed. When the object is initially created, it will be set to timeCreated.

Returns:

value or null for none

setTimeStorageClassUpdated

public StorageObject setTimeStorageClassUpdated(com.google.api.client.util.DateTime timeStorageClassUpdated)

The time at which the object's storage class was last changed. When the object is initially created, it will be set to timeCreated.

Parameters:

timeStorageClassUpdated - timeStorageClassUpdated or null for none

getUpdated

public com.google.api.client.util.DateTime getUpdated()

The modification time of the object metadata in RFC 3339 format.

Returns:

value or null for none

setUpdated

public StorageObject setUpdated(com.google.api.client.util.DateTime updated)

The modification time of the object metadata in RFC 3339 format.

Parameters:

updated - updated or null for none

set

public StorageObject set(java.lang.String fieldName,
                java.lang.Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public StorageObject clone()

Overrides:

clone in class com.google.api.client.json.GenericJson