com.google.cloud.compute.v1

Interface FirewallPolicyRuleOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

FirewallPolicyRule, FirewallPolicyRule.Builder

public interface FirewallPolicyRuleOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getAction() The Action to perform when the client connection triggers the rule.
com.google.protobuf.ByteString	getActionBytes() The Action to perform when the client connection triggers the rule.
String	getDescription() An optional description for this resource.
com.google.protobuf.ByteString	getDescriptionBytes() An optional description for this resource.
String	getDirection() The direction in which this rule applies.
com.google.protobuf.ByteString	getDirectionBytes() The direction in which this rule applies.
boolean	getDisabled() Denotes whether the firewall policy rule is disabled.
boolean	getEnableLogging() Denotes whether to enable logging for a particular rule.
String	getKind() [Output only] Type of the resource.
com.google.protobuf.ByteString	getKindBytes() [Output only] Type of the resource.
FirewallPolicyRuleMatcher	getMatch() A match condition that incoming traffic is evaluated against.
FirewallPolicyRuleMatcherOrBuilder	getMatchOrBuilder() A match condition that incoming traffic is evaluated against.
int	getPriority() An integer indicating the priority of a rule in the list.
String	getRuleName() An optional name for the rule.
com.google.protobuf.ByteString	getRuleNameBytes() An optional name for the rule.
int	getRuleTupleCount() [Output Only] Calculation of the complexity of a single firewall policy rule.
String	getTargetResources(int index) A list of network resource URLs to which this rule applies.
com.google.protobuf.ByteString	getTargetResourcesBytes(int index) A list of network resource URLs to which this rule applies.
int	getTargetResourcesCount() A list of network resource URLs to which this rule applies.
List<String>	getTargetResourcesList() A list of network resource URLs to which this rule applies.
FirewallPolicyRuleSecureTag	getTargetSecureTags(int index) A list of secure tags that controls which instances the firewall rule applies to.
int	getTargetSecureTagsCount() A list of secure tags that controls which instances the firewall rule applies to.
List<FirewallPolicyRuleSecureTag>	getTargetSecureTagsList() A list of secure tags that controls which instances the firewall rule applies to.
FirewallPolicyRuleSecureTagOrBuilder	getTargetSecureTagsOrBuilder(int index) A list of secure tags that controls which instances the firewall rule applies to.
List<? extends FirewallPolicyRuleSecureTagOrBuilder>	getTargetSecureTagsOrBuilderList() A list of secure tags that controls which instances the firewall rule applies to.
String	getTargetServiceAccounts(int index) A list of service accounts indicating the sets of instances that are applied with this rule.
com.google.protobuf.ByteString	getTargetServiceAccountsBytes(int index) A list of service accounts indicating the sets of instances that are applied with this rule.
int	getTargetServiceAccountsCount() A list of service accounts indicating the sets of instances that are applied with this rule.
List<String>	getTargetServiceAccountsList() A list of service accounts indicating the sets of instances that are applied with this rule.
boolean	hasAction() The Action to perform when the client connection triggers the rule.
boolean	hasDescription() An optional description for this resource.
boolean	hasDirection() The direction in which this rule applies.
boolean	hasDisabled() Denotes whether the firewall policy rule is disabled.
boolean	hasEnableLogging() Denotes whether to enable logging for a particular rule.
boolean	hasKind() [Output only] Type of the resource.
boolean	hasMatch() A match condition that incoming traffic is evaluated against.
boolean	hasPriority() An integer indicating the priority of a rule in the list.
boolean	hasRuleName() An optional name for the rule.
boolean	hasRuleTupleCount() [Output Only] Calculation of the complexity of a single firewall policy rule.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

hasAction

boolean hasAction()

 The Action to perform when the client connection triggers the rule. Valid actions are "allow", "deny" and "goto_next".
 

optional string action = 187661878;

Returns:

Whether the action field is set.

getAction

String getAction()

 The Action to perform when the client connection triggers the rule. Valid actions are "allow", "deny" and "goto_next".
 

optional string action = 187661878;

Returns:

The action.

getActionBytes

com.google.protobuf.ByteString getActionBytes()

 The Action to perform when the client connection triggers the rule. Valid actions are "allow", "deny" and "goto_next".
 

optional string action = 187661878;

Returns:

The bytes for action.

hasDescription

boolean hasDescription()

 An optional description for this resource.
 

optional string description = 422937596;

Returns:

Whether the description field is set.

getDescription

String getDescription()

 An optional description for this resource.
 

optional string description = 422937596;

Returns:

The description.

getDescriptionBytes

com.google.protobuf.ByteString getDescriptionBytes()

 An optional description for this resource.
 

optional string description = 422937596;

Returns:

The bytes for description.

hasDirection

boolean hasDirection()

 The direction in which this rule applies.
 Check the Direction enum for the list of possible values.
 

optional string direction = 111150975;

Returns:

Whether the direction field is set.

getDirection

String getDirection()

 The direction in which this rule applies.
 Check the Direction enum for the list of possible values.
 

optional string direction = 111150975;

Returns:

The direction.

getDirectionBytes

com.google.protobuf.ByteString getDirectionBytes()

 The direction in which this rule applies.
 Check the Direction enum for the list of possible values.
 

optional string direction = 111150975;

Returns:

The bytes for direction.

hasDisabled

boolean hasDisabled()

 Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled.
 

optional bool disabled = 270940796;

Returns:

Whether the disabled field is set.

getDisabled

boolean getDisabled()

 Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled.
 

optional bool disabled = 270940796;

Returns:

The disabled.

hasEnableLogging

boolean hasEnableLogging()

 Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules.
 

