com.google.api.services.compute.model

Class HttpHeaderOption

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class HttpHeaderOption
extends GenericJson

Specification determining how headers are added to requests or responses.

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

Method Summary

Modifier and Type	Method and Description
HttpHeaderOption	clone()
String	getHeaderName() The name of the header.
String	getHeaderValue() The value of the header to add.
Boolean	getReplace() If false, headerValue is appended to any values that already exist for the header.
HttpHeaderOption	set(String fieldName, Object value)
HttpHeaderOption	setHeaderName(String headerName) The name of the header.
HttpHeaderOption	setHeaderValue(String headerValue) The value of the header to add.
HttpHeaderOption	setReplace(Boolean replace) If false, headerValue is appended to any values that already exist for the header.

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

HttpHeaderOption

public HttpHeaderOption()

Method Detail

getHeaderName

public String getHeaderName()

The name of the header.

Returns:

value or null for none

setHeaderName

public HttpHeaderOption setHeaderName(String headerName)

The name of the header.

Parameters:

headerName - headerName or null for none

getHeaderValue

public String getHeaderValue()

The value of the header to add.

Returns:

value or null for none

setHeaderValue

public HttpHeaderOption setHeaderValue(String headerValue)

The value of the header to add.

Parameters:

headerValue - headerValue or null for none

getReplace

public Boolean getReplace()

If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. The default value is false.

Returns:

value or null for none

setReplace

public HttpHeaderOption setReplace(Boolean replace)

If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. The default value is false.

Parameters:

replace - replace or null for none

set

public HttpHeaderOption set(String fieldName,
                            Object value)

Overrides:

set in class GenericJson

clone

public HttpHeaderOption clone()

Overrides:

clone in class GenericJson