google_storage_api::Object Class Reference

#include <object.h>

Inheritance diagram for google_storage_api::Object:

Classes
class	ObjectCustomerEncryption
class	ObjectOwner

Public Member Functions
	Object (const Json::Value &storage)
	Object (Json::Value *storage)
virtual	~Object ()
const StringPiece	GetTypeName () const
bool	has_acl () const
void	clear_acl ()
const client::JsonCppArray< ObjectAccessControl >	get_acl () const
client::JsonCppArray< ObjectAccessControl >	mutable_acl ()
bool	has_bucket () const
void	clear_bucket ()
const StringPiece	get_bucket () const
void	set_bucket (const StringPiece &value)
bool	has_cache_control () const
void	clear_cache_control ()
const StringPiece	get_cache_control () const
void	set_cache_control (const StringPiece &value)
bool	has_component_count () const
void	clear_component_count ()
int32	get_component_count () const
void	set_component_count (int32 value)
bool	has_content_disposition () const
void	clear_content_disposition ()
const StringPiece	get_content_disposition () const
void	set_content_disposition (const StringPiece &value)
bool	has_content_encoding () const
void	clear_content_encoding ()
const StringPiece	get_content_encoding () const
void	set_content_encoding (const StringPiece &value)
bool	has_content_language () const
void	clear_content_language ()
const StringPiece	get_content_language () const
void	set_content_language (const StringPiece &value)
bool	has_content_type () const
void	clear_content_type ()
const StringPiece	get_content_type () const
void	set_content_type (const StringPiece &value)
bool	has_crc32c () const
void	clear_crc32c ()
const StringPiece	get_crc32c () const
void	set_crc32c (const StringPiece &value)
bool	has_customer_encryption () const
void	clear_customer_encryption ()
const ObjectCustomerEncryption	get_customer_encryption () const
ObjectCustomerEncryption	mutable_customerEncryption ()
bool	has_etag () const
void	clear_etag ()
const StringPiece	get_etag () const
void	set_etag (const StringPiece &value)
bool	has_event_based_hold () const
void	clear_event_based_hold ()
bool	get_event_based_hold () const
void	set_event_based_hold (bool value)
bool	has_generation () const
void	clear_generation ()
int64	get_generation () const
void	set_generation (int64 value)
bool	has_id () const
void	clear_id ()
const StringPiece	get_id () const
void	set_id (const StringPiece &value)
bool	has_kind () const
void	clear_kind ()
const StringPiece	get_kind () const
void	set_kind (const StringPiece &value)
bool	has_kms_key_name () const
void	clear_kms_key_name ()
const StringPiece	get_kms_key_name () const
void	set_kms_key_name (const StringPiece &value)
bool	has_md5_hash () const
void	clear_md5_hash ()
const StringPiece	get_md5_hash () const
void	set_md5_hash (const StringPiece &value)
bool	has_media_link () const
void	clear_media_link ()
const StringPiece	get_media_link () const
void	set_media_link (const StringPiece &value)
bool	has_metadata () const
void	clear_metadata ()
const client::JsonCppAssociativeArray< string >	get_metadata () const
client::JsonCppAssociativeArray< string >	mutable_metadata ()
bool	has_metageneration () const
void	clear_metageneration ()
int64	get_metageneration () const
void	set_metageneration (int64 value)
bool	has_name () const
void	clear_name ()
const StringPiece	get_name () const
void	set_name (const StringPiece &value)
bool	has_owner () const
void	clear_owner ()
const ObjectOwner	get_owner () const
ObjectOwner	mutable_owner ()
bool	has_retention_expiration_time () const
void	clear_retention_expiration_time ()
client::DateTime	get_retention_expiration_time () const
void	set_retention_expiration_time (client::DateTime value)
bool	has_self_link () const
void	clear_self_link ()
const StringPiece	get_self_link () const
void	set_self_link (const StringPiece &value)
bool	has_size () const
void	clear_size ()
uint64	get_size () const
void	set_size (uint64 value)
bool	has_storage_class () const
void	clear_storage_class ()
const StringPiece	get_storage_class () const
void	set_storage_class (const StringPiece &value)
bool	has_temporary_hold () const
void	clear_temporary_hold ()
bool	get_temporary_hold () const
void	set_temporary_hold (bool value)
bool	has_time_created () const
void	clear_time_created ()
client::DateTime	get_time_created () const
void	set_time_created (client::DateTime value)
bool	has_time_deleted () const
void	clear_time_deleted ()
client::DateTime	get_time_deleted () const
void	set_time_deleted (client::DateTime value)
bool	has_time_storage_class_updated () const
void	clear_time_storage_class_updated ()
client::DateTime	get_time_storage_class_updated () const
void	set_time_storage_class_updated (client::DateTime value)
bool	has_updated () const
void	clear_updated ()
client::DateTime	get_updated () const
void	set_updated (client::DateTime value)