optional bool enable_logging = 295396515;

Returns:

Whether the enableLogging field is set.

getEnableLogging

boolean getEnableLogging()

 Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules.
 

optional bool enable_logging = 295396515;

Returns:

The enableLogging.

hasKind

boolean hasKind()

 [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules
 

optional string kind = 3292052;

Returns:

Whether the kind field is set.

getKind

String getKind()

 [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules
 

optional string kind = 3292052;

Returns:

The kind.

getKindBytes

com.google.protobuf.ByteString getKindBytes()

 [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules
 

optional string kind = 3292052;

Returns:

The bytes for kind.

hasMatch

boolean hasMatch()

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

optional .google.cloud.compute.v1.FirewallPolicyRuleMatcher match = 103668165;

Returns:

Whether the match field is set.

getMatch

FirewallPolicyRuleMatcher getMatch()

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

optional .google.cloud.compute.v1.FirewallPolicyRuleMatcher match = 103668165;

Returns:

The match.

getMatchOrBuilder

FirewallPolicyRuleMatcherOrBuilder getMatchOrBuilder()

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

optional .google.cloud.compute.v1.FirewallPolicyRuleMatcher match = 103668165;

hasPriority

boolean hasPriority()

 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.
 

optional int32 priority = 445151652;

Returns:

Whether the priority field is set.

getPriority

int getPriority()

 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.
 

optional int32 priority = 445151652;

Returns:

The priority.

hasRuleName

boolean hasRuleName()

 An optional name for the rule. This field is not a unique identifier and can be updated.
 

optional string rule_name = 55286254;

Returns:

Whether the ruleName field is set.

getRuleName

String getRuleName()

 An optional name for the rule. This field is not a unique identifier and can be updated.
 

optional string rule_name = 55286254;

Returns:

The ruleName.

getRuleNameBytes

com.google.protobuf.ByteString getRuleNameBytes()

 An optional name for the rule. This field is not a unique identifier and can be updated.
 

optional string rule_name = 55286254;

Returns:

The bytes for ruleName.

hasRuleTupleCount

boolean hasRuleTupleCount()

 [Output Only] Calculation of the complexity of a single firewall policy rule.
 

optional int32 rule_tuple_count = 388342037;

Returns:

Whether the ruleTupleCount field is set.

getRuleTupleCount

int getRuleTupleCount()

 [Output Only] Calculation of the complexity of a single firewall policy rule.
 

optional int32 rule_tuple_count = 388342037;

Returns:

The ruleTupleCount.

getTargetResourcesList

List<String> getTargetResourcesList()

 A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule.
 

repeated string target_resources = 528230647;

Returns:

A list containing the targetResources.

getTargetResourcesCount

int getTargetResourcesCount()

 A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule.
 

repeated string target_resources = 528230647;

Returns:

The count of targetResources.

getTargetResources

String getTargetResources(int index)

 A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule.
 

repeated string target_resources = 528230647;

Parameters:

index - The index of the element to return.

Returns:

The targetResources at the given index.

getTargetResourcesBytes

com.google.protobuf.ByteString getTargetResourcesBytes(int index)

 A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule.
 

repeated string target_resources = 528230647;

Parameters:

index - The index of the value to return.

Returns:

The bytes of the targetResources at the given index.

getTargetSecureTagsList

List<FirewallPolicyRuleSecureTag> getTargetSecureTagsList()

 A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256.
 

repeated .google.cloud.compute.v1.FirewallPolicyRuleSecureTag target_secure_tags = 468132403;

getTargetSecureTags

FirewallPolicyRuleSecureTag getTargetSecureTags(int index)

 A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256.
 

repeated .google.cloud.compute.v1.FirewallPolicyRuleSecureTag target_secure_tags = 468132403;

getTargetSecureTagsCount

int getTargetSecureTagsCount()

 A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256.
 

repeated .google.cloud.compute.v1.FirewallPolicyRuleSecureTag target_secure_tags = 468132403;

getTargetSecureTagsOrBuilderList

List<? extends FirewallPolicyRuleSecureTagOrBuilder> getTargetSecureTagsOrBuilderList()

 A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256.
 

repeated .google.cloud.compute.v1.FirewallPolicyRuleSecureTag target_secure_tags = 468132403;

getTargetSecureTagsOrBuilder

FirewallPolicyRuleSecureTagOrBuilder getTargetSecureTagsOrBuilder(int index)

 A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256.
 

repeated .google.cloud.compute.v1.FirewallPolicyRuleSecureTag target_secure_tags = 468132403;

getTargetServiceAccountsList

List<String> getTargetServiceAccountsList()

 A list of service accounts indicating the sets of instances that are applied with this rule.
 

repeated string target_service_accounts = 457639710;

Returns:

A list containing the targetServiceAccounts.

getTargetServiceAccountsCount

int getTargetServiceAccountsCount()

 A list of service accounts indicating the sets of instances that are applied with this rule.
 

repeated string target_service_accounts = 457639710;

Returns:

The count of targetServiceAccounts.

getTargetServiceAccounts

String getTargetServiceAccounts(int index)

 A list of service accounts indicating the sets of instances that are applied with this rule.
 

repeated string target_service_accounts = 457639710;

Parameters:

index - The index of the element to return.

Returns:

The targetServiceAccounts at the given index.

getTargetServiceAccountsBytes

com.google.protobuf.ByteString getTargetServiceAccountsBytes(int index)

 A list of service accounts indicating the sets of instances that are applied with this rule.
 

repeated string target_service_accounts = 457639710;

Parameters:

index - The index of the value to return.

Returns:

The bytes of the targetServiceAccounts at the given index.