public final class FirewallPolicyRule extends GeneratedMessageV3 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
Static Fields
ACTION_FIELD_NUMBER
public static final int ACTION_FIELD_NUMBER
Field Value
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
Field Value
DIRECTION_FIELD_NUMBER
public static final int DIRECTION_FIELD_NUMBER
Field Value
DISABLED_FIELD_NUMBER
public static final int DISABLED_FIELD_NUMBER
Field Value
ENABLE_LOGGING_FIELD_NUMBER
public static final int ENABLE_LOGGING_FIELD_NUMBER
Field Value
KIND_FIELD_NUMBER
public static final int KIND_FIELD_NUMBER
Field Value
MATCH_FIELD_NUMBER
public static final int MATCH_FIELD_NUMBER
Field Value
PRIORITY_FIELD_NUMBER
public static final int PRIORITY_FIELD_NUMBER
Field Value
RULE_TUPLE_COUNT_FIELD_NUMBER
public static final int RULE_TUPLE_COUNT_FIELD_NUMBER
Field Value
TARGET_RESOURCES_FIELD_NUMBER
public static final int TARGET_RESOURCES_FIELD_NUMBER
Field Value
TARGET_SERVICE_ACCOUNTS_FIELD_NUMBER
public static final int TARGET_SERVICE_ACCOUNTS_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static FirewallPolicyRule getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static FirewallPolicyRule.Builder newBuilder()
Returns
newBuilder(FirewallPolicyRule prototype)
public static FirewallPolicyRule.Builder newBuilder(FirewallPolicyRule prototype)
Parameter
Returns
public static FirewallPolicyRule parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static FirewallPolicyRule parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static FirewallPolicyRule parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static FirewallPolicyRule parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static FirewallPolicyRule parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static FirewallPolicyRule parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static FirewallPolicyRule parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static FirewallPolicyRule parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static FirewallPolicyRule parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static FirewallPolicyRule parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static FirewallPolicyRule parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static FirewallPolicyRule parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<FirewallPolicyRule> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getAction()
public String getAction()
The Action to perform when the client connection triggers the rule. Can currently be either "allow" or "deny()" where valid values for status are 403, 404, and 502.
optional string action = 187661878;
| Type | Description |
| String | The action.
|
getActionBytes()
public ByteString getActionBytes()
The Action to perform when the client connection triggers the rule. Can currently be either "allow" or "deny()" where valid values for status are 403, 404, and 502.
optional string action = 187661878;
getDefaultInstanceForType()
public FirewallPolicyRule getDefaultInstanceForType()
Returns
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;
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()
[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;
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;
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;
getParserForType()
public Parser<FirewallPolicyRule> getParserForType()
Returns
Overrides
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.
|
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()
Returns
Overrides
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 | 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;
| 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;
| 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;
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 | 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;
| 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;
| 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;
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
hasAction()
public boolean hasAction()
The Action to perform when the client connection triggers the rule. Can currently be either "allow" or "deny()" where valid values for status are 403, 404, and 502.
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()
[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.
|
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()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public FirewallPolicyRule.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected FirewallPolicyRule.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public FirewallPolicyRule.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
