Google API Common Protos Client - Class BatchingDescriptorProto (4.13.0)

Reference documentation and code samples for the Google API Common Protos Client class BatchingDescriptorProto.

BatchingDescriptorProto specifies the fields of the request message to be used for batching, and, optionally, the fields of the response message to be used for demultiplexing.

Generated from protobuf message google.api.BatchingDescriptorProto

Namespace

Google \ Api

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ batched_field
string

The repeated field in the request message to be aggregated by batching.

↳ discriminator_fields
string[]

A list of the fields in the request message. Two requests will be batched together only if the values of every field specified in request_discriminator_fields is equal between the two requests.

↳ subresponse_field
string

Optional. When present, indicates the field in the response message to be used to demultiplex the response into multiple response messages, in correspondence with the multiple request messages originally batched together.

getBatchedField

The repeated field in the request message to be aggregated by batching.

Returns
Type
Description
string

setBatchedField

The repeated field in the request message to be aggregated by batching.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getDiscriminatorFields

A list of the fields in the request message. Two requests will be batched together only if the values of every field specified in request_discriminator_fields is equal between the two requests.

Returns
Type
Description

setDiscriminatorFields

A list of the fields in the request message. Two requests will be batched together only if the values of every field specified in request_discriminator_fields is equal between the two requests.

Parameter
Name
Description
var
string[]
Returns
Type
Description
$this

getSubresponseField

Optional. When present, indicates the field in the response message to be used to demultiplex the response into multiple response messages, in correspondence with the multiple request messages originally batched together.

Returns
Type
Description
string

setSubresponseField

Optional. When present, indicates the field in the response message to be used to demultiplex the response into multiple response messages, in correspondence with the multiple request messages originally batched together.

Parameter
Name
Description
var
string
Returns
Type
Description
$this
Create a Mobile Website
View Site in Mobile | Classic
Share by: