Class FirewallPolicy

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.recaptchaenterprise.v1.FirewallPolicy
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, FirewallPolicyOrBuilder, Serializable

@Generated public final class FirewallPolicy extends com.google.protobuf.GeneratedMessage implements FirewallPolicyOrBuilder
 A FirewallPolicy represents a single matching pattern and resulting actions
 to take.
 
Protobuf type google.cloud.recaptchaenterprise.v1.FirewallPolicy
See Also:
  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    A FirewallPolicy represents a single matching pattern and resulting actions to take.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
     
    static final int
     
    static final int
     
    static final int
     
    static final int
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode
  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
     
    getActions(int index)
    Optional.
    int
    Optional.
    Optional.
    Optional.
    Optional.
    Optional.
    com.google.protobuf.ByteString
    Optional.
     
     
    Optional.
    com.google.protobuf.ByteString
    Optional.
    static final com.google.protobuf.Descriptors.Descriptor
     
    Identifier.
    com.google.protobuf.ByteString
    Identifier.
    com.google.protobuf.Parser<FirewallPolicy>
     
    Optional.
    com.google.protobuf.ByteString
    Optional.
    int
     
    int
     
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
     
    final boolean
     
     
     
     
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
     
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    parseFrom(byte[] data)
     
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    parseFrom(com.google.protobuf.ByteString data)
     
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
     
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
     
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<FirewallPolicy>
     
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
  • Field Details

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage
    • getName

      public String getName()
       Identifier. The resource name for the FirewallPolicy in the format
       `projects/{project}/firewallpolicies/{firewallpolicy}`.
       
      string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
      Specified by:
      getName in interface FirewallPolicyOrBuilder
      Returns:
      The name.
    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Identifier. The resource name for the FirewallPolicy in the format
       `projects/{project}/firewallpolicies/{firewallpolicy}`.
       
      string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
      Specified by:
      getNameBytes in interface FirewallPolicyOrBuilder
      Returns:
      The bytes for name.
    • 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];
      Specified by:
      getDescription in interface FirewallPolicyOrBuilder
      Returns:
      The description.
    • getDescriptionBytes

      public com.google.protobuf.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];
      Specified by:
      getDescriptionBytes in interface FirewallPolicyOrBuilder
      Returns:
      The bytes for description.
    • getPath

      public String getPath()
       Optional. The path for which this policy applies, specified as a glob
       pattern. For more information on glob, see the [manual
       page](https://man7.org/linux/man-pages/man7/glob.7.html).
       A path has a max length of 200 characters.
       
      string path = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPath in interface FirewallPolicyOrBuilder
      Returns:
      The path.
    • getPathBytes

      public com.google.protobuf.ByteString getPathBytes()
       Optional. The path for which this policy applies, specified as a glob
       pattern. For more information on glob, see the [manual
       page](https://man7.org/linux/man-pages/man7/glob.7.html).
       A path has a max length of 200 characters.
       
      string path = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPathBytes in interface FirewallPolicyOrBuilder
      Returns:
      The bytes for path.
    • 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](https://github.com/google/cel-spec)
       and its [language
       definition](https://github.com/google/cel-spec/blob/master/doc/langdef.md).
       A condition has a max length of 500 characters.
       
      string condition = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getCondition in interface FirewallPolicyOrBuilder
      Returns:
      The condition.
    • getConditionBytes

      public com.google.protobuf.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](https://github.com/google/cel-spec)
       and its [language
       definition](https://github.com/google/cel-spec/blob/master/doc/langdef.md).
       A condition has a max length of 500 characters.
       
      string condition = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getConditionBytes in interface FirewallPolicyOrBuilder
      Returns:
      The bytes for condition.
    • 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];
      Specified by:
      getActionsList in interface FirewallPolicyOrBuilder
    • 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];
      Specified by:
      getActionsOrBuilderList in interface FirewallPolicyOrBuilder
    • 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];
      Specified by:
      getActionsCount in interface FirewallPolicyOrBuilder
    • getActions

      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];
      Specified by:
      getActions in interface FirewallPolicyOrBuilder
    • getActionsOrBuilder

      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];
      Specified by:
      getActionsOrBuilder in interface FirewallPolicyOrBuilder
    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage
    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException
    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage
    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage
    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage
    • parseFrom

      public static FirewallPolicy parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static FirewallPolicy parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static FirewallPolicy parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static FirewallPolicy parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static FirewallPolicy parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static FirewallPolicy parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static FirewallPolicy parseFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

      public static FirewallPolicy parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

      public static FirewallPolicy parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

      public static FirewallPolicy parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • parseFrom

      public static FirewallPolicy parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

      public static FirewallPolicy parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • newBuilderForType

      public FirewallPolicy.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite
    • newBuilder

      public static FirewallPolicy.Builder newBuilder()
    • newBuilder

      public static FirewallPolicy.Builder newBuilder(FirewallPolicy prototype)
    • toBuilder

      public FirewallPolicy.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite
    • newBuilderForType

      protected FirewallPolicy.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage
    • getDefaultInstance

      public static FirewallPolicy getDefaultInstance()
    • parser

      public static com.google.protobuf.Parser<FirewallPolicy> parser()
    • getParserForType

      public com.google.protobuf.Parser<FirewallPolicy> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage
    • getDefaultInstanceForType

      public FirewallPolicy getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder