Class BatchingSettingsProto.Builder (2.72.0)

2.72.0 (latest) 2.70.0 2.67.0 2.66.0 2.65.1 2.64.1 2.63.2 2.62.0 2.61.3 2.60.0 2.59.2 2.58.0 2.57.0 2.56.0 2.54.1 2.53.0 2.52.0 2.51.0 2.50.1 2.49.0 2.48.0 2.46.0 2.45.1 2.44.0 2.43.0 2.42.0 2.41.0 2.40.0 2.39.1 2.38.0 2.37.1 2.36.0 2.34.0 2.33.0 2.32.0 2.30.0 2.29.0 2.28.0 2.27.0 2.26.0 2.25.1 2.24.0 2.23.1 2.22.1 2.21.1 2.15.0 2.14.3 2.13.0 2.12.0 2.11.0 2.10.0 2.9.6 2.8.4 2.7.4

public static final class BatchingSettingsProto.Builder extends GeneratedMessage.Builder<BatchingSettingsProto.Builder> implements BatchingSettingsProtoOrBuilder

BatchingSettingsProto specifies a set of batching thresholds, each of which acts as a trigger to send a batch of messages as a request. At least one threshold must be positive nonzero.

Protobuf type google.api.BatchingSettingsProto

Inheritance

java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > BatchingSettingsProto.Builder

Implements

BatchingSettingsProtoOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessage.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.clear()

GeneratedMessage.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.clone()

GeneratedMessage.Builder.getAllFields()

GeneratedMessage.Builder.getDescriptorForType()

GeneratedMessage.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.getParentForChildren()

GeneratedMessage.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessage.Builder.getUnknownFieldSetBuilder()

GeneratedMessage.Builder.getUnknownFields()

GeneratedMessage.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.internalGetFieldAccessorTable()

GeneratedMessage.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMapFieldReflection(int)

GeneratedMessage.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessage.Builder.isClean()

GeneratedMessage.Builder.isInitialized()

GeneratedMessage.Builder.markClean()

GeneratedMessage.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownVarintField(int,int)

GeneratedMessage.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.onBuilt()

GeneratedMessage.Builder.onChanged()

com.google.protobuf.GeneratedMessage.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessage.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessage.Builder.setUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldsProto3(com.google.protobuf.UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

build()

public BatchingSettingsProto build()

Returns
Type	Description
BatchingSettingsProto

buildPartial()

public BatchingSettingsProto buildPartial()

Returns
Type	Description
BatchingSettingsProto

clear()

public BatchingSettingsProto.Builder clear()

Returns
Type	Description
BatchingSettingsProto.Builder

Overrides

GeneratedMessage.Builder<BuilderType>.clear()

clearDelayThreshold()

public BatchingSettingsProto.Builder clearDelayThreshold()

The duration after which a batch should be sent, starting from the addition of the first message to that batch.

.google.protobuf.Duration delay_threshold = 3;

Returns
Type	Description
BatchingSettingsProto.Builder

clearElementCountLimit()

public BatchingSettingsProto.Builder clearElementCountLimit()

The maximum number of elements collected in a batch that could be accepted by server.

int32 element_count_limit = 4;

Returns
Type	Description
BatchingSettingsProto.Builder	This builder for chaining.

clearElementCountThreshold()

public BatchingSettingsProto.Builder clearElementCountThreshold()

The number of elements of a field collected into a batch which, if exceeded, causes the batch to be sent.

int32 element_count_threshold = 1;

Returns
Type	Description
BatchingSettingsProto.Builder	This builder for chaining.

clearFlowControlByteLimit()

public BatchingSettingsProto.Builder clearFlowControlByteLimit()

The maximum size of data allowed by flow control.

int32 flow_control_byte_limit = 7;

Returns
Type	Description
BatchingSettingsProto.Builder	This builder for chaining.

clearFlowControlElementLimit()

public BatchingSettingsProto.Builder clearFlowControlElementLimit()

The maximum number of elements allowed by flow control.

int32 flow_control_element_limit = 6;

Returns
Type	Description
BatchingSettingsProto.Builder	This builder for chaining.

clearFlowControlLimitExceededBehavior()

public BatchingSettingsProto.Builder clearFlowControlLimitExceededBehavior()

The behavior to take when the flow control limit is exceeded.

.google.api.FlowControlLimitExceededBehaviorProto flow_control_limit_exceeded_behavior = 8;

Returns
Type	Description
BatchingSettingsProto.Builder	This builder for chaining.

clearRequestByteLimit()

public BatchingSettingsProto.Builder clearRequestByteLimit()

The maximum size of the request that could be accepted by server.

int32 request_byte_limit = 5;

Returns
Type	Description
BatchingSettingsProto.Builder	This builder for chaining.

clearRequestByteThreshold()

public BatchingSettingsProto.Builder clearRequestByteThreshold()

The aggregated size of the batched field which, if exceeded, causes the batch to be sent. This size is computed by aggregating the sizes of the request field to be batched, not of the entire request message.

int64 request_byte_threshold = 2;

Returns
Type	Description
BatchingSettingsProto.Builder	This builder for chaining.

getDefaultInstanceForType()

public BatchingSettingsProto getDefaultInstanceForType()

Returns
Type	Description
BatchingSettingsProto

getDelayThreshold()

public Duration getDelayThreshold()

The duration after which a batch should be sent, starting from the addition of the first message to that batch.

.google.protobuf.Duration delay_threshold = 3;

Returns
Type	Description
Duration	The delayThreshold.

getDelayThresholdBuilder()

public Duration.Builder getDelayThresholdBuilder()

The duration after which a batch should be sent, starting from the addition of the first message to that batch.

.google.protobuf.Duration delay_threshold = 3;

Returns
Type	Description
Builder

getDelayThresholdOrBuilder()

public DurationOrBuilder getDelayThresholdOrBuilder()

The duration after which a batch should be sent, starting from the addition of the first message to that batch.

.google.protobuf.Duration delay_threshold = 3;

Returns
Type	Description
DurationOrBuilder

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessage.Builder<BuilderType>.getDescriptorForType()

getElementCountLimit()

public int getElementCountLimit()

The maximum number of elements collected in a batch that could be accepted by server.

int32 element_count_limit = 4;

Returns
Type	Description
int	The elementCountLimit.

getElementCountThreshold()

public int getElementCountThreshold()

The number of elements of a field collected into a batch which, if exceeded, causes the batch to be sent.

int32 element_count_threshold = 1;

Returns
Type	Description
int	The elementCountThreshold.

getFlowControlByteLimit()

public int getFlowControlByteLimit()

The maximum size of data allowed by flow control.

int32 flow_control_byte_limit = 7;

Returns
Type	Description
int	The flowControlByteLimit.

getFlowControlElementLimit()

public int getFlowControlElementLimit()

The maximum number of elements allowed by flow control.

int32 flow_control_element_limit = 6;

Returns
Type	Description
int	The flowControlElementLimit.

getFlowControlLimitExceededBehavior()

public FlowControlLimitExceededBehaviorProto getFlowControlLimitExceededBehavior()

The behavior to take when the flow control limit is exceeded.

.google.api.FlowControlLimitExceededBehaviorProto flow_control_limit_exceeded_behavior = 8;

Returns
Type	Description
FlowControlLimitExceededBehaviorProto	The flowControlLimitExceededBehavior.

getFlowControlLimitExceededBehaviorValue()

public int getFlowControlLimitExceededBehaviorValue()

The behavior to take when the flow control limit is exceeded.

.google.api.FlowControlLimitExceededBehaviorProto flow_control_limit_exceeded_behavior = 8;

Returns
Type	Description
int	The enum numeric value on the wire for flowControlLimitExceededBehavior.

getRequestByteLimit()

public int getRequestByteLimit()

The maximum size of the request that could be accepted by server.

int32 request_byte_limit = 5;

Returns
Type	Description
int	The requestByteLimit.

getRequestByteThreshold()

public long getRequestByteThreshold()

The aggregated size of the batched field which, if exceeded, causes the batch to be sent. This size is computed by aggregating the sizes of the request field to be batched, not of the entire request message.

int64 request_byte_threshold = 2;

Returns
Type	Description
long	The requestByteThreshold.

hasDelayThreshold()

public boolean hasDelayThreshold()

The duration after which a batch should be sent, starting from the addition of the first message to that batch.

.google.protobuf.Duration delay_threshold = 3;

Returns
Type	Description
boolean	Whether the delayThreshold field is set.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.Builder<BuilderType>.isInitialized()

mergeDelayThreshold(Duration value)

public BatchingSettingsProto.Builder mergeDelayThreshold(Duration value)

The duration after which a batch should be sent, starting from the addition of the first message to that batch.

.google.protobuf.Duration delay_threshold = 3;

Parameter
Name	Description
value	Duration

Returns
Type	Description
BatchingSettingsProto.Builder

mergeFrom(BatchingSettingsProto other)

public BatchingSettingsProto.Builder mergeFrom(BatchingSettingsProto other)

Parameter
Name	Description
other	BatchingSettingsProto

Returns
Type	Description
BatchingSettingsProto.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public BatchingSettingsProto.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
BatchingSettingsProto.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public BatchingSettingsProto.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
BatchingSettingsProto.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

setDelayThreshold(Duration value)

public BatchingSettingsProto.Builder setDelayThreshold(Duration value)

The duration after which a batch should be sent, starting from the addition of the first message to that batch.

.google.protobuf.Duration delay_threshold = 3;

Parameter
Name	Description
value	Duration

Returns
Type	Description
BatchingSettingsProto.Builder

setDelayThreshold(Duration.Builder builderForValue)

public BatchingSettingsProto.Builder setDelayThreshold(Duration.Builder builderForValue)

The duration after which a batch should be sent, starting from the addition of the first message to that batch.

.google.protobuf.Duration delay_threshold = 3;

Parameter
Name	Description
builderForValue	Builder

Returns
Type	Description
BatchingSettingsProto.Builder

setElementCountLimit(int value)

public BatchingSettingsProto.Builder setElementCountLimit(int value)

The maximum number of elements collected in a batch that could be accepted by server.

int32 element_count_limit = 4;

Parameter
Name	Description
value	int The elementCountLimit to set.

Returns
Type	Description
BatchingSettingsProto.Builder	This builder for chaining.

setElementCountThreshold(int value)

public BatchingSettingsProto.Builder setElementCountThreshold(int value)

The number of elements of a field collected into a batch which, if exceeded, causes the batch to be sent.

int32 element_count_threshold = 1;

Parameter
Name	Description
value	int The elementCountThreshold to set.

Returns
Type	Description
BatchingSettingsProto.Builder	This builder for chaining.

setFlowControlByteLimit(int value)

public BatchingSettingsProto.Builder setFlowControlByteLimit(int value)

The maximum size of data allowed by flow control.

int32 flow_control_byte_limit = 7;

Parameter
Name	Description
value	int The flowControlByteLimit to set.

Returns
Type	Description
BatchingSettingsProto.Builder	This builder for chaining.

setFlowControlElementLimit(int value)

public BatchingSettingsProto.Builder setFlowControlElementLimit(int value)

The maximum number of elements allowed by flow control.

int32 flow_control_element_limit = 6;

Parameter
Name	Description
value	int The flowControlElementLimit to set.

Returns
Type	Description
BatchingSettingsProto.Builder	This builder for chaining.

setFlowControlLimitExceededBehavior(FlowControlLimitExceededBehaviorProto value)

public BatchingSettingsProto.Builder setFlowControlLimitExceededBehavior(FlowControlLimitExceededBehaviorProto value)

The behavior to take when the flow control limit is exceeded.

.google.api.FlowControlLimitExceededBehaviorProto flow_control_limit_exceeded_behavior = 8;

Parameter
Name	Description
value	FlowControlLimitExceededBehaviorProto The flowControlLimitExceededBehavior to set.

Returns
Type	Description
BatchingSettingsProto.Builder	This builder for chaining.

setFlowControlLimitExceededBehaviorValue(int value)

public BatchingSettingsProto.Builder setFlowControlLimitExceededBehaviorValue(int value)

The behavior to take when the flow control limit is exceeded.

.google.api.FlowControlLimitExceededBehaviorProto flow_control_limit_exceeded_behavior = 8;

Parameter
Name	Description
value	int The enum numeric value on the wire for flowControlLimitExceededBehavior to set.

Returns
Type	Description
BatchingSettingsProto.Builder	This builder for chaining.

setRequestByteLimit(int value)

public BatchingSettingsProto.Builder setRequestByteLimit(int value)

The maximum size of the request that could be accepted by server.

int32 request_byte_limit = 5;

Parameter
Name	Description
value	int The requestByteLimit to set.

Returns
Type	Description
BatchingSettingsProto.Builder	This builder for chaining.

setRequestByteThreshold(long value)

public BatchingSettingsProto.Builder setRequestByteThreshold(long value)

The aggregated size of the batched field which, if exceeded, causes the batch to be sent. This size is computed by aggregating the sizes of the request field to be batched, not of the entire request message.

int64 request_byte_threshold = 2;

Parameter
Name	Description
value	long The requestByteThreshold to set.

Returns
Type	Description
BatchingSettingsProto.Builder	This builder for chaining.