compute  v1
Public Member Functions | Static Public Member Functions | List of all members
google_compute_api::DiskInstantiationConfig Class Reference
Compute Engine API Data Objects

#include <disk_instantiation_config.h>

Inheritance diagram for google_compute_api::DiskInstantiationConfig:

Public Member Functions

 DiskInstantiationConfig (const Json::Value &storage)
 
 DiskInstantiationConfig (Json::Value *storage)
 
virtual ~DiskInstantiationConfig ()
 
const StringPiece GetTypeName () const
 
bool has_auto_delete () const
 
void clear_auto_delete ()
 
bool get_auto_delete () const
 
void set_auto_delete (bool value)
 
bool has_custom_image () const
 
void clear_custom_image ()
 
const StringPiece get_custom_image () const
 
void set_custom_image (const StringPiece &value)
 
bool has_device_name () const
 
void clear_device_name ()
 
const StringPiece get_device_name () const
 
void set_device_name (const StringPiece &value)
 
bool has_instantiate_from () const
 
void clear_instantiate_from ()
 
const StringPiece get_instantiate_from () const
 
void set_instantiate_from (const StringPiece &value)
 

Static Public Member Functions

static DiskInstantiationConfig * New ()
 

Detailed Description

A specification of the desired way to instantiate a disk in the instance template when its created from a source instance.

Constructor & Destructor Documentation

◆ DiskInstantiationConfig() [1/2]

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

Standard constructor for an immutable data object instance.

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

◆ DiskInstantiationConfig() [2/2]

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

Standard constructor for a mutable data object instance.

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

◆ ~DiskInstantiationConfig()

google_compute_api::DiskInstantiationConfig::~DiskInstantiationConfig ( )
virtual

Standard destructor.

Member Function Documentation

◆ clear_auto_delete()

void google_compute_api::DiskInstantiationConfig::clear_auto_delete ( )
inline

Clears the 'autoDelete' attribute.

◆ clear_custom_image()

void google_compute_api::DiskInstantiationConfig::clear_custom_image ( )
inline

Clears the 'customImage' attribute.

◆ clear_device_name()

void google_compute_api::DiskInstantiationConfig::clear_device_name ( )
inline

Clears the 'deviceName' attribute.

◆ clear_instantiate_from()

void google_compute_api::DiskInstantiationConfig::clear_instantiate_from ( )
inline

Clears the 'instantiateFrom' attribute.

◆ get_auto_delete()

bool google_compute_api::DiskInstantiationConfig::get_auto_delete ( ) const
inline

Get the value of the 'autoDelete' attribute.

◆ get_custom_image()

const StringPiece google_compute_api::DiskInstantiationConfig::get_custom_image ( ) const
inline

Get the value of the 'customImage' attribute.

◆ get_device_name()

const StringPiece google_compute_api::DiskInstantiationConfig::get_device_name ( ) const
inline

Get the value of the 'deviceName' attribute.

◆ get_instantiate_from()

const StringPiece google_compute_api::DiskInstantiationConfig::get_instantiate_from ( ) const
inline

Get the value of the 'instantiateFrom' attribute.

◆ GetTypeName()

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

Returns a string denoting the type of this data object.

Returns
google_compute_api::DiskInstantiationConfig

◆ has_auto_delete()

bool google_compute_api::DiskInstantiationConfig::has_auto_delete ( ) const
inline

Determine if the 'autoDelete' attribute was set.

Returns
true if the 'autoDelete' attribute was set.

◆ has_custom_image()

bool google_compute_api::DiskInstantiationConfig::has_custom_image ( ) const
inline

Determine if the 'customImage' attribute was set.

Returns
true if the 'customImage' attribute was set.

◆ has_device_name()

bool google_compute_api::DiskInstantiationConfig::has_device_name ( ) const
inline

Determine if the 'deviceName' attribute was set.

Returns
true if the 'deviceName' attribute was set.

◆ has_instantiate_from()

bool google_compute_api::DiskInstantiationConfig::has_instantiate_from ( ) const
inline

Determine if the 'instantiateFrom' attribute was set.

Returns
true if the 'instantiateFrom' attribute was set.

◆ New()

DiskInstantiationConfig * google_compute_api::DiskInstantiationConfig::New ( )
static

Creates a new default instance.

Returns
Ownership is passed back to the caller.

◆ set_auto_delete()

void google_compute_api::DiskInstantiationConfig::set_auto_delete ( bool  value)
inline

Change the 'autoDelete' attribute.

Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).

Parameters
[in]valueThe new value.

◆ set_custom_image()

void google_compute_api::DiskInstantiationConfig::set_custom_image ( const StringPiece &  value)
inline

Change the 'customImage' attribute.

The custom source image to be used to restore this disk when instantiating this instance template.

Parameters
[in]valueThe new value.

◆ set_device_name()

void google_compute_api::DiskInstantiationConfig::set_device_name ( const StringPiece &  value)
inline

Change the 'deviceName' attribute.

Specifies the device name of the disk to which the configurations apply to.

Parameters
[in]valueThe new value.

◆ set_instantiate_from()

void google_compute_api::DiskInstantiationConfig::set_instantiate_from ( const StringPiece &  value)
inline

Change the 'instantiateFrom' attribute.

Specifies whether to include the disk and what image to use. Possible values are:

source-image
to use the same image that was used to create the source instance's corresponding disk. Applicable to the boot disk and additional read-write disks.
source-image-family
to use the same image family that was used to create the source instance's corresponding disk. Applicable to the boot disk and additional read-write disks.
custom-image
to use a user-provided image url for disk creation. Applicable to the boot disk and additional read-write disks.
attach-read-only
to attach a read-only disk. Applicable to read-only disks.
do-not-include
to exclude a disk from the template. Applicable to additional read- write disks, local SSDs, and read-only disks.
Parameters
[in]valueThe new value.
The documentation for this class was generated from the following files: