target.apidocs.com.google.api.services.compute.model.UrlRewrite.html Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of google-api-services-compute Show documentation

There is a newer version: v1-rev20240903-2.0.0

Show newest version







UrlRewrite (Compute Engine API v1-rev20240919-2.0.0)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.compute.model
Class UrlRewrite



java.lang.Object


java.util.AbstractMap<String,Object>


com.google.api.client.util.GenericData


com.google.api.client.json.GenericJson


com.google.api.services.compute.model.UrlRewrite













All Implemented Interfaces:
Cloneable, Map<String,Object>




public final class UrlRewrite
extends com.google.api.client.json.GenericJson
The spec for modifying the path before sending the request to the matched backend service.

  This is the Java data model class that specifies how to parse/serialize into the JSON that is
 transmitted over HTTP when working with the Compute Engine API. For a detailed explanation see:
 https://developers.google.com/api-client-library/java/google-http-java-client/json
 

Author:
Google, Inc.












Nested Class Summary




Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
com.google.api.client.util.GenericData.Flags





Nested classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>





Nested classes/interfaces inherited from interface java.util.Map
Map.Entry<K,V>








Constructor Summary

Constructors 

Constructor and Description


UrlRewrite() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


UrlRewrite
clone() 


String
getHostRewrite()
Before forwarding the request to the selected service, the request's host header is replaced
 with contents of hostRewrite.



String
getPathPrefixRewrite()
Before forwarding the request to the selected backend service, the matching portion of the
 request's path is replaced by pathPrefixRewrite.



String
getPathTemplateRewrite()
If specified, the pattern rewrites the URL path (based on the :path header) using the HTTP
 template syntax.



UrlRewrite
set(String fieldName,
   Object value) 


UrlRewrite
setHostRewrite(String hostRewrite)
Before forwarding the request to the selected service, the request's host header is replaced
 with contents of hostRewrite.



UrlRewrite
setPathPrefixRewrite(String pathPrefixRewrite)
Before forwarding the request to the selected backend service, the matching portion of the
 request's path is replaced by pathPrefixRewrite.



UrlRewrite
setPathTemplateRewrite(String pathTemplateRewrite)
If specified, the pattern rewrites the URL path (based on the :path header) using the HTTP
 template syntax.







Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString





Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys





Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values





Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait





Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll














Constructor Detail





UrlRewrite
public UrlRewrite()









Method Detail





getHostRewrite
public String getHostRewrite()
Before forwarding the request to the selected service, the request's host header is replaced
 with contents of hostRewrite. The value must be from 1 to 255 characters.

Returns:
value or null for none








setHostRewrite
public UrlRewrite setHostRewrite(String hostRewrite)
Before forwarding the request to the selected service, the request's host header is replaced
 with contents of hostRewrite. The value must be from 1 to 255 characters.

Parameters:
hostRewrite - hostRewrite or null for none








getPathPrefixRewrite
public String getPathPrefixRewrite()
Before forwarding the request to the selected backend service, the matching portion of the
 request's path is replaced by pathPrefixRewrite. The value must be from 1 to 1024 characters.

Returns:
value or null for none








setPathPrefixRewrite
public UrlRewrite setPathPrefixRewrite(String pathPrefixRewrite)
Before forwarding the request to the selected backend service, the matching portion of the
 request's path is replaced by pathPrefixRewrite. The value must be from 1 to 1024 characters.

Parameters:
pathPrefixRewrite - pathPrefixRewrite or null for none








getPathTemplateRewrite
public String getPathTemplateRewrite()
If specified, the pattern rewrites the URL path (based on the :path header) using the HTTP
 template syntax. A corresponding path_template_match must be specified. Any template variables
 must exist in the path_template_match field. - -At least one variable must be specified in the
 path_template_match field - You can omit variables from the rewritten URL - The * and **
 operators cannot be matched unless they have a corresponding variable name - e.g. {format=*} or
 {var=**}. For example, a path_template_match of /static/{format=**} could be rewritten as
 /static/content/{format} to prefix /content to the URL. Variables can also be re-ordered in a
 rewrite, so that /{country}/{format}/{suffix=**} can be rewritten as
 /content/{format}/{country}/{suffix}. At least one non-empty
 routeRules[].matchRules[].path_template_match is required. Only one of path_prefix_rewrite or
 path_template_rewrite may be specified.

Returns:
value or null for none








setPathTemplateRewrite
public UrlRewrite setPathTemplateRewrite(String pathTemplateRewrite)
If specified, the pattern rewrites the URL path (based on the :path header) using the HTTP
 template syntax. A corresponding path_template_match must be specified. Any template variables
 must exist in the path_template_match field. - -At least one variable must be specified in the
 path_template_match field - You can omit variables from the rewritten URL - The * and **
 operators cannot be matched unless they have a corresponding variable name - e.g. {format=*} or
 {var=**}. For example, a path_template_match of /static/{format=**} could be rewritten as
 /static/content/{format} to prefix /content to the URL. Variables can also be re-ordered in a
 rewrite, so that /{country}/{format}/{suffix=**} can be rewritten as
 /content/{format}/{country}/{suffix}. At least one non-empty
 routeRules[].matchRules[].path_template_match is required. Only one of path_prefix_rewrite or
 path_template_rewrite may be specified.

Parameters:
pathTemplateRewrite - pathTemplateRewrite or null for none








set
public UrlRewrite set(String fieldName,
                      Object value)

Overrides:
set in class com.google.api.client.json.GenericJson








clone
public UrlRewrite clone()

Overrides:
clone in class com.google.api.client.json.GenericJson














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2024 Google. All rights reserved.

Modifier and Type	Method and Description
`UrlRewrite`	`clone()`
`String`	`getHostRewrite()` Before forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.
`String`	`getPathPrefixRewrite()` Before forwarding the request to the selected backend service, the matching portion of the request's path is replaced by pathPrefixRewrite.
`String`	`getPathTemplateRewrite()` If specified, the pattern rewrites the URL path (based on the :path header) using the HTTP template syntax.
`UrlRewrite`	`set(String fieldName, Object value)`
`UrlRewrite`	`setHostRewrite(String hostRewrite)` Before forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.
`UrlRewrite`	`setPathPrefixRewrite(String pathPrefixRewrite)` Before forwarding the request to the selected backend service, the matching portion of the request's path is replaced by pathPrefixRewrite.
`UrlRewrite`	`setPathTemplateRewrite(String pathTemplateRewrite)` If specified, the pattern rewrites the URL path (based on the :path header) using the HTTP template syntax.