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

#include <network_interface.h>

Inheritance diagram for google_compute_api::NetworkInterface:

Public Member Functions

 NetworkInterface (const Json::Value &storage)
 
 NetworkInterface (Json::Value *storage)
 
virtual ~NetworkInterface ()
 
const StringPiece GetTypeName () const
 
bool has_access_configs () const
 
void clear_access_configs ()
 
const client::JsonCppArray< AccessConfigget_access_configs () const
 
client::JsonCppArray< AccessConfigmutable_accessConfigs ()
 
bool has_alias_ip_ranges () const
 
void clear_alias_ip_ranges ()
 
const client::JsonCppArray< AliasIpRangeget_alias_ip_ranges () const
 
client::JsonCppArray< AliasIpRangemutable_aliasIpRanges ()
 
bool has_fingerprint () const
 
void clear_fingerprint ()
 
const StringPiece get_fingerprint () const
 
void set_fingerprint (const StringPiece &value)
 
bool has_kind () const
 
void clear_kind ()
 
const StringPiece get_kind () const
 
void set_kind (const StringPiece &value)
 
bool has_name () const
 
void clear_name ()
 
const StringPiece get_name () const
 
void set_name (const StringPiece &value)
 
bool has_network () const
 
void clear_network ()
 
const StringPiece get_network () const
 
void set_network (const StringPiece &value)
 
bool has_network_ip () const
 
void clear_network_ip ()
 
const StringPiece get_network_ip () const
 
void set_network_ip (const StringPiece &value)
 
bool has_subnetwork () const
 
void clear_subnetwork ()
 
const StringPiece get_subnetwork () const
 
void set_subnetwork (const StringPiece &value)
 

Static Public Member Functions

static NetworkInterfaceNew ()
 

Detailed Description

A network interface resource attached to an instance.

Constructor & Destructor Documentation

◆ NetworkInterface() [1/2]

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

Standard constructor for an immutable data object instance.

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

◆ NetworkInterface() [2/2]

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

Standard constructor for a mutable data object instance.

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

◆ ~NetworkInterface()

google_compute_api::NetworkInterface::~NetworkInterface ( )
virtual

Standard destructor.

Member Function Documentation

◆ clear_access_configs()

void google_compute_api::NetworkInterface::clear_access_configs ( )
inline

Clears the 'accessConfigs' attribute.

◆ clear_alias_ip_ranges()

void google_compute_api::NetworkInterface::clear_alias_ip_ranges ( )
inline

Clears the 'aliasIpRanges' attribute.

◆ clear_fingerprint()

void google_compute_api::NetworkInterface::clear_fingerprint ( )
inline

Clears the 'fingerprint' attribute.

◆ clear_kind()

void google_compute_api::NetworkInterface::clear_kind ( )
inline

Clears the 'kind' attribute.

◆ clear_name()

void google_compute_api::NetworkInterface::clear_name ( )
inline

Clears the 'name' attribute.

◆ clear_network()

void google_compute_api::NetworkInterface::clear_network ( )
inline

Clears the 'network' attribute.

◆ clear_network_ip()

void google_compute_api::NetworkInterface::clear_network_ip ( )
inline

Clears the 'networkIP' attribute.

◆ clear_subnetwork()

void google_compute_api::NetworkInterface::clear_subnetwork ( )
inline

Clears the 'subnetwork' attribute.

◆ get_access_configs()

const client::JsonCppArray<AccessConfig > google_compute_api::NetworkInterface::get_access_configs ( ) const

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

◆ get_alias_ip_ranges()

const client::JsonCppArray<AliasIpRange > google_compute_api::NetworkInterface::get_alias_ip_ranges ( ) const

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

◆ get_fingerprint()

const StringPiece google_compute_api::NetworkInterface::get_fingerprint ( ) const
inline

Get the value of the 'fingerprint' attribute.

◆ get_kind()

const StringPiece google_compute_api::NetworkInterface::get_kind ( ) const
inline

Get the value of the 'kind' attribute.

◆ get_name()

const StringPiece google_compute_api::NetworkInterface::get_name ( ) const
inline

Get the value of the 'name' attribute.

◆ get_network()

const StringPiece google_compute_api::NetworkInterface::get_network ( ) const
inline

Get the value of the 'network' attribute.

◆ get_network_ip()

const StringPiece google_compute_api::NetworkInterface::get_network_ip ( ) const
inline

