public final class SecurityPolicyRule extends com.google.protobuf.GeneratedMessageV3 implements SecurityPolicyRuleOrBuilder
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.SecurityPolicyRule| Modifier and Type | Class and Description |
|---|---|
static class |
SecurityPolicyRule.Builder
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).
|
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter| Modifier and Type | Field and Description |
|---|---|
static int |
ACTION_FIELD_NUMBER |
static int |
DESCRIPTION_FIELD_NUMBER |
static int |
HEADER_ACTION_FIELD_NUMBER |
static int |
KIND_FIELD_NUMBER |
static int |
MATCH_FIELD_NUMBER |
static int |
PREVIEW_FIELD_NUMBER |
static int |
PRIORITY_FIELD_NUMBER |
static int |
RATE_LIMIT_OPTIONS_FIELD_NUMBER |
static int |
REDIRECT_OPTIONS_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object obj) |
String |
getAction()
The Action to perform when the rule is matched.
|
com.google.protobuf.ByteString |
getActionBytes()
The Action to perform when the rule is matched.
|
static SecurityPolicyRule |
getDefaultInstance() |
SecurityPolicyRule |
getDefaultInstanceForType() |
String |
getDescription()
An optional description of this resource.
|
com.google.protobuf.ByteString |
getDescriptionBytes()
An optional description of this resource.
|
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
SecurityPolicyRuleHttpHeaderAction |
getHeaderAction()
Optional, additional actions that are performed on headers.
|
SecurityPolicyRuleHttpHeaderActionOrBuilder |
getHeaderActionOrBuilder()
Optional, additional actions that are performed on headers.
|
String |
getKind()
[Output only] Type of the resource.
|
com.google.protobuf.ByteString |
getKindBytes()
[Output only] Type of the resource.
|
SecurityPolicyRuleMatcher |
getMatch()
A match condition that incoming traffic is evaluated against.
|
SecurityPolicyRuleMatcherOrBuilder |
getMatchOrBuilder()
A match condition that incoming traffic is evaluated against.
|
com.google.protobuf.Parser<SecurityPolicyRule> |
getParserForType() |
boolean |
getPreview()
If set to true, the specified action is not enforced.
|
int |
getPriority()
An integer indicating the priority of a rule in the list.
|
SecurityPolicyRuleRateLimitOptions |
getRateLimitOptions()
Must be specified if the action is "rate_based_ban" or "throttle".
|
SecurityPolicyRuleRateLimitOptionsOrBuilder |
getRateLimitOptionsOrBuilder()
Must be specified if the action is "rate_based_ban" or "throttle".
|
SecurityPolicyRuleRedirectOptions |
getRedirectOptions()
Parameters defining the redirect action.
|
SecurityPolicyRuleRedirectOptionsOrBuilder |
getRedirectOptionsOrBuilder()
Parameters defining the redirect action.
|
int |
getSerializedSize() |
com.google.protobuf.UnknownFieldSet |
getUnknownFields() |
boolean |
hasAction()
The Action to perform when the rule is matched.
|
boolean |
hasDescription()
An optional description of this resource.
|
int |
hashCode() |
boolean |
hasHeaderAction()
Optional, additional actions that are performed on headers.
|
boolean |
hasKind()
[Output only] Type of the resource.
|
boolean |
hasMatch()
A match condition that incoming traffic is evaluated against.
|
boolean |
hasPreview()
If set to true, the specified action is not enforced.
|
boolean |
hasPriority()
An integer indicating the priority of a rule in the list.
|
boolean |
hasRateLimitOptions()
Must be specified if the action is "rate_based_ban" or "throttle".
|
boolean |
hasRedirectOptions()
Parameters defining the redirect action.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
static SecurityPolicyRule.Builder |
newBuilder() |
static SecurityPolicyRule.Builder |
newBuilder(SecurityPolicyRule prototype) |
SecurityPolicyRule.Builder |
newBuilderForType() |
protected SecurityPolicyRule.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static SecurityPolicyRule |
parseDelimitedFrom(InputStream input) |
static SecurityPolicyRule |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static SecurityPolicyRule |
parseFrom(byte[] data) |
static SecurityPolicyRule |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static SecurityPolicyRule |
parseFrom(ByteBuffer data) |
static SecurityPolicyRule |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static SecurityPolicyRule |
parseFrom(com.google.protobuf.ByteString data) |
static SecurityPolicyRule |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static SecurityPolicyRule |
parseFrom(com.google.protobuf.CodedInputStream input) |
static SecurityPolicyRule |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static SecurityPolicyRule |
parseFrom(InputStream input) |
static SecurityPolicyRule |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<SecurityPolicyRule> |
parser() |
SecurityPolicyRule.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int ACTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
public static final int HEADER_ACTION_FIELD_NUMBER
public static final int KIND_FIELD_NUMBER
public static final int MATCH_FIELD_NUMBER
public static final int PREVIEW_FIELD_NUMBER
public static final int PRIORITY_FIELD_NUMBER
public static final int RATE_LIMIT_OPTIONS_FIELD_NUMBER
public static final int REDIRECT_OPTIONS_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class com.google.protobuf.GeneratedMessageV3public final com.google.protobuf.UnknownFieldSet getUnknownFields()
getUnknownFields in interface com.google.protobuf.MessageOrBuildergetUnknownFields in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public boolean hasAction()
The Action to perform when the rule is matched. The following are the valid actions: - allow: allow access to target. - deny(): deny access to target, returns the HTTP response code specified (valid values are 403, 404, and 502). - rate_based_ban: limit client traffic to the configured threshold and ban the client if the traffic exceeds the threshold. Configure parameters for this action in RateLimitOptions. Requires rate_limit_options to be set. - redirect: redirect to a different target. This can either be an internal reCAPTCHA redirect, or an external URL-based redirect via a 302 response. Parameters for this action can be configured via redirectOptions. - throttle: limit client traffic to the configured threshold. Configure parameters for this action in rateLimitOptions. Requires rate_limit_options to be set for this.
optional string action = 187661878;hasAction in interface SecurityPolicyRuleOrBuilderpublic String getAction()
The Action to perform when the rule is matched. The following are the valid actions: - allow: allow access to target. - deny(): deny access to target, returns the HTTP response code specified (valid values are 403, 404, and 502). - rate_based_ban: limit client traffic to the configured threshold and ban the client if the traffic exceeds the threshold. Configure parameters for this action in RateLimitOptions. Requires rate_limit_options to be set. - redirect: redirect to a different target. This can either be an internal reCAPTCHA redirect, or an external URL-based redirect via a 302 response. Parameters for this action can be configured via redirectOptions. - throttle: limit client traffic to the configured threshold. Configure parameters for this action in rateLimitOptions. Requires rate_limit_options to be set for this.
optional string action = 187661878;getAction in interface SecurityPolicyRuleOrBuilderpublic com.google.protobuf.ByteString getActionBytes()
The Action to perform when the rule is matched. The following are the valid actions: - allow: allow access to target. - deny(): deny access to target, returns the HTTP response code specified (valid values are 403, 404, and 502). - rate_based_ban: limit client traffic to the configured threshold and ban the client if the traffic exceeds the threshold. Configure parameters for this action in RateLimitOptions. Requires rate_limit_options to be set. - redirect: redirect to a different target. This can either be an internal reCAPTCHA redirect, or an external URL-based redirect via a 302 response. Parameters for this action can be configured via redirectOptions. - throttle: limit client traffic to the configured threshold. Configure parameters for this action in rateLimitOptions. Requires rate_limit_options to be set for this.
optional string action = 187661878;getActionBytes in interface SecurityPolicyRuleOrBuilderpublic boolean hasDescription()
An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;hasDescription in interface SecurityPolicyRuleOrBuilderpublic String getDescription()
An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;getDescription in interface SecurityPolicyRuleOrBuilderpublic com.google.protobuf.ByteString getDescriptionBytes()
An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;getDescriptionBytes in interface SecurityPolicyRuleOrBuilderpublic boolean hasHeaderAction()
Optional, additional actions that are performed on headers.
optional .google.cloud.compute.v1.SecurityPolicyRuleHttpHeaderAction header_action = 328077352;
hasHeaderAction in interface SecurityPolicyRuleOrBuilderpublic SecurityPolicyRuleHttpHeaderAction getHeaderAction()
Optional, additional actions that are performed on headers.
optional .google.cloud.compute.v1.SecurityPolicyRuleHttpHeaderAction header_action = 328077352;
getHeaderAction in interface SecurityPolicyRuleOrBuilderpublic SecurityPolicyRuleHttpHeaderActionOrBuilder getHeaderActionOrBuilder()
Optional, additional actions that are performed on headers.
optional .google.cloud.compute.v1.SecurityPolicyRuleHttpHeaderAction header_action = 328077352;
getHeaderActionOrBuilder in interface SecurityPolicyRuleOrBuilderpublic boolean hasKind()
[Output only] Type of the resource. Always compute#securityPolicyRule for security policy rules
optional string kind = 3292052;hasKind in interface SecurityPolicyRuleOrBuilderpublic String getKind()
[Output only] Type of the resource. Always compute#securityPolicyRule for security policy rules
optional string kind = 3292052;getKind in interface SecurityPolicyRuleOrBuilderpublic com.google.protobuf.ByteString getKindBytes()
[Output only] Type of the resource. Always compute#securityPolicyRule for security policy rules
optional string kind = 3292052;getKindBytes in interface SecurityPolicyRuleOrBuilderpublic 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.SecurityPolicyRuleMatcher match = 103668165;hasMatch in interface SecurityPolicyRuleOrBuilderpublic SecurityPolicyRuleMatcher 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.SecurityPolicyRuleMatcher match = 103668165;getMatch in interface SecurityPolicyRuleOrBuilderpublic SecurityPolicyRuleMatcherOrBuilder 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.SecurityPolicyRuleMatcher match = 103668165;getMatchOrBuilder in interface SecurityPolicyRuleOrBuilderpublic boolean hasPreview()
If set to true, the specified action is not enforced.
optional bool preview = 218686408;hasPreview in interface SecurityPolicyRuleOrBuilderpublic boolean getPreview()
If set to true, the specified action is not enforced.
optional bool preview = 218686408;getPreview in interface SecurityPolicyRuleOrBuilderpublic 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 priority.
optional int32 priority = 445151652;hasPriority in interface SecurityPolicyRuleOrBuilderpublic 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;getPriority in interface SecurityPolicyRuleOrBuilderpublic boolean hasRateLimitOptions()
Must be specified if the action is "rate_based_ban" or "throttle". Cannot be specified for any other actions.
optional .google.cloud.compute.v1.SecurityPolicyRuleRateLimitOptions rate_limit_options = 67544315;
hasRateLimitOptions in interface SecurityPolicyRuleOrBuilderpublic SecurityPolicyRuleRateLimitOptions getRateLimitOptions()
Must be specified if the action is "rate_based_ban" or "throttle". Cannot be specified for any other actions.
optional .google.cloud.compute.v1.SecurityPolicyRuleRateLimitOptions rate_limit_options = 67544315;
getRateLimitOptions in interface SecurityPolicyRuleOrBuilderpublic SecurityPolicyRuleRateLimitOptionsOrBuilder getRateLimitOptionsOrBuilder()
Must be specified if the action is "rate_based_ban" or "throttle". Cannot be specified for any other actions.
optional .google.cloud.compute.v1.SecurityPolicyRuleRateLimitOptions rate_limit_options = 67544315;
getRateLimitOptionsOrBuilder in interface SecurityPolicyRuleOrBuilderpublic boolean hasRedirectOptions()
Parameters defining the redirect action. Cannot be specified for any other actions.
optional .google.cloud.compute.v1.SecurityPolicyRuleRedirectOptions redirect_options = 163285307;
hasRedirectOptions in interface SecurityPolicyRuleOrBuilderpublic SecurityPolicyRuleRedirectOptions getRedirectOptions()
Parameters defining the redirect action. Cannot be specified for any other actions.
optional .google.cloud.compute.v1.SecurityPolicyRuleRedirectOptions redirect_options = 163285307;
getRedirectOptions in interface SecurityPolicyRuleOrBuilderpublic SecurityPolicyRuleRedirectOptionsOrBuilder getRedirectOptionsOrBuilder()
Parameters defining the redirect action. Cannot be specified for any other actions.
optional .google.cloud.compute.v1.SecurityPolicyRuleRedirectOptions redirect_options = 163285307;
getRedirectOptionsOrBuilder in interface SecurityPolicyRuleOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static SecurityPolicyRule parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static SecurityPolicyRule parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static SecurityPolicyRule parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static SecurityPolicyRule parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static SecurityPolicyRule parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static SecurityPolicyRule parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static SecurityPolicyRule parseFrom(InputStream input) throws IOException
IOExceptionpublic static SecurityPolicyRule parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static SecurityPolicyRule parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static SecurityPolicyRule parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static SecurityPolicyRule parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static SecurityPolicyRule parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic SecurityPolicyRule.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static SecurityPolicyRule.Builder newBuilder()
public static SecurityPolicyRule.Builder newBuilder(SecurityPolicyRule prototype)
public SecurityPolicyRule.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected SecurityPolicyRule.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static SecurityPolicyRule getDefaultInstance()
public static com.google.protobuf.Parser<SecurityPolicyRule> parser()
public com.google.protobuf.Parser<SecurityPolicyRule> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public SecurityPolicyRule getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2023 Google LLC. All rights reserved.