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

#include <instance_properties.h>

Inheritance diagram for google_compute_api::InstanceProperties:

Public Member Functions

 InstanceProperties (const Json::Value &storage)
 
 InstanceProperties (Json::Value *storage)
 
virtual ~InstanceProperties ()
 
const StringPiece GetTypeName () const
 
bool has_can_ip_forward () const
 
void clear_can_ip_forward ()
 
bool get_can_ip_forward () const
 
void set_can_ip_forward (bool value)
 
bool has_description () const
 
void clear_description ()
 
const StringPiece get_description () const
 
void set_description (const StringPiece &value)
 
bool has_disks () const
 
void clear_disks ()
 
const client::JsonCppArray< AttachedDiskget_disks () const
 
client::JsonCppArray< AttachedDiskmutable_disks ()
 
bool has_guest_accelerators () const
 
void clear_guest_accelerators ()
 
const client::JsonCppArray< AcceleratorConfigget_guest_accelerators () const
 
client::JsonCppArray< AcceleratorConfigmutable_guestAccelerators ()
 
bool has_labels () const
 
void clear_labels ()
 
const client::JsonCppAssociativeArray< string > get_labels () const
 
client::JsonCppAssociativeArray< string > mutable_labels ()
 
bool has_machine_type () const
 
void clear_machine_type ()
 
const StringPiece get_machine_type () const
 
void set_machine_type (const StringPiece &value)
 
bool has_metadata () const
 
void clear_metadata ()
 
const Metadata get_metadata () const
 
Metadata mutable_metadata ()
 
bool has_min_cpu_platform () const
 
void clear_min_cpu_platform ()
 
const StringPiece get_min_cpu_platform () const
 
void set_min_cpu_platform (const StringPiece &value)
 
bool has_network_interfaces () const
 
void clear_network_interfaces ()
 
const client::JsonCppArray< NetworkInterfaceget_network_interfaces () const
 
client::JsonCppArray< NetworkInterfacemutable_networkInterfaces ()
 
bool has_scheduling () const
 
void clear_scheduling ()
 
const Scheduling get_scheduling () const
 
Scheduling mutable_scheduling ()
 
bool has_service_accounts () const
 
void clear_service_accounts ()
 
const client::JsonCppArray< ServiceAccountget_service_accounts () const
 
client::JsonCppArray< ServiceAccountmutable_serviceAccounts ()
 
bool has_shielded_instance_config () const
 
void clear_shielded_instance_config ()
 
const ShieldedInstanceConfig get_shielded_instance_config () const
 
ShieldedInstanceConfig mutable_shieldedInstanceConfig ()
 
bool has_tags () const
 
void clear_tags ()
 
const Tags get_tags () const
 
Tags mutable_tags ()
 

Static Public Member Functions

static InstancePropertiesNew ()
 

Detailed Description

No description provided.

Constructor & Destructor Documentation

◆ InstanceProperties() [1/2]

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

Standard constructor for an immutable data object instance.

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

◆ InstanceProperties() [2/2]

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

Standard constructor for a mutable data object instance.

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

◆ ~InstanceProperties()

google_compute_api::InstanceProperties::~InstanceProperties ( )
virtual

Standard destructor.

Member Function Documentation

◆ clear_can_ip_forward()

void google_compute_api::InstanceProperties::clear_can_ip_forward ( )
inline

Clears the 'canIpForward' attribute.

◆ clear_description()

void google_compute_api::InstanceProperties::clear_description ( )
inline

Clears the 'description' attribute.

◆ clear_disks()

void google_compute_api::InstanceProperties::clear_disks ( )
inline

Clears the 'disks' attribute.

◆ clear_guest_accelerators()

void google_compute_api::InstanceProperties::clear_guest_accelerators ( )
inline

Clears the 'guestAccelerators' attribute.

◆ clear_labels()

void google_compute_api::InstanceProperties::clear_labels ( )
inline

Clears the 'labels' attribute.

◆ clear_machine_type()

void google_compute_api::InstanceProperties::clear_machine_type ( )
inline

Clears the 'machineType' attribute.

◆ clear_metadata()

void google_compute_api::InstanceProperties::clear_metadata ( )
inline

Clears the 'metadata' attribute.

◆ clear_min_cpu_platform()

void google_compute_api::InstanceProperties::clear_min_cpu_platform ( )
inline

