1. class
  2. Google
  3. \
  4. Api
  5. \
  6. HttpBody

HttpBody

class HttpBody extends Message

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.

Generated from protobuf message google.api.HttpBody

Methods

__construct(array $data = NULL)

Constructor.

string
getContentType()

The HTTP Content-Type string representing the content type of the body.

$this
setContentType(string $var)

The HTTP Content-Type string representing the content type of the body.

string
getData()

HTTP body binary data.

$this
setData(string $var)

HTTP body binary data.

RepeatedField
getExtensions()

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

$this
setExtensions(Any[]|RepeatedField $var)

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

Details

at line 80
__construct(array $data = NULL)

Constructor.

Parameters

array $data { Optional. Data for populating the Message object.

@type string $content_type
      The HTTP Content-Type string representing the content type of the body.
@type string $data
      HTTP body binary data.
@type \Google\Protobuf\Any[]|\Google\Protobuf\Internal\RepeatedField $extensions
      Application specific response metadata. Must be set in the first response
      for streaming APIs.

}

at line 91
string getContentType()

The HTTP Content-Type string representing the content type of the body.

Generated from protobuf field string content_type = 1;

Return Value

string

at line 103
$this setContentType(string $var)

The HTTP Content-Type string representing the content type of the body.

Generated from protobuf field string content_type = 1;

Parameters

string $var

Return Value

$this

at line 117
string getData()

HTTP body binary data.

Generated from protobuf field bytes data = 2;

Return Value

string

at line 129
$this setData(string $var)

HTTP body binary data.

Generated from protobuf field bytes data = 2;

Parameters

string $var

Return Value

$this

at line 144
RepeatedField getExtensions()

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

Generated from protobuf field repeated .google.protobuf.Any extensions = 3;

Return Value

RepeatedField

at line 157
$this setExtensions(Any[]|RepeatedField $var)

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

Generated from protobuf field repeated .google.protobuf.Any extensions = 3;

Parameters

Any[]|RepeatedField $var

Return Value

$this