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

#include <firewall.h>

Inheritance diagram for google_compute_api::Firewall:

Classes

class  FirewallAllowed
 
class  FirewallDenied
 

Public Member Functions

 Firewall (const Json::Value &storage)
 
 Firewall (Json::Value *storage)
 
virtual ~Firewall ()
 
const StringPiece GetTypeName () const
 
bool has_allowed () const
 
void clear_allowed ()
 
const client::JsonCppArray< FirewallAllowedget_allowed () const
 
client::JsonCppArray< FirewallAllowedmutable_allowed ()
 
bool has_creation_timestamp () const
 
void clear_creation_timestamp ()
 
const StringPiece get_creation_timestamp () const
 
void set_creation_timestamp (const StringPiece &value)
 
bool has_denied () const
 
void clear_denied ()
 
const client::JsonCppArray< FirewallDeniedget_denied () const
 
client::JsonCppArray< FirewallDeniedmutable_denied ()
 
bool has_description () const
 
void clear_description ()
 
const StringPiece get_description () const
 
void set_description (const StringPiece &value)
 
bool has_destination_ranges () const
 
void clear_destination_ranges ()
 
const client::JsonCppArray< string > get_destination_ranges () const
 
client::JsonCppArray< string > mutable_destinationRanges ()
 
bool has_direction () const
 
void clear_direction ()
 
const StringPiece get_direction () const
 
void set_direction (const StringPiece &value)
 
bool has_disabled () const
 
void clear_disabled ()
 
bool get_disabled () const
 
