Class SecurityPolicyRuleMatcher.Builder (1.54.0)

public static final class SecurityPolicyRuleMatcher.Builder extends GeneratedMessageV3.Builder<SecurityPolicyRuleMatcher.Builder> 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 Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public SecurityPolicyRuleMatcher.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
SecurityPolicyRuleMatcher.Builder
Overrides

build()

public SecurityPolicyRuleMatcher build()
Returns
Type Description
SecurityPolicyRuleMatcher

buildPartial()

public SecurityPolicyRuleMatcher buildPartial()
Returns
Type Description
SecurityPolicyRuleMatcher

clear()

public SecurityPolicyRuleMatcher.Builder clear()
Returns
Type Description
SecurityPolicyRuleMatcher.Builder
Overrides

clearConfig()

public SecurityPolicyRuleMatcher.Builder clearConfig()

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
SecurityPolicyRuleMatcher.Builder

clearExpr()

public SecurityPolicyRuleMatcher.Builder clearExpr()

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
SecurityPolicyRuleMatcher.Builder

clearExprOptions()

public SecurityPolicyRuleMatcher.Builder clearExprOptions()

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
SecurityPolicyRuleMatcher.Builder

clearField(Descriptors.FieldDescriptor field)

public SecurityPolicyRuleMatcher.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
SecurityPolicyRuleMatcher.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public SecurityPolicyRuleMatcher.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
SecurityPolicyRuleMatcher.Builder
Overrides

clearVersionedExpr()

public SecurityPolicyRuleMatcher.Builder clearVersionedExpr()

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
SecurityPolicyRuleMatcher.Builder

This builder for chaining.

clone()

public SecurityPolicyRuleMatcher.Builder clone()
Returns
Type Description
SecurityPolicyRuleMatcher.Builder
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.

getConfigBuilder()

public SecurityPolicyRuleMatcherConfig.Builder getConfigBuilder()

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

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

getExprBuilder()

public Expr.Builder getExprBuilder()

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

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.

getExprOptionsBuilder()

public SecurityPolicyRuleMatcherExprOptions.Builder getExprOptionsBuilder()

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

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

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeConfig(SecurityPolicyRuleMatcherConfig value)

public SecurityPolicyRuleMatcher.Builder mergeConfig(SecurityPolicyRuleMatcherConfig value)

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;

Parameter
Name Description
value SecurityPolicyRuleMatcherConfig
Returns
Type Description
SecurityPolicyRuleMatcher.Builder

mergeExpr(Expr value)

public SecurityPolicyRuleMatcher.Builder mergeExpr(Expr value)

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;

Parameter
Name Description
value Expr
Returns
Type Description
SecurityPolicyRuleMatcher.Builder

mergeExprOptions(SecurityPolicyRuleMatcherExprOptions value)

public SecurityPolicyRuleMatcher.Builder mergeExprOptions(SecurityPolicyRuleMatcherExprOptions value)

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

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

Parameter
Name Description
value SecurityPolicyRuleMatcherExprOptions
Returns
Type Description
SecurityPolicyRuleMatcher.Builder

mergeFrom(SecurityPolicyRuleMatcher other)

public SecurityPolicyRuleMatcher.Builder mergeFrom(SecurityPolicyRuleMatcher other)
Parameter
Name Description
other SecurityPolicyRuleMatcher
Returns
Type Description
SecurityPolicyRuleMatcher.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SecurityPolicyRuleMatcher.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SecurityPolicyRuleMatcher.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public SecurityPolicyRuleMatcher.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
SecurityPolicyRuleMatcher.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final SecurityPolicyRuleMatcher.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
SecurityPolicyRuleMatcher.Builder
Overrides

setConfig(SecurityPolicyRuleMatcherConfig value)

public SecurityPolicyRuleMatcher.Builder setConfig(SecurityPolicyRuleMatcherConfig value)

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;

Parameter
Name Description
value SecurityPolicyRuleMatcherConfig
Returns
Type Description
SecurityPolicyRuleMatcher.Builder

setConfig(SecurityPolicyRuleMatcherConfig.Builder builderForValue)

public SecurityPolicyRuleMatcher.Builder setConfig(SecurityPolicyRuleMatcherConfig.Builder builderForValue)

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;

Parameter
Name Description
builderForValue SecurityPolicyRuleMatcherConfig.Builder
Returns
Type Description
SecurityPolicyRuleMatcher.Builder

setExpr(Expr value)

public SecurityPolicyRuleMatcher.Builder setExpr(Expr value)

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;

Parameter
Name Description
value Expr
Returns
Type Description
SecurityPolicyRuleMatcher.Builder

setExpr(Expr.Builder builderForValue)

public SecurityPolicyRuleMatcher.Builder setExpr(Expr.Builder builderForValue)

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;

Parameter
Name Description
builderForValue Expr.Builder
Returns
Type Description
SecurityPolicyRuleMatcher.Builder

setExprOptions(SecurityPolicyRuleMatcherExprOptions value)

public SecurityPolicyRuleMatcher.Builder setExprOptions(SecurityPolicyRuleMatcherExprOptions value)

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

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

Parameter
Name Description
value SecurityPolicyRuleMatcherExprOptions
Returns
Type Description
SecurityPolicyRuleMatcher.Builder

setExprOptions(SecurityPolicyRuleMatcherExprOptions.Builder builderForValue)

public SecurityPolicyRuleMatcher.Builder setExprOptions(SecurityPolicyRuleMatcherExprOptions.Builder builderForValue)

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

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

Parameter
Name Description
builderForValue SecurityPolicyRuleMatcherExprOptions.Builder
Returns
Type Description
SecurityPolicyRuleMatcher.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public SecurityPolicyRuleMatcher.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
SecurityPolicyRuleMatcher.Builder
Overrides

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public SecurityPolicyRuleMatcher.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
SecurityPolicyRuleMatcher.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final SecurityPolicyRuleMatcher.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
SecurityPolicyRuleMatcher.Builder
Overrides

setVersionedExpr(String value)

public SecurityPolicyRuleMatcher.Builder setVersionedExpr(String value)

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;

Parameter
Name Description
value String

The versionedExpr to set.

Returns
Type Description
SecurityPolicyRuleMatcher.Builder

This builder for chaining.

setVersionedExprBytes(ByteString value)

public SecurityPolicyRuleMatcher.Builder setVersionedExprBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for versionedExpr to set.

Returns
Type Description
SecurityPolicyRuleMatcher.Builder

This builder for chaining.