Class: Google::Apis::ComputeAlpha::HttpRedirectAction
- Inherits:
-
Object
- Object
- Google::Apis::ComputeAlpha::HttpRedirectAction
- Defined in:
- generated/google/apis/compute_alpha/classes.rb,
generated/google/apis/compute_alpha/representations.rb,
generated/google/apis/compute_alpha/representations.rb
Overview
Specifies settings for an HTTP redirect.
Instance Attribute Summary collapse
-
#host_redirect ⇒ String
The host that will be used in the redirect response instead of the one that was supplied in the request.
-
#https_redirect ⇒ Boolean
(also: #https_redirect?)
If set to true, the URL scheme in the redirected request is set to https.
-
#path_redirect ⇒ String
The path that will be used in the redirect response instead of the one that was supplied in the request.
-
#prefix_redirect ⇒ String
The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.
-
#redirect_response_code ⇒ String
The HTTP Status code to use for this RedirectAction.
-
#strip_query ⇒ Boolean
(also: #strip_query?)
If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request.
Instance Method Summary collapse
-
#initialize(**args) ⇒ HttpRedirectAction
constructor
A new instance of HttpRedirectAction.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Google::Apis::Core::JsonObjectSupport
Methods included from Google::Apis::Core::Hashable
Constructor Details
#initialize(**args) ⇒ HttpRedirectAction
Returns a new instance of HttpRedirectAction
10001 10002 10003 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 10001 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
9951 9952 9953 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 9951 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
9961 9962 9963 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 9961 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.
Only one of pathRedirect or prefixRedirect must be specified.
The value must be between 1 and 1024 characters.
Corresponds to the JSON property pathRedirect
9970 9971 9972 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 9970 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.
Corresponds to the JSON property prefixRedirect
9976 9977 9978 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 9976 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
9990 9991 9992 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 9990 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
9998 9999 10000 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 9998 def strip_query @strip_query end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
10006 10007 10008 10009 10010 10011 10012 10013 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 10006 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 |