Class FirewallRule.Builder

  • All Implemented Interfaces:
    FirewallRuleOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
    Enclosing class:
    FirewallRule

    public static final class FirewallRule.Builder
    extends com.google.protobuf.GeneratedMessageV3.Builder<FirewallRule.Builder>
    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
    • Method Detail

      • 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.Builder<FirewallRule.Builder>
      • clear

        public FirewallRule.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessageV3.Builder<FirewallRule.Builder>
      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<FirewallRule.Builder>
      • getDefaultInstanceForType

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

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

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

        public FirewallRule.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<FirewallRule.Builder>
      • setField

        public FirewallRule.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                             Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<FirewallRule.Builder>
      • clearField

        public FirewallRule.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<FirewallRule.Builder>
      • clearOneof

        public FirewallRule.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<FirewallRule.Builder>
      • setRepeatedField

        public FirewallRule.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                     int index,
                                                     Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<FirewallRule.Builder>
      • addRepeatedField

        public FirewallRule.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                     Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<FirewallRule.Builder>
      • mergeFrom

        public FirewallRule.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<FirewallRule.Builder>
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<FirewallRule.Builder>
      • mergeFrom

        public FirewallRule.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<FirewallRule.Builder>
        Throws:
        IOException
      • 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.
      • setPriority

        public FirewallRule.Builder setPriority​(int value)
         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;
        Parameters:
        value - The priority to set.
        Returns:
        This builder for chaining.
      • clearPriority

        public FirewallRule.Builder clearPriority()
         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;
        Returns:
        This builder for chaining.
      • 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.
      • setActionValue

        public FirewallRule.Builder setActionValue​(int value)
         The action to take on matched requests.
         
        .google.appengine.v1.FirewallRule.Action action = 2;
        Parameters:
        value - The enum numeric value on the wire for action to set.
        Returns:
        This builder for chaining.
      • setAction

        public FirewallRule.Builder setAction​(FirewallRule.Action value)
         The action to take on matched requests.
         
        .google.appengine.v1.FirewallRule.Action action = 2;
        Parameters:
        value - The action to set.
        Returns:
        This builder for chaining.
      • clearAction

        public FirewallRule.Builder clearAction()
         The action to take on matched requests.
         
        .google.appengine.v1.FirewallRule.Action action = 2;
        Returns:
        This builder for chaining.
      • 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.
      • setSourceRange

        public FirewallRule.Builder setSourceRange​(String value)
         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;
        Parameters:
        value - The sourceRange to set.
        Returns:
        This builder for chaining.
      • clearSourceRange

        public FirewallRule.Builder clearSourceRange()
         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;
        Returns:
        This builder for chaining.
      • setSourceRangeBytes

        public FirewallRule.Builder setSourceRangeBytes​(com.google.protobuf.ByteString value)
         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;
        Parameters:
        value - The bytes for sourceRange to set.
        Returns:
        This builder for chaining.
      • 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.
      • setDescription

        public FirewallRule.Builder setDescription​(String value)
         An optional string description of this rule.
         This field has a maximum length of 100 characters.
         
        string description = 4;
        Parameters:
        value - The description to set.
        Returns:
        This builder for chaining.
      • clearDescription

        public FirewallRule.Builder clearDescription()
         An optional string description of this rule.
         This field has a maximum length of 100 characters.
         
        string description = 4;
        Returns:
        This builder for chaining.
      • setDescriptionBytes

        public FirewallRule.Builder setDescriptionBytes​(com.google.protobuf.ByteString value)
         An optional string description of this rule.
         This field has a maximum length of 100 characters.
         
        string description = 4;
        Parameters:
        value - The bytes for description to set.
        Returns:
        This builder for chaining.
      • setUnknownFields

        public final FirewallRule.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<FirewallRule.Builder>
      • mergeUnknownFields

        public final FirewallRule.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<FirewallRule.Builder>