Class BatchingDescriptorProto (2.72.0)

public final class BatchingDescriptorProto extends GeneratedMessage 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 Fields

BATCHED_FIELD_FIELD_NUMBER

public static final int BATCHED_FIELD_FIELD_NUMBER
Field Value
Type Description
int

DISCRIMINATOR_FIELDS_FIELD_NUMBER

public static final int DISCRIMINATOR_FIELDS_FIELD_NUMBER
Field Value
Type Description
int

SUBRESPONSE_FIELD_FIELD_NUMBER

public static final int SUBRESPONSE_FIELD_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static BatchingDescriptorProto getDefaultInstance()
Returns
Type Description
BatchingDescriptorProto

getDescriptor()

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

newBuilder()

public static BatchingDescriptorProto.Builder newBuilder()
Returns
Type Description
BatchingDescriptorProto.Builder

newBuilder(BatchingDescriptorProto prototype)

public static BatchingDescriptorProto.Builder newBuilder(BatchingDescriptorProto prototype)
Parameter
Name Description
prototype BatchingDescriptorProto
Returns
Type Description
BatchingDescriptorProto.Builder

parseDelimitedFrom(InputStream input)

public static BatchingDescriptorProto parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
BatchingDescriptorProto
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BatchingDescriptorProto parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BatchingDescriptorProto
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static BatchingDescriptorProto parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
BatchingDescriptorProto
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static BatchingDescriptorProto parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BatchingDescriptorProto
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static BatchingDescriptorProto parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
BatchingDescriptorProto
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static BatchingDescriptorProto parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BatchingDescriptorProto
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static BatchingDescriptorProto parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
BatchingDescriptorProto
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static BatchingDescriptorProto parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BatchingDescriptorProto
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static BatchingDescriptorProto parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
BatchingDescriptorProto
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BatchingDescriptorProto parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BatchingDescriptorProto
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static BatchingDescriptorProto parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
BatchingDescriptorProto
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static BatchingDescriptorProto parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BatchingDescriptorProto
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<BatchingDescriptorProto> parser()
Returns
Type Description
Parser<BatchingDescriptorProto>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

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

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.

getParserForType()

public Parser<BatchingDescriptorProto> getParserForType()
Returns
Type Description
Parser<BatchingDescriptorProto>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public BatchingDescriptorProto.Builder newBuilderForType()
Returns
Type Description
BatchingDescriptorProto.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected BatchingDescriptorProto.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
BatchingDescriptorProto.Builder
Overrides

toBuilder()

public BatchingDescriptorProto.Builder toBuilder()
Returns
Type Description
BatchingDescriptorProto.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException