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

Go to download







HttpRouteRuleMatch (Compute Engine API beta-rev20220726-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 HttpRouteRuleMatch



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













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




public final class HttpRouteRuleMatch
extends GenericJson
HttpRouteRuleMatch specifies a set of criteria for matching requests to an HttpRouteRule. All
 specified criteria must be satisfied for a match to occur.

  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


HttpRouteRuleMatch() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


HttpRouteRuleMatch
clone() 


String
getFullPathMatch()
For satisfying the matchRule condition, the path of the request must exactly match the value
 specified in fullPathMatch after removing any query parameters and anchor that may be part of
 the original URL.



List<HttpHeaderMatch>
getHeaderMatches()
Specifies a list of header match criteria, all of which must match corresponding headers in the
 request.



Boolean
getIgnoreCase()
Specifies that prefixMatch and fullPathMatch matches are case sensitive.



List<MetadataFilter>
getMetadataFilters()
Opaque filter criteria used by the load balancer to restrict routing configuration to a limited
 set of xDS compliant clients.



String
getPrefixMatch()
For satisfying the matchRule condition, the request's path must begin with the specified
 prefixMatch.



List<HttpQueryParameterMatch>
getQueryParameterMatches()
Specifies a list of query parameter match criteria, all of which must match corresponding query
 parameters in the request.



String
getRegexMatch()
For satisfying the matchRule condition, the path of the request must satisfy the regular
 expression specified in regexMatch after removing any query parameters and anchor supplied with
 the original URL.



HttpRouteRuleMatch
set(String fieldName,
   Object value) 


HttpRouteRuleMatch
setFullPathMatch(String fullPathMatch)
For satisfying the matchRule condition, the path of the request must exactly match the value
 specified in fullPathMatch after removing any query parameters and anchor that may be part of
 the original URL.



HttpRouteRuleMatch
setHeaderMatches(List<HttpHeaderMatch> headerMatches)
Specifies a list of header match criteria, all of which must match corresponding headers in the
 request.



HttpRouteRuleMatch
setIgnoreCase(Boolean ignoreCase)
Specifies that prefixMatch and fullPathMatch matches are case sensitive.



HttpRouteRuleMatch
setMetadataFilters(List<MetadataFilter> metadataFilters)
Opaque filter criteria used by the load balancer to restrict routing configuration to a limited
 set of xDS compliant clients.



HttpRouteRuleMatch
setPrefixMatch(String prefixMatch)
For satisfying the matchRule condition, the request's path must begin with the specified
 prefixMatch.



HttpRouteRuleMatch
setQueryParameterMatches(List<HttpQueryParameterMatch> queryParameterMatches)
Specifies a list of query parameter match criteria, all of which must match corresponding query
 parameters in the request.



HttpRouteRuleMatch
setRegexMatch(String regexMatch)
For satisfying the matchRule condition, the path of the request must satisfy the regular
 expression specified in regexMatch after removing any query parameters and anchor supplied with
 the original URL.







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





HttpRouteRuleMatch
public HttpRouteRuleMatch()









Method Detail





getFullPathMatch
public String getFullPathMatch()
For satisfying the matchRule condition, the path of the request must exactly match the value
 specified in fullPathMatch after removing any query parameters and anchor that may be part of
 the original URL. fullPathMatch must be from 1 to 1024 characters. Only one of prefixMatch,
 fullPathMatch or regexMatch must be specified.

Returns:
value or null for none








setFullPathMatch
public HttpRouteRuleMatch setFullPathMatch(String fullPathMatch)
For satisfying the matchRule condition, the path of the request must exactly match the value
 specified in fullPathMatch after removing any query parameters and anchor that may be part of
 the original URL. fullPathMatch must be from 1 to 1024 characters. Only one of prefixMatch,
 fullPathMatch or regexMatch must be specified.

Parameters:
fullPathMatch - fullPathMatch or null for none








getHeaderMatches
public List<HttpHeaderMatch> getHeaderMatches()
Specifies a list of header match criteria, all of which must match corresponding headers in the
 request.

Returns:
value or null for none








setHeaderMatches
public HttpRouteRuleMatch setHeaderMatches(List<HttpHeaderMatch> headerMatches)
Specifies a list of header match criteria, all of which must match corresponding headers in the
 request.

Parameters:
headerMatches - headerMatches or null for none








getIgnoreCase
public Boolean getIgnoreCase()
Specifies that prefixMatch and fullPathMatch matches are case sensitive. The default value is
 false. ignoreCase must not be used with regexMatch. Not supported when the URL map is bound to
 a target gRPC proxy.

Returns:
value or null for none








setIgnoreCase
public HttpRouteRuleMatch setIgnoreCase(Boolean ignoreCase)
Specifies that prefixMatch and fullPathMatch matches are case sensitive. The default value is
 false. ignoreCase must not be used with regexMatch. Not supported when the URL map is bound to
 a target gRPC proxy.

Parameters:
ignoreCase - ignoreCase or null for none








getMetadataFilters
public List<MetadataFilter> getMetadataFilters()
Opaque filter criteria used by the load balancer to restrict routing configuration to a limited
 set of xDS compliant clients. In their xDS requests to the load balancer, xDS clients present
 node metadata. When there is a match, the relevant routing configuration is made available to
 those proxies. For each metadataFilter in this list, if its filterMatchCriteria is set to
 MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the
 metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must
 match with corresponding labels provided in the metadata. If multiple metadata filters are
 specified, all of them need to be satisfied in order to be considered a match. metadataFilters
 specified here is applied after those specified in ForwardingRule that refers to the UrlMap
 this HttpRouteRuleMatch belongs to. metadataFilters only applies to load balancers that have
 loadBalancingScheme set to INTERNAL_SELF_MANAGED. Not supported when the URL map is bound to a
 target gRPC proxy that has validateForProxyless field set to true.

Returns:
value or null for none








setMetadataFilters
public HttpRouteRuleMatch setMetadataFilters(List<MetadataFilter> metadataFilters)
Opaque filter criteria used by the load balancer to restrict routing configuration to a limited
 set of xDS compliant clients. In their xDS requests to the load balancer, xDS clients present
 node metadata. When there is a match, the relevant routing configuration is made available to
 those proxies. For each metadataFilter in this list, if its filterMatchCriteria is set to
 MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the
 metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must
 match with corresponding labels provided in the metadata. If multiple metadata filters are
 specified, all of them need to be satisfied in order to be considered a match. metadataFilters
 specified here is applied after those specified in ForwardingRule that refers to the UrlMap
 this HttpRouteRuleMatch belongs to. metadataFilters only applies to load balancers that have
 loadBalancingScheme set to INTERNAL_SELF_MANAGED. Not supported when the URL map is bound to a
 target gRPC proxy that has validateForProxyless field set to true.

Parameters:
metadataFilters - metadataFilters or null for none








getPrefixMatch
public String getPrefixMatch()
For satisfying the matchRule condition, the request's path must begin with the specified
 prefixMatch. prefixMatch must begin with a /. The value must be from 1 to 1024 characters. Only
 one of prefixMatch, fullPathMatch or regexMatch must be specified.

Returns:
value or null for none








setPrefixMatch
public HttpRouteRuleMatch setPrefixMatch(String prefixMatch)
For satisfying the matchRule condition, the request's path must begin with the specified
 prefixMatch. prefixMatch must begin with a /. The value must be from 1 to 1024 characters. Only
 one of prefixMatch, fullPathMatch or regexMatch must be specified.

Parameters:
prefixMatch - prefixMatch or null for none








getQueryParameterMatches
public List<HttpQueryParameterMatch> getQueryParameterMatches()
Specifies a list of query parameter match criteria, all of which must match corresponding query
 parameters in the request. Not supported when the URL map is bound to a target gRPC proxy.

Returns:
value or null for none








setQueryParameterMatches
public HttpRouteRuleMatch setQueryParameterMatches(List<HttpQueryParameterMatch> queryParameterMatches)
Specifies a list of query parameter match criteria, all of which must match corresponding query
 parameters in the request. Not supported when the URL map is bound to a target gRPC proxy.

Parameters:
queryParameterMatches - queryParameterMatches or null for none








getRegexMatch
public String getRegexMatch()
For satisfying the matchRule condition, the path of the request must satisfy the regular
 expression specified in regexMatch after removing any query parameters and anchor supplied with
 the original URL. For more information about regular expression syntax, see Syntax. Only one of
 prefixMatch, fullPathMatch or regexMatch must be specified. regexMatch only applies to load
 balancers that have loadBalancingScheme set to INTERNAL_SELF_MANAGED.

Returns:
value or null for none








setRegexMatch
public HttpRouteRuleMatch setRegexMatch(String regexMatch)
For satisfying the matchRule condition, the path of the request must satisfy the regular
 expression specified in regexMatch after removing any query parameters and anchor supplied with
 the original URL. For more information about regular expression syntax, see Syntax. Only one of
 prefixMatch, fullPathMatch or regexMatch must be specified. regexMatch only applies to load
 balancers that have loadBalancingScheme set to INTERNAL_SELF_MANAGED.

Parameters:
regexMatch - regexMatch or null for none








set
public HttpRouteRuleMatch set(String fieldName,
                              Object value)

Overrides:
set in class GenericJson








clone
public HttpRouteRuleMatch 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–2022 Google. All rights reserved.

Modifier and Type	Method and Description
`HttpRouteRuleMatch`	`clone()`
`String`	`getFullPathMatch()` For satisfying the matchRule condition, the path of the request must exactly match the value specified in fullPathMatch after removing any query parameters and anchor that may be part of the original URL.
`List<HttpHeaderMatch>`	`getHeaderMatches()` Specifies a list of header match criteria, all of which must match corresponding headers in the request.
`Boolean`	`getIgnoreCase()` Specifies that prefixMatch and fullPathMatch matches are case sensitive.
`List<MetadataFilter>`	`getMetadataFilters()` Opaque filter criteria used by the load balancer to restrict routing configuration to a limited set of xDS compliant clients.
`String`	`getPrefixMatch()` For satisfying the matchRule condition, the request's path must begin with the specified prefixMatch.
`List<HttpQueryParameterMatch>`	`getQueryParameterMatches()` Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request.
`String`	`getRegexMatch()` For satisfying the matchRule condition, the path of the request must satisfy the regular expression specified in regexMatch after removing any query parameters and anchor supplied with the original URL.
`HttpRouteRuleMatch`	`set(String fieldName, Object value)`
`HttpRouteRuleMatch`	`setFullPathMatch(String fullPathMatch)` For satisfying the matchRule condition, the path of the request must exactly match the value specified in fullPathMatch after removing any query parameters and anchor that may be part of the original URL.
`HttpRouteRuleMatch`	`setHeaderMatches(List<HttpHeaderMatch> headerMatches)` Specifies a list of header match criteria, all of which must match corresponding headers in the request.
`HttpRouteRuleMatch`	`setIgnoreCase(Boolean ignoreCase)` Specifies that prefixMatch and fullPathMatch matches are case sensitive.
`HttpRouteRuleMatch`	`setMetadataFilters(List<MetadataFilter> metadataFilters)` Opaque filter criteria used by the load balancer to restrict routing configuration to a limited set of xDS compliant clients.
`HttpRouteRuleMatch`	`setPrefixMatch(String prefixMatch)` For satisfying the matchRule condition, the request's path must begin with the specified prefixMatch.
`HttpRouteRuleMatch`	`setQueryParameterMatches(List<HttpQueryParameterMatch> queryParameterMatches)` Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request.
`HttpRouteRuleMatch`	`setRegexMatch(String regexMatch)` For satisfying the matchRule condition, the path of the request must satisfy the regular expression specified in regexMatch after removing any query parameters and anchor supplied with the original URL.