Package com.google.api
Class BatchingSettingsProto.Builder
java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder<BatchingSettingsProto,BatchingSettingsProto.Builder>
com.google.protobuf.GeneratedMessageLite.Builder<BatchingSettingsProto,BatchingSettingsProto.Builder>
com.google.api.BatchingSettingsProto.Builder
- All Implemented Interfaces:
BatchingSettingsProtoOrBuilder,com.google.protobuf.MessageLite.Builder,com.google.protobuf.MessageLiteOrBuilder,Cloneable
- Enclosing class:
BatchingSettingsProto
public static final class BatchingSettingsProto.Builder
extends com.google.protobuf.GeneratedMessageLite.Builder<BatchingSettingsProto,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-
Field Summary
Fields inherited from class com.google.protobuf.GeneratedMessageLite.Builder
instance -
Method Summary
Modifier and TypeMethodDescriptionThe duration after which a batch should be sent, starting from the addition of the first message to that batch.The maximum number of elements collected in a batch that could be accepted by server.The number of elements of a field collected into a batch which, if exceeded, causes the batch to be sent.The maximum size of data allowed by flow control.The maximum number of elements allowed by flow control.The behavior to take when the flow control limit is exceeded.The maximum size of the request that could be accepted by server.The aggregated size of the batched field which, if exceeded, causes the batch to be sent.com.google.protobuf.DurationThe duration after which a batch should be sent, starting from the addition of the first message to that batch.intThe maximum number of elements collected in a batch that could be accepted by server.intThe number of elements of a field collected into a batch which, if exceeded, causes the batch to be sent.intThe maximum size of data allowed by flow control.intThe maximum number of elements allowed by flow control.The behavior to take when the flow control limit is exceeded.intThe behavior to take when the flow control limit is exceeded.intThe maximum size of the request that could be accepted by server.longThe aggregated size of the batched field which, if exceeded, causes the batch to be sent.booleanThe duration after which a batch should be sent, starting from the addition of the first message to that batch.mergeDelayThreshold(com.google.protobuf.Duration value) The duration after which a batch should be sent, starting from the addition of the first message to that batch.setDelayThreshold(com.google.protobuf.Duration value) The duration after which a batch should be sent, starting from the addition of the first message to that batch.setDelayThreshold(com.google.protobuf.Duration.Builder builderForValue) The duration after which a batch should be sent, starting from the addition of the first message to that batch.setElementCountLimit(int value) The maximum number of elements collected in a batch that could be accepted by server.setElementCountThreshold(int value) The number of elements of a field collected into a batch which, if exceeded, causes the batch to be sent.setFlowControlByteLimit(int value) The maximum size of data allowed by flow control.setFlowControlElementLimit(int value) The maximum number of elements allowed by flow control.The behavior to take when the flow control limit is exceeded.setFlowControlLimitExceededBehaviorValue(int value) The behavior to take when the flow control limit is exceeded.setRequestByteLimit(int value) The maximum size of the request that could be accepted by server.setRequestByteThreshold(long value) The aggregated size of the batched field which, if exceeded, causes the batch to be sent.Methods inherited from class com.google.protobuf.GeneratedMessageLite.Builder
build, buildPartial, clear, clone, copyOnWrite, copyOnWriteInternal, getDefaultInstanceForType, internalMergeFrom, isInitialized, mergeFrom, mergeFrom, mergeFrom, mergeFromMethods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageExceptionMethods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface com.google.protobuf.MessageLiteOrBuilder
getDefaultInstanceForType, isInitialized
-
Method Details
-
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 [json_name = "elementCountThreshold"];- Specified by:
getElementCountThresholdin interfaceBatchingSettingsProtoOrBuilder- Returns:
- The elementCountThreshold.
-
setElementCountThreshold
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 [json_name = "elementCountThreshold"];- Parameters:
value- The elementCountThreshold to set.- Returns:
- This builder for chaining.
-
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 [json_name = "elementCountThreshold"];- Returns:
- This builder for chaining.
-
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 [json_name = "requestByteThreshold"];- Specified by:
getRequestByteThresholdin interfaceBatchingSettingsProtoOrBuilder- Returns:
- The requestByteThreshold.
-
setRequestByteThreshold
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 [json_name = "requestByteThreshold"];- Parameters:
value- The requestByteThreshold to set.- Returns:
- This builder for chaining.
-
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 [json_name = "requestByteThreshold"];- Returns:
- This builder for chaining.
-
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 [json_name = "delayThreshold"];- Specified by:
hasDelayThresholdin interfaceBatchingSettingsProtoOrBuilder- Returns:
- Whether the delayThreshold field is set.
-
getDelayThreshold
public com.google.protobuf.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 [json_name = "delayThreshold"];- Specified by:
getDelayThresholdin interfaceBatchingSettingsProtoOrBuilder- Returns:
- The delayThreshold.
-
setDelayThreshold
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 [json_name = "delayThreshold"]; -
setDelayThreshold
public BatchingSettingsProto.Builder setDelayThreshold(com.google.protobuf.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 [json_name = "delayThreshold"]; -
mergeDelayThreshold
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 [json_name = "delayThreshold"]; -
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 [json_name = "delayThreshold"]; -
getElementCountLimit
public int getElementCountLimit()The maximum number of elements collected in a batch that could be accepted by server.
int32 element_count_limit = 4 [json_name = "elementCountLimit"];- Specified by:
getElementCountLimitin interfaceBatchingSettingsProtoOrBuilder- Returns:
- The elementCountLimit.
-
setElementCountLimit
The maximum number of elements collected in a batch that could be accepted by server.
int32 element_count_limit = 4 [json_name = "elementCountLimit"];- Parameters:
value- The elementCountLimit to set.- Returns:
- This builder for chaining.
-
clearElementCountLimit
The maximum number of elements collected in a batch that could be accepted by server.
int32 element_count_limit = 4 [json_name = "elementCountLimit"];- Returns:
- This builder for chaining.
-
getRequestByteLimit
public int getRequestByteLimit()The maximum size of the request that could be accepted by server.
int32 request_byte_limit = 5 [json_name = "requestByteLimit"];- Specified by:
getRequestByteLimitin interfaceBatchingSettingsProtoOrBuilder- Returns:
- The requestByteLimit.
-
setRequestByteLimit
The maximum size of the request that could be accepted by server.
int32 request_byte_limit = 5 [json_name = "requestByteLimit"];- Parameters:
value- The requestByteLimit to set.- Returns:
- This builder for chaining.
-
clearRequestByteLimit
The maximum size of the request that could be accepted by server.
int32 request_byte_limit = 5 [json_name = "requestByteLimit"];- Returns:
- This builder for chaining.
-
getFlowControlElementLimit
public int getFlowControlElementLimit()The maximum number of elements allowed by flow control.
int32 flow_control_element_limit = 6 [json_name = "flowControlElementLimit"];- Specified by:
getFlowControlElementLimitin interfaceBatchingSettingsProtoOrBuilder- Returns:
- The flowControlElementLimit.
-
setFlowControlElementLimit
The maximum number of elements allowed by flow control.
int32 flow_control_element_limit = 6 [json_name = "flowControlElementLimit"];- Parameters:
value- The flowControlElementLimit to set.- Returns:
- This builder for chaining.
-
clearFlowControlElementLimit
The maximum number of elements allowed by flow control.
int32 flow_control_element_limit = 6 [json_name = "flowControlElementLimit"];- Returns:
- This builder for chaining.
-
getFlowControlByteLimit
public int getFlowControlByteLimit()The maximum size of data allowed by flow control.
int32 flow_control_byte_limit = 7 [json_name = "flowControlByteLimit"];- Specified by:
getFlowControlByteLimitin interfaceBatchingSettingsProtoOrBuilder- Returns:
- The flowControlByteLimit.
-
setFlowControlByteLimit
The maximum size of data allowed by flow control.
int32 flow_control_byte_limit = 7 [json_name = "flowControlByteLimit"];- Parameters:
value- The flowControlByteLimit to set.- Returns:
- This builder for chaining.
-
clearFlowControlByteLimit
The maximum size of data allowed by flow control.
int32 flow_control_byte_limit = 7 [json_name = "flowControlByteLimit"];- Returns:
- This builder for chaining.
-
getFlowControlLimitExceededBehaviorValue
public int getFlowControlLimitExceededBehaviorValue()The behavior to take when the flow control limit is exceeded.
.google.api.FlowControlLimitExceededBehaviorProto flow_control_limit_exceeded_behavior = 8 [json_name = "flowControlLimitExceededBehavior"];- Specified by:
getFlowControlLimitExceededBehaviorValuein interfaceBatchingSettingsProtoOrBuilder- Returns:
- The enum numeric value on the wire for flowControlLimitExceededBehavior.
-
setFlowControlLimitExceededBehaviorValue
The behavior to take when the flow control limit is exceeded.
.google.api.FlowControlLimitExceededBehaviorProto flow_control_limit_exceeded_behavior = 8 [json_name = "flowControlLimitExceededBehavior"];- Parameters:
value- The flowControlLimitExceededBehavior to set.- Returns:
- This builder for chaining.
-
getFlowControlLimitExceededBehavior
The behavior to take when the flow control limit is exceeded.
.google.api.FlowControlLimitExceededBehaviorProto flow_control_limit_exceeded_behavior = 8 [json_name = "flowControlLimitExceededBehavior"];- Specified by:
getFlowControlLimitExceededBehaviorin interfaceBatchingSettingsProtoOrBuilder- Returns:
- The flowControlLimitExceededBehavior.
-
setFlowControlLimitExceededBehavior
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 [json_name = "flowControlLimitExceededBehavior"];- Parameters:
value- The enum numeric value on the wire for flowControlLimitExceededBehavior to set.- Returns:
- This builder for chaining.
- Throws:
IllegalArgumentException- if UNRECOGNIZED is provided.
-
clearFlowControlLimitExceededBehavior
The behavior to take when the flow control limit is exceeded.
.google.api.FlowControlLimitExceededBehaviorProto flow_control_limit_exceeded_behavior = 8 [json_name = "flowControlLimitExceededBehavior"];- Returns:
- This builder for chaining.
-