Google Cloud Compute V1 API - Class Google::Cloud::Compute::V1::HttpRedirectAction (v3.5.0)

Reference documentation and code samples for the Google Cloud Compute V1 API class Google::Cloud::Compute::V1::HttpRedirectAction.

Specifies settings for an HTTP redirect.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#host_redirect

def host_redirect() -> ::String
Returns
  • (::String) — 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.

#host_redirect=

def host_redirect=(value) -> ::String
Parameter
  • value (::String) — 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.

Returns
  • (::String) — 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.

#https_redirect

def https_redirect() -> ::Boolean
Returns
  • (::Boolean) — 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 inTargetHttpProxys. Setting this true forTargetHttpsProxy is not permitted.

    The default is set to false.

#https_redirect=

def https_redirect=(value) -> ::Boolean
Parameter
  • value (::Boolean) — 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 inTargetHttpProxys. Setting this true forTargetHttpsProxy is not permitted.

    The default is set to false.

Returns
  • (::Boolean) — 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 inTargetHttpProxys. Setting this true forTargetHttpsProxy is not permitted.

    The default is set to false.

#path_redirect

def path_redirect() -> ::String
Returns
  • (::String) — The path that is used in the redirect response instead of the one that was supplied in the request.

    pathRedirect cannot be supplied together withprefixRedirect. 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.

#path_redirect=

def path_redirect=(value) -> ::String
Parameter
  • value (::String) — The path that is used in the redirect response instead of the one that was supplied in the request.

    pathRedirect cannot be supplied together withprefixRedirect. 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.

Returns
  • (::String) — The path that is used in the redirect response instead of the one that was supplied in the request.

    pathRedirect cannot be supplied together withprefixRedirect. 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.

#prefix_redirect

def prefix_redirect() -> ::String
Returns
  • (::String) — 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 withpathRedirect. 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.

#prefix_redirect=

def prefix_redirect=(value) -> ::String
Parameter
  • value (::String) — 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 withpathRedirect. 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.

Returns
  • (::String) — 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 withpathRedirect. 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.

#redirect_response_code

def redirect_response_code() -> ::String
Returns
  • (::String) —

    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.

#redirect_response_code=

def redirect_response_code=(value) -> ::String
Parameter
  • value (::String) —

    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.
Returns
  • (::String) —

    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.

#strip_query

def strip_query() -> ::Boolean
Returns
  • (::Boolean) — 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.

#strip_query=

def strip_query=(value) -> ::Boolean
Parameter
  • value (::Boolean) — 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.

Returns
  • (::Boolean) — 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.