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

#include <address.h>

Inheritance diagram for google_compute_api::Address:

Public Member Functions

 Address (const Json::Value &storage)
 
 Address (Json::Value *storage)
 
virtual ~Address ()
 
const StringPiece GetTypeName () const
 
bool has_address () const
 
void clear_address ()
 
const StringPiece get_address () const
 
void set_address (const StringPiece &value)
 
bool has_address_type () const
 
void clear_address_type ()
 
const StringPiece get_address_type () const
 
void set_address_type (const StringPiece &value)
 
bool has_creation_timestamp () const
 
void clear_creation_timestamp ()
 
const StringPiece get_creation_timestamp () const
 
void set_creation_timestamp (const StringPiece &value)
 
bool has_description () const
 
void clear_description ()
 
const StringPiece get_description () const
 
void set_description (const StringPiece &value)
 
bool has_id () const
 
void clear_id ()
 
uint64 get_id () const
 
void set_id (uint64 value)
 
bool has_ip_version () const
 
void clear_ip_version ()
 
const StringPiece get_ip_version () const
 
void set_ip_version (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_tier () const
 
void clear_network_tier ()
 
const StringPiece get_network_tier () const
 
void set_network_tier (const StringPiece &value)
 
bool has_prefix_length () const
 
void clear_prefix_length ()
 
int32 get_prefix_length () const
 
void set_prefix_length (int32 value)
 
bool has_purpose () const
 
void clear_purpose ()
 
const StringPiece get_purpose () const
 
void set_purpose (const StringPiece &value)
 
bool has_region () const
 
void clear_region ()
 
const StringPiece get_region () const
 
void set_region (const StringPiece &value)
 
bool has_self_link () const
 
void clear_self_link ()
 
const StringPiece get_self_link () const
 
void set_self_link (const StringPiece &value)
 
bool has_status () const
 
void clear_status ()
 
const StringPiece get_status () const
 
void set_status (const StringPiece &value)
 
bool has_subnetwork () const
 
void clear_subnetwork ()
 
const StringPiece get_subnetwork () const
 
void set_subnetwork (const StringPiece &value)
 
bool has_users () const
 
void clear_users ()
 
const client::JsonCppArray< string > get_users () const
 
client::JsonCppArray< string > mutable_users ()
 

Static Public Member Functions

static AddressNew ()
 

Detailed Description

A reserved address resource. (== resource_for beta.addresses ==) (== resource_for v1.addresses ==) (== resource_for beta.globalAddresses ==) (== resource_for v1.globalAddresses ==).

Constructor & Destructor Documentation

◆ Address() [1/2]

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

Standard constructor for an immutable data object instance.

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

◆ Address() [2/2]

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

Standard constructor for a mutable data object instance.

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

◆ ~Address()

google_compute_api::Address::~Address ( )
virtual

Standard destructor.

Member Function Documentation

◆ clear_address()

void google_compute_api::Address::clear_address ( )
inline

Clears the 'address' attribute.

◆ clear_address_type()

void google_compute_api::Address::clear_address_type ( )
inline

Clears the 'addressType' attribute.

◆ clear_creation_timestamp()

void google_compute_api::Address::clear_creation_timestamp ( )
inline

Clears the 'creationTimestamp' attribute.

◆ clear_description()

void google_compute_api::Address::clear_description ( )
inline

Clears the 'description' attribute.

◆ clear_id()

void google_compute_api::Address::clear_id ( )
inline

Clears the 'id' attribute.

◆ clear_ip_version()

void google_compute_api::Address::clear_ip_version ( )
inline

Clears the 'ipVersion' attribute.

◆ clear_kind()

void google_compute_api::Address::clear_kind ( )
inline

Clears the 'kind' attribute.

◆ clear_name()

void google_compute_api::Address::clear_name ( )
inline

Clears the 'name' attribute.

◆ clear_network()

void google_compute_api::Address::clear_network ( )
inline

Clears the 'network' attribute.

◆ clear_network_tier()

void google_compute_api::Address::clear_network_tier ( )
inline

Clears the 'networkTier' attribute.

◆ clear_prefix_length()

void google_compute_api::Address::clear_prefix_length ( )
inline

Clears the 'prefixLength' attribute.

◆ clear_purpose()

void google_compute_api::Address::clear_purpose ( )
inline

Clears the 'purpose' attribute.

◆ clear_region()

void google_compute_api::Address::clear_region ( )
inline

Clears the 'region' attribute.

◆ clear_self_link()

void google_compute_api::Address::clear_self_link ( )
inline

Clears the 'selfLink' attribute.

◆ clear_status()

void google_compute_api::Address::clear_status ( )
inline

Clears the 'status' attribute.

◆ clear_subnetwork()

void google_compute_api::Address::clear_subnetwork ( )
inline

Clears the 'subnetwork' attribute.

◆ clear_users()

void google_compute_api::Address::clear_users ( )
inline

Clears the 'users' attribute.

◆ get_address()

const StringPiece google_compute_api::Address::get_address ( ) const
inline

Get the value of the 'address' attribute.

◆ get_address_type()

const StringPiece google_compute_api::Address::get_address_type ( ) const
inline

Get the value of the 'addressType' attribute.

◆ get_creation_timestamp()

const StringPiece google_compute_api::Address::get_creation_timestamp ( ) const
inline

Get the value of the 'creationTimestamp' attribute.

◆ get_description()

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

Get the value of the 'description' attribute.

◆ get_id()

uint64 google_compute_api::Address::get_id ( ) const
inline

Get the value of the 'id' attribute.

◆ get_ip_version()

const StringPiece google_compute_api::Address::get_ip_version ( ) const
inline

Get the value of the 'ipVersion' attribute.

◆ get_kind()

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

Get the value of the 'kind' attribute.

◆ get_name()

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

Get the value of the 'name' attribute.

◆ get_network()

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

Get the value of the 'network' attribute.

◆ get_network_tier()

const StringPiece google_compute_api::Address::get_network_tier ( ) const
inline

Get the value of the 'networkTier' attribute.

◆ get_prefix_length()

int32 google_compute_api::Address::get_prefix_length ( ) const
inline

Get the value of the 'prefixLength' attribute.

◆ get_purpose()

const StringPiece google_compute_api::Address::get_purpose ( ) const
inline

Get the value of the 'purpose' attribute.

◆ get_region()

const StringPiece google_compute_api::Address::get_region ( ) const
inline

Get the value of the 'region' attribute.

◆ get_self_link()

const StringPiece google_compute_api::Address::get_self_link ( ) const
inline

Get the value of the 'selfLink' attribute.

◆ get_status()

const StringPiece google_compute_api::Address::get_status ( ) const
inline

Get the value of the 'status' attribute.

◆ get_subnetwork()

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

Get the value of the 'subnetwork' attribute.

◆ get_users()

const client::JsonCppArray<string > google_compute_api::Address::get_users ( ) const
inline

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

◆ GetTypeName()

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

Returns a string denoting the type of this data object.

Returns
google_compute_api::Address

◆ has_address()

bool google_compute_api::Address::has_address ( ) const
inline

Determine if the 'address' attribute was set.

Returns
true if the 'address' attribute was set.

◆ has_address_type()

bool google_compute_api::Address::has_address_type ( ) const
inline

Determine if the 'addressType' attribute was set.

Returns
true if the 'addressType' attribute was set.

◆ has_creation_timestamp()

bool google_compute_api::Address::has_creation_timestamp ( ) const
inline

Determine if the 'creationTimestamp' attribute was set.

Returns
true if the 'creationTimestamp' attribute was set.

◆ has_description()

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

Determine if the 'description' attribute was set.

Returns
true if the 'description' attribute was set.

◆ has_id()

bool google_compute_api::Address::has_id ( ) const
inline

Determine if the 'id' attribute was set.

Returns
true if the 'id' attribute was set.

◆ has_ip_version()

bool google_compute_api::Address::has_ip_version ( ) const
inline

Determine if the 'ipVersion' attribute was set.

Returns
true if the 'ipVersion' attribute was set.

◆ has_kind()

bool google_compute_api::Address::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::Address::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::Address::has_network ( ) const
inline

Determine if the 'network' attribute was set.

Returns
true if the 'network' attribute was set.

◆ has_network_tier()

bool google_compute_api::Address::has_network_tier ( ) const
inline

Determine if the 'networkTier' attribute was set.

Returns
true if the 'networkTier' attribute was set.

◆ has_prefix_length()

bool google_compute_api::Address::has_prefix_length ( ) const
inline

Determine if the 'prefixLength' attribute was set.

Returns
true if the 'prefixLength' attribute was set.

◆ has_purpose()

bool google_compute_api::Address::has_purpose ( ) const
inline

Determine if the 'purpose' attribute was set.

Returns
true if the 'purpose' attribute was set.

◆ has_region()

bool google_compute_api::Address::has_region ( ) const
inline

Determine if the 'region' attribute was set.

Returns
true if the 'region' attribute was set.

◆ has_self_link()

bool google_compute_api::Address::has_self_link ( ) const
inline

Determine if the 'selfLink' attribute was set.

Returns
true if the 'selfLink' attribute was set.

◆ has_status()

bool google_compute_api::Address::has_status ( ) const
inline

Determine if the 'status' attribute was set.

Returns
true if the 'status' attribute was set.

◆ has_subnetwork()

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

Determine if the 'subnetwork' attribute was set.

Returns
true if the 'subnetwork' attribute was set.

◆ has_users()

bool google_compute_api::Address::has_users ( ) const
inline

Determine if the 'users' attribute was set.

Returns
true if the 'users' attribute was set.

◆ mutable_users()

client::JsonCppArray<string > google_compute_api::Address::mutable_users ( )
inline

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

[Output Only] The URLs of the resources that are using this address.

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

◆ New()

Address * google_compute_api::Address::New ( )
static

Creates a new default instance.

Returns
Ownership is passed back to the caller.

◆ set_address()

void google_compute_api::Address::set_address ( const StringPiece &  value)
inline

Change the 'address' attribute.

The static IP address represented by this resource.

Parameters
[in]valueThe new value.

◆ set_address_type()

void google_compute_api::Address::set_address_type ( const StringPiece &  value)
inline

Change the 'addressType' attribute.

The type of address to reserve, either INTERNAL or EXTERNAL. If unspecified, defaults to EXTERNAL.

Parameters
[in]valueThe new value.

◆ set_creation_timestamp()

void google_compute_api::Address::set_creation_timestamp ( const StringPiece &  value)
inline

Change the 'creationTimestamp' attribute.

[Output Only] Creation timestamp in RFC3339 text format.

Parameters
[in]valueThe new value.

◆ set_description()

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

Change the 'description' attribute.

An optional description of this resource. Provide this property when you create the resource.

Parameters
[in]valueThe new value.

◆ set_id()

void google_compute_api::Address::set_id ( uint64  value)
inline

Change the 'id' attribute.

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

Parameters
[in]valueThe new value.

◆ set_ip_version()

void google_compute_api::Address::set_ip_version ( const StringPiece &  value)
inline

Change the 'ipVersion' attribute.

The IP Version that will be used by this address. Valid options are IPV4 or IPV6. This can only be specified for a global address.

Parameters
[in]valueThe new value.

◆ set_kind()

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

Change the 'kind' attribute.

[Output Only] Type of the resource. Always compute::address for addresses.

Parameters
[in]valueThe new value.

◆ set_name()

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

Change the 'name' attribute.

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

Parameters
[in]valueThe new value.

◆ set_network()

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

Change the 'network' attribute.

The URL of the network in which to reserve the address. This field can only be used with INTERNAL type with VPC_PEERING purpose.

Parameters
[in]valueThe new value.

◆ set_network_tier()

void google_compute_api::Address::set_network_tier ( const StringPiece &  value)
inline

Change the 'networkTier' attribute.

This signifies the networking tier used for configuring this Address and can only take the following values: PREMIUM, STANDARD. Global forwarding rules can only be Premium Tier. Regional forwarding rules can be either Premium or Standard Tier. Standard Tier addresses applied to regional forwarding rules can be used with any external load balancer. Regional forwarding rules in Premium Tier can only be used with a Network load balancer.

If this field is not specified, it is assumed to be PREMIUM.

Parameters
[in]valueThe new value.

◆ set_prefix_length()

void google_compute_api::Address::set_prefix_length ( int32  value)
inline

Change the 'prefixLength' attribute.

The prefix length if the resource reprensents an IP range.

Parameters
[in]valueThe new value.

◆ set_purpose()

void google_compute_api::Address::set_purpose ( const StringPiece &  value)
inline

Change the 'purpose' attribute.

The purpose of resource, only used with INTERNAL type.

Parameters
[in]valueThe new value.

◆ set_region()

void google_compute_api::Address::set_region ( const StringPiece &  value)
inline

Change the 'region' attribute.

[Output Only] URL of the region where the regional address resides. This field is not applicable to global addresses. You must specify this field as part of the HTTP request URL. You cannot set this field in the request body.

Parameters
[in]valueThe new value.

◆ set_self_link()

void google_compute_api::Address::set_self_link ( const StringPiece &  value)
inline

Change the 'selfLink' attribute.

[Output Only] Server-defined URL for the resource.

Parameters
[in]valueThe new value.

◆ set_status()

void google_compute_api::Address::set_status ( const StringPiece &  value)
inline

Change the 'status' attribute.

[Output Only] The status of the address, which can be one of RESERVING, RESERVED, or IN_USE. An address that is RESERVING is currently in the process of being reserved. A RESERVED address is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available.

Parameters
[in]valueThe new value.

◆ set_subnetwork()

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

Change the 'subnetwork' attribute.

The URL of the subnetwork in which to reserve the address. If an IP address is specified, it must be within the subnetwork's IP range. This field can only be used with INTERNAL type with GCE_ENDPOINT/DNS_RESOLVER purposes.

Parameters
[in]valueThe new value.

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