Class BatchSizeTooLargeError.Builder (3.20.0)

public static final class BatchSizeTooLargeError.Builder extends GeneratedMessage.Builder<BatchSizeTooLargeError.Builder> implements BatchSizeTooLargeErrorOrBuilder

Structured custom error message for batch size too large error. The error can be attached as error details in the returned rpc Status for more structured error handling in the client.

Protobuf type google.cloud.bigquery.storage.v1alpha.BatchSizeTooLargeError

Static Methods

getDescriptor()

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

Methods

build()

public BatchSizeTooLargeError build()
Returns
Type Description
BatchSizeTooLargeError

buildPartial()

public BatchSizeTooLargeError buildPartial()
Returns
Type Description
BatchSizeTooLargeError

clear()

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

clearErrorMessage()

public BatchSizeTooLargeError.Builder clearErrorMessage()

Optional. The error message that is returned to the client.

string error_message = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
BatchSizeTooLargeError.Builder

This builder for chaining.

clearMaxBatchSize()

public BatchSizeTooLargeError.Builder clearMaxBatchSize()

The maximum number of items that are supported in a single batch. This is returned as a hint to the client to adjust the batch size.

int64 max_batch_size = 1;

Returns
Type Description
BatchSizeTooLargeError.Builder

This builder for chaining.

getDefaultInstanceForType()

public BatchSizeTooLargeError getDefaultInstanceForType()
Returns
Type Description
BatchSizeTooLargeError

getDescriptorForType()

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

getErrorMessage()

public String getErrorMessage()

Optional. The error message that is returned to the client.

string error_message = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The errorMessage.

getErrorMessageBytes()

public ByteString getErrorMessageBytes()

Optional. The error message that is returned to the client.

string error_message = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for errorMessage.

getMaxBatchSize()

public long getMaxBatchSize()

The maximum number of items that are supported in a single batch. This is returned as a hint to the client to adjust the batch size.

int64 max_batch_size = 1;

Returns
Type Description
long

The maxBatchSize.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(BatchSizeTooLargeError other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

setErrorMessage(String value)

public BatchSizeTooLargeError.Builder setErrorMessage(String value)

Optional. The error message that is returned to the client.

string error_message = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The errorMessage to set.

Returns
Type Description
BatchSizeTooLargeError.Builder

This builder for chaining.

setErrorMessageBytes(ByteString value)

public BatchSizeTooLargeError.Builder setErrorMessageBytes(ByteString value)

Optional. The error message that is returned to the client.

string error_message = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for errorMessage to set.

Returns
Type Description
BatchSizeTooLargeError.Builder

This builder for chaining.

setMaxBatchSize(long value)

public BatchSizeTooLargeError.Builder setMaxBatchSize(long value)

The maximum number of items that are supported in a single batch. This is returned as a hint to the client to adjust the batch size.

int64 max_batch_size = 1;

Parameter
Name Description
value long

The maxBatchSize to set.

Returns
Type Description
BatchSizeTooLargeError.Builder

This builder for chaining.