public final class FirewallPolicy extends GeneratedMessageV3 implements FirewallPolicyOrBuilder
A FirewallPolicy represents a single matching pattern and resulting actions
to take.
Protobuf type google.cloud.recaptchaenterprise.v1.FirewallPolicy
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
ACTIONS_FIELD_NUMBER
public static final int ACTIONS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
CONDITION_FIELD_NUMBER
public static final int CONDITION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PATH_FIELD_NUMBER
public static final int PATH_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static FirewallPolicy getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static FirewallPolicy.Builder newBuilder()
newBuilder(FirewallPolicy prototype)
public static FirewallPolicy.Builder newBuilder(FirewallPolicy prototype)
public static FirewallPolicy parseDelimitedFrom(InputStream input)
public static FirewallPolicy parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static FirewallPolicy parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static FirewallPolicy parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static FirewallPolicy parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static FirewallPolicy parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static FirewallPolicy parseFrom(CodedInputStream input)
public static FirewallPolicy parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static FirewallPolicy parseFrom(InputStream input)
public static FirewallPolicy parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static FirewallPolicy parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static FirewallPolicy parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<FirewallPolicy> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getActions(int index)
public FirewallAction getActions(int index)
Optional. The actions that the caller should take regarding user access.
There should be at most one terminal action. A terminal action is any
action that forces a response, such as AllowAction,
BlockAction or SubstituteAction.
Zero or more non-terminal actions such as SetHeader might be
specified. A single policy can contain up to 16 actions.
repeated .google.cloud.recaptchaenterprise.v1.FirewallAction actions = 6 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
index |
int
|
getActionsCount()
public int getActionsCount()
Optional. The actions that the caller should take regarding user access.
There should be at most one terminal action. A terminal action is any
action that forces a response, such as AllowAction,
BlockAction or SubstituteAction.
Zero or more non-terminal actions such as SetHeader might be
specified. A single policy can contain up to 16 actions.
repeated .google.cloud.recaptchaenterprise.v1.FirewallAction actions = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
int |
|
getActionsList()
public List<FirewallAction> getActionsList()
Optional. The actions that the caller should take regarding user access.
There should be at most one terminal action. A terminal action is any
action that forces a response, such as AllowAction,
BlockAction or SubstituteAction.
Zero or more non-terminal actions such as SetHeader might be
specified. A single policy can contain up to 16 actions.
repeated .google.cloud.recaptchaenterprise.v1.FirewallAction actions = 6 [(.google.api.field_behavior) = OPTIONAL];
getActionsOrBuilder(int index)
public FirewallActionOrBuilder getActionsOrBuilder(int index)
Optional. The actions that the caller should take regarding user access.
There should be at most one terminal action. A terminal action is any
action that forces a response, such as AllowAction,
BlockAction or SubstituteAction.
Zero or more non-terminal actions such as SetHeader might be
specified. A single policy can contain up to 16 actions.
repeated .google.cloud.recaptchaenterprise.v1.FirewallAction actions = 6 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
index |
int
|
getActionsOrBuilderList()
public List<? extends FirewallActionOrBuilder> getActionsOrBuilderList()
Optional. The actions that the caller should take regarding user access.
There should be at most one terminal action. A terminal action is any
action that forces a response, such as AllowAction,
BlockAction or SubstituteAction.
Zero or more non-terminal actions such as SetHeader might be
specified. A single policy can contain up to 16 actions.
repeated .google.cloud.recaptchaenterprise.v1.FirewallAction actions = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
List<? extends com.google.recaptchaenterprise.v1.FirewallActionOrBuilder> |
|
getCondition()
public String getCondition()
Optional. A CEL (Common Expression Language) conditional expression that
specifies if this policy applies to an incoming user request. If this
condition evaluates to true and the requested path matched the path
pattern, the associated actions should be executed by the caller. The
condition string is checked for CEL syntax correctness on creation. For
more information, see the CEL spec
and its language
definition.
A condition has a max length of 500 characters.
string condition = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
String |
The condition.
|
getConditionBytes()
public ByteString getConditionBytes()
Optional. A CEL (Common Expression Language) conditional expression that
specifies if this policy applies to an incoming user request. If this
condition evaluates to true and the requested path matched the path
pattern, the associated actions should be executed by the caller. The
condition string is checked for CEL syntax correctness on creation. For
more information, see the CEL spec
and its language
definition.
A condition has a max length of 500 characters.
string condition = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
ByteString |
The bytes for condition.
|
getDefaultInstanceForType()
public FirewallPolicy getDefaultInstanceForType()
getDescription()
public String getDescription()
Optional. A description of what this policy aims to achieve, for
convenience purposes. The description can at most include 256 UTF-8
characters.
string description = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
String |
The description.
|
getDescriptionBytes()
public ByteString getDescriptionBytes()
Optional. A description of what this policy aims to achieve, for
convenience purposes. The description can at most include 256 UTF-8
characters.
string description = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
ByteString |
The bytes for description.
|
getName()
Identifier. The resource name for the FirewallPolicy in the format
projects/{project}/firewallpolicies/{firewallpolicy}.
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
| Returns |
| Type |
Description |
String |
The name.
|
getNameBytes()
public ByteString getNameBytes()
Identifier. The resource name for the FirewallPolicy in the format
projects/{project}/firewallpolicies/{firewallpolicy}.
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
| Returns |
| Type |
Description |
ByteString |
The bytes for name.
|
getParserForType()
public Parser<FirewallPolicy> getParserForType()
Overrides
getPath()
Optional. The path for which this policy applies, specified as a glob
pattern. For more information on glob, see the manual
page.
A path has a max length of 200 characters.
string path = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
String |
The path.
|
getPathBytes()
public ByteString getPathBytes()
Optional. The path for which this policy applies, specified as a glob
pattern. For more information on glob, see the manual
page.
A path has a max length of 200 characters.
string path = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
ByteString |
The bytes for path.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public FirewallPolicy.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected FirewallPolicy.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public FirewallPolicy.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
