com.google.api.services.cloudbuild.v2.model

Class HttpBody

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.cloudbuild.v2.model.HttpBody

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class HttpBody
extends com.google.api.client.json.GenericJson

Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.

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

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

Method Summary

Modifier and Type	Method and Description
HttpBody	clone()
byte[]	decodeData() The HTTP request/response body as raw binary.
HttpBody	encodeData(byte[] data) The HTTP request/response body as raw binary.
String	getContentType() The HTTP Content-Type header value specifying the content type of the body.
String	getData() The HTTP request/response body as raw binary.
List<Map<String,Object>>	getExtensions() Application specific response metadata.
HttpBody	set(String fieldName, Object value)
HttpBody	setContentType(String contentType) The HTTP Content-Type header value specifying the content type of the body.
HttpBody	setData(String data) The HTTP request/response body as raw binary.
HttpBody	setExtensions(List<Map<String,Object>> extensions) Application specific response metadata.

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

HttpBody

public HttpBody()

Method Detail

getContentType

public String getContentType()

The HTTP Content-Type header value specifying the content type of the body.

Returns:

value or null for none

setContentType

public HttpBody setContentType(String contentType)

The HTTP Content-Type header value specifying the content type of the body.

Parameters:

contentType - contentType or null for none

getData

public String getData()

The HTTP request/response body as raw binary.

Returns:

value or null for none

See Also:

decodeData()

decodeData

public byte[] decodeData()

The HTTP request/response body as raw binary.

Returns:

Base64 decoded value or null for none

Since:

1.14

See Also:

getData()

setData

public HttpBody setData(String data)

The HTTP request/response body as raw binary.

Parameters:

data - data or null for none

See Also:

#encodeData()

encodeData

public HttpBody encodeData(byte[] data)

The HTTP request/response body as raw binary.

Since:

1.14

See Also:

The value is encoded Base64 or {@code null} for none.

getExtensions

public List<Map<String,Object>> getExtensions()

Application specific response metadata. Must be set in the first response for streaming APIs.

Returns:

value or null for none

setExtensions

public HttpBody setExtensions(List<Map<String,Object>> extensions)

Application specific response metadata. Must be set in the first response for streaming APIs.

Parameters:

extensions - extensions or null for none

set

public HttpBody set(String fieldName,
                    Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public HttpBody clone()

Overrides:

clone in class com.google.api.client.json.GenericJson