- 1.64.0 (latest)
- 1.63.0
- 1.62.0
- 1.61.0
- 1.59.0
- 1.58.0
- 1.57.0
- 1.56.0
- 1.55.0
- 1.54.0
- 1.53.0
- 1.52.0
- 1.51.0
- 1.50.0
- 1.49.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.42.0
- 1.41.0
- 1.40.0
- 1.39.0
- 1.38.0
- 1.37.0
- 1.34.0
- 1.33.0
- 1.32.0
- 1.31.0
- 1.30.0
- 1.29.0
- 1.28.0
- 1.27.0
- 1.26.0
- 1.25.0
- 1.24.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.0
- 1.12.1
- 1.11.0
- 1.9.1
- 1.8.1
- 1.7.2
- 1.6.0-beta
public static final class FirewallPolicyRule.Builder extends GeneratedMessageV3.Builder<FirewallPolicyRule.Builder> implements FirewallPolicyRuleOrBuilder
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).
Protobuf type google.cloud.compute.v1.FirewallPolicyRule
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > FirewallPolicyRule.BuilderImplements
FirewallPolicyRuleOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
Methods
addAllTargetResources(Iterable<String> values)
public FirewallPolicyRule.Builder addAllTargetResources(Iterable<String> values)
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;
Parameter | |
---|---|
Name | Description |
values | Iterable<String> The targetResources to add. |
Returns | |
---|---|
Type | Description |
FirewallPolicyRule.Builder | This builder for chaining. |
addAllTargetSecureTags(Iterable<? extends FirewallPolicyRuleSecureTag> values)
public FirewallPolicyRule.Builder addAllTargetSecureTags(Iterable<? extends FirewallPolicyRuleSecureTag> values)
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;
Parameter | |
---|---|
Name | Description |
values | Iterable<? extends com.google.cloud.compute.v1.FirewallPolicyRuleSecureTag> |
Returns | |
---|---|
Type | Description |
FirewallPolicyRule.Builder |
addAllTargetServiceAccounts(Iterable<String> values)
public FirewallPolicyRule.Builder addAllTargetServiceAccounts(Iterable<String> values)
A list of service accounts indicating the sets of instances that are applied with this rule.
repeated string target_service_accounts = 457639710;
Parameter | |
---|---|
Name | Description |
values | Iterable<String> The targetServiceAccounts to add. |
Returns | |
---|---|
Type | Description |
FirewallPolicyRule.Builder | This builder for chaining. |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public FirewallPolicyRule.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field | FieldDescriptor |
value | Object |
Returns | |
---|---|
Type | Description |
FirewallPolicyRule.Builder |
addTargetResources(String value)
public FirewallPolicyRule.Builder addTargetResources(String value)
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;
Parameter | |
---|---|
Name | Description |
value | String The targetResources to add. |
Returns | |
---|---|
Type | Description |
FirewallPolicyRule.Builder | This builder for chaining. |
addTargetResourcesBytes(ByteString value)
public FirewallPolicyRule.Builder addTargetResourcesBytes(ByteString value)
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;
Parameter | |
---|---|
Name | Description |
value | ByteString The bytes of the targetResources to add. |
Returns | |
---|---|
Type | Description |
FirewallPolicyRule.Builder | This builder for chaining. |
addTargetSecureTags(FirewallPolicyRuleSecureTag value)
public FirewallPolicyRule.Builder addTargetSecureTags(FirewallPolicyRuleSecureTag value)
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;
Parameter | |
---|---|
Name | Description |
value | FirewallPolicyRuleSecureTag |
Returns | |
---|---|
Type | Description |
FirewallPolicyRule.Builder |
addTargetSecureTags(FirewallPolicyRuleSecureTag.Builder builderForValue)
public FirewallPolicyRule.Builder addTargetSecureTags(FirewallPolicyRuleSecureTag.Builder builderForValue)
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;
Parameter | |
---|---|
Name | Description |
builderForValue | FirewallPolicyRuleSecureTag.Builder |
Returns | |
---|---|
Type | Description |
FirewallPolicyRule.Builder |
addTargetSecureTags(int index, FirewallPolicyRuleSecureTag value)
public FirewallPolicyRule.Builder addTargetSecureTags(int index, FirewallPolicyRuleSecureTag value)
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;
Parameters | |
---|---|
Name | Description |
index | int |
value | FirewallPolicyRuleSecureTag |
Returns | |
---|---|
Type | Description |
FirewallPolicyRule.Builder |
addTargetSecureTags(int index, FirewallPolicyRuleSecureTag.Builder builderForValue)
public FirewallPolicyRule.Builder addTargetSecureTags(int index, FirewallPolicyRuleSecureTag.Builder builderForValue)
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;
Parameters | |
---|---|
Name | Description |
index | int |
builderForValue | FirewallPolicyRuleSecureTag.Builder |
Returns | |
---|---|
Type | Description |
FirewallPolicyRule.Builder |
addTargetSecureTagsBuilder()
public FirewallPolicyRuleSecureTag.Builder addTargetSecureTagsBuilder()
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;
Returns | |
---|---|
Type | Description |
FirewallPolicyRuleSecureTag.Builder |
addTargetSecureTagsBuilder(int index)
public FirewallPolicyRuleSecureTag.Builder addTargetSecureTagsBuilder(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;
Parameter | |
---|---|
Name | Description |
index | int |
Returns | |
---|---|
Type | Description |
FirewallPolicyRuleSecureTag.Builder |
addTargetServiceAccounts(String value)
public FirewallPolicyRule.Builder addTargetServiceAccounts(String value)
A list of service accounts indicating the sets of instances that are applied with this rule.
repeated string target_service_accounts = 457639710;
Parameter | |
---|---|
Name | Description |
value | String The targetServiceAccounts to add. |
Returns | |
---|---|
Type | Description |
FirewallPolicyRule.Builder | This builder for chaining. |
addTargetServiceAccountsBytes(ByteString value)
public FirewallPolicyRule.Builder addTargetServiceAccountsBytes(ByteString value)
A list of service accounts indicating the sets of instances that are applied with this rule.
repeated string target_service_accounts = 457639710;
Parameter | |
---|---|
Name | Description |
value | ByteString The bytes of the targetServiceAccounts to add. |
Returns | |
---|---|
Type | Description |
FirewallPolicyRule.Builder | This builder for chaining. |
build()
public FirewallPolicyRule build()
Returns | |
---|---|
Type | Description |
FirewallPolicyRule |
buildPartial()
public FirewallPolicyRule buildPartial()
Returns | |
---|---|
Type | Description |
FirewallPolicyRule |
clear()
public FirewallPolicyRule.Builder clear()
Returns | |
---|---|
Type | Description |
FirewallPolicyRule.Builder |
clearAction()
public FirewallPolicyRule.Builder clearAction()
The Action to perform when the client connection triggers the rule. Valid actions are "allow", "deny" and "goto_next".
optional string action = 187661878;
Returns | |
---|---|
Type | Description |
FirewallPolicyRule.Builder | This builder for chaining. |
clearDescription()
public FirewallPolicyRule.Builder clearDescription()
An optional description for this resource.
optional string description = 422937596;
Returns | |
---|---|
Type | Description |
FirewallPolicyRule.Builder | This builder for chaining. |
clearDirection()
public FirewallPolicyRule.Builder clearDirection()
The direction in which this rule applies. Check the Direction enum for the list of possible values.
optional string direction = 111150975;
Returns | |
---|---|
Type | Description |
FirewallPolicyRule.Builder | This builder for chaining. |
clearDisabled()
public FirewallPolicyRule.Builder clearDisabled()
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 | |
---|---|
Type | Description |
FirewallPolicyRule.Builder | This builder for chaining. |
clearEnableLogging()
public FirewallPolicyRule.Builder clearEnableLogging()
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 | |
---|---|
Type | Description |
FirewallPolicyRule.Builder | This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public FirewallPolicyRule.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field | FieldDescriptor |
Returns | |
---|---|
Type | Description |
FirewallPolicyRule.Builder |
clearKind()
public FirewallPolicyRule.Builder clearKind()
[Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules
optional string kind = 3292052;
Returns | |
---|---|
Type | Description |
FirewallPolicyRule.Builder | This builder for chaining. |
clearMatch()
public FirewallPolicyRule.Builder clearMatch()
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 | |
---|---|
Type | Description |
FirewallPolicyRule.Builder |
clearOneof(Descriptors.OneofDescriptor oneof)
public FirewallPolicyRule.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter | |
---|---|
Name | Description |
oneof | OneofDescriptor |
Returns | |
---|---|
Type | Description |
FirewallPolicyRule.Builder |
clearPriority()
public FirewallPolicyRule.Builder clearPriority()
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 | |
---|---|
Type | Description |
FirewallPolicyRule.Builder | This builder for chaining. |
clearRuleName()
public FirewallPolicyRule.Builder clearRuleName()
An optional name for the rule. This field is not a unique identifier and can be updated.
optional string rule_name = 55286254;
Returns | |
---|---|
Type | Description |
FirewallPolicyRule.Builder | This builder for chaining. |
clearRuleTupleCount()
public FirewallPolicyRule.Builder clearRuleTupleCount()
[Output Only] Calculation of the complexity of a single firewall policy rule.
optional int32 rule_tuple_count = 388342037;
Returns | |
---|---|
Type | Description |
FirewallPolicyRule.Builder | This builder for chaining. |
clearTargetResources()
public FirewallPolicyRule.Builder clearTargetResources()
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 | |
---|---|
Type | Description |
FirewallPolicyRule.Builder | This builder for chaining. |
clearTargetSecureTags()
public FirewallPolicyRule.Builder clearTargetSecureTags()
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;
Returns | |
---|---|
Type | Description |
FirewallPolicyRule.Builder |
clearTargetServiceAccounts()
public FirewallPolicyRule.Builder clearTargetServiceAccounts()
A list of service accounts indicating the sets of instances that are applied with this rule.
repeated string target_service_accounts = 457639710;
Returns | |
---|---|
Type | Description |
FirewallPolicyRule.Builder | This builder for chaining. |
clone()
public FirewallPolicyRule.Builder clone()
Returns | |
---|---|
Type | Description |
FirewallPolicyRule.Builder |
getAction()
public 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 | |
---|---|
Type | Description |
String | The action. |
getActionBytes()
public 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 | |
---|---|
Type | Description |
ByteString | The bytes for action. |
getDefaultInstanceForType()
public FirewallPolicyRule getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
FirewallPolicyRule |
getDescription()
public String getDescription()
An optional description for this resource.
optional string description = 422937596;
Returns | |
---|---|
Type | Description |
String | The description. |
getDescriptionBytes()
public ByteString getDescriptionBytes()
An optional description for this resource.
optional string description = 422937596;
Returns | |
---|---|
Type | Description |
ByteString | The bytes for description. |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns | |
---|---|
Type | Description |
Descriptor |
getDirection()
public String getDirection()
The direction in which this rule applies. Check the Direction enum for the list of possible values.
optional string direction = 111150975;
Returns | |
---|---|
Type | Description |
String | The direction. |
getDirectionBytes()
public ByteString getDirectionBytes()
The direction in which this rule applies. Check the Direction enum for the list of possible values.
optional string direction = 111150975;
Returns | |
---|---|
Type | Description |
ByteString | The bytes for direction. |
getDisabled()
public 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 | |
---|---|
Type | Description |
boolean | The disabled. |
getEnableLogging()
public 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 | |
---|---|
Type | Description |
boolean | The enableLogging. |
getKind()
public String getKind()
[Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules
optional string kind = 3292052;
Returns | |
---|---|
Type | Description |
String | The kind. |
getKindBytes()
public ByteString getKindBytes()
[Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules
optional string kind = 3292052;
Returns | |
---|---|
Type | Description |
ByteString | The bytes for kind. |
getMatch()
public 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 | |
---|---|
Type | Description |
FirewallPolicyRuleMatcher | The match. |
getMatchBuilder()
public FirewallPolicyRuleMatcher.Builder getMatchBuilder()
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 | |
---|---|
Type | Description |
FirewallPolicyRuleMatcher.Builder |
getMatchOrBuilder()
public 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;
Returns | |
---|---|
Type | Description |
FirewallPolicyRuleMatcherOrBuilder |
getPriority()
public 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 | |
---|---|
Type | Description |
int | The priority. |
getRuleName()
public 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 | |
---|---|
Type | Description |
String | The ruleName. |
getRuleNameBytes()
public 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 | |
---|---|
Type | Description |
ByteString | The bytes for ruleName. |
getRuleTupleCount()
public int getRuleTupleCount()
[Output Only] Calculation of the complexity of a single firewall policy rule.
optional int32 rule_tuple_count = 388342037;
Returns | |
---|---|
Type | Description |
int | The ruleTupleCount. |
getTargetResources(int index)
public 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;
Parameter | |
---|---|
Name | Description |
index | int The index of the element to return. |
Returns | |
---|---|
Type | Description |
String | The targetResources at the given index. |
getTargetResourcesBytes(int index)
public 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;
Parameter | |
---|---|
Name | Description |
index | int The index of the value to return. |
Returns | |
---|---|
Type | Description |
ByteString | The bytes of the targetResources at the given index. |
getTargetResourcesCount()
public 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 | |
---|---|
Type | Description |
int | The count of targetResources. |
getTargetResourcesList()
public ProtocolStringList 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 | |
---|---|
Type | Description |
ProtocolStringList | A list containing the targetResources. |
getTargetSecureTags(int index)
public 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;
Parameter | |
---|---|
Name | Description |
index | int |
Returns | |
---|---|
Type | Description |
FirewallPolicyRuleSecureTag |
getTargetSecureTagsBuilder(int index)
public FirewallPolicyRuleSecureTag.Builder getTargetSecureTagsBuilder(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;
Parameter | |
---|---|
Name | Description |
index | int |
Returns | |
---|---|
Type | Description |
FirewallPolicyRuleSecureTag.Builder |
getTargetSecureTagsBuilderList()
public List<FirewallPolicyRuleSecureTag.Builder> getTargetSecureTagsBuilderList()
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;
Returns | |
---|---|
Type | Description |
List<Builder> |
getTargetSecureTagsCount()
public 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;
Returns | |
---|---|
Type | Description |
int |
getTargetSecureTagsList()
public 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;
Returns | |
---|---|
Type | Description |
List<FirewallPolicyRuleSecureTag> |
getTargetSecureTagsOrBuilder(int index)
public 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;
Parameter | |
---|---|
Name | Description |
index | int |
Returns | |
---|---|
Type | Description |
FirewallPolicyRuleSecureTagOrBuilder |
getTargetSecureTagsOrBuilderList()
public 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;
Returns | |
---|---|
Type | Description |
List<? extends com.google.cloud.compute.v1.FirewallPolicyRuleSecureTagOrBuilder> |
getTargetServiceAccounts(int index)
public 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;
Parameter | |
---|---|
Name | Description |
index | int The index of the element to return. |
Returns | |
---|---|
Type | Description |
String | The targetServiceAccounts at the given index. |
getTargetServiceAccountsBytes(int index)
public 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;
Parameter | |
---|---|
Name | Description |
index | int The index of the value to return. |
Returns | |
---|---|
Type | Description |
ByteString | The bytes of the targetServiceAccounts at the given index. |
getTargetServiceAccountsCount()
public 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 | |
---|---|
Type | Description |
int | The count of targetServiceAccounts. |
getTargetServiceAccountsList()
public ProtocolStringList getTargetServiceAccountsList()
A list of service accounts indicating the sets of instances that are applied with this rule.
repeated string target_service_accounts = 457639710;
Returns | |
---|---|
Type | Description |
ProtocolStringList | A list containing the targetServiceAccounts. |
hasAction()
public 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 | |
---|---|
Type | Description |
boolean | Whether the action field is set. |
hasDescription()
public boolean hasDescription()
An optional description for this resource.
optional string description = 422937596;
Returns | |
---|---|
Type | Description |
boolean | Whether the description field is set. |
hasDirection()
public boolean hasDirection()
The direction in which this rule applies. Check the Direction enum for the list of possible values.
optional string direction = 111150975;
Returns | |
---|---|
Type | Description |
boolean | Whether the direction field is set. |
hasDisabled()
public 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 | |
---|---|
Type | Description |
boolean | Whether the disabled field is set. |
hasEnableLogging()
public 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 | |
---|---|
Type | Description |
boolean | Whether the enableLogging field is set. |
hasKind()
public boolean hasKind()
[Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules
optional string kind = 3292052;
Returns | |
---|---|
Type | Description |
boolean | Whether the kind field is set. |
hasMatch()
public 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 | |
---|---|
Type | Description |
boolean | Whether the match field is set. |
hasPriority()
public 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 | |
---|---|
Type | Description |
boolean | Whether the priority field is set. |
hasRuleName()
public 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 | |
---|---|
Type | Description |
boolean | Whether the ruleName field is set. |
hasRuleTupleCount()
public boolean hasRuleTupleCount()
[Output Only] Calculation of the complexity of a single firewall policy rule.
optional int32 rule_tuple_count = 388342037;
Returns | |
---|---|
Type | Description |
boolean | Whether the ruleTupleCount field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
mergeFrom(FirewallPolicyRule other)
public FirewallPolicyRule.Builder mergeFrom(FirewallPolicyRule other)
Parameter | |
---|---|
Name | Description |
other | FirewallPolicyRule |
Returns | |
---|---|
Type | Description |
FirewallPolicyRule.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public FirewallPolicyRule.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
FirewallPolicyRule.Builder |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public FirewallPolicyRule.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other | Message |
Returns | |
---|---|
Type | Description |
FirewallPolicyRule.Builder |
mergeMatch(FirewallPolicyRuleMatcher value)
public FirewallPolicyRule.Builder mergeMatch(FirewallPolicyRuleMatcher value)
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;
Parameter | |
---|---|
Name | Description |
value | FirewallPolicyRuleMatcher |
Returns | |
---|---|
Type | Description |
FirewallPolicyRule.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final FirewallPolicyRule.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields | UnknownFieldSet |
Returns | |
---|---|
Type | Description |
FirewallPolicyRule.Builder |
removeTargetSecureTags(int index)
public FirewallPolicyRule.Builder removeTargetSecureTags(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;
Parameter | |
---|---|
Name | Description |
index | int |
Returns | |
---|---|
Type | Description |
FirewallPolicyRule.Builder |
setAction(String value)
public FirewallPolicyRule.Builder setAction(String value)
The Action to perform when the client connection triggers the rule. Valid actions are "allow", "deny" and "goto_next".
optional string action = 187661878;
Parameter | |
---|---|
Name | Description |
value | String The action to set. |
Returns | |
---|---|
Type | Description |
FirewallPolicyRule.Builder | This builder for chaining. |
setActionBytes(ByteString value)
public FirewallPolicyRule.Builder setActionBytes(ByteString value)
The Action to perform when the client connection triggers the rule. Valid actions are "allow", "deny" and "goto_next".
optional string action = 187661878;
Parameter | |
---|---|
Name | Description |
value | ByteString The bytes for action to set. |
Returns | |
---|---|
Type | Description |
FirewallPolicyRule.Builder | This builder for chaining. |
setDescription(String value)
public FirewallPolicyRule.Builder setDescription(String value)
An optional description for this resource.
optional string description = 422937596;
Parameter | |
---|---|
Name | Description |
value | String The description to set. |
Returns | |
---|---|
Type | Description |
FirewallPolicyRule.Builder | This builder for chaining. |
setDescriptionBytes(ByteString value)
public FirewallPolicyRule.Builder setDescriptionBytes(ByteString value)
An optional description for this resource.
optional string description = 422937596;
Parameter | |
---|---|
Name | Description |
value | ByteString The bytes for description to set. |
Returns | |
---|---|
Type | Description |
FirewallPolicyRule.Builder | This builder for chaining. |
setDirection(String value)
public FirewallPolicyRule.Builder setDirection(String value)
The direction in which this rule applies. Check the Direction enum for the list of possible values.
optional string direction = 111150975;
Parameter | |
---|---|
Name | Description |
value | String The direction to set. |
Returns | |
---|---|
Type | Description |
FirewallPolicyRule.Builder | This builder for chaining. |
setDirectionBytes(ByteString value)
public FirewallPolicyRule.Builder setDirectionBytes(ByteString value)
The direction in which this rule applies. Check the Direction enum for the list of possible values.
optional string direction = 111150975;
Parameter | |
---|---|
Name | Description |
value | ByteString The bytes for direction to set. |
Returns | |
---|---|
Type | Description |
FirewallPolicyRule.Builder | This builder for chaining. |
setDisabled(boolean value)
public FirewallPolicyRule.Builder setDisabled(boolean value)
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;
Parameter | |
---|---|
Name | Description |
value | boolean The disabled to set. |
Returns | |
---|---|
Type | Description |
FirewallPolicyRule.Builder | This builder for chaining. |
setEnableLogging(boolean value)
public FirewallPolicyRule.Builder setEnableLogging(boolean value)
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;
Parameter | |
---|---|
Name | Description |
value | boolean The enableLogging to set. |
Returns | |
---|---|
Type | Description |
FirewallPolicyRule.Builder | This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public FirewallPolicyRule.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field | FieldDescriptor |
value | Object |
Returns | |
---|---|
Type | Description |
FirewallPolicyRule.Builder |
setKind(String value)
public FirewallPolicyRule.Builder setKind(String value)
[Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules
optional string kind = 3292052;
Parameter | |
---|---|
Name | Description |
value | String The kind to set. |
Returns | |
---|---|
Type | Description |
FirewallPolicyRule.Builder | This builder for chaining. |
setKindBytes(ByteString value)
public FirewallPolicyRule.Builder setKindBytes(ByteString value)
[Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules
optional string kind = 3292052;
Parameter | |
---|---|
Name | Description |
value | ByteString The bytes for kind to set. |
Returns | |
---|---|
Type | Description |
FirewallPolicyRule.Builder | This builder for chaining. |
setMatch(FirewallPolicyRuleMatcher value)
public FirewallPolicyRule.Builder setMatch(FirewallPolicyRuleMatcher value)
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;
Parameter | |
---|---|
Name | Description |
value | FirewallPolicyRuleMatcher |
Returns | |
---|---|
Type | Description |
FirewallPolicyRule.Builder |
setMatch(FirewallPolicyRuleMatcher.Builder builderForValue)
public FirewallPolicyRule.Builder setMatch(FirewallPolicyRuleMatcher.Builder builderForValue)
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;
Parameter | |
---|---|
Name | Description |
builderForValue | FirewallPolicyRuleMatcher.Builder |
Returns | |
---|---|
Type | Description |
FirewallPolicyRule.Builder |
setPriority(int value)
public FirewallPolicyRule.Builder setPriority(int value)
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;
Parameter | |
---|---|
Name | Description |
value | int The priority to set. |
Returns | |
---|---|
Type | Description |
FirewallPolicyRule.Builder | This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public FirewallPolicyRule.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters | |
---|---|
Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
Returns | |
---|---|
Type | Description |
FirewallPolicyRule.Builder |
setRuleName(String value)
public FirewallPolicyRule.Builder setRuleName(String value)
An optional name for the rule. This field is not a unique identifier and can be updated.
optional string rule_name = 55286254;
Parameter | |
---|---|
Name | Description |
value | String The ruleName to set. |
Returns | |
---|---|
Type | Description |
FirewallPolicyRule.Builder | This builder for chaining. |
setRuleNameBytes(ByteString value)
public FirewallPolicyRule.Builder setRuleNameBytes(ByteString value)
An optional name for the rule. This field is not a unique identifier and can be updated.
optional string rule_name = 55286254;
Parameter | |
---|---|
Name | Description |
value | ByteString The bytes for ruleName to set. |
Returns | |
---|---|
Type | Description |
FirewallPolicyRule.Builder | This builder for chaining. |
setRuleTupleCount(int value)
public FirewallPolicyRule.Builder setRuleTupleCount(int value)
[Output Only] Calculation of the complexity of a single firewall policy rule.
optional int32 rule_tuple_count = 388342037;
Parameter | |
---|---|
Name | Description |
value | int The ruleTupleCount to set. |
Returns | |
---|---|
Type | Description |
FirewallPolicyRule.Builder | This builder for chaining. |
setTargetResources(int index, String value)
public FirewallPolicyRule.Builder setTargetResources(int index, String value)
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 | |
---|---|
Name | Description |
index | int The index to set the value at. |
value | String The targetResources to set. |
Returns | |
---|---|
Type | Description |
FirewallPolicyRule.Builder | This builder for chaining. |
setTargetSecureTags(int index, FirewallPolicyRuleSecureTag value)
public FirewallPolicyRule.Builder setTargetSecureTags(int index, FirewallPolicyRuleSecureTag value)
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;
Parameters | |
---|---|
Name | Description |
index | int |
value | FirewallPolicyRuleSecureTag |
Returns | |
---|---|
Type | Description |
FirewallPolicyRule.Builder |
setTargetSecureTags(int index, FirewallPolicyRuleSecureTag.Builder builderForValue)
public FirewallPolicyRule.Builder setTargetSecureTags(int index, FirewallPolicyRuleSecureTag.Builder builderForValue)
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;
Parameters | |
---|---|
Name | Description |
index | int |
builderForValue | FirewallPolicyRuleSecureTag.Builder |
Returns | |
---|---|
Type | Description |
FirewallPolicyRule.Builder |
setTargetServiceAccounts(int index, String value)
public FirewallPolicyRule.Builder setTargetServiceAccounts(int index, String value)
A list of service accounts indicating the sets of instances that are applied with this rule.
repeated string target_service_accounts = 457639710;
Parameters | |
---|---|
Name | Description |
index | int The index to set the value at. |
value | String The targetServiceAccounts to set. |
Returns | |
---|---|
Type | Description |
FirewallPolicyRule.Builder | This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final FirewallPolicyRule.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields | UnknownFieldSet |
Returns | |
---|---|
Type | Description |
FirewallPolicyRule.Builder |