Static Public Member Functions
static Object *	New ()

Detailed Description

An object.

Constructor & Destructor Documentation

Object() [1/2]

google_storage_api::Object::Object ( const Json::Value &  storage )

explicit

Standard constructor for an immutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

Object() [2/2]

google_storage_api::Object::Object ( Json::Value *  storage )

explicit

Standard constructor for a mutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

~Object()

google_storage_api::Object::~Object ( )

virtual

Standard destructor.

Member Function Documentation

clear_acl()

void google_storage_api::Object::clear_acl ( )

inline

Clears the 'acl' attribute.

clear_bucket()

void google_storage_api::Object::clear_bucket ( )

inline

Clears the 'bucket' attribute.

clear_cache_control()

void google_storage_api::Object::clear_cache_control ( )

inline

Clears the 'cacheControl' attribute.

clear_component_count()

void google_storage_api::Object::clear_component_count ( )

inline

Clears the 'componentCount' attribute.

clear_content_disposition()

void google_storage_api::Object::clear_content_disposition ( )

inline

Clears the 'contentDisposition' attribute.

clear_content_encoding()

void google_storage_api::Object::clear_content_encoding ( )

inline

Clears the 'contentEncoding' attribute.

clear_content_language()

void google_storage_api::Object::clear_content_language ( )

inline

Clears the 'contentLanguage' attribute.

clear_content_type()

void google_storage_api::Object::clear_content_type ( )

inline

Clears the 'contentType' attribute.

clear_crc32c()

void google_storage_api::Object::clear_crc32c ( )

inline

Clears the 'crc32c' attribute.

clear_customer_encryption()

void google_storage_api::Object::clear_customer_encryption ( )

inline

Clears the 'customerEncryption' attribute.

clear_etag()

void google_storage_api::Object::clear_etag ( )

inline

Clears the 'etag' attribute.

clear_event_based_hold()

void google_storage_api::Object::clear_event_based_hold ( )

inline

Clears the 'eventBasedHold' attribute.

clear_generation()

void google_storage_api::Object::clear_generation ( )

inline

Clears the 'generation' attribute.

clear_id()

void google_storage_api::Object::clear_id ( )

inline

Clears the 'id' attribute.

clear_kind()

void google_storage_api::Object::clear_kind ( )

inline

Clears the 'kind' attribute.

clear_kms_key_name()

void google_storage_api::Object::clear_kms_key_name ( )

inline

Clears the 'kmsKeyName' attribute.

clear_md5_hash()

void google_storage_api::Object::clear_md5_hash ( )

inline

Clears the 'md5Hash' attribute.

clear_media_link()

void google_storage_api::Object::clear_media_link ( )

inline

Clears the 'mediaLink' attribute.

clear_metadata()

void google_storage_api::Object::clear_metadata ( )

inline

Clears the 'metadata' attribute.

clear_metageneration()

void google_storage_api::Object::clear_metageneration ( )

inline

Clears the 'metageneration' attribute.

clear_name()

void google_storage_api::Object::clear_name ( )

inline

Clears the 'name' attribute.

clear_owner()

void google_storage_api::Object::clear_owner ( )

inline

Clears the 'owner' attribute.

clear_retention_expiration_time()

void google_storage_api::Object::clear_retention_expiration_time ( )

inline

Clears the 'retentionExpirationTime' attribute.

clear_self_link()

void google_storage_api::Object::clear_self_link ( )

inline

Clears the 'selfLink' attribute.

clear_size()

void google_storage_api::Object::clear_size ( )

inline

Clears the 'size' attribute.

clear_storage_class()

void google_storage_api::Object::clear_storage_class ( )

inline

Clears the 'storageClass' attribute.

clear_temporary_hold()

void google_storage_api::Object::clear_temporary_hold ( )

inline

Clears the 'temporaryHold' attribute.

clear_time_created()

void google_storage_api::Object::clear_time_created ( )

inline

Clears the 'timeCreated' attribute.

clear_time_deleted()

void google_storage_api::Object::clear_time_deleted ( )

inline

Clears the 'timeDeleted' attribute.

clear_time_storage_class_updated()

void google_storage_api::Object::clear_time_storage_class_updated ( )

inline

Clears the 'timeStorageClassUpdated' attribute.

clear_updated()

void google_storage_api::Object::clear_updated ( )

inline

Clears the 'updated' attribute.

get_acl()

const client::JsonCppArray<ObjectAccessControl > google_storage_api::Object::get_acl

(

)

const

Get a reference to the value of the 'acl' attribute.

get_bucket()

const StringPiece google_storage_api::Object::get_bucket ( ) const

inline

Get the value of the 'bucket' attribute.

get_cache_control()

const StringPiece google_storage_api::Object::get_cache_control ( ) const

inline

Get the value of the 'cacheControl' attribute.

get_component_count()

int32 google_storage_api::Object::get_component_count ( ) const

inline

Get the value of the 'componentCount' attribute.

get_content_disposition()

const StringPiece google_storage_api::Object::get_content_disposition ( ) const

inline

Get the value of the 'contentDisposition' attribute.

get_content_encoding()

const StringPiece google_storage_api::Object::get_content_encoding ( ) const

inline

Get the value of the 'contentEncoding' attribute.

get_content_language()

const StringPiece google_storage_api::Object::get_content_language ( ) const

inline

Get the value of the 'contentLanguage' attribute.

get_content_type()

const StringPiece google_storage_api::Object::get_content_type ( ) const

inline

Get the value of the 'contentType' attribute.

get_crc32c()

const StringPiece google_storage_api::Object::get_crc32c ( ) const

inline

Get the value of the 'crc32c' attribute.

get_customer_encryption()

const ObjectCustomerEncryption google_storage_api::Object::get_customer_encryption ( ) const

inline

Get a reference to the value of the 'customerEncryption' attribute.

get_etag()

const StringPiece google_storage_api::Object::get_etag ( ) const

inline

Get the value of the 'etag' attribute.

get_event_based_hold()

bool google_storage_api::Object::get_event_based_hold ( ) const

inline

Get the value of the 'eventBasedHold' attribute.

get_generation()

int64 google_storage_api::Object::get_generation ( ) const

inline

Get the value of the 'generation' attribute.

get_id()

const StringPiece google_storage_api::Object::get_id ( ) const

inline

Get the value of the 'id' attribute.

get_kind()

const StringPiece google_storage_api::Object::get_kind ( ) const

inline

Get the value of the 'kind' attribute.

get_kms_key_name()

const StringPiece google_storage_api::Object::get_kms_key_name ( ) const

inline

Get the value of the 'kmsKeyName' attribute.

get_md5_hash()

const StringPiece google_storage_api::Object::get_md5_hash ( ) const

inline

Get the value of the 'md5Hash' attribute.

get_media_link()

const StringPiece google_storage_api::Object::get_media_link ( ) const

inline

Get the value of the 'mediaLink' attribute.

get_metadata()

const client::JsonCppAssociativeArray<string > google_storage_api::Object::get_metadata ( ) const

inline

Get a reference to the value of the 'metadata' attribute.

get_metageneration()

int64 google_storage_api::Object::get_metageneration ( ) const

inline

Get the value of the 'metageneration' attribute.

get_name()

const StringPiece google_storage_api::Object::get_name ( ) const

inline

Get the value of the 'name' attribute.

get_owner()

const ObjectOwner google_storage_api::Object::get_owner ( ) const

inline

Get a reference to the value of the 'owner' attribute.

get_retention_expiration_time()

client::DateTime google_storage_api::Object::get_retention_expiration_time ( ) const

inline

Get the value of the 'retentionExpirationTime' attribute.

get_self_link()

const StringPiece google_storage_api::Object::get_self_link ( ) const

inline

Get the value of the 'selfLink' attribute.

get_size()

uint64 google_storage_api::Object::get_size ( ) const

inline

Get the value of the 'size' attribute.

get_storage_class()

const StringPiece google_storage_api::Object::get_storage_class ( ) const

inline

Get the value of the 'storageClass' attribute.

get_temporary_hold()

bool google_storage_api::Object::get_temporary_hold ( ) const