Get the value of the 'networkIP' attribute.

◆ get_subnetwork()

const StringPiece google_compute_api::NetworkInterface::get_subnetwork ( ) const
inline

Get the value of the 'subnetwork' attribute.

◆ GetTypeName()

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

Returns a string denoting the type of this data object.

Returns
google_compute_api::NetworkInterface

◆ has_access_configs()

bool google_compute_api::NetworkInterface::has_access_configs ( ) const
inline

Determine if the 'accessConfigs' attribute was set.

Returns
true if the 'accessConfigs' attribute was set.

◆ has_alias_ip_ranges()

bool google_compute_api::NetworkInterface::has_alias_ip_ranges ( ) const
inline

Determine if the 'aliasIpRanges' attribute was set.

Returns
true if the 'aliasIpRanges' attribute was set.

◆ has_fingerprint()

bool google_compute_api::NetworkInterface::has_fingerprint ( ) const
inline

Determine if the 'fingerprint' attribute was set.

Returns
true if the 'fingerprint' attribute was set.

◆ has_kind()

bool google_compute_api::NetworkInterface::has_kind ( ) const
inline

Determine if the 'kind' attribute was set.

Returns
true if the 'kind' attribute was set.

◆ has_name()

bool google_compute_api::NetworkInterface::has_name ( ) const
inline

Determine if the 'name' attribute was set.

Returns
true if the 'name' attribute was set.

◆ has_network()

bool google_compute_api::NetworkInterface::has_network ( ) const
inline

Determine if the 'network' attribute was set.

Returns
true if the 'network' attribute was set.

◆ has_network_ip()

bool google_compute_api::NetworkInterface::has_network_ip ( ) const
inline

Determine if the 'networkIP' attribute was set.

Returns
true if the 'networkIP' attribute was set.

◆ has_subnetwork()

bool google_compute_api::NetworkInterface::has_subnetwork ( ) const
inline

Determine if the 'subnetwork' attribute was set.

Returns
true if the 'subnetwork' attribute was set.

◆ mutable_accessConfigs()

client::JsonCppArray<AccessConfig > google_compute_api::NetworkInterface::mutable_accessConfigs ( )

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

An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access.

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

◆ mutable_aliasIpRanges()

client::JsonCppArray<AliasIpRange > google_compute_api::NetworkInterface::mutable_aliasIpRanges ( )

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

An array of alias IP ranges for this network interface. Can only be specified for network interfaces on subnet-mode networks.

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

◆ New()

NetworkInterface * google_compute_api::NetworkInterface::New ( )
static

Creates a new default instance.

Returns
Ownership is passed back to the caller.

◆ set_fingerprint()

void google_compute_api::NetworkInterface::set_fingerprint ( const StringPiece &  value)
inline

Change the 'fingerprint' attribute.

Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface, otherwise the request will fail with error 412 conditionNotMet.

Parameters
[in]valueThe new value.

◆ set_kind()

void google_compute_api::NetworkInterface::set_kind ( const StringPiece &  value)
inline

Change the 'kind' attribute.

[Output Only] Type of the resource. Always compute::networkInterface for network interfaces.

Parameters
[in]valueThe new value.

◆ set_name()

void google_compute_api::NetworkInterface::set_name ( const StringPiece &  value)
inline

Change the 'name' attribute.

[Output Only] The name of the network interface, generated by the server. For network devices, these are eth0, eth1, etc.

Parameters
[in]valueThe new value.

◆ set_network()

void google_compute_api::NetworkInterface::set_network ( const StringPiece &  value)
inline

Change the 'network' attribute.

URL of the network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used; if the network is not specified but the subnetwork is specified, the network is inferred.

This field is optional when creating a firewall rule. If not specified when creating a firewall rule, the default network global/networks/default is used.

If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:

Parameters
[in]valueThe new value.

◆ set_network_ip()

void google_compute_api::NetworkInterface::set_network_ip ( const StringPiece &  value)
inline

Change the 'networkIP' attribute.

An IPv4 internal network address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.

Parameters
[in]valueThe new value.

◆ set_subnetwork()

void google_compute_api::NetworkInterface::set_subnetwork ( const StringPiece &  value)
inline

Change the 'subnetwork' attribute.

The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not provide this property. If the network is in auto subnet mode, providing the subnetwork is optional. If the network is in custom subnet mode, then this field should be specified. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:

Parameters
[in]valueThe new value.

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