void set_disabled (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_log_config () const
 
void clear_log_config ()
 
const FirewallLogConfig get_log_config () const
 
FirewallLogConfig mutable_logConfig ()
 
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_priority () const
 
void clear_priority ()
 
int32 get_priority () const
 
void set_priority (int32 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_source_ranges () const
 
void clear_source_ranges ()
 
const client::JsonCppArray< string > get_source_ranges () const
 
client::JsonCppArray< string > mutable_sourceRanges ()
 
bool has_source_service_accounts () const
 
void clear_source_service_accounts ()
 
const client::JsonCppArray< string > get_source_service_accounts () const
 
client::JsonCppArray< string > mutable_sourceServiceAccounts ()
 
bool has_source_tags () const
 
void clear_source_tags ()
 
const client::JsonCppArray< string > get_source_tags () const
 
client::JsonCppArray< string > mutable_sourceTags ()
 
bool has_target_service_accounts () const
 
void clear_target_service_accounts ()
 
const client::JsonCppArray< string > get_target_service_accounts () const
 
client::JsonCppArray< string > mutable_targetServiceAccounts ()
 
bool has_target_tags () const
 
void clear_target_tags ()
 
const client::JsonCppArray< string > get_target_tags () const
 
client::JsonCppArray< string > mutable_targetTags ()
 

Static Public Member Functions

static FirewallNew ()
 

Detailed Description

Represents a Firewall resource.

Constructor & Destructor Documentation

◆ Firewall() [1/2]

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

Standard constructor for an immutable data object instance.

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

◆ Firewall() [2/2]

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

Standard constructor for a mutable data object instance.

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

◆ ~Firewall()

google_compute_api::Firewall::~Firewall ( )
virtual

Standard destructor.

Member Function Documentation

◆ clear_allowed()

void google_compute_api::Firewall::clear_allowed ( )
inline

Clears the 'allowed' attribute.

◆ clear_creation_timestamp()

void google_compute_api::Firewall::clear_creation_timestamp ( )
inline

Clears the 'creationTimestamp' attribute.

◆ clear_denied()

void google_compute_api::Firewall::clear_denied ( )
inline

Clears the 'denied' attribute.

◆ clear_description()

void google_compute_api::Firewall::clear_description ( )
inline

Clears the 'description' attribute.

◆ clear_destination_ranges()

void google_compute_api::Firewall::clear_destination_ranges ( )
inline

Clears the 'destinationRanges' attribute.

◆ clear_direction()

void google_compute_api::Firewall::clear_direction ( )
inline

Clears the 'direction' attribute.

◆ clear_disabled()

void google_compute_api::Firewall::clear_disabled ( )
inline

Clears the 'disabled' attribute.

◆ clear_id()

void google_compute_api::Firewall::clear_id ( )
inline

Clears the 'id' attribute.

◆ clear_kind()

void google_compute_api::Firewall::clear_kind ( )
inline

Clears the 'kind' attribute.

◆ clear_log_config()

void google_compute_api::Firewall::clear_log_config ( )
inline

Clears the 'logConfig' attribute.

◆ clear_name()

void google_compute_api::Firewall::clear_name ( )
inline

Clears the 'name' attribute.

◆ clear_network()

void google_compute_api::Firewall::clear_network ( )
inline

Clears the 'network' attribute.

◆ clear_priority()

void google_compute_api::Firewall::clear_priority ( )
inline

Clears the 'priority' attribute.

◆ clear_self_link()

void google_compute_api::Firewall::clear_self_link ( )
inline

Clears the 'selfLink' attribute.

◆ clear_source_ranges()

void google_compute_api::Firewall::clear_source_ranges ( )
inline

Clears the 'sourceRanges' attribute.

◆ clear_source_service_accounts()

void google_compute_api::Firewall::clear_source_service_accounts ( )
inline

Clears the 'sourceServiceAccounts' attribute.

◆ clear_source_tags()

void google_compute_api::Firewall::clear_source_tags ( )
inline

Clears the 'sourceTags' attribute.

◆ clear_target_service_accounts()

void google_compute_api::Firewall::clear_target_service_accounts ( )
inline

Clears the 'targetServiceAccounts' attribute.

◆ clear_target_tags()

void google_compute_api::Firewall::clear_target_tags ( )
inline

Clears the 'targetTags' attribute.

◆ get_allowed()

const client::JsonCppArray<FirewallAllowed > google_compute_api::Firewall::get_allowed ( ) const
inline

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

◆ get_creation_timestamp()

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

Get the value of the 'creationTimestamp' attribute.

◆ get_denied()

const client::JsonCppArray<FirewallDenied > google_compute_api::Firewall::get_denied ( ) const
inline

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

◆ get_description()

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

Get the value of the 'description' attribute.

◆ get_destination_ranges()

const client::JsonCppArray<string > google_compute_api::Firewall::get_destination_ranges ( ) const
inline

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

◆ get_direction()

const StringPiece google_compute_api::Firewall::get_direction ( ) const
inline

Get the value of the 'direction' attribute.

◆ get_disabled()

bool google_compute_api::Firewall::get_disabled ( ) const
inline

Get the value of the 'disabled' attribute.

◆ get_id()

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

Get the value of the 'id' attribute.

◆ get_kind()

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

Get the value of the 'kind' attribute.

◆ get_log_config()

const FirewallLogConfig google_compute_api::Firewall::get_log_config ( ) const

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

◆ get_name()

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

Get the value of the 'name' attribute.

◆ get_network()

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

Get the value of the 'network' attribute.

◆ get_priority()

int32 google_compute_api::Firewall::get_priority ( ) const
inline

Get the value of the 'priority' attribute.

◆ get_self_link()

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

Get the value of the 'selfLink' attribute.

◆ get_source_ranges()

const client::JsonCppArray<string > google_compute_api::Firewall::get_source_ranges ( ) const
inline

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

◆ get_source_service_accounts()

const client::JsonCppArray<string > google_compute_api::Firewall::get_source_service_accounts ( ) const
inline

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

◆ get_source_tags()

const client::JsonCppArray<string > google_compute_api::Firewall::get_source_tags ( ) const
inline

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

◆ get_target_service_accounts()

const client::JsonCppArray<string > google_compute_api::Firewall::get_target_service_accounts ( ) const
inline

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

◆ get_target_tags()

const client::JsonCppArray<string > google_compute_api::Firewall::get_target_tags ( ) const
inline

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

◆ GetTypeName()

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

Returns a string denoting the type of this data object.

Returns
google_compute_api::Firewall

◆ has_allowed()

bool google_compute_api::Firewall::has_allowed ( ) const
inline

Determine if the 'allowed' attribute was set.

Returns
true if the 'allowed' attribute was set.

◆ has_creation_timestamp()

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

Determine if the 'creationTimestamp' attribute was set.

Returns
true if the 'creationTimestamp' attribute was set.

◆ has_denied()

bool google_compute_api::Firewall::has_denied ( ) const
inline

Determine if the 'denied' attribute was set.

Returns
true if the 'denied' attribute was set.

◆ has_description()

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

Determine if the 'description' attribute was set.

Returns
true if the 'description' attribute was set.

◆ has_destination_ranges()

bool google_compute_api::Firewall::has_destination_ranges ( ) const
inline

Determine if the 'destinationRanges' attribute was set.

Returns
true if the 'destinationRanges' attribute was set.

◆ has_direction()

bool google_compute_api::Firewall::has_direction ( ) const
inline

Determine if the 'direction' attribute was set.

Returns
true if the 'direction' attribute was set.

◆ has_disabled()

bool google_compute_api::Firewall::has_disabled ( ) const
inline

Determine if the 'disabled' attribute was set.

Returns
true if the 'disabled' attribute was set.

◆ has_id()

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

Determine if the 'id' attribute was set.

Returns
true if the 'id' attribute was set.

◆ has_kind()

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

Determine if the 'kind' attribute was set.

Returns
true if the 'kind' attribute was set.

◆ has_log_config()

bool google_compute_api::Firewall::has_log_config ( ) const
inline

Determine if the 'logConfig' attribute was set.

Returns
true if the 'logConfig' attribute was set.

◆ has_name()

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

Determine if the 'network' attribute was set.

Returns
true if the 'network' attribute was set.

◆ has_priority()

bool google_compute_api::Firewall::has_priority ( ) const
inline

Determine if the 'priority' attribute was set.

Returns
true if the 'priority' attribute was set.

◆ has_self_link()

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

Determine if the 'selfLink' attribute was set.

Returns
true if the 'selfLink' attribute was set.

◆ has_source_ranges()

bool google_compute_api::Firewall::has_source_ranges ( ) const
inline

Determine if the 'sourceRanges' attribute was set.

Returns
true if the 'sourceRanges' attribute was set.

◆ has_source_service_accounts()

bool google_compute_api::Firewall::has_source_service_accounts ( ) const
inline

Determine if the 'sourceServiceAccounts' attribute was set.

Returns
true if the 'sourceServiceAccounts' attribute was set.

◆ has_source_tags()

bool google_compute_api::Firewall::has_source_tags ( ) const
inline

Determine if the 'sourceTags' attribute was set.

Returns
true if the 'sourceTags' attribute was set.

◆ has_target_service_accounts()

bool google_compute_api::Firewall::has_target_service_accounts ( ) const
inline

Determine if the 'targetServiceAccounts' attribute was set.

Returns
true if the 'targetServiceAccounts' attribute was set.

◆ has_target_tags()

bool google_compute_api::Firewall::has_target_tags ( ) const
inline

Determine if the 'targetTags' attribute was set.

Returns
true if the 'targetTags' attribute was set.

◆ mutable_allowed()

client::JsonCppArray<FirewallAllowed > google_compute_api::Firewall::mutable_allowed ( )
inline

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

The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.

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

◆ mutable_denied()

client::JsonCppArray<FirewallDenied > google_compute_api::Firewall::mutable_denied ( )
inline

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

The list of DENY rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a denied connection.

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

◆ mutable_destinationRanges()

client::JsonCppArray<string > google_compute_api::Firewall::mutable_destinationRanges ( )
inline

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

If destination ranges are specified, the firewall will apply only to traffic that has destination IP address in these ranges. These ranges must be expressed in CIDR format. Only IPv4 is supported.

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

◆ mutable_logConfig()

FirewallLogConfig google_compute_api::Firewall::mutable_logConfig ( )

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

This field denotes the logging options for a particular firewall rule. If logging is enabled, logs will be exported to Stackdriver.

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

◆ mutable_sourceRanges()

client::JsonCppArray<string > google_compute_api::Firewall::mutable_sourceRanges ( )
inline

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

If source ranges are specified, the firewall will apply only to traffic that has source IP address in these ranges. These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply. Only IPv4 is supported.

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

◆ mutable_sourceServiceAccounts()

client::JsonCppArray<string > google_compute_api::Firewall::mutable_sourceServiceAccounts ( )
inline

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

If source service accounts are specified, the firewall will apply only to traffic originating from an instance with a service account in this list. Source service accounts cannot be used to control traffic to an instance's external IP address because service accounts are associated with an instance, not an IP address. sourceRanges can be set at the same time as sourceServiceAccounts. If both are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP belongs to an instance with service account listed in sourceServiceAccount. The connection does not need to match both properties for the firewall to apply. sourceServiceAccounts cannot be used at the same time as sourceTags or targetTags.

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

◆ mutable_sourceTags()

client::JsonCppArray<string > google_compute_api::Firewall::mutable_sourceTags ( )
inline

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

If source tags are specified, the firewall rule applies only to traffic with source IPs that match the primary network interfaces of VM instances that have the tag and are in the same VPC network. Source tags cannot be used to control traffic to an instance's external IP address, it only applies to traffic between instances in the same virtual network. Because tags are associated with instances, not IP addresses. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply.

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

◆ mutable_targetServiceAccounts()

client::JsonCppArray<string > google_compute_api::Firewall::mutable_targetServiceAccounts ( )
inline

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

A list of service accounts indicating sets of instances located in the network that may make network connections as specified in allowed[]. targetServiceAccounts cannot be used at the same time as targetTags or sourceTags. If neither targetServiceAccounts nor targetTags are specified, the firewall rule applies to all instances on the specified network.

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

◆ mutable_targetTags()

client::JsonCppArray<string > google_compute_api::Firewall::mutable_targetTags ( )
inline

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

A list of tags that controls which instances the firewall rule applies to. If targetTags are specified, then the firewall rule applies only to instances in the VPC network that have one of those tags. If no targetTags are specified, the firewall rule applies to all instances on the specified network.

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

◆ New()

Firewall * google_compute_api::Firewall::New ( )
static

Creates a new default instance.

Returns
Ownership is passed back to the caller.

◆ set_creation_timestamp()

void google_compute_api::Firewall::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::Firewall::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_direction()

void google_compute_api::Firewall::set_direction ( const StringPiece &  value)
inline

Change the 'direction' attribute.

Direction of traffic to which this firewall applies; default is INGRESS. Note: For INGRESS traffic, it is NOT supported to specify destinationRanges; For EGRESS traffic, it is NOT supported to specify sourceRanges OR sourceTags.

Parameters
[in]valueThe new value.

◆ set_disabled()

void google_compute_api::Firewall::set_disabled ( bool  value)
inline

Change the 'disabled' attribute.

Denotes whether the firewall rule is disabled, i.e not applied to the network it is associated with. When set to true, the firewall rule is not enforced and the network behaves as if it did not exist. If this is unspecified, the firewall rule will be enabled.

Parameters
[in]valueThe new value.

◆ set_id()

void google_compute_api::Firewall::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_kind()

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

Change the 'kind' attribute.

[Output Only] Type of the resource. Always compute::firewall for firewall rules.

Parameters
[in]valueThe new value.

◆ set_name()

void google_compute_api::Firewall::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::Firewall::set_network ( const StringPiece &  value)
inline

Change the 'network' attribute.

used
global/networks/default.
URLs
.
Parameters
[in]valueThe new value.

◆ set_priority()

void google_compute_api::Firewall::set_priority ( int32  value)
inline

Change the 'priority' attribute.

Priority for this rule. This is an integer between 0 and 65535, both inclusive. When not specified, the value assumed is 1000. Relative priorities determine precedence of conflicting rules. Lower value of priority implies higher precedence (eg, a rule with priority 0 has higher precedence than a rule with priority 1). DENY rules take precedence over ALLOW rules having equal priority.

Parameters
[in]valueThe new value.

◆ set_self_link()

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

Change the 'selfLink' attribute.

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

Parameters
[in]valueThe new value.

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