#include <policy.h>

Inheritance diagram for google_dns_api::Policy:

Public Member Functions
	Policy (const Json::Value &storage)

	Policy (Json::Value *storage)

virtual	~Policy ()

const StringPiece	GetTypeName () const

bool	has_alternative_name_server_config () const

void	clear_alternative_name_server_config ()

const PolicyAlternativeNameServerConfig	get_alternative_name_server_config () const

PolicyAlternativeNameServerConfig	mutable_alternativeNameServerConfig ()

bool	has_description () const

void	clear_description ()

const StringPiece	get_description () const

void	set_description (const StringPiece &value)

bool	has_enable_inbound_forwarding () const

void	clear_enable_inbound_forwarding ()

bool	get_enable_inbound_forwarding () const

void	set_enable_inbound_forwarding (bool value)

bool	has_enable_logging () const

void	clear_enable_logging ()

bool	get_enable_logging () const

void	set_enable_logging (bool value)

bool	has_id () const

void	clear_id ()

uint64	get_id () const

void	set_id (uint64 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_networks () const

void	clear_networks ()

const client::JsonCppArray< PolicyNetwork >	get_networks () const

client::JsonCppArray< PolicyNetwork >	mutable_networks ()

Static Public Member Functions
static Policy *	New ()

Detailed Description

A policy is a collection of DNS rules applied to one or more Virtual Private Cloud resources.

Constructor & Destructor Documentation

◆ Policy() [1/2]

google_dns_api::Policy::Policy ( const Json::Value & storage )

explicit

Standard constructor for an immutable data object instance.

Parameters

[in] storage The underlying data storage for this instance.

◆ Policy() [2/2]

google_dns_api::Policy::Policy ( Json::Value * storage )

explicit

Standard constructor for a mutable data object instance.

Parameters

[in] storage The underlying data storage for this instance.

◆ ~Policy()

google_dns_api::Policy::~Policy ( )

virtual

Standard destructor.

Member Function Documentation

◆ clear_alternative_name_server_config()

void google_dns_api::Policy::clear_alternative_name_server_config ( )

inline

Clears the 'alternativeNameServerConfig' attribute.

◆ clear_description()

void google_dns_api::Policy::clear_description ( )

inline

Clears the 'description' attribute.

◆ clear_enable_inbound_forwarding()

void google_dns_api::Policy::clear_enable_inbound_forwarding ( )

inline

Clears the 'enableInboundForwarding' attribute.

◆ clear_enable_logging()

void google_dns_api::Policy::clear_enable_logging ( )

inline

Clears the 'enableLogging' attribute.

◆ clear_id()

void google_dns_api::Policy::clear_id ( )

inline

Clears the 'id' attribute.

◆ clear_kind()

void google_dns_api::Policy::clear_kind ( )

inline

Clears the 'kind' attribute.

◆ clear_name()

void google_dns_api::Policy::clear_name ( )

inline

Clears the 'name' attribute.

◆ clear_networks()

void google_dns_api::Policy::clear_networks ( )

inline

Clears the 'networks' attribute.

◆ get_alternative_name_server_config()

const PolicyAlternativeNameServerConfig google_dns_api::Policy::get_alternative_name_server_config ( ) const

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

◆ get_description()

const StringPiece google_dns_api::Policy::get_description ( ) const

inline

Get the value of the 'description' attribute.

◆ get_enable_inbound_forwarding()

bool google_dns_api::Policy::get_enable_inbound_forwarding ( ) const

inline

Get the value of the 'enableInboundForwarding' attribute.

◆ get_enable_logging()

bool google_dns_api::Policy::get_enable_logging ( ) const

inline

Get the value of the 'enableLogging' attribute.

◆ get_id()

uint64 google_dns_api::Policy::get_id ( ) const

inline

Get the value of the 'id' attribute.

◆ get_kind()

const StringPiece google_dns_api::Policy::get_kind ( ) const

inline

Get the value of the 'kind' attribute.

◆ get_name()

const StringPiece google_dns_api::Policy::get_name ( ) const

inline

Get the value of the 'name' attribute.

◆ get_networks()

const client::JsonCppArray<PolicyNetwork > google_dns_api::Policy::get_networks ( ) const

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

◆ GetTypeName()

const StringPiece google_dns_api::Policy::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns: google_dns_api::Policy

◆ has_alternative_name_server_config()

bool google_dns_api::Policy::has_alternative_name_server_config ( ) const

inline

Determine if the 'alternativeNameServerConfig' attribute was set.

Returns: true if the 'alternativeNameServerConfig' attribute was set.

◆ has_description()

bool google_dns_api::Policy::has_description ( ) const

inline

Determine if the 'description' attribute was set.

Returns: true if the 'description' attribute was set.

◆ has_enable_inbound_forwarding()

bool google_dns_api::Policy::has_enable_inbound_forwarding ( ) const

inline

Determine if the 'enableInboundForwarding' attribute was set.

Returns: true if the 'enableInboundForwarding' attribute was set.

◆ has_enable_logging()

bool google_dns_api::Policy::has_enable_logging ( ) const

inline

Determine if the 'enableLogging' attribute was set.

Returns: true if the 'enableLogging' attribute was set.

◆ has_id()

bool google_dns_api::Policy::has_id ( ) const

inline

Determine if the 'id' attribute was set.

Returns: true if the 'id' attribute was set.

◆ has_kind()

bool google_dns_api::Policy::has_kind ( ) const

inline

Determine if the 'kind' attribute was set.

Returns: true if the 'kind' attribute was set.

◆ has_name()

bool google_dns_api::Policy::has_name ( ) const

inline

Determine if the 'name' attribute was set.

Returns: true if the 'name' attribute was set.

◆ has_networks()

bool google_dns_api::Policy::has_networks ( ) const

inline

Determine if the 'networks' attribute was set.

Returns: true if the 'networks' attribute was set.

◆ mutable_alternativeNameServerConfig()

PolicyAlternativeNameServerConfig google_dns_api::Policy::mutable_alternativeNameServerConfig ( )

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

Sets an alternative name server for the associated networks. When specified, all DNS queries are forwarded to a name server that you choose. Names such as .internal are not available when an alternative name server is specified.

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

◆ mutable_networks()

client::JsonCppArray<PolicyNetwork > google_dns_api::Policy::mutable_networks ( )

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

List of network names specifying networks to which this policy is applied.

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

◆ New()

Policy * google_dns_api::Policy::New ( )

static

Creates a new default instance.

Returns: Ownership is passed back to the caller.

◆ set_description()

void google_dns_api::Policy::set_description ( const StringPiece & value )

inline

Change the 'description' attribute.

A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the policy's function.

Parameters

[in] value The new value.

◆ set_enable_inbound_forwarding()

void google_dns_api::Policy::set_enable_inbound_forwarding ( bool value )

inline

Change the 'enableInboundForwarding' attribute.

Allows networks bound to this policy to receive DNS queries sent by VMs or applications over VPN connections. When enabled, a virtual IP address will be allocated from each of the sub-networks that are bound to this policy.

Parameters

[in] value The new value.

◆ set_enable_logging()

void google_dns_api::Policy::set_enable_logging ( bool value )

inline

Change the 'enableLogging' attribute.

Controls whether logging is enabled for the networks bound to this policy. Defaults to no logging if not set.

Parameters

[in] value The new value.

◆ set_id()

void google_dns_api::Policy::set_id ( uint64 value )

inline

Change the 'id' attribute.

Unique identifier for the resource; defined by the server (output only).

Parameters

[in] value The new value.

◆ set_kind()

void google_dns_api::Policy::set_kind ( const StringPiece & value )

inline

Change the 'kind' attribute.

Identifies what kind of resource this is. Value: the fixed string "dns#policy".

Parameters

[in] value The new value.

◆ set_name()

void google_dns_api::Policy::set_name ( const StringPiece & value )

inline

Change the 'name' attribute.

User assigned name for this policy.

Parameters

[in] value The new value.

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

google/dns_api/policy.h
google/dns_api/policy.cc

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Policy() [1/2]

◆ Policy() [2/2]

◆ ~Policy()

Member Function Documentation

◆ clear_alternative_name_server_config()

◆ clear_description()

◆ clear_enable_inbound_forwarding()

◆ clear_enable_logging()

◆ clear_id()

◆ clear_kind()

◆ clear_name()

◆ clear_networks()

◆ get_alternative_name_server_config()

◆ get_description()

◆ get_enable_inbound_forwarding()

◆ get_enable_logging()

◆ get_id()

◆ get_kind()

◆ get_name()

◆ get_networks()

◆ GetTypeName()

◆ has_alternative_name_server_config()

◆ has_description()

◆ has_enable_inbound_forwarding()

◆ has_enable_logging()

◆ has_id()

◆ has_kind()

◆ has_name()

◆ has_networks()

◆ mutable_alternativeNameServerConfig()

◆ mutable_networks()

◆ New()

◆ set_description()

◆ set_enable_inbound_forwarding()

◆ set_enable_logging()

◆ set_id()

◆ set_kind()

◆ set_name()