HttpHeaderMatch (Compute Engine API v1 (Rev. 235) 1.25.0)

java.lang.Object
- java.util.AbstractMap<java.lang.String,java.lang.Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.compute.model.HttpHeaderMatch

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>
```
public final class HttpHeaderMatch
extends com.google.api.client.json.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
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  java.util.Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

HttpHeaderMatch()

Constructors
Constructor and Description
`HttpHeaderMatch()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`HttpHeaderMatch`	`clone()`
`java.lang.String`	`getExactMatch()` The value should exactly match contents of exactMatch.
`java.lang.String`	`getHeaderName()` The name of the HTTP header to match.
`java.lang.Boolean`	`getInvertMatch()` If set to false, the headerMatch is considered a match if the match criteria above are met.
`java.lang.String`	`getPrefixMatch()` The value of the header must start with the contents of prefixMatch.
`java.lang.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.
`java.lang.String`	`getRegexMatch()` The value of the header must match the regular expression specified in regexMatch.
`java.lang.String`	`getSuffixMatch()` The value of the header must end with the contents of suffixMatch.
`HttpHeaderMatch`	`set(java.lang.String fieldName, java.lang.Object value)`
`HttpHeaderMatch`	`setExactMatch(java.lang.String exactMatch)` The value should exactly match contents of exactMatch.
`HttpHeaderMatch`	`setHeaderName(java.lang.String headerName)` The name of the HTTP header to match.
`HttpHeaderMatch`	`setInvertMatch(java.lang.Boolean invertMatch)` If set to false, the headerMatch is considered a match if the match criteria above are met.
`HttpHeaderMatch`	`setPrefixMatch(java.lang.String prefixMatch)` The value of the header must start with the contents of prefixMatch.
`HttpHeaderMatch`	`setPresentMatch(java.lang.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(java.lang.String regexMatch)` The value of the header must match the regular expression specified in regexMatch.
`HttpHeaderMatch`	`setSuffixMatch(java.lang.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, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, equals, hashCode, 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 java.lang.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(java.lang.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 java.lang.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".
    
    Returns:
    
    value or null for none
  - setHeaderName
```
public HttpHeaderMatch setHeaderName(java.lang.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".
    
    Parameters:
    
    headerName - headerName or null for none
  - getInvertMatch
```
public java.lang.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(java.lang.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 java.lang.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(java.lang.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 java.lang.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(java.lang.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 java.lang.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(java.lang.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 java.lang.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(java.lang.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(java.lang.String fieldName,
                           java.lang.Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public HttpHeaderMatch clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Compute Engine API v1 (revision 235)

Class HttpHeaderMatch

Nested Class Summary

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

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

HttpHeaderMatch

Method Detail

getExactMatch

setExactMatch

getHeaderName

setHeaderName

getInvertMatch

setInvertMatch

getPrefixMatch

setPrefixMatch

getPresentMatch

setPresentMatch

getRangeMatch

setRangeMatch

getRegexMatch

setRegexMatch

getSuffixMatch

setSuffixMatch

set

clone