Skip to content

Commit

Permalink
Update urlRedirect property of UrlMap and RegionUrlMap
Browse files Browse the repository at this point in the history 
* The stripQuery parameter should not be required since it is set to
  false by default.
* Documentation has been synced with:
  https://cloud.google.com/compute/docs/reference/rest/v1/urlMaps
  • Loading branch information
@ctavan
ctavan committed Apr 23, 2020
1 parent d6c95b8 commit 31153d5
Showing 1 changed file with 81 additions and 55 deletions.
136 changes: 81 additions & 55 deletions products/compute/api.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9420,35 +9420,45 @@ objects:
- !ruby/object:Api::Type::String
name: 'hostRedirect'
description: |
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.
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.
- !ruby/object:Api::Type::Boolean
name: 'httpsRedirect'
default_value: false
description: |
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. Defaults to false.
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.
- !ruby/object:Api::Type::String
name: 'pathRedirect'
description: |
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.
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.
- !ruby/object:Api::Type::String
name: 'prefixRedirect'
description: |
The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch,
retaining the remaining portion of the URL before redirecting the request.
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.
- !ruby/object:Api::Type::Enum
name: 'redirectResponseCode'
description: |
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 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.
values:
- :FOUND
Expand All @@ -9460,9 +9470,9 @@ objects:
name: 'stripQuery'
default_value: false
description: |
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. Defaults to false.
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.
- !ruby/object:Api::Type::Array
name: 'pathRules'
description: |
Expand Down Expand Up @@ -9822,34 +9832,42 @@ objects:
- !ruby/object:Api::Type::NestedObject
name: 'urlRedirect'
description: |
When a path pattern is matched, the request is redirected to a URL specified by
urlRedirect. If urlRedirect is specified, service or routeAction must not be
set.
When a path pattern is matched, the request is redirected to a URL specified
by urlRedirect. If urlRedirect is specified, service or routeAction must not
be set.
properties:
- !ruby/object:Api::Type::String
name: 'hostRedirect'
description: |
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.
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.
- !ruby/object:Api::Type::Boolean
name: 'httpsRedirect'
default_value: false
description: |
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. Defaults to false.
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.
- !ruby/object:Api::Type::String
name: 'pathRedirect'
description: |
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.
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.
- !ruby/object:Api::Type::String
name: 'prefixRedirect'
description: |
The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch,
retaining the remaining portion of the URL before redirecting the request.
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.
- !ruby/object:Api::Type::Enum
name: 'redirectResponseCode'
description: |
Expand All @@ -9869,11 +9887,11 @@ objects:
- :TEMPORARY_REDIRECT
- !ruby/object:Api::Type::Boolean
name: 'stripQuery'
required: true
default_value: false
description: |
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.
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.
- !ruby/object:Api::Type::Array
name: 'tests'
description: |
Expand Down Expand Up @@ -14254,34 +14272,42 @@ objects:
- !ruby/object:Api::Type::NestedObject
name: 'urlRedirect'
description: |
When a path pattern is matched, the request is redirected to a URL specified by
urlRedirect. If urlRedirect is specified, service or routeAction must not be
set.
When a path pattern is matched, the request is redirected to a URL specified
by urlRedirect. If urlRedirect is specified, service or routeAction must not
be set.
properties:
- !ruby/object:Api::Type::String
name: 'hostRedirect'
description: |
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.
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.
- !ruby/object:Api::Type::Boolean
name: 'httpsRedirect'
default_value: false
description: |
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. Defaults to false.
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.
- !ruby/object:Api::Type::String
name: 'pathRedirect'
description: |
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.
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.
- !ruby/object:Api::Type::String
name: 'prefixRedirect'
description: |
The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch,
retaining the remaining portion of the URL before redirecting the request.
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.
- !ruby/object:Api::Type::Enum
name: 'redirectResponseCode'
description: |
Expand All @@ -14301,11 +14327,11 @@ objects:
- :TEMPORARY_REDIRECT
- !ruby/object:Api::Type::Boolean
name: 'stripQuery'
required: true
default_value: false
description: |
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.
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.
- !ruby/object:Api::Type::Array
name: 'routeRules'
description: |
Expand Down

0 comments on commit 31153d5

Please sign in to comment.