- 1.63.0 (latest)
- 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 final class FirewallPolicyRule extends GeneratedMessageV3 implements FirewallPolicyRuleOrBuilderRepresents 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<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > FirewallPolicyRuleImplements
FirewallPolicyRuleOrBuilderStatic Fields
ACTION_FIELD_NUMBER
public static final int ACTION_FIELD_NUMBER| Type | Description |
int |
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER| Type | Description |
int |
DIRECTION_FIELD_NUMBER
public static final int DIRECTION_FIELD_NUMBER| Type | Description |
int |
DISABLED_FIELD_NUMBER
public static final int DISABLED_FIELD_NUMBER| Type | Description |
int |
ENABLE_LOGGING_FIELD_NUMBER
public static final int ENABLE_LOGGING_FIELD_NUMBER| Type | Description |
int |
KIND_FIELD_NUMBER
public static final int KIND_FIELD_NUMBER| Type | Description |
int |
MATCH_FIELD_NUMBER
public static final int MATCH_FIELD_NUMBER| Type | Description |
int |
PRIORITY_FIELD_NUMBER
public static final int PRIORITY_FIELD_NUMBER| Type | Description |
int |
RULE_NAME_FIELD_NUMBER
public static final int RULE_NAME_FIELD_NUMBER| Type | Description |
int |
RULE_TUPLE_COUNT_FIELD_NUMBER
public static final int RULE_TUPLE_COUNT_FIELD_NUMBER| Type | Description |
int |
TARGET_RESOURCES_FIELD_NUMBER
public static final int TARGET_RESOURCES_FIELD_NUMBER| Type | Description |
int |
TARGET_SECURE_TAGS_FIELD_NUMBER
public static final int TARGET_SECURE_TAGS_FIELD_NUMBER| Type | Description |
int |
TARGET_SERVICE_ACCOUNTS_FIELD_NUMBER
public static final int TARGET_SERVICE_ACCOUNTS_FIELD_NUMBER| Type | Description |
int |
Static Methods
getDefaultInstance()
public static FirewallPolicyRule getDefaultInstance()| Type | Description |
FirewallPolicyRule |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Type | Description |
Descriptor |
newBuilder()
public static FirewallPolicyRule.Builder newBuilder()| Type | Description |
FirewallPolicyRule.Builder |
newBuilder(FirewallPolicyRule prototype)
public static FirewallPolicyRule.Builder newBuilder(FirewallPolicyRule prototype)| Name | Description |
prototype | FirewallPolicyRule |
| Type | Description |
FirewallPolicyRule.Builder |
parseDelimitedFrom(InputStream input)
public static FirewallPolicyRule parseDelimitedFrom(InputStream input)| Name | Description |
input | InputStream |
| Type | Description |
FirewallPolicyRule |
| Type | Description |
IOException |
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static FirewallPolicyRule parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
input | InputStream |
extensionRegistry | ExtensionRegistryLite |
| Type | Description |
FirewallPolicyRule |
| Type | Description |
IOException |
parseFrom(byte[] data)
public static FirewallPolicyRule parseFrom(byte[] data)| Name | Description |
data | byte[] |
| Type | Description |
FirewallPolicyRule |
| Type | Description |
InvalidProtocolBufferException |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static FirewallPolicyRule parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)| Name | Description |
data | byte[] |
extensionRegistry | ExtensionRegistryLite |
| Type | Description |
FirewallPolicyRule |
| Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data)
public static FirewallPolicyRule parseFrom(ByteString data)| Name | Description |
data | ByteString |
| Type | Description |
FirewallPolicyRule |
| Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static FirewallPolicyRule parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)| Name | Description |
data | ByteString |
extensionRegistry | ExtensionRegistryLite |
| Type | Description |
FirewallPolicyRule |
| Type | Description |
InvalidProtocolBufferException |
parseFrom(CodedInputStream input)
public static FirewallPolicyRule parseFrom(CodedInputStream input)| Name | Description |
input | CodedInputStream |
| Type | Description |
FirewallPolicyRule |
| Type | Description |
IOException |
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static FirewallPolicyRule parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
| Type | Description |
FirewallPolicyRule |
| Type | Description |
IOException |
parseFrom(InputStream input)
public static FirewallPolicyRule parseFrom(InputStream input)| Name | Description |
input | InputStream |
| Type | Description |
FirewallPolicyRule |
| Type | Description |
IOException |
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static FirewallPolicyRule parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
input | InputStream |
extensionRegistry | ExtensionRegistryLite |
| Type | Description |
FirewallPolicyRule |
| Type | Description |
IOException |
parseFrom(ByteBuffer data)
public static FirewallPolicyRule parseFrom(ByteBuffer data)| Name | Description |
data | ByteBuffer |
| Type | Description |
FirewallPolicyRule |
| Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static FirewallPolicyRule parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)| Name | Description |
data | ByteBuffer |
extensionRegistry | ExtensionRegistryLite |
| Type | Description |
FirewallPolicyRule |
| Type | Description |
InvalidProtocolBufferException |
parser()
public static Parser<FirewallPolicyRule> parser()| Type | Description |
Parser<FirewallPolicyRule> |
Methods
equals(Object obj)
public boolean equals(Object obj)| Name | Description |
obj | Object |
| Type | Description |
boolean |
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;
| 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;
| Type | Description |
ByteString | The bytes for action. |
getDefaultInstanceForType()
public FirewallPolicyRule getDefaultInstanceForType()| Type | Description |
FirewallPolicyRule |
getDescription()
public String getDescription()An optional description for this resource.
optional string description = 422937596;
| Type | Description |
String | The description. |
getDescriptionBytes()
public ByteString getDescriptionBytes()An optional description for this resource.
optional string description = 422937596;
| Type | Description |
ByteString | The bytes for description. |
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;
| 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;
| 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;
| 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;
| 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;
| 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;
| 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;
| Type | Description |
FirewallPolicyRuleMatcher | The match. |
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;
| Type | Description |
FirewallPolicyRuleMatcherOrBuilder |
getParserForType()
public Parser<FirewallPolicyRule> getParserForType()| Type | Description |
Parser<FirewallPolicyRule> |
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;
| 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;
| 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;
| 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;
| Type | Description |
int | The ruleTupleCount. |
getSerializedSize()
public int getSerializedSize()| Type | Description |
int |
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;
| Name | Description |
index | intThe index of the element to return. |
| 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;
| Name | Description |
index | intThe index of the value to return. |
| 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;
| 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;
| 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;
| Name | Description |
index | int |
| Type | Description |
FirewallPolicyRuleSecureTag |
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;
| 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;
| 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;
| Name | Description |
index | int |
| 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;
| 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;
| Name | Description |
index | intThe index of the element to return. |
| 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;
| Name | Description |
index | intThe index of the value to return. |
| 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;
| 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;
| Type | Description |
ProtocolStringList | A list containing the targetServiceAccounts. |
getUnknownFields()
public final UnknownFieldSet getUnknownFields()| Type | Description |
UnknownFieldSet |
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;
| Type | Description |
boolean | Whether the action field is set. |
hasDescription()
public boolean hasDescription()An optional description for this resource.
optional string description = 422937596;
| 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;
| 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;
| 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;
| 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;
| 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;
| 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;
| 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;
| 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;
| Type | Description |
boolean | Whether the ruleTupleCount field is set. |
hashCode()
public int hashCode()| Type | Description |
int |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()| Type | Description |
boolean |
newBuilderForType()
public FirewallPolicyRule.Builder newBuilderForType()| Type | Description |
FirewallPolicyRule.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected FirewallPolicyRule.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)| Name | Description |
parent | BuilderParent |
| Type | Description |
FirewallPolicyRule.Builder |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)| Name | Description |
unused | UnusedPrivateParameter |
| Type | Description |
Object |
toBuilder()
public FirewallPolicyRule.Builder toBuilder()| Type | Description |
FirewallPolicyRule.Builder |
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)| Name | Description |
output | CodedOutputStream |
| Type | Description |
IOException |