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

Go to download







HttpRouteRule (Compute Engine API alpha-rev20200526-1.30.9)











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 HttpRouteRule



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.HttpRouteRule













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




public final class HttpRouteRule
extends GenericJson
An HttpRouteRule specifies how to match an HTTP request and the corresponding routing action that
 load balancing proxies will perform.

  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
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


HttpRouteRule() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


HttpRouteRule
clone() 


String
getDescription()
The short description conveying the intent of this routeRule.



HttpHeaderAction
getHeaderAction()
Specifies changes to request and response headers that need to take effect for the selected
 backendService.



List<HttpFilterConfig>
getHttpFilterConfigs()
Outbound route specific configuration for networkservices.HttpFilter resources enabled by
 Traffic Director.



List<HttpFilterConfig>
getHttpFilterMetadata()
Outbound route specific metadata supplied to networkservices.HttpFilter resources enabled by
 Traffic Director.



List<HttpRouteRuleMatch>
getMatchRules() 


Integer
getPriority()
For routeRules within a given pathMatcher, priority determines the order in which load balancer
 will interpret routeRules.



HttpRouteAction
getRouteAction()
In response to a matching matchRule, the load balancer performs advanced routing actions like
 URL rewrites, header transformations, etc.



String
getService()
The full or partial URL of the backend service resource to which traffic is directed if this
 rule is matched.



HttpRedirectAction
getUrlRedirect()
When this rule is matched, the request is redirected to a URL specified by urlRedirect.



HttpRouteRule
set(String fieldName,
   Object value) 


HttpRouteRule
setDescription(String description)
The short description conveying the intent of this routeRule.



HttpRouteRule
setHeaderAction(HttpHeaderAction headerAction)
Specifies changes to request and response headers that need to take effect for the selected
 backendService.



HttpRouteRule
setHttpFilterConfigs(List<HttpFilterConfig> httpFilterConfigs)
Outbound route specific configuration for networkservices.HttpFilter resources enabled by
 Traffic Director.



HttpRouteRule
setHttpFilterMetadata(List<HttpFilterConfig> httpFilterMetadata)
Outbound route specific metadata supplied to networkservices.HttpFilter resources enabled by
 Traffic Director.



HttpRouteRule
setMatchRules(List<HttpRouteRuleMatch> matchRules) 


HttpRouteRule
setPriority(Integer priority)
For routeRules within a given pathMatcher, priority determines the order in which load balancer
 will interpret routeRules.



HttpRouteRule
setRouteAction(HttpRouteAction routeAction)
In response to a matching matchRule, the load balancer performs advanced routing actions like
 URL rewrites, header transformations, etc.



HttpRouteRule
setService(String service)
The full or partial URL of the backend service resource to which traffic is directed if this
 rule is matched.



HttpRouteRule
setUrlRedirect(HttpRedirectAction urlRedirect)
When this rule is matched, the request is redirected to a URL specified by urlRedirect.







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





HttpRouteRule
public HttpRouteRule()









Method Detail





getDescription
public String getDescription()
The short description conveying the intent of this routeRule. The description can have a
 maximum length of 1024 characters.

Returns:
value or null for none








setDescription
public HttpRouteRule setDescription(String description)
The short description conveying the intent of this routeRule. The description can have a
 maximum length of 1024 characters.

Parameters:
description - description or null for none








getHeaderAction
public HttpHeaderAction getHeaderAction()
Specifies changes to request and response headers that need to take effect for the selected
 backendService. The headerAction specified here are applied before the matching
 pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendSe
 rvice.backendServiceWeightAction[].headerAction

Returns:
value or null for none








setHeaderAction
public HttpRouteRule setHeaderAction(HttpHeaderAction headerAction)
Specifies changes to request and response headers that need to take effect for the selected
 backendService. The headerAction specified here are applied before the matching
 pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendSe
 rvice.backendServiceWeightAction[].headerAction

Parameters:
headerAction - headerAction or null for none








getHttpFilterConfigs
public List<HttpFilterConfig> getHttpFilterConfigs()
Outbound route specific configuration for networkservices.HttpFilter resources enabled by
 Traffic Director. httpFilterConfigs only applies for Loadbalancers with loadBalancingScheme set
 to INTERNAL_SELF_MANAGED. See ForwardingRule for more details.

Returns:
value or null for none








