Class SecurityPolicyRuleMatcher (1.58.0)

public final class SecurityPolicyRuleMatcher extends GeneratedMessageV3 implements SecurityPolicyRuleMatcherOrBuilder

Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified.

Protobuf type google.cloud.compute.v1.SecurityPolicyRuleMatcher

Static Fields

CONFIG_FIELD_NUMBER

public static final int CONFIG_FIELD_NUMBER
Field Value
Type Description
int

EXPR_FIELD_NUMBER

public static final int EXPR_FIELD_NUMBER
Field Value
Type Description
int

EXPR_OPTIONS_FIELD_NUMBER

public static final int EXPR_OPTIONS_FIELD_NUMBER
Field Value
Type Description
int

VERSIONED_EXPR_FIELD_NUMBER

public static final int VERSIONED_EXPR_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static SecurityPolicyRuleMatcher getDefaultInstance()
Returns
Type Description
SecurityPolicyRuleMatcher

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static SecurityPolicyRuleMatcher.Builder newBuilder()
Returns
Type Description
SecurityPolicyRuleMatcher.Builder

newBuilder(SecurityPolicyRuleMatcher prototype)

public static SecurityPolicyRuleMatcher.Builder newBuilder(SecurityPolicyRuleMatcher prototype)
Parameter
Name Description
prototype SecurityPolicyRuleMatcher
Returns
Type Description
SecurityPolicyRuleMatcher.Builder

parseDelimitedFrom(InputStream input)

public static SecurityPolicyRuleMatcher parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SecurityPolicyRuleMatcher
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SecurityPolicyRuleMatcher parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SecurityPolicyRuleMatcher
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static SecurityPolicyRuleMatcher parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
SecurityPolicyRuleMatcher
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SecurityPolicyRuleMatcher parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SecurityPolicyRuleMatcher
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SecurityPolicyRuleMatcher parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
SecurityPolicyRuleMatcher
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SecurityPolicyRuleMatcher parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SecurityPolicyRuleMatcher
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SecurityPolicyRuleMatcher parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
SecurityPolicyRuleMatcher
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SecurityPolicyRuleMatcher parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SecurityPolicyRuleMatcher
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static SecurityPolicyRuleMatcher parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SecurityPolicyRuleMatcher
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SecurityPolicyRuleMatcher parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SecurityPolicyRuleMatcher
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static SecurityPolicyRuleMatcher parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
SecurityPolicyRuleMatcher
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SecurityPolicyRuleMatcher parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SecurityPolicyRuleMatcher
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<SecurityPolicyRuleMatcher> parser()
Returns
Type Description
Parser<SecurityPolicyRuleMatcher>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getConfig()

public SecurityPolicyRuleMatcherConfig getConfig()

The configuration options available when specifying versioned_expr. This field must be specified if versioned_expr is specified and cannot be specified if versioned_expr is not specified.

optional .google.cloud.compute.v1.SecurityPolicyRuleMatcherConfig config = 255820610;

Returns
Type Description
SecurityPolicyRuleMatcherConfig

The config.

getConfigOrBuilder()

public SecurityPolicyRuleMatcherConfigOrBuilder getConfigOrBuilder()

The configuration options available when specifying versioned_expr. This field must be specified if versioned_expr is specified and cannot be specified if versioned_expr is not specified.

optional .google.cloud.compute.v1.SecurityPolicyRuleMatcherConfig config = 255820610;

Returns
Type Description
SecurityPolicyRuleMatcherConfigOrBuilder

getDefaultInstanceForType()

public SecurityPolicyRuleMatcher getDefaultInstanceForType()
Returns
Type Description
SecurityPolicyRuleMatcher

getExpr()

public Expr getExpr()

User defined CEVAL expression. A CEVAL expression is used to specify match criteria such as origin.ip, source.region_code and contents in the request header. Expressions containing evaluateThreatIntelligence require Cloud Armor Managed Protection Plus tier and are not supported in Edge Policies nor in Regional Policies. Expressions containing evaluatePreconfiguredExpr('sourceiplist-*') require Cloud Armor Managed Protection Plus tier and are only supported in Global Security Policies.

optional .google.cloud.compute.v1.Expr expr = 3127797;

Returns
Type Description
Expr

The expr.

getExprOptions()

public SecurityPolicyRuleMatcherExprOptions getExprOptions()

