storage  v1
Public Member Functions | Static Public Member Functions | List of all members
google_storage_api::RewriteResponse Class Reference

#include <rewrite_response.h>

Inheritance diagram for google_storage_api::RewriteResponse:

Public Member Functions

 RewriteResponse (const Json::Value &storage)
 
 RewriteResponse (Json::Value *storage)
 
virtual ~RewriteResponse ()
 
const StringPiece GetTypeName () const
 
bool has_done () const
 
void clear_done ()
 
bool get_done () const
 
void set_done (bool value)
 
bool has_kind () const
 
void clear_kind ()
 
const StringPiece get_kind () const
 
void set_kind (const StringPiece &value)
 
bool has_object_size () const
 
void clear_object_size ()
 
int64 get_object_size () const
 
void set_object_size (int64 value)
 
bool has_resource () const
 
void clear_resource ()
 
const Object get_resource () const
 
Object mutable_resource ()
 
bool has_rewrite_token () const
 
void clear_rewrite_token ()
 
const StringPiece get_rewrite_token () const
 
void set_rewrite_token (const StringPiece &value)
 
bool has_total_bytes_rewritten () const
 
void clear_total_bytes_rewritten ()
 
int64 get_total_bytes_rewritten () const
 
void set_total_bytes_rewritten (int64 value)
 

Static Public Member Functions

static RewriteResponseNew ()
 

Detailed Description

A rewrite response.

Constructor & Destructor Documentation

◆ RewriteResponse() [1/2]

google_storage_api::RewriteResponse::RewriteResponse ( const Json::Value &  storage)
explicit

Standard constructor for an immutable data object instance.

Parameters
[in]storageThe underlying data storage for this instance.

◆ RewriteResponse() [2/2]

google_storage_api::RewriteResponse::RewriteResponse ( Json::Value *  storage)
explicit

Standard constructor for a mutable data object instance.

Parameters
[in]storageThe underlying data storage for this instance.

◆ ~RewriteResponse()

google_storage_api::RewriteResponse::~RewriteResponse ( )
virtual

Standard destructor.

Member Function Documentation

◆ clear_done()

void google_storage_api::RewriteResponse::clear_done ( )
inline

Clears the 'done' attribute.

◆ clear_kind()

void google_storage_api::RewriteResponse::clear_kind ( )
inline

Clears the 'kind' attribute.

◆ clear_object_size()

void google_storage_api::RewriteResponse::clear_object_size ( )
inline

Clears the 'objectSize' attribute.

◆ clear_resource()

void google_storage_api::RewriteResponse::clear_resource ( )
inline

Clears the 'resource' attribute.

◆ clear_rewrite_token()

void google_storage_api::RewriteResponse::clear_rewrite_token ( )
inline

Clears the 'rewriteToken' attribute.

◆ clear_total_bytes_rewritten()

void google_storage_api::RewriteResponse::clear_total_bytes_rewritten ( )
inline

Clears the 'totalBytesRewritten' attribute.

◆ get_done()

bool google_storage_api::RewriteResponse::get_done ( ) const
inline

Get the value of the 'done' attribute.

◆ get_kind()

const StringPiece google_storage_api::RewriteResponse::get_kind ( ) const
inline

Get the value of the 'kind' attribute.

◆ get_object_size()

int64 google_storage_api::RewriteResponse::get_object_size ( ) const
inline

Get the value of the 'objectSize' attribute.

◆ get_resource()

const Object google_storage_api::RewriteResponse::get_resource ( ) const

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

◆ get_rewrite_token()

const StringPiece google_storage_api::RewriteResponse::get_rewrite_token ( ) const
inline

Get the value of the 'rewriteToken' attribute.

◆ get_total_bytes_rewritten()

int64 google_storage_api::RewriteResponse::get_total_bytes_rewritten ( ) const
inline

Get the value of the 'totalBytesRewritten' attribute.

◆ GetTypeName()

const StringPiece google_storage_api::RewriteResponse::GetTypeName ( ) const
inline

Returns a string denoting the type of this data object.

Returns
google_storage_api::RewriteResponse

◆ has_done()

bool google_storage_api::RewriteResponse::has_done ( ) const
inline

Determine if the 'done' attribute was set.

Returns
true if the 'done' attribute was set.

◆ has_kind()

bool google_storage_api::RewriteResponse::has_kind ( ) const
inline

Determine if the 'kind' attribute was set.

Returns
true if the 'kind' attribute was set.

◆ has_object_size()

bool google_storage_api::RewriteResponse::has_object_size ( ) const
inline

Determine if the 'objectSize' attribute was set.

Returns
true if the 'objectSize' attribute was set.

◆ has_resource()

bool google_storage_api::RewriteResponse::has_resource ( ) const
inline

Determine if the 'resource' attribute was set.

Returns
true if the 'resource' attribute was set.

◆ has_rewrite_token()

bool google_storage_api::RewriteResponse::has_rewrite_token ( ) const
inline

Determine if the 'rewriteToken' attribute was set.

Returns
true if the 'rewriteToken' attribute was set.

◆ has_total_bytes_rewritten()

bool google_storage_api::RewriteResponse::has_total_bytes_rewritten ( ) const
inline

Determine if the 'totalBytesRewritten' attribute was set.

Returns
true if the 'totalBytesRewritten' attribute was set.

◆ mutable_resource()

Object google_storage_api::RewriteResponse::mutable_resource ( )

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

A resource containing the metadata for the copied-to object. This property is present in the response only when copying completes.

Returns
The result can be modified to change the attribute value.

◆ New()

RewriteResponse * google_storage_api::RewriteResponse::New ( )
static

Creates a new default instance.

Returns
Ownership is passed back to the caller.

◆ set_done()

void google_storage_api::RewriteResponse::set_done ( bool  value)
inline

Change the 'done' attribute.

true if the copy is finished; otherwise, false if the copy is in progress. This property is always present in the response.

Parameters
[in]valueThe new value.

◆ set_kind()

void google_storage_api::RewriteResponse::set_kind ( const StringPiece &  value)
inline

Change the 'kind' attribute.

The kind of item this is.

Parameters
[in]valueThe new value.

◆ set_object_size()

void google_storage_api::RewriteResponse::set_object_size ( int64  value)
inline

Change the 'objectSize' attribute.

The total size of the object being copied in bytes. This property is always present in the response.

Parameters
[in]valueThe new value.

◆ set_rewrite_token()

void google_storage_api::RewriteResponse::set_rewrite_token ( const StringPiece &  value)
inline

Change the 'rewriteToken' attribute.

A token to use in subsequent requests to continue copying data. This token is present in the response only when there is more data to copy.

Parameters
[in]valueThe new value.

◆ set_total_bytes_rewritten()

void google_storage_api::RewriteResponse::set_total_bytes_rewritten ( int64  value)
inline

Change the 'totalBytesRewritten' attribute.

The total bytes written so far, which can be used to provide a waiting user with a progress indicator. This property is always present in the response.

Parameters
[in]valueThe new value.

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