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.BuilderImplements
BatchingSettingsProtoOrBuilderStatic 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 |
|
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 |
|
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 |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
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 |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public BatchingSettingsProto.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
BatchingSettingsProto.Builder |
|
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 |
intThe 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 |
intThe 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 |
intThe 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 |
intThe 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 |
FlowControlLimitExceededBehaviorProtoThe 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 |
intThe 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 |
intThe 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 |
longThe requestByteThreshold to set. |
| Returns | |
|---|---|
| Type | Description |
BatchingSettingsProto.Builder |
This builder for chaining. |