public final class BatchingSettingsProto extends GeneratedMessage 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
Inherited Members
com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)
com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)
com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)
com.google.protobuf.GeneratedMessage.canUseUnsafe()
com.google.protobuf.GeneratedMessage.emptyBooleanList()
com.google.protobuf.GeneratedMessage.emptyDoubleList()
com.google.protobuf.GeneratedMessage.emptyFloatList()
com.google.protobuf.GeneratedMessage.emptyIntList()
com.google.protobuf.GeneratedMessage.emptyLongList()
com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)
com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)
com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)
com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,int)
Static Fields
DELAY_THRESHOLD_FIELD_NUMBER
public static final int DELAY_THRESHOLD_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
ELEMENT_COUNT_LIMIT_FIELD_NUMBER
public static final int ELEMENT_COUNT_LIMIT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
ELEMENT_COUNT_THRESHOLD_FIELD_NUMBER
public static final int ELEMENT_COUNT_THRESHOLD_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
FLOW_CONTROL_BYTE_LIMIT_FIELD_NUMBER
public static final int FLOW_CONTROL_BYTE_LIMIT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
FLOW_CONTROL_ELEMENT_LIMIT_FIELD_NUMBER
public static final int FLOW_CONTROL_ELEMENT_LIMIT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
FLOW_CONTROL_LIMIT_EXCEEDED_BEHAVIOR_FIELD_NUMBER
public static final int FLOW_CONTROL_LIMIT_EXCEEDED_BEHAVIOR_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
REQUEST_BYTE_LIMIT_FIELD_NUMBER
public static final int REQUEST_BYTE_LIMIT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
REQUEST_BYTE_THRESHOLD_FIELD_NUMBER
public static final int REQUEST_BYTE_THRESHOLD_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static BatchingSettingsProto getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static BatchingSettingsProto.Builder newBuilder()
newBuilder(BatchingSettingsProto prototype)
public static BatchingSettingsProto.Builder newBuilder(BatchingSettingsProto prototype)
public static BatchingSettingsProto parseDelimitedFrom(InputStream input)
public static BatchingSettingsProto parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static BatchingSettingsProto parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static BatchingSettingsProto parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static BatchingSettingsProto parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static BatchingSettingsProto parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static BatchingSettingsProto parseFrom(CodedInputStream input)
public static BatchingSettingsProto parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static BatchingSettingsProto parseFrom(InputStream input)
public static BatchingSettingsProto parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static BatchingSettingsProto parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static BatchingSettingsProto parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<BatchingSettingsProto> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
public BatchingSettingsProto getDefaultInstanceForType()
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.
|
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;
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;
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.
|
getParserForType()
public Parser<BatchingSettingsProto> getParserForType()
Overrides
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.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
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.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public BatchingSettingsProto.Builder newBuilderForType()
newBuilderForType(AbstractMessage.BuilderParent parent)
protected BatchingSettingsProto.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Overrides
toBuilder()
public BatchingSettingsProto.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
