StorageObject (Cloud Storage JSON API v1 (Rev. 136) 1.18.0-rc)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.storage.model.StorageObject

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class StorageObject
extends 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: http://code.google.com/p/google-http-java-client/wiki/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
GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map
Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

StorageObject()

Constructors
Constructor and Description
`StorageObject()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`StorageObject`	`clone()`
`List<ObjectAccessControl>`	`getAcl()` Access controls on the object.
`String`	`getBucket()` The name of the bucket containing this object.
`String`	`getCacheControl()` Cache-Control directive for the object data.
`Integer`	`getComponentCount()` Number of underlying components that make up this object.
`String`	`getContentDisposition()` Content-Disposition of the object data.
`String`	`getContentEncoding()` Content-Encoding of the object data.
`String`	`getContentLanguage()` Content-Language of the object data.
`String`	`getContentType()` Content-Type of the object data.
`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.
`String`	`getEtag()` HTTP 1.1 Entity tag for the object.
`Boolean`	`getEventBasedHold()` Whether an object is under event-based hold.
`Long`	`getGeneration()` The content generation of this object.
`String`	`getId()` The ID of the object, including the bucket name, object name, and generation number.
`String`	`getKind()` The kind of item this is.
`String`	`getKmsKeyName()` Cloud KMS Key used to encrypt this object, if the object is encrypted by such a key.
`String`	`getMd5Hash()` MD5 hash of the data; encoded using base64.
`String`	`getMediaLink()` Media download link.
`Map<String,String>`	`getMetadata()` User-provided metadata, in key/value pairs.
`Long`	`getMetageneration()` The version of the metadata for this object at this generation.
`String`	`getName()` The name of the object.
`StorageObject.Owner`	`getOwner()` The owner of the object.
`DateTime`	`getRetentionExpirationTime()` A server-determined value that specifies the earliest time that the object's retention period expires.
`String`	`getSelfLink()` The link to this object.
`BigInteger`	`getSize()` Content-Length of the data in bytes.
`String`	`getStorageClass()` Storage class of the object.
`Boolean`	`getTemporaryHold()` Whether an object is under temporary hold.
`DateTime`	`getTimeCreated()` The creation time of the object in RFC 3339 format.
`DateTime`	`getTimeDeleted()` The deletion time of the object in RFC 3339 format.
`DateTime`	`getTimeStorageClassUpdated()` The time at which the object's storage class was last changed.
`DateTime`	`getUpdated()` The modification time of the object metadata in RFC 3339 format.
`StorageObject`	`set(String fieldName, Object value)`
`StorageObject`	`setAcl(List<ObjectAccessControl> acl)` Access controls on the object.
`StorageObject`	`setBucket(String bucket)` The name of the bucket containing this object.
`StorageObject`	`setCacheControl(String cacheControl)` Cache-Control directive for the object data.
`StorageObject`	`setComponentCount(Integer componentCount)` Number of underlying components that make up this object.
`StorageObject`	`setContentDisposition(String contentDisposition)` Content-Disposition of the object data.
`StorageObject`	`setContentEncoding(String contentEncoding)` Content-Encoding of the object data.
`StorageObject`	`setContentLanguage(String contentLanguage)` Content-Language of the object data.
`StorageObject`	`setContentType(String contentType)` Content-Type of the object data.
`StorageObject`	`setCrc32c(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(String etag)` HTTP 1.1 Entity tag for the object.
`StorageObject`	`setEventBasedHold(Boolean eventBasedHold)` Whether an object is under event-based hold.
`StorageObject`	`setGeneration(Long generation)` The content generation of this object.
`StorageObject`	`setId(String id)` The ID of the object, including the bucket name, object name, and generation number.
`StorageObject`	`setKind(String kind)` The kind of item this is.
`StorageObject`	`setKmsKeyName(String kmsKeyName)` Cloud KMS Key used to encrypt this object, if the object is encrypted by such a key.
`StorageObject`	`setMd5Hash(String md5Hash)` MD5 hash of the data; encoded using base64.
`StorageObject`	`setMediaLink(String mediaLink)` Media download link.
`StorageObject`	`setMetadata(Map<String,String> metadata)` User-provided metadata, in key/value pairs.
`StorageObject`	`setMetageneration(Long metageneration)` The version of the metadata for this object at this generation.
`StorageObject`	`setName(String name)` The name of the object.
`StorageObject`	`setOwner(StorageObject.Owner owner)` The owner of the object.
`StorageObject`	`setRetentionExpirationTime(DateTime retentionExpirationTime)` A server-determined value that specifies the earliest time that the object's retention period expires.
`StorageObject`	`setSelfLink(String selfLink)` The link to this object.
`StorageObject`	`setSize(BigInteger size)` Content-Length of the data in bytes.
`StorageObject`	`setStorageClass(String storageClass)` Storage class of the object.
`StorageObject`	`setTemporaryHold(Boolean temporaryHold)` Whether an object is under temporary hold.
`StorageObject`	`setTimeCreated(DateTime timeCreated)` The creation time of the object in RFC 3339 format.
`StorageObject`	`setTimeDeleted(DateTime timeDeleted)` The deletion time of the object in RFC 3339 format.
`StorageObject`	`setTimeStorageClassUpdated(DateTime timeStorageClassUpdated)` The time at which the object's storage class was last changed.
`StorageObject`	`setUpdated(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

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - StorageObject
```
public StorageObject()
```
- Method Detail
  - getAcl
```
public List<ObjectAccessControl> getAcl()
```
    Access controls on the object.
    
    Returns:
    
    value or null for none
  - setAcl
```
public StorageObject setAcl(List<ObjectAccessControl> acl)
```
    Access controls on the object.
    
    Parameters:
    
    acl - acl or null for none
  - getBucket
```
public String getBucket()
```
    The name of the bucket containing this object.
    
    Returns:
    
    value or null for none
  - setBucket
```
public StorageObject setBucket(String bucket)
```
    The name of the bucket containing this object.
    
    Parameters:
    
    bucket - bucket or null for none
  - getCacheControl
```
public 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(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 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(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 String getContentDisposition()
```
    Content-Disposition of the object data.
    
    Returns:
    
    value or null for none
  - setContentDisposition
```
public StorageObject setContentDisposition(String contentDisposition)
```
    Content-Disposition of the object data.
    
    Parameters:
    
    contentDisposition - contentDisposition or null for none
  - getContentEncoding
```
public String getContentEncoding()
```
    Content-Encoding of the object data.
    
    Returns:
    
    value or null for none
  - setContentEncoding
```
public StorageObject setContentEncoding(String contentEncoding)
```
    Content-Encoding of the object data.
    
    Parameters:
    
    contentEncoding - contentEncoding or null for none
  - getContentLanguage
```
public String getContentLanguage()
```
    Content-Language of the object data.
    
    Returns:
    
    value or null for none
  - setContentLanguage
```
public StorageObject setContentLanguage(String contentLanguage)
```
    Content-Language of the object data.
    
    Parameters:
    
    contentLanguage - contentLanguage or null for none
  - getContentType
```
public String getContentType()
```
    Content-Type of the object data. If an object is stored without a Content-Type, it is served as application/octet-stream.
    
    Returns:
    
    value or null for none
  - setContentType
```
public StorageObject setContentType(String contentType)
```
    Content-Type of the object data. If an object is stored without a Content-Type, it is served as application/octet-stream.
    
    Parameters:
    
    contentType - contentType or null for none
  - getCrc32c
```
public 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(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 String getEtag()
```
    HTTP 1.1 Entity tag for the object.
    
    Returns:
    
    value or null for none
  - setEtag
```
public StorageObject setEtag(String etag)
```
    HTTP 1.1 Entity tag for the object.
    
    Parameters:
    
    etag - etag or null for none
  - getEventBasedHold
```
public Boolean getEventBasedHold()
```
    Whether an object is under event-based hold. Event-based hold is a way to retain objects until an event occurs, which is signified by the hold's release (i.e. this value is set to false). After being released (set to false), such objects will be subject to bucket-level retention (if any). One sample use case of this flag is for banks to hold loan documents for at least 3 years after loan is paid in full. Here, bucket-level retention is 3 years and the event is the loan being paid in full. In this example, these objects will be held intact for any number of years until the event has occurred (event-based hold on the object is released) and then 3 more years after that. That means retention duration of the objects begins from the moment event-based hold transitioned from true to false.
    
    Returns:
    
    value or null for none
  - setEventBasedHold
```
public StorageObject setEventBasedHold(Boolean eventBasedHold)
```
    Whether an object is under event-based hold. Event-based hold is a way to retain objects until an event occurs, which is signified by the hold's release (i.e. this value is set to false). After being released (set to false), such objects will be subject to bucket-level retention (if any). One sample use case of this flag is for banks to hold loan documents for at least 3 years after loan is paid in full. Here, bucket-level retention is 3 years and the event is the loan being paid in full. In this example, these objects will be held intact for any number of years until the event has occurred (event-based hold on the object is released) and then 3 more years after that. That means retention duration of the objects begins from the moment event-based hold transitioned from true to false.
    
    Parameters:
    
    eventBasedHold - eventBasedHold or null for none
  - getGeneration
```
public Long getGeneration()
```
    The content generation of this object. Used for object versioning.
    
    Returns:
    
    value or null for none
  - setGeneration
```
public StorageObject setGeneration(Long generation)
```
    The content generation of this object. Used for object versioning.
    
    Parameters:
    
    generation - generation or null for none
  - getId
```
public 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(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 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(String kind)
```
    The kind of item this is. For objects, this is always storage#object.
    
    Parameters:
    
    kind - kind or null for none
  - getKmsKeyName
```
public String getKmsKeyName()
```
    Cloud KMS Key used to encrypt this object, if the object is encrypted by such a key. Limited availability; usable only by enabled projects.
    
    Returns:
    
    value or null for none
  - setKmsKeyName
```
public StorageObject setKmsKeyName(String kmsKeyName)
```
    Cloud KMS Key used to encrypt this object, if the object is encrypted by such a key. Limited availability; usable only by enabled projects.
    
    Parameters:
    
    kmsKeyName - kmsKeyName or null for none
  - getMd5Hash
```
public 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(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 String getMediaLink()
```
    Media download link.
    
    Returns:
    
    value or null for none
  - setMediaLink
```
public StorageObject setMediaLink(String mediaLink)
```
    Media download link.
    
    Parameters:
    
    mediaLink - mediaLink or null for none
  - getMetadata
```
public Map<String,String> getMetadata()
```
    User-provided metadata, in key/value pairs.
    
    Returns:
    
    value or null for none
  - setMetadata
```
public StorageObject setMetadata(Map<String,String> metadata)
```
    User-provided metadata, in key/value pairs.
    
    Parameters:
    
    metadata - metadata or null for none
  - getMetageneration
```
public 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(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 String getName()
```
    The name of the object. Required if not specified by URL parameter.
    
    Returns:
    
    value or null for none
  - setName
```
public StorageObject setName(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
  - getRetentionExpirationTime
```
public DateTime getRetentionExpirationTime()
```
    A server-determined value that specifies the earliest time that the object's retention period expires. This value is in RFC 3339 format. Note 1: This field is not provided for objects with an active event-based hold, since retention expiration is unknown until the hold is removed. Note 2: This value can be provided even when temporary hold is set (so that the user can reason about policy without having to first unset the temporary hold).
    
    Returns:
    
    value or null for none
  - setRetentionExpirationTime
```
public StorageObject setRetentionExpirationTime(DateTime retentionExpirationTime)
```
    A server-determined value that specifies the earliest time that the object's retention period expires. This value is in RFC 3339 format. Note 1: This field is not provided for objects with an active event-based hold, since retention expiration is unknown until the hold is removed. Note 2: This value can be provided even when temporary hold is set (so that the user can reason about policy without having to first unset the temporary hold).
    
    Parameters:
    
    retentionExpirationTime - retentionExpirationTime or null for none
  - getSelfLink
```
public String getSelfLink()
```
    The link to this object.
    
    Returns:
    
    value or null for none
  - setSelfLink
```
public StorageObject setSelfLink(String selfLink)
```
    The link to this object.
    
    Parameters:
    
    selfLink - selfLink or null for none
  - getSize
```
public BigInteger getSize()
```
    Content-Length of the data in bytes.
    
    Returns:
    
    value or null for none
  - setSize
```
public StorageObject setSize(BigInteger size)
```
    Content-Length of the data in bytes.
    
    Parameters:
    
    size - size or null for none
  - getStorageClass
```
public String getStorageClass()
```
    Storage class of the object.
    
    Returns:
    
    value or null for none
  - setStorageClass
```
public StorageObject setStorageClass(String storageClass)
```
    Storage class of the object.
    
    Parameters:
    
    storageClass - storageClass or null for none
  - getTemporaryHold
```
public Boolean getTemporaryHold()
```
    Whether an object is under temporary hold. While this flag is set to true, the object is protected against deletion and overwrites. A common use case of this flag is regulatory investigations where objects need to be retained while the investigation is ongoing. Note that unlike event-based hold, temporary hold does not impact retention expiration time of an object.
    
    Returns:
    
    value or null for none
  - setTemporaryHold
```
public StorageObject setTemporaryHold(Boolean temporaryHold)
```
    Whether an object is under temporary hold. While this flag is set to true, the object is protected against deletion and overwrites. A common use case of this flag is regulatory investigations where objects need to be retained while the investigation is ongoing. Note that unlike event-based hold, temporary hold does not impact retention expiration time of an object.
    
    Parameters:
    
    temporaryHold - temporaryHold or null for none
  - getTimeCreated
```
public DateTime getTimeCreated()
```
    The creation time of the object in RFC 3339 format.
    
    Returns:
    
    value or null for none
  - setTimeCreated
```
public StorageObject setTimeCreated(DateTime timeCreated)
```
    The creation time of the object in RFC 3339 format.
    
    Parameters:
    
    timeCreated - timeCreated or null for none
  - getTimeDeleted
```
public 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(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 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(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 DateTime getUpdated()
```
    The modification time of the object metadata in RFC 3339 format.
    
    Returns:
    
    value or null for none
  - setUpdated
```
public StorageObject setUpdated(DateTime updated)
```
    The modification time of the object metadata in RFC 3339 format.
    
    Parameters:
    
    updated - updated or null for none
  - set
```
public StorageObject set(String fieldName,
                         Object value)
```
    Overrides:
    
    set in class GenericJson
  - clone
```
public StorageObject clone()
```
    Overrides:
    
    clone in class GenericJson

Cloud Storage JSON API v1 (revision 136)

Class StorageObject

Nested Class Summary

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

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

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

StorageObject

Method Detail

getAcl

setAcl

getBucket

setBucket

getCacheControl

setCacheControl

getComponentCount

setComponentCount

getContentDisposition

setContentDisposition

getContentEncoding

setContentEncoding

getContentLanguage

setContentLanguage

getContentType

setContentType

getCrc32c

setCrc32c

getCustomerEncryption

setCustomerEncryption

getEtag

setEtag

getEventBasedHold

setEventBasedHold

getGeneration

setGeneration

getId

setId

getKind

setKind

getKmsKeyName

setKmsKeyName

getMd5Hash

setMd5Hash

getMediaLink

setMediaLink

getMetadata

setMetadata

getMetageneration

setMetageneration

getName

setName

getOwner

setOwner

getRetentionExpirationTime

setRetentionExpirationTime

getSelfLink

setSelfLink

getSize

setSize

getStorageClass

setStorageClass

getTemporaryHold

setTemporaryHold

getTimeCreated

setTimeCreated

getTimeDeleted

setTimeDeleted

getTimeStorageClassUpdated

setTimeStorageClassUpdated

getUpdated

setUpdated

set

clone