Package com.google.cloud.compute.v1

Class HttpRedirectAction

  • All Implemented Interfaces:
    HttpRedirectActionOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class HttpRedirectAction
extends com.google.protobuf.GeneratedMessageV3
implements HttpRedirectActionOrBuilder
     Specifies settings for an HTTP redirect.
    Protobuf type google.cloud.compute.v1.HttpRedirectAction
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  HttpRedirectAction.Builder
      Specifies settings for an HTTP redirect.
      static class  HttpRedirectAction.RedirectResponseCode
      The HTTP Status code to use for this RedirectAction.

      • 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 Detail

      • HOST_REDIRECT_FIELD_NUMBER

        public static final int HOST_REDIRECT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • HTTPS_REDIRECT_FIELD_NUMBER

        public static final int HTTPS_REDIRECT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • PATH_REDIRECT_FIELD_NUMBER

        public static final int PATH_REDIRECT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • PREFIX_REDIRECT_FIELD_NUMBER

        public static final int PREFIX_REDIRECT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • REDIRECT_RESPONSE_CODE_FIELD_NUMBER

        public static final int REDIRECT_RESPONSE_CODE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • STRIP_QUERY_FIELD_NUMBER

        public static final int STRIP_QUERY_FIELD_NUMBER
        See Also:
        Constant Field Values

    • 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

      • 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.

      • 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.

      • 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.

      • 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.

      • 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.

      • 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.

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

        public com.google.protobuf.Parser<HttpRedirectAction> 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 HttpRedirectAction getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder