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

#include <security_policy_rule.h>

Inheritance diagram for google_compute_api::SecurityPolicyRule:

Public Member Functions

 SecurityPolicyRule (const Json::Value &storage)
 
 SecurityPolicyRule (Json::Value *storage)
 
virtual ~SecurityPolicyRule ()
 
const StringPiece GetTypeName () const
 
bool has_action () const
 
void clear_action ()
 
const StringPiece get_action () const
 
void set_action (const StringPiece &value)
 
bool has_description () const
 
void clear_description ()
 
const StringPiece get_description () const
 
void set_description (const StringPiece &value)
 
bool has_kind () const
 
void clear_kind ()
 
const StringPiece get_kind () const
 
void set_kind (const StringPiece &value)
 
bool has_match () const
 
void clear_match ()
 
const SecurityPolicyRuleMatcher get_match () const
 
SecurityPolicyRuleMatcher mutable_match ()
 
bool has_preview () const
 
void clear_preview ()
 
bool get_preview () const
 
void set_preview (bool value)
 
bool has_priority () const
 
void clear_priority ()
 
int32 get_priority () const
 
void set_priority (int32 value)
 

Static Public Member Functions

static SecurityPolicyRuleNew ()
 

Detailed Description

Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny).

Constructor & Destructor Documentation

◆ SecurityPolicyRule() [1/2]

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

Standard constructor for an immutable data object instance.

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

◆ SecurityPolicyRule() [2/2]

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

Standard constructor for a mutable data object instance.

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

◆ ~SecurityPolicyRule()

google_compute_api::SecurityPolicyRule::~SecurityPolicyRule ( )
virtual

Standard destructor.

Member Function Documentation

◆ clear_action()

void google_compute_api::SecurityPolicyRule::clear_action ( )
inline

Clears the 'action' attribute.

◆ clear_description()

void google_compute_api::SecurityPolicyRule::clear_description ( )
inline

Clears the 'description' attribute.

◆ clear_kind()

void google_compute_api::SecurityPolicyRule::clear_kind ( )
inline

Clears the 'kind' attribute.

◆ clear_match()

void google_compute_api::SecurityPolicyRule::clear_match ( )
inline

Clears the 'match' attribute.

◆ clear_preview()

void google_compute_api::SecurityPolicyRule::clear_preview ( )
inline

Clears the 'preview' attribute.

◆ clear_priority()

void google_compute_api::SecurityPolicyRule::clear_priority ( )
inline

Clears the 'priority' attribute.

◆ get_action()

const StringPiece google_compute_api::SecurityPolicyRule::get_action ( ) const
inline

Get the value of the 'action' attribute.

◆ get_description()

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

Get the value of the 'description' attribute.

◆ get_kind()

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

Get the value of the 'kind' attribute.

◆ get_match()

const SecurityPolicyRuleMatcher google_compute_api::SecurityPolicyRule::get_match ( ) const

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

◆ get_preview()

bool google_compute_api::SecurityPolicyRule::get_preview ( ) const
inline

Get the value of the 'preview' attribute.

◆ get_priority()

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

Get the value of the 'priority' attribute.

◆ GetTypeName()

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

Returns a string denoting the type of this data object.

Returns
google_compute_api::SecurityPolicyRule

◆ has_action()

bool google_compute_api::SecurityPolicyRule::has_action ( ) const
inline

Determine if the 'action' attribute was set.

Returns
true if the 'action' attribute was set.

◆ has_description()

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

Determine if the 'description' attribute was set.

Returns
true if the 'description' attribute was set.

◆ has_kind()

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

Determine if the 'kind' attribute was set.

Returns
true if the 'kind' attribute was set.

◆ has_match()

bool google_compute_api::SecurityPolicyRule::has_match ( ) const
inline

Determine if the 'match' attribute was set.

Returns
true if the 'match' attribute was set.

◆ has_preview()

bool google_compute_api::SecurityPolicyRule::has_preview ( ) const
inline

Determine if the 'preview' attribute was set.

Returns
true if the 'preview' attribute was set.

◆ has_priority()

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

Determine if the 'priority' attribute was set.

Returns
true if the 'priority' attribute was set.

◆ mutable_match()

SecurityPolicyRuleMatcher google_compute_api::SecurityPolicyRule::mutable_match ( )

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

A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding ?action? is enforced.

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

◆ New()

SecurityPolicyRule * google_compute_api::SecurityPolicyRule::New ( )
static

Creates a new default instance.

Returns
Ownership is passed back to the caller.

◆ set_action()

void google_compute_api::SecurityPolicyRule::set_action ( const StringPiece &  value)
inline

Change the 'action' attribute.

The Action to preform when the client connection triggers the rule. Can currently be either "allow" or "deny()" where valid values for status are 403, 404, and 502.

Parameters
[in]valueThe new value.

◆ set_description()

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

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

Change the 'kind' attribute.

[Output only] Type of the resource. Always compute::securityPolicyRule for security policy rules.

Parameters
[in]valueThe new value.

◆ set_preview()

void google_compute_api::SecurityPolicyRule::set_preview ( bool  value)
inline

Change the 'preview' attribute.

If set to true, the specified action is not enforced.

Parameters
[in]valueThe new value.

◆ set_priority()

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

Change the 'priority' attribute.

An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority.

Parameters
[in]valueThe new value.

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