setHttpFilterConfigs
public HttpRouteRule setHttpFilterConfigs(List<HttpFilterConfig> httpFilterConfigs)
Outbound route specific configuration for networkservices.HttpFilter resources enabled by
 Traffic Director. httpFilterConfigs only applies for Loadbalancers with loadBalancingScheme set
 to INTERNAL_SELF_MANAGED. See ForwardingRule for more details.

Parameters:
httpFilterConfigs - httpFilterConfigs or null for none








getHttpFilterMetadata
public List<HttpFilterConfig> getHttpFilterMetadata()
Outbound route specific metadata supplied to networkservices.HttpFilter resources enabled by
 Traffic Director. httpFilterMetadata only applies for Loadbalancers with loadBalancingScheme
 set to INTERNAL_SELF_MANAGED. See ForwardingRule for more details. The only configTypeUrl
 supported is type.googleapis.com/google.protobuf.Struct

Returns:
value or null for none








setHttpFilterMetadata
public HttpRouteRule setHttpFilterMetadata(List<HttpFilterConfig> httpFilterMetadata)
Outbound route specific metadata supplied to networkservices.HttpFilter resources enabled by
 Traffic Director. httpFilterMetadata only applies for Loadbalancers with loadBalancingScheme
 set to INTERNAL_SELF_MANAGED. See ForwardingRule for more details. The only configTypeUrl
 supported is type.googleapis.com/google.protobuf.Struct

Parameters:
httpFilterMetadata - httpFilterMetadata or null for none








getMatchRules
public List<HttpRouteRuleMatch> getMatchRules()

Returns:
value or null for none








setMatchRules
public HttpRouteRule setMatchRules(List<HttpRouteRuleMatch> matchRules)

Parameters:
matchRules - matchRules or null for none








getPriority
public Integer getPriority()
For routeRules within a given pathMatcher, priority determines the order in which load balancer
 will interpret routeRules. RouteRules are evaluated in order of priority, from the lowest to
 highest number. The priority of a rule decreases as its number increases (1, 2, 3, N+1). The
 first rule that matches the request is applied. You cannot configure two or more routeRules
 with the same priority. Priority for each rule must be set to a number between 0 and 2147483647
 inclusive. Priority numbers can have gaps, which enable you to add or remove rules in the
 future without affecting the rest of the rules. For example, 1, 2, 3, 4, 5, 9, 12, 16 is a
 valid series of priority numbers to which you could add rules numbered from 6 to 8, 10 to 11,
 and 13 to 15 in the future without any impact on existing rules.

Returns:
value or null for none








setPriority
public HttpRouteRule setPriority(Integer priority)
For routeRules within a given pathMatcher, priority determines the order in which load balancer
 will interpret routeRules. RouteRules are evaluated in order of priority, from the lowest to
 highest number. The priority of a rule decreases as its number increases (1, 2, 3, N+1). The
 first rule that matches the request is applied. You cannot configure two or more routeRules
 with the same priority. Priority for each rule must be set to a number between 0 and 2147483647
 inclusive. Priority numbers can have gaps, which enable you to add or remove rules in the
 future without affecting the rest of the rules. For example, 1, 2, 3, 4, 5, 9, 12, 16 is a
 valid series of priority numbers to which you could add rules numbered from 6 to 8, 10 to 11,
 and 13 to 15 in the future without any impact on existing rules.

Parameters:
priority - priority or null for none








getRouteAction
public HttpRouteAction getRouteAction()
In response to a matching matchRule, the load balancer performs advanced routing actions like
 URL rewrites, header transformations, etc. prior to forwarding the request to the selected
 backend. If  routeAction specifies any  weightedBackendServices, service must not be set.
 Conversely if service is set, routeAction cannot contain any  weightedBackendServices. Only one
 of urlRedirect, service or routeAction.weightedBackendService must be set.

Returns:
value or null for none








setRouteAction
public HttpRouteRule setRouteAction(HttpRouteAction routeAction)
In response to a matching matchRule, the load balancer performs advanced routing actions like
 URL rewrites, header transformations, etc. prior to forwarding the request to the selected
 backend. If  routeAction specifies any  weightedBackendServices, service must not be set.
 Conversely if service is set, routeAction cannot contain any  weightedBackendServices. Only one
 of urlRedirect, service or routeAction.weightedBackendService must be set.

Parameters:
routeAction - routeAction or null for none