The configuration options available when specifying a user defined CEVAL expression (i.e., 'expr').

optional .google.cloud.compute.v1.SecurityPolicyRuleMatcherExprOptions expr_options = 486220372;

Returns
Type Description
SecurityPolicyRuleMatcherExprOptions

The exprOptions.

getExprOptionsOrBuilder()

public SecurityPolicyRuleMatcherExprOptionsOrBuilder getExprOptionsOrBuilder()

The configuration options available when specifying a user defined CEVAL expression (i.e., 'expr').

optional .google.cloud.compute.v1.SecurityPolicyRuleMatcherExprOptions expr_options = 486220372;

Returns
Type Description
SecurityPolicyRuleMatcherExprOptionsOrBuilder

getExprOrBuilder()

public ExprOrBuilder getExprOrBuilder()

User defined CEVAL expression. A CEVAL expression is used to specify match criteria such as origin.ip, source.region_code and contents in the request header. Expressions containing evaluateThreatIntelligence require Cloud Armor Managed Protection Plus tier and are not supported in Edge Policies nor in Regional Policies. Expressions containing evaluatePreconfiguredExpr('sourceiplist-*') require Cloud Armor Managed Protection Plus tier and are only supported in Global Security Policies.

optional .google.cloud.compute.v1.Expr expr = 3127797;

Returns
Type Description
ExprOrBuilder

getParserForType()

public Parser<SecurityPolicyRuleMatcher> getParserForType()
Returns
Type Description
Parser<SecurityPolicyRuleMatcher>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getVersionedExpr()

public String getVersionedExpr()

Preconfigured versioned expression. If this field is specified, config must also be specified. Available preconfigured expressions along with their requirements are: SRC_IPS_V1 - must specify the corresponding src_ip_range field in config. Check the VersionedExpr enum for the list of possible values.

optional string versioned_expr = 322286013;

Returns
Type Description
String

The versionedExpr.

getVersionedExprBytes()

public ByteString getVersionedExprBytes()

Preconfigured versioned expression. If this field is specified, config must also be specified. Available preconfigured expressions along with their requirements are: SRC_IPS_V1 - must specify the corresponding src_ip_range field in config. Check the VersionedExpr enum for the list of possible values.

optional string versioned_expr = 322286013;

Returns
Type Description
ByteString

The bytes for versionedExpr.

hasConfig()

public boolean hasConfig()

The configuration options available when specifying versioned_expr. This field must be specified if versioned_expr is specified and cannot be specified if versioned_expr is not specified.

optional .google.cloud.compute.v1.SecurityPolicyRuleMatcherConfig config = 255820610;

Returns
Type Description
boolean

Whether the config field is set.

hasExpr()

public boolean hasExpr()

User defined CEVAL expression. A CEVAL expression is used to specify match criteria such as origin.ip, source.region_code and contents in the request header. Expressions containing evaluateThreatIntelligence require Cloud Armor Managed Protection Plus tier and are not supported in Edge Policies nor in Regional Policies. Expressions containing evaluatePreconfiguredExpr('sourceiplist-*') require Cloud Armor Managed Protection Plus tier and are only supported in Global Security Policies.

optional .google.cloud.compute.v1.Expr expr = 3127797;

Returns
Type Description
boolean

Whether the expr field is set.

hasExprOptions()

public boolean hasExprOptions()

The configuration options available when specifying a user defined CEVAL expression (i.e., 'expr').

optional .google.cloud.compute.v1.SecurityPolicyRuleMatcherExprOptions expr_options = 486220372;

Returns
Type Description
boolean

Whether the exprOptions field is set.

hasVersionedExpr()

public boolean hasVersionedExpr()

Preconfigured versioned expression. If this field is specified, config must also be specified. Available preconfigured expressions along with their requirements are: SRC_IPS_V1 - must specify the corresponding src_ip_range field in config. Check the VersionedExpr enum for the list of possible values.

optional string versioned_expr = 322286013;

Returns
Type Description
boolean

Whether the versionedExpr field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public SecurityPolicyRuleMatcher.Builder newBuilderForType()
Returns
Type Description
SecurityPolicyRuleMatcher.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SecurityPolicyRuleMatcher.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
SecurityPolicyRuleMatcher.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public SecurityPolicyRuleMatcher.Builder toBuilder()
Returns
Type Description
SecurityPolicyRuleMatcher.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException