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

#include <attached_disk_initialize_params.h>

Inheritance diagram for google_compute_api::AttachedDiskInitializeParams:

Public Member Functions

 AttachedDiskInitializeParams (const Json::Value &storage)
 
 AttachedDiskInitializeParams (Json::Value *storage)
 
virtual ~AttachedDiskInitializeParams ()
 
const StringPiece GetTypeName () const
 
bool has_description () const
 
void clear_description ()
 
const StringPiece get_description () const
 
void set_description (const StringPiece &value)
 
bool has_disk_name () const
 
void clear_disk_name ()
 
const StringPiece get_disk_name () const
 
void set_disk_name (const StringPiece &value)
 
bool has_disk_size_gb () const
 
void clear_disk_size_gb ()
 
int64 get_disk_size_gb () const
 
void set_disk_size_gb (int64 value)
 
bool has_disk_type () const
 
void clear_disk_type ()
 
const StringPiece get_disk_type () const
 
void set_disk_type (const StringPiece &value)
 
bool has_labels () const
 
void clear_labels ()
 
const client::JsonCppAssociativeArray< string > get_labels () const
 
client::JsonCppAssociativeArray< string > mutable_labels ()
 
bool has_source_image () const
 
void clear_source_image ()
 
const StringPiece get_source_image () const
 
void set_source_image (const StringPiece &value)
 
bool has_source_image_encryption_key () const
 
void clear_source_image_encryption_key ()
 
const CustomerEncryptionKey get_source_image_encryption_key () const
 
CustomerEncryptionKey mutable_sourceImageEncryptionKey ()
 

Static Public Member Functions

static AttachedDiskInitializeParamsNew ()
 

Detailed Description

[Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.

This property is mutually exclusive with the source property; you can only define one or the other, but not both.

Constructor & Destructor Documentation

◆ AttachedDiskInitializeParams() [1/2]

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

Standard constructor for an immutable data object instance.

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

◆ AttachedDiskInitializeParams() [2/2]

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

Standard constructor for a mutable data object instance.

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

◆ ~AttachedDiskInitializeParams()

google_compute_api::AttachedDiskInitializeParams::~AttachedDiskInitializeParams ( )
virtual

Standard destructor.

Member Function Documentation

◆ clear_description()

void google_compute_api::AttachedDiskInitializeParams::clear_description ( )
inline

Clears the 'description' attribute.

◆ clear_disk_name()

void google_compute_api::AttachedDiskInitializeParams::clear_disk_name ( )
inline

Clears the 'diskName' attribute.

◆ clear_disk_size_gb()

void google_compute_api::AttachedDiskInitializeParams::clear_disk_size_gb ( )
inline

Clears the 'diskSizeGb' attribute.

◆ clear_disk_type()

void google_compute_api::AttachedDiskInitializeParams::clear_disk_type ( )
inline

Clears the 'diskType' attribute.

◆ clear_labels()

void google_compute_api::AttachedDiskInitializeParams::clear_labels ( )
inline

Clears the 'labels' attribute.

◆ clear_source_image()

void google_compute_api::AttachedDiskInitializeParams::clear_source_image ( )
inline

Clears the 'sourceImage' attribute.

◆ clear_source_image_encryption_key()

void google_compute_api::AttachedDiskInitializeParams::clear_source_image_encryption_key ( )
inline

Clears the 'sourceImageEncryptionKey' attribute.

◆ get_description()

const StringPiece google_compute_api::AttachedDiskInitializeParams::get_description ( ) const
inline

Get the value of the 'description' attribute.

◆ get_disk_name()

const StringPiece google_compute_api::AttachedDiskInitializeParams::get_disk_name ( ) const
inline

Get the value of the 'diskName' attribute.

◆ get_disk_size_gb()

int64 google_compute_api::AttachedDiskInitializeParams::get_disk_size_gb ( ) const
inline

Get the value of the 'diskSizeGb' attribute.

◆ get_disk_type()

const StringPiece google_compute_api::AttachedDiskInitializeParams::get_disk_type ( ) const
inline

Get the value of the 'diskType' attribute.

◆ get_labels()

const client::JsonCppAssociativeArray<string > google_compute_api::AttachedDiskInitializeParams::get_labels ( ) const
inline

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

◆ get_source_image()

const StringPiece google_compute_api::AttachedDiskInitializeParams::get_source_image ( ) const
inline

Get the value of the 'sourceImage' attribute.

◆ get_source_image_encryption_key()

const CustomerEncryptionKey google_compute_api::AttachedDiskInitializeParams::get_source_image_encryption_key ( ) const

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

◆ GetTypeName()

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

Returns a string denoting the type of this data object.

Returns
google_compute_api::AttachedDiskInitializeParams

◆ has_description()

bool google_compute_api::AttachedDiskInitializeParams::has_description ( ) const
inline

Determine if the 'description' attribute was set.

Returns
true if the 'description' attribute was set.

◆ has_disk_name()

bool google_compute_api::AttachedDiskInitializeParams::has_disk_name ( ) const
inline

Determine if the 'diskName' attribute was set.

Returns
true if the 'diskName' attribute was set.

◆ has_disk_size_gb()

bool google_compute_api::AttachedDiskInitializeParams::has_disk_size_gb ( ) const
inline

Determine if the 'diskSizeGb' attribute was set.

Returns
true if the 'diskSizeGb' attribute was set.

◆ has_disk_type()

bool google_compute_api::AttachedDiskInitializeParams::has_disk_type ( ) const
inline

Determine if the 'diskType' attribute was set.

Returns
true if the 'diskType' attribute was set.

◆ has_labels()

bool google_compute_api::AttachedDiskInitializeParams::has_labels ( ) const
inline

Determine if the 'labels' attribute was set.

Returns
true if the 'labels' attribute was set.

◆ has_source_image()

bool google_compute_api::AttachedDiskInitializeParams::has_source_image ( ) const
inline

Determine if the 'sourceImage' attribute was set.

Returns
true if the 'sourceImage' attribute was set.

◆ has_source_image_encryption_key()

bool google_compute_api::AttachedDiskInitializeParams::has_source_image_encryption_key ( ) const
inline

Determine if the 'sourceImageEncryptionKey' attribute was set.

Returns
true if the 'sourceImageEncryptionKey' attribute was set.

◆ mutable_labels()

client::JsonCppAssociativeArray<string > google_compute_api::AttachedDiskInitializeParams::mutable_labels ( )
inline

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

Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks.

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

◆ mutable_sourceImageEncryptionKey()

CustomerEncryptionKey google_compute_api::AttachedDiskInitializeParams::mutable_sourceImageEncryptionKey ( )

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

The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.

Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.

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

◆ New()

AttachedDiskInitializeParams * google_compute_api::AttachedDiskInitializeParams::New ( )
static

Creates a new default instance.

Returns
Ownership is passed back to the caller.

◆ set_description()

void google_compute_api::AttachedDiskInitializeParams::set_description ( const StringPiece &  value)
inline

Change the 'description' attribute.

An optional description. Provide this property when creating the disk.

Parameters
[in]valueThe new value.

◆ set_disk_name()

void google_compute_api::AttachedDiskInitializeParams::set_disk_name ( const StringPiece &  value)
inline

Change the 'diskName' attribute.

Specifies the disk name. If not specified, the default is to use the name of the instance. If the disk with the instance name exists already in the given zone/region, a new name will be automatically generated.

Parameters
[in]valueThe new value.

◆ set_disk_size_gb()

void google_compute_api::AttachedDiskInitializeParams::set_disk_size_gb ( int64  value)
inline

Change the 'diskSizeGb' attribute.

Specifies the size of the disk in base-2 GB.

Parameters
[in]valueThe new value.

◆ set_disk_type()

void google_compute_api::AttachedDiskInitializeParams::set_disk_type ( const StringPiece &  value)
inline

Change the 'diskType' attribute.

Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example: https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes /pd-standard

pd
ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values:.
https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskT ypes/diskType
projects/project/zones/zone/diskTypes/diskType.
Parameters
[in]valueThe new value.

◆ set_source_image()

void google_compute_api::AttachedDiskInitializeParams::set_source_image ( const StringPiece &  value)
inline

Change the 'sourceImage' attribute.

family/debian
9 to use the latest Debian 9 image:.
projects/debian-cloud/global/images/family/debian
9.

projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD

To create a disk with a custom image that you created, specify the image name in the following format: global/images/my-custom-image

You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name: global/images/family/my-image-family

If the source image is deleted later, this field will not be set.

Parameters
[in]valueThe new value.

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