getService
public String getService()
The full or partial URL of the backend service resource to which traffic is directed if this
 rule is matched. If routeAction is additionally specified, advanced routing actions like URL
 Rewrites, etc. take effect prior to sending the request to the backend. However, if service is
 specified, routeAction cannot contain any weightedBackendService s. Conversely, if routeAction
 specifies any  weightedBackendServices, service must not be specified. Only one of urlRedirect,
 service or routeAction.weightedBackendService must be set.

Returns:
value or null for none








setService
public HttpRouteRule setService(String service)
The full or partial URL of the backend service resource to which traffic is directed if this
 rule is matched. If routeAction is additionally specified, advanced routing actions like URL
 Rewrites, etc. take effect prior to sending the request to the backend. However, if service is
 specified, routeAction cannot contain any weightedBackendService s. Conversely, if routeAction
 specifies any  weightedBackendServices, service must not be specified. Only one of urlRedirect,
 service or routeAction.weightedBackendService must be set.

Parameters:
service - service or null for none








getUrlRedirect
public HttpRedirectAction getUrlRedirect()
When this rule is matched, the request is redirected to a URL specified by urlRedirect. If
 urlRedirect is specified, service or routeAction must not be set.

Returns:
value or null for none








setUrlRedirect
public HttpRouteRule setUrlRedirect(HttpRedirectAction urlRedirect)
When this rule is matched, the request is redirected to a URL specified by urlRedirect. If
 urlRedirect is specified, service or routeAction must not be set.

Parameters:
urlRedirect - urlRedirect or null for none








set
public HttpRouteRule set(String fieldName,
                         Object value)

Overrides:
set in class GenericJson








clone
public HttpRouteRule clone()

Overrides:
clone in class 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–2020 Google. All rights reserved.

Modifier and Type	Method and Description
`HttpRouteRule`	`clone()`
`String`	`getDescription()` The short description conveying the intent of this routeRule.
`HttpHeaderAction`	`getHeaderAction()` Specifies changes to request and response headers that need to take effect for the selected backendService.
`List<HttpFilterConfig>`	`getHttpFilterConfigs()` Outbound route specific configuration for networkservices.HttpFilter resources enabled by Traffic Director.
`List<HttpFilterConfig>`	`getHttpFilterMetadata()` Outbound route specific metadata supplied to networkservices.HttpFilter resources enabled by Traffic Director.
`List<HttpRouteRuleMatch>`	`getMatchRules()`
`Integer`	`getPriority()` For routeRules within a given pathMatcher, priority determines the order in which load balancer will interpret routeRules.
`HttpRouteAction`	`getRouteAction()` In response to a matching matchRule, the load balancer performs advanced routing actions like URL rewrites, header transformations, etc.
`String`	`getService()` The full or partial URL of the backend service resource to which traffic is directed if this rule is matched.
`HttpRedirectAction`	`getUrlRedirect()` When this rule is matched, the request is redirected to a URL specified by urlRedirect.
`HttpRouteRule`	`set(String fieldName, Object value)`
`HttpRouteRule`	`setDescription(String description)` The short description conveying the intent of this routeRule.
`HttpRouteRule`	`setHeaderAction(HttpHeaderAction headerAction)` Specifies changes to request and response headers that need to take effect for the selected backendService.
`HttpRouteRule`	`setHttpFilterConfigs(List<HttpFilterConfig> httpFilterConfigs)` Outbound route specific configuration for networkservices.HttpFilter resources enabled by Traffic Director.
`HttpRouteRule`	`setHttpFilterMetadata(List<HttpFilterConfig> httpFilterMetadata)` Outbound route specific metadata supplied to networkservices.HttpFilter resources enabled by Traffic Director.
`HttpRouteRule`	`setMatchRules(List<HttpRouteRuleMatch> matchRules)`
`HttpRouteRule`	`setPriority(Integer priority)` For routeRules within a given pathMatcher, priority determines the order in which load balancer will interpret routeRules.
`HttpRouteRule`	`setRouteAction(HttpRouteAction routeAction)` In response to a matching matchRule, the load balancer performs advanced routing actions like URL rewrites, header transformations, etc.
`HttpRouteRule`	`setService(String service)` The full or partial URL of the backend service resource to which traffic is directed if this rule is matched.
`HttpRouteRule`	`setUrlRedirect(HttpRedirectAction urlRedirect)` When this rule is matched, the request is redirected to a URL specified by urlRedirect.