Class BatchingDescriptorProto.Builder (2.72.0)

public static final class BatchingDescriptorProto.Builder extends GeneratedMessage.Builder<BatchingDescriptorProto.Builder> implements BatchingDescriptorProtoOrBuilder

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.

Protobuf type google.api.BatchingDescriptorProto

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllDiscriminatorFields(Iterable<String> values)

public BatchingDescriptorProto.Builder addAllDiscriminatorFields(Iterable<String> values)

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.

repeated string discriminator_fields = 2;

Parameter
Name Description
values Iterable<String>

The discriminatorFields to add.

Returns
Type Description
BatchingDescriptorProto.Builder

This builder for chaining.

addDiscriminatorFields(String value)

public BatchingDescriptorProto.Builder addDiscriminatorFields(String value)

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.

repeated string discriminator_fields = 2;

Parameter
Name Description
value String

The discriminatorFields to add.

Returns
Type Description
BatchingDescriptorProto.Builder

This builder for chaining.

addDiscriminatorFieldsBytes(ByteString value)

public BatchingDescriptorProto.Builder addDiscriminatorFieldsBytes(ByteString value)

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.

repeated string discriminator_fields = 2;

Parameter
Name Description
value ByteString

The bytes of the discriminatorFields to add.

Returns
Type Description
BatchingDescriptorProto.Builder

This builder for chaining.

build()

public BatchingDescriptorProto build()
Returns
Type Description
BatchingDescriptorProto

buildPartial()

public BatchingDescriptorProto buildPartial()
Returns
Type Description
BatchingDescriptorProto

clear()

public BatchingDescriptorProto.Builder clear()
Returns
Type Description
BatchingDescriptorProto.Builder
Overrides

clearBatchedField()

public BatchingDescriptorProto.Builder clearBatchedField()

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

string batched_field = 1;

Returns
Type Description
BatchingDescriptorProto.Builder

This builder for chaining.

clearDiscriminatorFields()

public BatchingDescriptorProto.Builder clearDiscriminatorFields()

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.

repeated string discriminator_fields = 2;

Returns
Type Description
BatchingDescriptorProto.Builder

This builder for chaining.

clearSubresponseField()

public BatchingDescriptorProto.Builder clearSubresponseField()

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.

string subresponse_field = 3;

Returns
Type Description
BatchingDescriptorProto.Builder

This builder for chaining.

getBatchedField()

public String getBatchedField()

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

string batched_field = 1;

Returns
Type Description
String

The batchedField.

getBatchedFieldBytes()

public ByteString getBatchedFieldBytes()

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

string batched_field = 1;

Returns
Type Description
ByteString

The bytes for batchedField.

getDefaultInstanceForType()

public BatchingDescriptorProto getDefaultInstanceForType()
Returns
Type Description
BatchingDescriptorProto

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDiscriminatorFields(int index)

public String getDiscriminatorFields(int index)

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.

repeated string discriminator_fields = 2;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The discriminatorFields at the given index.

getDiscriminatorFieldsBytes(int index)

public ByteString getDiscriminatorFieldsBytes(int index)

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.

repeated string discriminator_fields = 2;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the discriminatorFields at the given index.

getDiscriminatorFieldsCount()

public int getDiscriminatorFieldsCount()

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.

repeated string discriminator_fields = 2;

Returns
Type Description
int

The count of discriminatorFields.

getDiscriminatorFieldsList()

public ProtocolStringList getDiscriminatorFieldsList()

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.

repeated string discriminator_fields = 2;

Returns
Type Description
ProtocolStringList

A list containing the discriminatorFields.

getSubresponseField()

public String 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.

string subresponse_field = 3;

Returns
Type Description
String

The subresponseField.

getSubresponseFieldBytes()

public ByteString getSubresponseFieldBytes()

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.

string subresponse_field = 3;

Returns
Type Description
ByteString

The bytes for subresponseField.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(BatchingDescriptorProto other)

public BatchingDescriptorProto.Builder mergeFrom(BatchingDescriptorProto other)
Parameter
Name Description
other BatchingDescriptorProto
Returns
Type Description
BatchingDescriptorProto.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public BatchingDescriptorProto.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BatchingDescriptorProto.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public BatchingDescriptorProto.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
BatchingDescriptorProto.Builder
Overrides

setBatchedField(String value)

public BatchingDescriptorProto.Builder setBatchedField(String value)

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

string batched_field = 1;

Parameter
Name Description
value String

The batchedField to set.

Returns
Type Description
BatchingDescriptorProto.Builder

This builder for chaining.

setBatchedFieldBytes(ByteString value)

public BatchingDescriptorProto.Builder setBatchedFieldBytes(ByteString value)

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

string batched_field = 1;

Parameter
Name Description
value ByteString

The bytes for batchedField to set.

Returns
Type Description
BatchingDescriptorProto.Builder

This builder for chaining.

setDiscriminatorFields(int index, String value)

public BatchingDescriptorProto.Builder setDiscriminatorFields(int index, String value)

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.

repeated string discriminator_fields = 2;

Parameters
Name Description
index int

The index to set the value at.

value String

The discriminatorFields to set.

Returns
Type Description
BatchingDescriptorProto.Builder

This builder for chaining.

setSubresponseField(String value)

public BatchingDescriptorProto.Builder setSubresponseField(String value)

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.

string subresponse_field = 3;

Parameter
Name Description
value String

The subresponseField to set.

Returns
Type Description
BatchingDescriptorProto.Builder

This builder for chaining.

setSubresponseFieldBytes(ByteString value)

public BatchingDescriptorProto.Builder setSubresponseFieldBytes(ByteString value)

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.

string subresponse_field = 3;

Parameter
Name Description
value ByteString

The bytes for subresponseField to set.

Returns
Type Description
BatchingDescriptorProto.Builder

This builder for chaining.