compute  v1
Public Member Functions | Static Public Member Functions | List of all members
google_compute_api::UsageExportLocation Class Reference

#include <usage_export_location.h>

Inheritance diagram for google_compute_api::UsageExportLocation:

Public Member Functions

 UsageExportLocation (const Json::Value &storage)
 
 UsageExportLocation (Json::Value *storage)
 
virtual ~UsageExportLocation ()
 
const StringPiece GetTypeName () const
 
bool has_bucket_name () const
 
void clear_bucket_name ()
 
const StringPiece get_bucket_name () const
 
void set_bucket_name (const StringPiece &value)
 
bool has_report_name_prefix () const
 
void clear_report_name_prefix ()
 
const StringPiece get_report_name_prefix () const
 
void set_report_name_prefix (const StringPiece &value)
 

Static Public Member Functions

static UsageExportLocationNew ()
 

Detailed Description

The location in Cloud Storage and naming method of the daily usage report. Contains bucket_name and report_name prefix.

Constructor & Destructor Documentation

◆ UsageExportLocation() [1/2]

google_compute_api::UsageExportLocation::UsageExportLocation ( const Json::Value &  storage)
explicit

Standard constructor for an immutable data object instance.

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

◆ UsageExportLocation() [2/2]

google_compute_api::UsageExportLocation::UsageExportLocation ( Json::Value *  storage)
explicit

Standard constructor for a mutable data object instance.

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

◆ ~UsageExportLocation()

google_compute_api::UsageExportLocation::~UsageExportLocation ( )
virtual

Standard destructor.

Member Function Documentation

◆ clear_bucket_name()

void google_compute_api::UsageExportLocation::clear_bucket_name ( )
inline

Clears the 'bucketName' attribute.

◆ clear_report_name_prefix()

void google_compute_api::UsageExportLocation::clear_report_name_prefix ( )
inline

Clears the 'reportNamePrefix' attribute.

◆ get_bucket_name()

const StringPiece google_compute_api::UsageExportLocation::get_bucket_name ( ) const
inline

Get the value of the 'bucketName' attribute.

◆ get_report_name_prefix()

const StringPiece google_compute_api::UsageExportLocation::get_report_name_prefix ( ) const
inline

Get the value of the 'reportNamePrefix' attribute.

◆ GetTypeName()

const StringPiece google_compute_api::UsageExportLocation::GetTypeName ( ) const
inline

Returns a string denoting the type of this data object.

Returns
google_compute_api::UsageExportLocation

◆ has_bucket_name()

bool google_compute_api::UsageExportLocation::has_bucket_name ( ) const
inline

Determine if the 'bucketName' attribute was set.

Returns
true if the 'bucketName' attribute was set.

◆ has_report_name_prefix()

bool google_compute_api::UsageExportLocation::has_report_name_prefix ( ) const
inline

Determine if the 'reportNamePrefix' attribute was set.

Returns
true if the 'reportNamePrefix' attribute was set.

◆ New()

UsageExportLocation * google_compute_api::UsageExportLocation::New ( )
static

Creates a new default instance.

Returns
Ownership is passed back to the caller.

◆ set_bucket_name()

void google_compute_api::UsageExportLocation::set_bucket_name ( const StringPiece &  value)
inline

Change the 'bucketName' attribute.

The name of an existing bucket in Cloud Storage where the usage report object is stored. The Google Service Account is granted write access to this bucket. This can either be the bucket name by itself, such as example- bucket, or the bucket name with gs:// or https://storage.googleapis.com/ in front of it, such as gs://example-bucket.

Parameters
[in]valueThe new value.

◆ set_report_name_prefix()

void google_compute_api::UsageExportLocation::set_report_name_prefix ( const StringPiece &  value)
inline

Change the 'reportNamePrefix' attribute.

An optional prefix for the name of the usage report object stored in bucketName. If not supplied, defaults to usage. The report is stored as a CSV file named report_name_prefix_gce_YYYYMMDD.csv where YYYYMMDD is the day of the usage according to Pacific Time. If you supply a prefix, it should conform to Cloud Storage object naming conventions.

Parameters
[in]valueThe new value.

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