Package com.google.appengine.v1.firewall

Class FirewallRule

  • All Implemented Interfaces:
    FirewallRuleOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class FirewallRule
extends com.google.protobuf.GeneratedMessageV3
implements FirewallRuleOrBuilder
     A single firewall rule that is evaluated against incoming traffic
 and provides an action to take on matched requests.
    Protobuf type google.appengine.v1.FirewallRule
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  FirewallRule.Action
      Available actions to take on matching requests.
      static class  FirewallRule.Builder
      A single firewall rule that is evaluated against incoming traffic and provides an action to take on matched requests.

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

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

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int ACTION_FIELD_NUMBER  
      static int DESCRIPTION_FIELD_NUMBER  
      static int PRIORITY_FIELD_NUMBER  
      static int SOURCE_RANGE_FIELD_NUMBER  

      • Fields inherited from class com.google.protobuf.GeneratedMessageV3

        alwaysUseFieldBuilders, unknownFields

      • Fields inherited from class com.google.protobuf.AbstractMessage

        memoizedSize

      • Fields inherited from class com.google.protobuf.AbstractMessageLite

        memoizedHashCode

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

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

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getPriority

        public int getPriority()
         A positive integer between [1, Int32.MaxValue-1] that defines the order of
 rule evaluation. Rules with the lowest priority are evaluated first.

 A default rule at priority Int32.MaxValue matches all IPv4 and IPv6 traffic
 when no previous rule matches. Only the action of this rule can be modified
 by the user.
        int32 priority = 1;
        Specified by:
        getPriority in interface FirewallRuleOrBuilder
        Returns:
        The priority.

      • getActionValue

        public int getActionValue()
         The action to take on matched requests.
        .google.appengine.v1.FirewallRule.Action action = 2;
        Specified by:
        getActionValue in interface FirewallRuleOrBuilder
        Returns:
        The enum numeric value on the wire for action.

      • getSourceRange

        public String getSourceRange()
         IP address or range, defined using CIDR notation, of requests that this
 rule applies to. You can use the wildcard character "*" to match all IPs
 equivalent to "0/0" and "::/0" together.
 Examples: `192.168.1.1` or `192.168.0.0/16` or `2001:db8::/32`
           or `2001:0db8:0000:0042:0000:8a2e:0370:7334`.


 <p>Truncation will be silently performed on addresses which are not
 properly truncated. For example, `1.2.3.4/24` is accepted as the same
 address as `1.2.3.0/24`. Similarly, for IPv6, `2001:db8::1/32` is accepted
 as the same address as `2001:db8::/32`.
        string source_range = 3;
        Specified by:
        getSourceRange in interface FirewallRuleOrBuilder
        Returns:
        The sourceRange.

      • getSourceRangeBytes

        public com.google.protobuf.ByteString getSourceRangeBytes()
         IP address or range, defined using CIDR notation, of requests that this
 rule applies to. You can use the wildcard character "*" to match all IPs
 equivalent to "0/0" and "::/0" together.
 Examples: `192.168.1.1` or `192.168.0.0/16` or `2001:db8::/32`
           or `2001:0db8:0000:0042:0000:8a2e:0370:7334`.


 <p>Truncation will be silently performed on addresses which are not
 properly truncated. For example, `1.2.3.4/24` is accepted as the same
 address as `1.2.3.0/24`. Similarly, for IPv6, `2001:db8::1/32` is accepted
 as the same address as `2001:db8::/32`.
        string source_range = 3;
        Specified by:
        getSourceRangeBytes in interface FirewallRuleOrBuilder
        Returns:
        The bytes for sourceRange.

      • getDescription

        public String getDescription()
         An optional string description of this rule.
 This field has a maximum length of 100 characters.
        string description = 4;
        Specified by:
        getDescription in interface FirewallRuleOrBuilder
        Returns:
        The description.

      • getDescriptionBytes

        public com.google.protobuf.ByteString getDescriptionBytes()
         An optional string description of this rule.
 This field has a maximum length of 100 characters.
        string description = 4;
        Specified by:
        getDescriptionBytes in interface FirewallRuleOrBuilder
        Returns:
        The bytes for description.

      • isInitialized

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

      • 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.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

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

      • 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 FirewallRule parseFrom​(ByteBuffer data)
                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

        public static FirewallRule parseFrom​(com.google.protobuf.ByteString data)
                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

        public static FirewallRule parseFrom​(com.google.protobuf.CodedInputStream input,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws IOException
        Throws:
        IOException

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

        protected FirewallRule.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static FirewallRule getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<FirewallRule> parser()

      • getParserForType

        public com.google.protobuf.Parser<FirewallRule> 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.GeneratedMessageV3

      • getDefaultInstanceForType

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