Class HttpRedirectAction.Builder

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

    public static final class HttpRedirectAction.Builder
    extends com.google.protobuf.GeneratedMessageV3.Builder<HttpRedirectAction.Builder>
    implements HttpRedirectActionOrBuilder
     Specifies settings for an HTTP redirect.
     
    Protobuf type google.cloud.compute.v1.HttpRedirectAction
    • 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<HttpRedirectAction.Builder>
      • clear

        public HttpRedirectAction.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<HttpRedirectAction.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<HttpRedirectAction.Builder>
      • getDefaultInstanceForType

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

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

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

        public HttpRedirectAction.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<HttpRedirectAction.Builder>
      • setField

        public HttpRedirectAction.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<HttpRedirectAction.Builder>
      • clearField

        public HttpRedirectAction.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<HttpRedirectAction.Builder>
      • clearOneof

        public HttpRedirectAction.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<HttpRedirectAction.Builder>
      • setRepeatedField

        public HttpRedirectAction.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<HttpRedirectAction.Builder>
      • addRepeatedField

        public HttpRedirectAction.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<HttpRedirectAction.Builder>
      • mergeFrom

        public HttpRedirectAction.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<HttpRedirectAction.Builder>
      • isInitialized

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

        public HttpRedirectAction.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<HttpRedirectAction.Builder>
        Throws:
        IOException
      • hasHostRedirect

        public boolean hasHostRedirect()
         The host that is used in the redirect response instead of the one that was supplied in the request. The value must be from 1 to 255 characters.
         
        optional string host_redirect = 107417747;
        Specified by:
        hasHostRedirect in interface HttpRedirectActionOrBuilder
        Returns:
        Whether the hostRedirect field is set.
      • getHostRedirect

        public String getHostRedirect()
         The host that is used in the redirect response instead of the one that was supplied in the request. The value must be from 1 to 255 characters.
         
        optional string host_redirect = 107417747;
        Specified by:
        getHostRedirect in interface HttpRedirectActionOrBuilder
        Returns:
        The hostRedirect.
      • getHostRedirectBytes

        public com.google.protobuf.ByteString getHostRedirectBytes()
         The host that is used in the redirect response instead of the one that was supplied in the request. The value must be from 1 to 255 characters.
         
        optional string host_redirect = 107417747;
        Specified by:
        getHostRedirectBytes in interface HttpRedirectActionOrBuilder
        Returns:
        The bytes for hostRedirect.
      • setHostRedirect

        public HttpRedirectAction.Builder setHostRedirect​(String value)
         The host that is used in the redirect response instead of the one that was supplied in the request. The value must be from 1 to 255 characters.
         
        optional string host_redirect = 107417747;
        Parameters:
        value - The hostRedirect to set.
        Returns:
        This builder for chaining.
      • clearHostRedirect

        public HttpRedirectAction.Builder clearHostRedirect()
         The host that is used in the redirect response instead of the one that was supplied in the request. The value must be from 1 to 255 characters.
         
        optional string host_redirect = 107417747;
        Returns:
        This builder for chaining.
      • setHostRedirectBytes

        public HttpRedirectAction.Builder setHostRedirectBytes​(com.google.protobuf.ByteString value)
         The host that is used in the redirect response instead of the one that was supplied in the request. The value must be from 1 to 255 characters.
         
        optional string host_redirect = 107417747;
        Parameters:
        value - The bytes for hostRedirect to set.
        Returns:
        This builder for chaining.
      • hasHttpsRedirect

        public boolean hasHttpsRedirect()
         If set to true, the URL scheme in the redirected request is set to HTTPS. If set to false, the URL scheme of the redirected request remains the same as that of the request. This must only be set for URL maps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false.
         
        optional bool https_redirect = 170260656;
        Specified by:
        hasHttpsRedirect in interface HttpRedirectActionOrBuilder
        Returns:
        Whether the httpsRedirect field is set.
      • getHttpsRedirect

        public boolean getHttpsRedirect()
         If set to true, the URL scheme in the redirected request is set to HTTPS. If set to false, the URL scheme of the redirected request remains the same as that of the request. This must only be set for URL maps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false.
         
        optional bool https_redirect = 170260656;
        Specified by:
        getHttpsRedirect in interface HttpRedirectActionOrBuilder
        Returns:
        The httpsRedirect.
      • setHttpsRedirect

        public HttpRedirectAction.Builder setHttpsRedirect​(boolean value)
         If set to true, the URL scheme in the redirected request is set to HTTPS. If set to false, the URL scheme of the redirected request remains the same as that of the request. This must only be set for URL maps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false.
         
        optional bool https_redirect = 170260656;
        Parameters:
        value - The httpsRedirect to set.
        Returns:
        This builder for chaining.
      • clearHttpsRedirect

        public HttpRedirectAction.Builder clearHttpsRedirect()
         If set to true, the URL scheme in the redirected request is set to HTTPS. If set to false, the URL scheme of the redirected request remains the same as that of the request. This must only be set for URL maps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false.
         
        optional bool https_redirect = 170260656;
        Returns:
        This builder for chaining.
      • hasPathRedirect

        public boolean hasPathRedirect()
         The path that is used in the redirect response instead of the one that was supplied in the request. pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request is used for the redirect. The value must be from 1 to 1024 characters.
         
        optional string path_redirect = 272342710;
        Specified by:
        hasPathRedirect in interface HttpRedirectActionOrBuilder
        Returns:
        Whether the pathRedirect field is set.
      • getPathRedirect

        public String getPathRedirect()
         The path that is used in the redirect response instead of the one that was supplied in the request. pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request is used for the redirect. The value must be from 1 to 1024 characters.
         
        optional string path_redirect = 272342710;
        Specified by:
        getPathRedirect in interface HttpRedirectActionOrBuilder
        Returns:
        The pathRedirect.
      • getPathRedirectBytes

        public com.google.protobuf.ByteString getPathRedirectBytes()
         The path that is used in the redirect response instead of the one that was supplied in the request. pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request is used for the redirect. The value must be from 1 to 1024 characters.
         
        optional string path_redirect = 272342710;
        Specified by:
        getPathRedirectBytes in interface HttpRedirectActionOrBuilder
        Returns:
        The bytes for pathRedirect.
      • setPathRedirect

        public HttpRedirectAction.Builder setPathRedirect​(String value)
         The path that is used in the redirect response instead of the one that was supplied in the request. pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request is used for the redirect. The value must be from 1 to 1024 characters.
         
        optional string path_redirect = 272342710;
        Parameters:
        value - The pathRedirect to set.
        Returns:
        This builder for chaining.
      • clearPathRedirect

        public HttpRedirectAction.Builder clearPathRedirect()
         The path that is used in the redirect response instead of the one that was supplied in the request. pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request is used for the redirect. The value must be from 1 to 1024 characters.
         
        optional string path_redirect = 272342710;
        Returns:
        This builder for chaining.
      • setPathRedirectBytes

        public HttpRedirectAction.Builder setPathRedirectBytes​(com.google.protobuf.ByteString value)
         The path that is used in the redirect response instead of the one that was supplied in the request. pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request is used for the redirect. The value must be from 1 to 1024 characters.
         
        optional string path_redirect = 272342710;
        Parameters:
        value - The bytes for pathRedirect to set.
        Returns:
        This builder for chaining.
      • hasPrefixRedirect

        public boolean hasPrefixRedirect()
         The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. prefixRedirect cannot be supplied together with pathRedirect. Supply one alone or neither. If neither is supplied, the path of the original request is used for the redirect. The value must be from 1 to 1024 characters.
         
        optional string prefix_redirect = 446184169;
        Specified by:
        hasPrefixRedirect in interface HttpRedirectActionOrBuilder
        Returns:
        Whether the prefixRedirect field is set.
      • getPrefixRedirect

        public String getPrefixRedirect()
         The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. prefixRedirect cannot be supplied together with pathRedirect. Supply one alone or neither. If neither is supplied, the path of the original request is used for the redirect. The value must be from 1 to 1024 characters.
         
        optional string prefix_redirect = 446184169;
        Specified by:
        getPrefixRedirect in interface HttpRedirectActionOrBuilder
        Returns:
        The prefixRedirect.
      • getPrefixRedirectBytes

        public com.google.protobuf.ByteString getPrefixRedirectBytes()
         The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. prefixRedirect cannot be supplied together with pathRedirect. Supply one alone or neither. If neither is supplied, the path of the original request is used for the redirect. The value must be from 1 to 1024 characters.
         
        optional string prefix_redirect = 446184169;
        Specified by:
        getPrefixRedirectBytes in interface HttpRedirectActionOrBuilder
        Returns:
        The bytes for prefixRedirect.
      • setPrefixRedirect

        public HttpRedirectAction.Builder setPrefixRedirect​(String value)
         The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. prefixRedirect cannot be supplied together with pathRedirect. Supply one alone or neither. If neither is supplied, the path of the original request is used for the redirect. The value must be from 1 to 1024 characters.
         
        optional string prefix_redirect = 446184169;
        Parameters:
        value - The prefixRedirect to set.
        Returns:
        This builder for chaining.
      • clearPrefixRedirect

        public HttpRedirectAction.Builder clearPrefixRedirect()
         The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. prefixRedirect cannot be supplied together with pathRedirect. Supply one alone or neither. If neither is supplied, the path of the original request is used for the redirect. The value must be from 1 to 1024 characters.
         
        optional string prefix_redirect = 446184169;
        Returns:
        This builder for chaining.
      • setPrefixRedirectBytes

        public HttpRedirectAction.Builder setPrefixRedirectBytes​(com.google.protobuf.ByteString value)
         The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. prefixRedirect cannot be supplied together with pathRedirect. Supply one alone or neither. If neither is supplied, the path of the original request is used for the redirect. The value must be from 1 to 1024 characters.
         
        optional string prefix_redirect = 446184169;
        Parameters:
        value - The bytes for prefixRedirect to set.
        Returns:
        This builder for chaining.
      • hasRedirectResponseCode

        public boolean hasRedirectResponseCode()
         The HTTP Status code to use for this RedirectAction. Supported values are: - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301. - FOUND, which corresponds to 302. - SEE_OTHER which corresponds to 303. - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method is retained. - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method is retained.
         Check the RedirectResponseCode enum for the list of possible values.
         
        optional string redirect_response_code = 436710408;
        Specified by:
        hasRedirectResponseCode in interface HttpRedirectActionOrBuilder
        Returns:
        Whether the redirectResponseCode field is set.
      • getRedirectResponseCode

        public String getRedirectResponseCode()
         The HTTP Status code to use for this RedirectAction. Supported values are: - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301. - FOUND, which corresponds to 302. - SEE_OTHER which corresponds to 303. - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method is retained. - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method is retained.
         Check the RedirectResponseCode enum for the list of possible values.
         
        optional string redirect_response_code = 436710408;
        Specified by:
        getRedirectResponseCode in interface HttpRedirectActionOrBuilder
        Returns:
        The redirectResponseCode.
      • getRedirectResponseCodeBytes

        public com.google.protobuf.ByteString getRedirectResponseCodeBytes()
         The HTTP Status code to use for this RedirectAction. Supported values are: - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301. - FOUND, which corresponds to 302. - SEE_OTHER which corresponds to 303. - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method is retained. - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method is retained.
         Check the RedirectResponseCode enum for the list of possible values.
         
        optional string redirect_response_code = 436710408;
        Specified by:
        getRedirectResponseCodeBytes in interface HttpRedirectActionOrBuilder
        Returns:
        The bytes for redirectResponseCode.
      • setRedirectResponseCode

        public HttpRedirectAction.Builder setRedirectResponseCode​(String value)
         The HTTP Status code to use for this RedirectAction. Supported values are: - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301. - FOUND, which corresponds to 302. - SEE_OTHER which corresponds to 303. - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method is retained. - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method is retained.
         Check the RedirectResponseCode enum for the list of possible values.
         
        optional string redirect_response_code = 436710408;
        Parameters:
        value - The redirectResponseCode to set.
        Returns:
        This builder for chaining.
      • clearRedirectResponseCode

        public HttpRedirectAction.Builder clearRedirectResponseCode()
         The HTTP Status code to use for this RedirectAction. Supported values are: - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301. - FOUND, which corresponds to 302. - SEE_OTHER which corresponds to 303. - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method is retained. - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method is retained.
         Check the RedirectResponseCode enum for the list of possible values.
         
        optional string redirect_response_code = 436710408;
        Returns:
        This builder for chaining.
      • setRedirectResponseCodeBytes

        public HttpRedirectAction.Builder setRedirectResponseCodeBytes​(com.google.protobuf.ByteString value)
         The HTTP Status code to use for this RedirectAction. Supported values are: - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301. - FOUND, which corresponds to 302. - SEE_OTHER which corresponds to 303. - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method is retained. - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method is retained.
         Check the RedirectResponseCode enum for the list of possible values.
         
        optional string redirect_response_code = 436710408;
        Parameters:
        value - The bytes for redirectResponseCode to set.
        Returns:
        This builder for chaining.
      • hasStripQuery

        public boolean hasStripQuery()
         If set to true, any accompanying query portion of the original URL is removed before redirecting the request. If set to false, the query portion of the original URL is retained. The default is set to false.
         
        optional bool strip_query = 52284641;
        Specified by:
        hasStripQuery in interface HttpRedirectActionOrBuilder
        Returns:
        Whether the stripQuery field is set.
      • getStripQuery

        public boolean getStripQuery()
         If set to true, any accompanying query portion of the original URL is removed before redirecting the request. If set to false, the query portion of the original URL is retained. The default is set to false.
         
        optional bool strip_query = 52284641;
        Specified by:
        getStripQuery in interface HttpRedirectActionOrBuilder
        Returns:
        The stripQuery.
      • setStripQuery

        public HttpRedirectAction.Builder setStripQuery​(boolean value)
         If set to true, any accompanying query portion of the original URL is removed before redirecting the request. If set to false, the query portion of the original URL is retained. The default is set to false.
         
        optional bool strip_query = 52284641;
        Parameters:
        value - The stripQuery to set.
        Returns:
        This builder for chaining.
      • clearStripQuery

        public HttpRedirectAction.Builder clearStripQuery()
         If set to true, any accompanying query portion of the original URL is removed before redirecting the request. If set to false, the query portion of the original URL is retained. The default is set to false.
         
        optional bool strip_query = 52284641;
        Returns:
        This builder for chaining.
      • setUnknownFields

        public final HttpRedirectAction.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<HttpRedirectAction.Builder>
      • mergeUnknownFields

        public final HttpRedirectAction.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<HttpRedirectAction.Builder>