com.google.api.services.compute.model

Class HttpHeaderMatch

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class HttpHeaderMatch
extends GenericJson

matchRule criteria for request header matches.

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
HttpHeaderMatch()

Method Summary

Modifier and Type	Method and Description
HttpHeaderMatch	clone()
String	getExactMatch() The value should exactly match contents of exactMatch.
String	getHeaderName() The name of the HTTP header to match.
Boolean	getInvertMatch() If set to false, the headerMatch is considered a match if the match criteria above are met.
String	getPrefixMatch() The value of the header must start with the contents of prefixMatch.
Boolean	getPresentMatch() A header with the contents of headerName must exist.
Int64RangeMatch	getRangeMatch() The header value must be an integer and its value must be in the range specified in rangeMatch.
String	getRegexMatch() The value of the header must match the regular expression specified in regexMatch.
String	getSuffixMatch() The value of the header must end with the contents of suffixMatch.
HttpHeaderMatch	set(String fieldName, Object value)
HttpHeaderMatch	setExactMatch(String exactMatch) The value should exactly match contents of exactMatch.
HttpHeaderMatch	setHeaderName(String headerName) The name of the HTTP header to match.
HttpHeaderMatch	setInvertMatch(Boolean invertMatch) If set to false, the headerMatch is considered a match if the match criteria above are met.
HttpHeaderMatch	setPrefixMatch(String prefixMatch) The value of the header must start with the contents of prefixMatch.
HttpHeaderMatch	setPresentMatch(Boolean presentMatch) A header with the contents of headerName must exist.
HttpHeaderMatch	setRangeMatch(Int64RangeMatch rangeMatch) The header value must be an integer and its value must be in the range specified in rangeMatch.
HttpHeaderMatch	setRegexMatch(String regexMatch) The value of the header must match the regular expression specified in regexMatch.
HttpHeaderMatch	setSuffixMatch(String suffixMatch) The value of the header must end with the contents of suffixMatch.

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

HttpHeaderMatch

public HttpHeaderMatch()

Method Detail

getExactMatch

public String getExactMatch()

The value should exactly match contents of exactMatch. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

Returns:

value or null for none

setExactMatch

public HttpHeaderMatch setExactMatch(String exactMatch)

The value should exactly match contents of exactMatch. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

Parameters:

exactMatch - exactMatch or null for none

getHeaderName

public String getHeaderName()

The name of the HTTP header to match. For matching against the HTTP request's authority, use a headerMatch with the header name ":authority". For matching a request's method, use the headerName ":method". When the URL map is bound to target gRPC proxy that has validateForProxyless field set to true, only non-binary user-specified custom metadata and the `content-type` header are supported. The following transport-level headers cannot be used in header matching rules: `:authority`, `:method`, `:path`, `:scheme`, `user-agent`, `accept- encoding`, `content-encoding`, `grpc-accept-encoding`, `grpc-encoding`, `grpc-previous-rpc- attempts`, `grpc-tags-bin`, `grpc-timeout` and `grpc-trace-bin.

Returns:

value or null for none

setHeaderName

public HttpHeaderMatch setHeaderName(String headerName)

The name of the HTTP header to match. For matching against the HTTP request's authority, use a headerMatch with the header name ":authority". For matching a request's method, use the headerName ":method". When the URL map is bound to target gRPC proxy that has validateForProxyless field set to true, only non-binary user-specified custom metadata and the `content-type` header are supported. The following transport-level headers cannot be used in header matching rules: `:authority`, `:method`, `:path`, `:scheme`, `user-agent`, `accept- encoding`, `content-encoding`, `grpc-accept-encoding`, `grpc-encoding`, `grpc-previous-rpc- attempts`, `grpc-tags-bin`, `grpc-timeout` and `grpc-trace-bin.

Parameters:

headerName - headerName or null for none

getInvertMatch

public Boolean getInvertMatch()

If set to false, the headerMatch is considered a match if the match criteria above are met. If set to true, the headerMatch is considered a match if the match criteria above are NOT met. The default setting is false.

Returns:

value or null for none

setInvertMatch

public HttpHeaderMatch setInvertMatch(Boolean invertMatch)

If set to false, the headerMatch is considered a match if the match criteria above are met. If set to true, the headerMatch is considered a match if the match criteria above are NOT met. The default setting is false.

Parameters:

invertMatch - invertMatch or null for none

getPrefixMatch

public String getPrefixMatch()

The value of the header must start with the contents of prefixMatch. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

Returns:

value or null for none

setPrefixMatch

public HttpHeaderMatch setPrefixMatch(String prefixMatch)

The value of the header must start with the contents of prefixMatch. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

Parameters:

prefixMatch - prefixMatch or null for none

getPresentMatch

public Boolean getPresentMatch()

A header with the contents of headerName must exist. The match takes place whether or not the request's header has a value. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

Returns:

value or null for none

setPresentMatch

public HttpHeaderMatch setPresentMatch(Boolean presentMatch)

A header with the contents of headerName must exist. The match takes place whether or not the request's header has a value. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

Parameters:

presentMatch - presentMatch or null for none

getRangeMatch

public Int64RangeMatch getRangeMatch()

The header value must be an integer and its value must be in the range specified in rangeMatch. If the header does not contain an integer, number or is empty, the match fails. For example for a range [-5, 0] - -3 will match. - 0 will not match. - 0.25 will not match. - -3someString will not match. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. Note that rangeMatch is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

Returns:

value or null for none

setRangeMatch

public HttpHeaderMatch setRangeMatch(Int64RangeMatch rangeMatch)

The header value must be an integer and its value must be in the range specified in rangeMatch. If the header does not contain an integer, number or is empty, the match fails. For example for a range [-5, 0] - -3 will match. - 0 will not match. - 0.25 will not match. - -3someString will not match. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. Note that rangeMatch is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

Parameters:

rangeMatch - rangeMatch or null for none

getRegexMatch

public String getRegexMatch()

The value of the header must match the regular expression specified in regexMatch. For regular expression grammar, please see: en.cppreference.com/w/cpp/regex/ecmascript For matching against a port specified in the HTTP request, use a headerMatch with headerName set to PORT and a regular expression that satisfies the RFC2616 Host header's port specifier. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

Returns:

value or null for none

setRegexMatch

public HttpHeaderMatch setRegexMatch(String regexMatch)

The value of the header must match the regular expression specified in regexMatch. For regular expression grammar, please see: en.cppreference.com/w/cpp/regex/ecmascript For matching against a port specified in the HTTP request, use a headerMatch with headerName set to PORT and a regular expression that satisfies the RFC2616 Host header's port specifier. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

Parameters:

regexMatch - regexMatch or null for none

getSuffixMatch

public String getSuffixMatch()

The value of the header must end with the contents of suffixMatch. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

Returns:

value or null for none

setSuffixMatch

public HttpHeaderMatch setSuffixMatch(String suffixMatch)

The value of the header must end with the contents of suffixMatch. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

Parameters:

suffixMatch - suffixMatch or null for none

set

public HttpHeaderMatch set(String fieldName,
                           Object value)

Overrides:

set in class GenericJson

clone

public HttpHeaderMatch clone()

Overrides:

clone in class GenericJson