inline

Get the value of the 'temporaryHold' attribute.

get_time_created()

client::DateTime google_storage_api::Object::get_time_created ( ) const

inline

Get the value of the 'timeCreated' attribute.

get_time_deleted()

client::DateTime google_storage_api::Object::get_time_deleted ( ) const

inline

Get the value of the 'timeDeleted' attribute.

get_time_storage_class_updated()

client::DateTime google_storage_api::Object::get_time_storage_class_updated ( ) const

inline

Get the value of the 'timeStorageClassUpdated' attribute.

get_updated()

client::DateTime google_storage_api::Object::get_updated ( ) const

inline

Get the value of the 'updated' attribute.

GetTypeName()

const StringPiece google_storage_api::Object::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns

google_storage_api::Object

has_acl()

bool google_storage_api::Object::has_acl ( ) const

inline

Determine if the 'acl' attribute was set.

Returns

true if the 'acl' attribute was set.

has_bucket()

bool google_storage_api::Object::has_bucket ( ) const

inline

Determine if the 'bucket' attribute was set.

Returns

true if the 'bucket' attribute was set.

has_cache_control()

bool google_storage_api::Object::has_cache_control ( ) const

inline

Determine if the 'cacheControl' attribute was set.

Returns

true if the 'cacheControl' attribute was set.

has_component_count()

bool google_storage_api::Object::has_component_count ( ) const

inline

Determine if the 'componentCount' attribute was set.

Returns

true if the 'componentCount' attribute was set.

has_content_disposition()

bool google_storage_api::Object::has_content_disposition ( ) const

inline

Determine if the 'contentDisposition' attribute was set.

Returns

true if the 'contentDisposition' attribute was set.

has_content_encoding()

bool google_storage_api::Object::has_content_encoding ( ) const

inline

Determine if the 'contentEncoding' attribute was set.

Returns

true if the 'contentEncoding' attribute was set.

has_content_language()

bool google_storage_api::Object::has_content_language ( ) const

inline

Determine if the 'contentLanguage' attribute was set.

Returns

true if the 'contentLanguage' attribute was set.

has_content_type()

bool google_storage_api::Object::has_content_type ( ) const

inline

Determine if the 'contentType' attribute was set.

Returns

true if the 'contentType' attribute was set.

has_crc32c()

bool google_storage_api::Object::has_crc32c ( ) const

inline

Determine if the 'crc32c' attribute was set.

Returns

true if the 'crc32c' attribute was set.

has_customer_encryption()

bool google_storage_api::Object::has_customer_encryption ( ) const

inline

Determine if the 'customerEncryption' attribute was set.

Returns

true if the 'customerEncryption' attribute was set.

has_etag()

bool google_storage_api::Object::has_etag ( ) const

inline

Determine if the 'etag' attribute was set.

Returns

true if the 'etag' attribute was set.

has_event_based_hold()

bool google_storage_api::Object::has_event_based_hold ( ) const

inline

Determine if the 'eventBasedHold' attribute was set.

Returns

true if the 'eventBasedHold' attribute was set.

has_generation()

bool google_storage_api::Object::has_generation ( ) const

inline

Determine if the 'generation' attribute was set.

Returns

true if the 'generation' attribute was set.

has_id()

bool google_storage_api::Object::has_id ( ) const

inline

Determine if the 'id' attribute was set.

Returns

true if the 'id' attribute was set.

has_kind()

bool google_storage_api::Object::has_kind ( ) const

inline

Determine if the 'kind' attribute was set.

Returns

true if the 'kind' attribute was set.

has_kms_key_name()

bool google_storage_api::Object::has_kms_key_name ( ) const

inline

Determine if the 'kmsKeyName' attribute was set.

Returns

true if the 'kmsKeyName' attribute was set.

has_md5_hash()

bool google_storage_api::Object::has_md5_hash ( ) const

inline

Determine if the 'md5Hash' attribute was set.

Returns

true if the 'md5Hash' attribute was set.

has_media_link()

bool google_storage_api::Object::has_media_link ( ) const

inline

Determine if the 'mediaLink' attribute was set.

Returns

true if the 'mediaLink' attribute was set.

has_metadata()

bool google_storage_api::Object::has_metadata ( ) const

inline

Determine if the 'metadata' attribute was set.

Returns

true if the 'metadata' attribute was set.

has_metageneration()

bool google_storage_api::Object::has_metageneration ( ) const

inline

Determine if the 'metageneration' attribute was set.

Returns

true if the 'metageneration' attribute was set.

has_name()

bool google_storage_api::Object::has_name ( ) const

inline

Determine if the 'name' attribute was set.

Returns

true if the 'name' attribute was set.

has_owner()

bool google_storage_api::Object::has_owner ( ) const

inline

Determine if the 'owner' attribute was set.

Returns

true if the 'owner' attribute was set.

has_retention_expiration_time()

bool google_storage_api::Object::has_retention_expiration_time ( ) const

inline

Determine if the 'retentionExpirationTime' attribute was set.

Returns

true if the 'retentionExpirationTime' attribute was set.

has_self_link()

bool google_storage_api::Object::has_self_link ( ) const

inline

Determine if the 'selfLink' attribute was set.

Returns

true if the 'selfLink' attribute was set.

has_size()

bool google_storage_api::Object::has_size ( ) const

inline

Determine if the 'size' attribute was set.

Returns

true if the 'size' attribute was set.

has_storage_class()

bool google_storage_api::Object::has_storage_class ( ) const

inline

Determine if the 'storageClass' attribute was set.

Returns

true if the 'storageClass' attribute was set.

has_temporary_hold()

bool google_storage_api::Object::has_temporary_hold ( ) const

inline

Determine if the 'temporaryHold' attribute was set.

Returns

true if the 'temporaryHold' attribute was set.

has_time_created()

bool google_storage_api::Object::has_time_created ( ) const

inline

Determine if the 'timeCreated' attribute was set.

Returns

true if the 'timeCreated' attribute was set.

has_time_deleted()

bool google_storage_api::Object::has_time_deleted ( ) const

inline

Determine if the 'timeDeleted' attribute was set.

Returns

true if the 'timeDeleted' attribute was set.

has_time_storage_class_updated()

bool google_storage_api::Object::has_time_storage_class_updated ( ) const

inline

Determine if the 'timeStorageClassUpdated' attribute was set.

Returns

true if the 'timeStorageClassUpdated' attribute was set.

has_updated()

bool google_storage_api::Object::has_updated ( ) const

inline

Determine if the 'updated' attribute was set.

Returns

true if the 'updated' attribute was set.

mutable_acl()

client::JsonCppArray<ObjectAccessControl > google_storage_api::Object::mutable_acl

(

)

Gets a reference to a mutable value of the 'acl' property.

Access controls on the object.

Returns

The result can be modified to change the attribute value.

mutable_customerEncryption()

ObjectCustomerEncryption google_storage_api::Object::mutable_customerEncryption ( )

inline

Gets a reference to a mutable value of the 'customerEncryption' property.

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

Returns

The result can be modified to change the attribute value.

mutable_metadata()

client::JsonCppAssociativeArray<string > google_storage_api::Object::mutable_metadata ( )

inline

Gets a reference to a mutable value of the 'metadata' property.

User-provided metadata, in key/value pairs.

Returns

The result can be modified to change the attribute value.

mutable_owner()

ObjectOwner google_storage_api::Object::mutable_owner ( )

inline

Gets a reference to a mutable value of the 'owner' property.

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

Returns

The result can be modified to change the attribute value.

New()

Object * google_storage_api::Object::New ( )

static

Creates a new default instance.

Returns

Ownership is passed back to the caller.

set_bucket()

void google_storage_api::Object::set_bucket ( const StringPiece &  value )

inline

Change the 'bucket' attribute.

The name of the bucket containing this object.

Parameters

[in]

value

The new value.

set_cache_control()

void google_storage_api::Object::set_cache_control ( const StringPiece &  value )

inline

Change the 'cacheControl' attribute.

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

[in]

value

The new value.

set_component_count()

void google_storage_api::Object::set_component_count ( int32  value )

inline

Change the 'componentCount' attribute.

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

Parameters

[in]

value

The new value.

set_content_disposition()

void google_storage_api::Object::set_content_disposition ( const StringPiece &  value )

inline

Change the 'contentDisposition' attribute.

Content-Disposition of the object data.

Parameters

[in]

value

The new value.

set_content_encoding()

void google_storage_api::Object::set_content_encoding ( const StringPiece &  value )

inline

Change the 'contentEncoding' attribute.

Content-Encoding of the object data.

Parameters

[in]

value

The new value.

set_content_language()

void google_storage_api::Object::set_content_language ( const StringPiece &  value )

inline

Change the 'contentLanguage' attribute.

Content-Language of the object data.

Parameters

[in]

value

The new value.

set_content_type()

void google_storage_api::Object::set_content_type ( const StringPiece &  value )

inline

Change the 'contentType' attribute.

Content-Type of the object data. If an object is stored without a Content- Type, it is served as application/octet-stream.

Parameters

[in]

value

The new value.

set_crc32c()

void google_storage_api::Object::set_crc32c ( const StringPiece &  value )

inline

Change the 'crc32c' attribute.

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

[in]

value

The new value.

set_etag()

void google_storage_api::Object::set_etag ( const StringPiece &  value )

inline

Change the 'etag' attribute.

HTTP 1.1 Entity tag for the object.

Parameters

[in]

value

The new value.

set_event_based_hold()

void google_storage_api::Object::set_event_based_hold ( bool  value )

inline

Change the 'eventBasedHold' attribute.

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

[in]

value

The new value.

set_generation()

void google_storage_api::Object::set_generation ( int64  value )

inline

Change the 'generation' attribute.

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

Parameters

[in]

value

The new value.

set_id()

void google_storage_api::Object::set_id ( const StringPiece &  value )

inline

Change the 'id' attribute.

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

Parameters

[in]

value

The new value.

set_kind()

void google_storage_api::Object::set_kind ( const StringPiece &  value )

inline

Change the 'kind' attribute.

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

Parameters

[in]

value

The new value.

set_kms_key_name()

void google_storage_api::Object::set_kms_key_name ( const StringPiece &  value )

inline

Change the 'kmsKeyName' attribute.

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

Parameters

[in]

value

The new value.

set_md5_hash()

void google_storage_api::Object::set_md5_hash ( const StringPiece &  value )

inline

Change the 'md5Hash' attribute.

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

Parameters

[in]

value

The new value.

set_media_link()

void google_storage_api::Object::set_media_link ( const StringPiece &  value )

inline

Change the 'mediaLink' attribute.

Media download link.

Parameters

[in]

value

The new value.

set_metageneration()

void google_storage_api::Object::set_metageneration ( int64  value )

inline

Change the 'metageneration' attribute.

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

[in]

value

The new value.

set_name()

void google_storage_api::Object::set_name ( const StringPiece &  value )

inline

Change the 'name' attribute.

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

Parameters

[in]

value

The new value.

set_retention_expiration_time()

void google_storage_api::Object::set_retention_expiration_time ( client::DateTime  value )

inline

Change the 'retentionExpirationTime' attribute.

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

[in]

value

The new value.

set_self_link()

void google_storage_api::Object::set_self_link ( const StringPiece &  value )

inline

Change the 'selfLink' attribute.

The link to this object.

Parameters

[in]

value

The new value.

set_size()

void google_storage_api::Object::set_size ( uint64  value )

inline

Change the 'size' attribute.

Content-Length of the data in bytes.

Parameters

[in]

value

The new value.

set_storage_class()

void google_storage_api::Object::set_storage_class ( const StringPiece &  value )

inline

Change the 'storageClass' attribute.

Storage class of the object.

Parameters

[in]

value

The new value.

set_temporary_hold()

void google_storage_api::Object::set_temporary_hold ( bool  value )

inline

Change the 'temporaryHold' attribute.

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

[in]

value

The new value.

set_time_created()

void google_storage_api::Object::set_time_created ( client::DateTime  value )

inline

Change the 'timeCreated' attribute.

The creation time of the object in RFC 3339 format.

Parameters

[in]

value

The new value.

set_time_deleted()

void google_storage_api::Object::set_time_deleted ( client::DateTime  value )

inline

Change the 'timeDeleted' attribute.

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

[in]

value

The new value.

set_time_storage_class_updated()

void google_storage_api::Object::set_time_storage_class_updated ( client::DateTime  value )

inline

Change the 'timeStorageClassUpdated' attribute.

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

[in]

value

The new value.

set_updated()

void google_storage_api::Object::set_updated ( client::DateTime  value )

inline

Change the 'updated' attribute.

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

Parameters

[in]

value

The new value.

---

The documentation for this class was generated from the following files:

• google/storage_api/object.h
• google/storage_api/object.cc