Class: Google::Apis::ComputeV1::HttpRedirectAction

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
generated/google/apis/compute_v1/classes.rb,
generated/google/apis/compute_v1/representations.rb,
generated/google/apis/compute_v1/representations.rb

Overview

Specifies settings for an HTTP redirect.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ HttpRedirectAction

Returns a new instance of HttpRedirectAction.



9722
9723
9724
 
# File 'generated/google/apis/compute_v1/classes.rb', line 9722

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#host_redirect ⇒ String

The host that will be used in the redirect response instead of the one that was supplied in the request. The value must be between 1 and 255 characters. Corresponds to the JSON property hostRedirect

Returns:

  • (String) 


9666
9667
9668
 
# File 'generated/google/apis/compute_v1/classes.rb', line 9666

def host_redirect
  @host_redirect
end

#https_redirect ⇒ Boolean Also known as: https_redirect?

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 will remain the same as that of the request. This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false. Corresponds to the JSON property httpsRedirect

Returns:

  • (Boolean) 


9676
9677
9678
 
# File 'generated/google/apis/compute_v1/classes.rb', line 9676

def https_redirect
  @https_redirect
end

#path_redirect ⇒ String

The path that will be 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 will be used for the redirect. The value must be between 1 and 1024 characters. Corresponds to the JSON property pathRedirect

Returns:

  • (String) 


9687
9688
9689
 
# File 'generated/google/apis/compute_v1/classes.rb', line 9687

def path_redirect
  @path_redirect
end

#prefix_redirect ⇒ 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 with pathRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect. The value must be between 1 and 1024 characters. Corresponds to the JSON property prefixRedirect

Returns:

  • (String) 


9697
9698
9699
 
# File 'generated/google/apis/compute_v1/classes.rb', line 9697

def prefix_redirect
  @prefix_redirect
end

#redirect_response_code ⇒ 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 will be retained.

  • PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained. Corresponds to the JSON property redirectResponseCode

Returns:

  • (String) 


9711
9712
9713
 
# File 'generated/google/apis/compute_v1/classes.rb', line 9711

def redirect_response_code
  @redirect_response_code
end

#strip_query ⇒ Boolean Also known as: strip_query?

If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained. The default is set to false. Corresponds to the JSON property stripQuery

Returns:

  • (Boolean) 


9719
9720
9721
 
# File 'generated/google/apis/compute_v1/classes.rb', line 9719

def strip_query
  @strip_query
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



9727
9728
9729
9730
9731
9732
9733
9734
 
# File 'generated/google/apis/compute_v1/classes.rb', line 9727

def update!(**args)
  @host_redirect = args[:host_redirect] if args.key?(:host_redirect)
  @https_redirect = args[:https_redirect] if args.key?(:https_redirect)
  @path_redirect = args[:path_redirect] if args.key?(:path_redirect)
  @prefix_redirect = args[:prefix_redirect] if args.key?(:prefix_redirect)
  @redirect_response_code = args[:redirect_response_code] if args.key?(:redirect_response_code)
  @strip_query = args[:strip_query] if args.key?(:strip_query)
end