Documentation

HttpBody extends Message
in package

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

Table of Contents

Properties

$content_type  : mixed
The HTTP Content-Type header value specifying the content type of the body.
$data  : mixed
The HTTP request/response body as raw binary.
$extensions  : mixed
Application specific response metadata. Must be set in the first response for streaming APIs.

Methods

__construct()  : mixed
Constructor.
getContentType()  : string
The HTTP Content-Type header value specifying the content type of the body.
getData()  : string
The HTTP request/response body as raw binary.
getExtensions()  : RepeatedField
Application specific response metadata. Must be set in the first response for streaming APIs.
setContentType()  : $this
The HTTP Content-Type header value specifying the content type of the body.
setData()  : $this
The HTTP request/response body as raw binary.
setExtensions()  : $this
Application specific response metadata. Must be set in the first response for streaming APIs.

Properties

$content_type

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

protected mixed $content_type = ''

Generated from protobuf field string content_type = 1 [json_name = "contentType"];

$data

The HTTP request/response body as raw binary.

protected mixed $data = ''

Generated from protobuf field bytes data = 2 [json_name = "data"];

$extensions

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

private mixed $extensions

Generated from protobuf field repeated .google.protobuf.Any extensions = 3 [json_name = "extensions"];

Methods

__construct()

Constructor.

public __construct([array<string|int, mixed> $data = NULL ]) : mixed
Parameters
$data : array<string|int, mixed> = NULL

{ Optional. Data for populating the Message object.

@type string $content_type
      The HTTP Content-Type header value specifying the content type of the body.
@type string $data
      The HTTP request/response body as raw binary.
@type array<\Google\Protobuf\Any>|\Google\Protobuf\Internal\RepeatedField $extensions
      Application specific response metadata. Must be set in the first response
      for streaming APIs.

}

getContentType()

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

public getContentType() : string

Generated from protobuf field string content_type = 1 [json_name = "contentType"];

Return values
string

getData()

The HTTP request/response body as raw binary.

public getData() : string

Generated from protobuf field bytes data = 2 [json_name = "data"];

Return values
string

getExtensions()

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

public getExtensions() : RepeatedField

Generated from protobuf field repeated .google.protobuf.Any extensions = 3 [json_name = "extensions"];

Return values
RepeatedField

setContentType()

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

public setContentType(string $var) : $this

Generated from protobuf field string content_type = 1 [json_name = "contentType"];

Parameters
$var : string
Return values
$this

setData()

The HTTP request/response body as raw binary.

public setData(string $var) : $this

Generated from protobuf field bytes data = 2 [json_name = "data"];

Parameters
$var : string
Return values
$this

setExtensions()

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

public setExtensions(array<string|int, Any>|RepeatedField $var) : $this

Generated from protobuf field repeated .google.protobuf.Any extensions = 3 [json_name = "extensions"];

Parameters
$var : array<string|int, Any>|RepeatedField
Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results