Class FirewallPolicyRule (1.64.0)

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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > FirewallPolicyRule

Implements

FirewallPolicyRuleOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

ACTION_FIELD_NUMBER

public static final int ACTION_FIELD_NUMBER

Field Value
Type	Description
`int`

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER

Field Value
Type	Description
`int`

DIRECTION_FIELD_NUMBER

public static final int DIRECTION_FIELD_NUMBER

Field Value
Type	Description
`int`

DISABLED_FIELD_NUMBER

public static final int DISABLED_FIELD_NUMBER

Field Value
Type	Description
`int`

ENABLE_LOGGING_FIELD_NUMBER

public static final int ENABLE_LOGGING_FIELD_NUMBER

Field Value
Type	Description
`int`

KIND_FIELD_NUMBER

public static final int KIND_FIELD_NUMBER

Field Value
Type	Description
`int`

MATCH_FIELD_NUMBER

public static final int MATCH_FIELD_NUMBER

Field Value
Type	Description
`int`

PRIORITY_FIELD_NUMBER

public static final int PRIORITY_FIELD_NUMBER

Field Value
Type	Description
`int`

RULE_NAME_FIELD_NUMBER

public static final int RULE_NAME_FIELD_NUMBER

Field Value
Type	Description
`int`

RULE_TUPLE_COUNT_FIELD_NUMBER

public static final int RULE_TUPLE_COUNT_FIELD_NUMBER

Field Value
Type	Description
`int`

SECURITY_PROFILE_GROUP_FIELD_NUMBER

public static final int SECURITY_PROFILE_GROUP_FIELD_NUMBER

Field Value
Type	Description
`int`

TARGET_RESOURCES_FIELD_NUMBER

public static final int TARGET_RESOURCES_FIELD_NUMBER

Field Value
Type	Description
`int`

TARGET_SECURE_TAGS_FIELD_NUMBER

public static final int TARGET_SECURE_TAGS_FIELD_NUMBER

Field Value
Type	Description
`int`

TARGET_SERVICE_ACCOUNTS_FIELD_NUMBER

public static final int TARGET_SERVICE_ACCOUNTS_FIELD_NUMBER

Field Value
Type	Description
`int`

TLS_INSPECT_FIELD_NUMBER

public static final int TLS_INSPECT_FIELD_NUMBER

Field Value
Type	Description
`int`

Static Methods

getDefaultInstance()

public static FirewallPolicyRule getDefaultInstance()

Returns
Type	Description
`FirewallPolicyRule`

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

newBuilder()

public static FirewallPolicyRule.Builder newBuilder()

Returns
Type	Description
`FirewallPolicyRule.Builder`

newBuilder(FirewallPolicyRule prototype)

public static FirewallPolicyRule.Builder newBuilder(FirewallPolicyRule prototype)

Parameter
Name	Description
`prototype`	`FirewallPolicyRule`

Returns
Type	Description
`FirewallPolicyRule.Builder`

parseDelimitedFrom(InputStream input)

public static FirewallPolicyRule parseDelimitedFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`FirewallPolicyRule`

Exceptions
Type	Description
`IOException`

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static FirewallPolicyRule parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`FirewallPolicyRule`

Exceptions
Type	Description
`IOException`

parseFrom(byte[] data)

public static FirewallPolicyRule parseFrom(byte[] data)

Parameter
Name	Description
`data`	`byte[]`

Returns
Type	Description
`FirewallPolicyRule`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static FirewallPolicyRule parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`byte[]`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`FirewallPolicyRule`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data)

public static FirewallPolicyRule parseFrom(ByteString data)

Parameter
Name	Description
`data`	`ByteString`

Returns
Type	Description
`FirewallPolicyRule`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static FirewallPolicyRule parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteString`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`FirewallPolicyRule`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(CodedInputStream input)

public static FirewallPolicyRule parseFrom(CodedInputStream input)

Parameter
Name	Description
`input`	`CodedInputStream`

Returns
Type	Description
`FirewallPolicyRule`

Exceptions
Type	Description
`IOException`

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static FirewallPolicyRule parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`FirewallPolicyRule`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input)

public static FirewallPolicyRule parseFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`FirewallPolicyRule`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static FirewallPolicyRule parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`FirewallPolicyRule`

Exceptions
Type	Description
`IOException`

parseFrom(ByteBuffer data)

public static FirewallPolicyRule parseFrom(ByteBuffer data)

Parameter
Name	Description
`data`	`ByteBuffer`

Returns
Type	Description
`FirewallPolicyRule`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static FirewallPolicyRule parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteBuffer`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`FirewallPolicyRule`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parser()

public static Parser<FirewallPolicyRule> parser()

Returns
Type	Description
`Parser<FirewallPolicyRule>`

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
`obj`	`Object`

Returns
Type	Description
`boolean`

Overrides

AbstractMessage.equals(Object other)

getAction()

public String getAction()

The Action to perform when the client connection triggers the rule. Valid actions for firewall rules are: "allow", "deny", "apply_security_profile_group" and "goto_next". Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" and "goto_next".

optional string action = 187661878;

Returns
Type	Description
`String`	The action.

getActionBytes()

public ByteString getActionBytes()

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.

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. Returns compute#firewallPolicyRule for firewall rules and compute#packetMirroringRule for packet mirroring rules.

optional string kind = 3292052;

Returns
Type	Description
`String`	The kind.

getKindBytes()

public ByteString getKindBytes()

[Output only] Type of the resource. Returns compute#firewallPolicyRule for firewall rules and compute#packetMirroringRule for packet mirroring 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.

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`

getParserForType()

public Parser<FirewallPolicyRule> getParserForType()

Returns
Type	Description
`Parser<FirewallPolicyRule>`

Overrides

GeneratedMessageV3.getParserForType()

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 priority.

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.

getSecurityProfileGroup()

public String getSecurityProfileGroup()

A fully-qualified URL of a SecurityProfile resource instance. Example: https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group Must be specified if action is one of 'apply_security_profile_group' or 'mirror'. Cannot be specified for other actions.

optional string security_profile_group = 207411626;

Returns
Type	Description
`String`	The securityProfileGroup.

getSecurityProfileGroupBytes()

public ByteString getSecurityProfileGroupBytes()

optional string security_profile_group = 207411626;

Returns
Type	Description
`ByteString`	The bytes for securityProfileGroup.

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
`int`

Overrides

GeneratedMessageV3.getSerializedSize()

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)

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()

repeated string target_resources = 528230647;

Returns
Type	Description
`int`	The count of targetResources.

getTargetResourcesList()

public ProtocolStringList getTargetResourcesList()

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.