Class GatewaySecurityPolicyRule (0.94.0)

public final class GatewaySecurityPolicyRule extends GeneratedMessage implements GatewaySecurityPolicyRuleOrBuilder

The GatewaySecurityPolicyRule resource is in a nested collection within a GatewaySecurityPolicy and represents a traffic matching condition and associated action to perform.

Protobuf type google.cloud.networksecurity.v1.GatewaySecurityPolicyRule

Static Fields

APPLICATION_MATCHER_FIELD_NUMBER

public static final int APPLICATION_MATCHER_FIELD_NUMBER
Field Value
Type Description
int

BASIC_PROFILE_FIELD_NUMBER

public static final int BASIC_PROFILE_FIELD_NUMBER
Field Value
Type Description
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

ENABLED_FIELD_NUMBER

public static final int ENABLED_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

PRIORITY_FIELD_NUMBER

public static final int PRIORITY_FIELD_NUMBER
Field Value
Type Description
int

SESSION_MATCHER_FIELD_NUMBER

public static final int SESSION_MATCHER_FIELD_NUMBER
Field Value
Type Description
int

TLS_INSPECTION_ENABLED_FIELD_NUMBER

public static final int TLS_INSPECTION_ENABLED_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static GatewaySecurityPolicyRule getDefaultInstance()
Returns
Type Description
GatewaySecurityPolicyRule

getDescriptor()

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

newBuilder()

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

newBuilder(GatewaySecurityPolicyRule prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getApplicationMatcher()

public String getApplicationMatcher()

Optional. CEL expression for matching on L7/application level criteria.

string application_matcher = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The applicationMatcher.

getApplicationMatcherBytes()

public ByteString getApplicationMatcherBytes()

Optional. CEL expression for matching on L7/application level criteria.

string application_matcher = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for applicationMatcher.

getBasicProfile()

public GatewaySecurityPolicyRule.BasicProfile getBasicProfile()

Required. Profile which tells what the primitive action should be.

.google.cloud.networksecurity.v1.GatewaySecurityPolicyRule.BasicProfile basic_profile = 9 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
GatewaySecurityPolicyRule.BasicProfile

The basicProfile.

getBasicProfileValue()

public int getBasicProfileValue()

Required. Profile which tells what the primitive action should be.

.google.cloud.networksecurity.v1.GatewaySecurityPolicyRule.BasicProfile basic_profile = 9 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for basicProfile.

getCreateTime()

public Timestamp getCreateTime()

Output only. Time when the rule was created.

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Time when the rule was created.

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public GatewaySecurityPolicyRule getDefaultInstanceForType()
Returns
Type Description
GatewaySecurityPolicyRule

getDescription()

public String getDescription()

Optional. Free-text description of the resource.

string description = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Optional. Free-text description of the resource.

string description = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for description.

getEnabled()

public boolean getEnabled()

Required. Whether the rule is enforced.

bool enabled = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

The enabled.

getName()

public String getName()

Required. Immutable. Name of the resource. ame is the full resource name so projects/{project}/locations/{location}/gatewaySecurityPolicies/{gateway_security_policy}/rules/{rule} rule should match the pattern: (^a-z?$).

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Required. Immutable. Name of the resource. ame is the full resource name so projects/{project}/locations/{location}/gatewaySecurityPolicies/{gateway_security_policy}/rules/{rule} rule should match the pattern: (^a-z?$).

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

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

getPriority()

public int getPriority()

Required. Priority of the rule. Lower number corresponds to higher precedence.

int32 priority = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The priority.

getProfileCase()

public GatewaySecurityPolicyRule.ProfileCase getProfileCase()
Returns
Type Description
GatewaySecurityPolicyRule.ProfileCase

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSessionMatcher()

public String getSessionMatcher()

Required. CEL expression for matching on session criteria.

string session_matcher = 7 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The sessionMatcher.

getSessionMatcherBytes()

public ByteString getSessionMatcherBytes()

Required. CEL expression for matching on session criteria.

string session_matcher = 7 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for sessionMatcher.

getTlsInspectionEnabled()

public boolean getTlsInspectionEnabled()

Optional. Flag to enable TLS inspection of traffic matching on <session_matcher>, can only be true if the parent GatewaySecurityPolicy references a TLSInspectionConfig.

bool tls_inspection_enabled = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The tlsInspectionEnabled.

getUpdateTime()

public Timestamp getUpdateTime()

Output only. Time when the rule was updated.

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Time when the rule was updated.

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

hasBasicProfile()

public boolean hasBasicProfile()

Required. Profile which tells what the primitive action should be.

.google.cloud.networksecurity.v1.GatewaySecurityPolicyRule.BasicProfile basic_profile = 9 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the basicProfile field is set.

hasCreateTime()

public boolean hasCreateTime()

Output only. Time when the rule was created.

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. Time when the rule was updated.

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the updateTime field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(AbstractMessage.BuilderParent parent)

protected GatewaySecurityPolicyRule.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
GatewaySecurityPolicyRule.Builder
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

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