Clears the 'minCpuPlatform' attribute.

◆ clear_network_interfaces()

void google_compute_api::InstanceProperties::clear_network_interfaces ( )
inline

Clears the 'networkInterfaces' attribute.

◆ clear_scheduling()

void google_compute_api::InstanceProperties::clear_scheduling ( )
inline

Clears the 'scheduling' attribute.

◆ clear_service_accounts()

void google_compute_api::InstanceProperties::clear_service_accounts ( )
inline

Clears the 'serviceAccounts' attribute.

◆ clear_shielded_instance_config()

void google_compute_api::InstanceProperties::clear_shielded_instance_config ( )
inline

Clears the 'shieldedInstanceConfig' attribute.

◆ clear_tags()

void google_compute_api::InstanceProperties::clear_tags ( )
inline

Clears the 'tags' attribute.

◆ get_can_ip_forward()

bool google_compute_api::InstanceProperties::get_can_ip_forward ( ) const
inline

Get the value of the 'canIpForward' attribute.

◆ get_description()

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

Get the value of the 'description' attribute.

◆ get_disks()

const client::JsonCppArray<AttachedDisk > google_compute_api::InstanceProperties::get_disks ( ) const

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

◆ get_guest_accelerators()

const client::JsonCppArray<AcceleratorConfig > google_compute_api::InstanceProperties::get_guest_accelerators ( ) const

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

◆ get_labels()

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

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

◆ get_machine_type()

const StringPiece google_compute_api::InstanceProperties::get_machine_type ( ) const
inline

Get the value of the 'machineType' attribute.

◆ get_metadata()

const Metadata google_compute_api::InstanceProperties::get_metadata ( ) const

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

◆ get_min_cpu_platform()

const StringPiece google_compute_api::InstanceProperties::get_min_cpu_platform ( ) const
inline

Get the value of the 'minCpuPlatform' attribute.

◆ get_network_interfaces()

const client::JsonCppArray<NetworkInterface > google_compute_api::InstanceProperties::get_network_interfaces ( ) const

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

◆ get_scheduling()

const Scheduling google_compute_api::InstanceProperties::get_scheduling ( ) const

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

◆ get_service_accounts()

const client::JsonCppArray<ServiceAccount > google_compute_api::InstanceProperties::get_service_accounts ( ) const

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

◆ get_shielded_instance_config()

const ShieldedInstanceConfig google_compute_api::InstanceProperties::get_shielded_instance_config ( ) const

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

◆ get_tags()

const Tags google_compute_api::InstanceProperties::get_tags ( ) const

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

◆ GetTypeName()

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

Returns a string denoting the type of this data object.

Returns
google_compute_api::InstanceProperties

◆ has_can_ip_forward()

bool google_compute_api::InstanceProperties::has_can_ip_forward ( ) const
inline

Determine if the 'canIpForward' attribute was set.

Returns
true if the 'canIpForward' attribute was set.

◆ has_description()

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

Determine if the 'description' attribute was set.

Returns
true if the 'description' attribute was set.

◆ has_disks()

bool google_compute_api::InstanceProperties::has_disks ( ) const
inline

Determine if the 'disks' attribute was set.

Returns
true if the 'disks' attribute was set.

◆ has_guest_accelerators()

bool google_compute_api::InstanceProperties::has_guest_accelerators ( ) const
inline

Determine if the 'guestAccelerators' attribute was set.

Returns
true if the 'guestAccelerators' attribute was set.

◆ has_labels()

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

Determine if the 'labels' attribute was set.

Returns
true if the 'labels' attribute was set.

◆ has_machine_type()

bool google_compute_api::InstanceProperties::has_machine_type ( ) const
inline

Determine if the 'machineType' attribute was set.

Returns
true if the 'machineType' attribute was set.

◆ has_metadata()

bool google_compute_api::InstanceProperties::has_metadata ( ) const
inline

Determine if the 'metadata' attribute was set.

Returns
true if the 'metadata' attribute was set.

◆ has_min_cpu_platform()

bool google_compute_api::InstanceProperties::has_min_cpu_platform ( ) const
inline

Determine if the 'minCpuPlatform' attribute was set.

Returns
true if the 'minCpuPlatform' attribute was set.

◆ has_network_interfaces()

bool google_compute_api::InstanceProperties::has_network_interfaces ( ) const
inline

Determine if the 'networkInterfaces' attribute was set.

Returns
true if the 'networkInterfaces' attribute was set.

◆ has_scheduling()

bool google_compute_api::InstanceProperties::has_scheduling ( ) const
inline

Determine if the 'scheduling' attribute was set.

Returns
true if the 'scheduling' attribute was set.

◆ has_service_accounts()

bool google_compute_api::InstanceProperties::has_service_accounts ( ) const
inline

Determine if the 'serviceAccounts' attribute was set.

Returns
true if the 'serviceAccounts' attribute was set.

◆ has_shielded_instance_config()

bool google_compute_api::InstanceProperties::has_shielded_instance_config ( ) const
inline

Determine if the 'shieldedInstanceConfig' attribute was set.

Returns
true if the 'shieldedInstanceConfig' attribute was set.

◆ has_tags()

bool google_compute_api::InstanceProperties::has_tags ( ) const
inline

Determine if the 'tags' attribute was set.

Returns
true if the 'tags' attribute was set.

◆ mutable_disks()

client::JsonCppArray<AttachedDisk > google_compute_api::InstanceProperties::mutable_disks ( )

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

An array of disks that are associated with the instances that are created from this template.

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

◆ mutable_guestAccelerators()

client::JsonCppArray<AcceleratorConfig > google_compute_api::InstanceProperties::mutable_guestAccelerators ( )

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

A list of guest accelerator cards' type and count to use for instances created from the instance template.

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

◆ mutable_labels()

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

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

Labels to apply to instances that are created from this template.

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

◆ mutable_metadata()

Metadata google_compute_api::InstanceProperties::mutable_metadata ( )

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

The metadata key/value pairs to assign to instances that are created from this template. These pairs can consist of custom metadata or predefined keys. See Project and instance metadata for more information.

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

◆ mutable_networkInterfaces()

client::JsonCppArray<NetworkInterface > google_compute_api::InstanceProperties::mutable_networkInterfaces ( )

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

An array of network access configurations for this interface.

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

◆ mutable_scheduling()

Scheduling google_compute_api::InstanceProperties::mutable_scheduling ( )

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

Specifies the scheduling options for the instances that are created from this template.

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

◆ mutable_serviceAccounts()

client::JsonCppArray<ServiceAccount > google_compute_api::InstanceProperties::mutable_serviceAccounts ( )

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

A list of service accounts with specified scopes. Access tokens for these service accounts are available to the instances that are created from this template. Use metadata queries to obtain the access tokens for these instances.

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

◆ mutable_shieldedInstanceConfig()

ShieldedInstanceConfig google_compute_api::InstanceProperties::mutable_shieldedInstanceConfig ( )

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

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

◆ mutable_tags()

Tags google_compute_api::InstanceProperties::mutable_tags ( )

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

A list of tags to apply to the instances that are created from this template. The tags identify valid sources or targets for network firewalls. The setTags method can modify this list of tags. Each tag within the list must comply with RFC1035.

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

◆ New()

InstanceProperties * google_compute_api::InstanceProperties::New ( )
static

Creates a new default instance.

Returns
Ownership is passed back to the caller.

◆ set_can_ip_forward()

void google_compute_api::InstanceProperties::set_can_ip_forward ( bool  value)
inline

Change the 'canIpForward' attribute.

Enables instances created based on this template to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, specify true. If unsure, leave this set to false. See the Enable IP forwarding documentation for more information.

Parameters
[in]valueThe new value.

◆ set_description()

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

Change the 'description' attribute.

An optional text description for the instances that are created from this instance template.

Parameters
[in]valueThe new value.

◆ set_machine_type()

void google_compute_api::InstanceProperties::set_machine_type ( const StringPiece &  value)
inline

Change the 'machineType' attribute.

The machine type to use for instances that are created from this template.

Parameters
[in]valueThe new value.

◆ set_min_cpu_platform()

void google_compute_api::InstanceProperties::set_min_cpu_platform ( const StringPiece &  value)
inline

Change the 'minCpuPlatform' attribute.

Minimum cpu/platform to be used by this instance. The instance may be scheduled on the specified or newer cpu/platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: "Intel Haswell" or minCpuPlatform: "Intel Sandy Bridge". For more information, read Specifying a Minimum CPU Platform.

Parameters
[in]valueThe new value.

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