Package com.google.api
Class BatchingSettingsProto
java.lang.Object
com.google.protobuf.AbstractMessageLite<BatchingSettingsProto,BatchingSettingsProto.Builder>
com.google.protobuf.GeneratedMessageLite<BatchingSettingsProto,BatchingSettingsProto.Builder>
com.google.api.BatchingSettingsProto
- All Implemented Interfaces:
BatchingSettingsProtoOrBuilder,com.google.protobuf.MessageLite,com.google.protobuf.MessageLiteOrBuilder
@Generated
public final class BatchingSettingsProto
extends com.google.protobuf.GeneratedMessageLite<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-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final class`BatchingSettingsProto` specifies a set of batching thresholds, each of which acts as a trigger to send a batch of messages as a request.Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageLite
com.google.protobuf.GeneratedMessageLite.DefaultInstanceBasedParser<T extends com.google.protobuf.GeneratedMessageLite<T,?>>, com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType, BuilderType>, BuilderType extends com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType, BuilderType>>, com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType, BuilderType>, BuilderType extends com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType, BuilderType>>, com.google.protobuf.GeneratedMessageLite.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType, BuilderType>, BuilderType extends com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType, BuilderType>>, com.google.protobuf.GeneratedMessageLite.GeneratedExtension<ContainingType extends com.google.protobuf.MessageLite, Type>, com.google.protobuf.GeneratedMessageLite.MethodToInvoke, com.google.protobuf.GeneratedMessageLite.SerializedForm Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intFields inherited from class com.google.protobuf.GeneratedMessageLite
unknownFieldsFields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode -
Method Summary
Modifier and TypeMethodDescriptionprotected final ObjectdynamicMethod(com.google.protobuf.GeneratedMessageLite.MethodToInvoke method, Object arg0, Object arg1) static BatchingSettingsProtocom.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.newBuilder(BatchingSettingsProto prototype) static BatchingSettingsProtoparseDelimitedFrom(InputStream input) static BatchingSettingsProtoparseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static BatchingSettingsProtoparseFrom(byte[] data) static BatchingSettingsProtoparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static BatchingSettingsProtoparseFrom(com.google.protobuf.ByteString data) static BatchingSettingsProtoparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static BatchingSettingsProtoparseFrom(com.google.protobuf.CodedInputStream input) static BatchingSettingsProtoparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static BatchingSettingsProtoparseFrom(InputStream input) static BatchingSettingsProtoparseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static BatchingSettingsProtoparseFrom(ByteBuffer data) static BatchingSettingsProtoparseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<BatchingSettingsProto> parser()Methods inherited from class com.google.protobuf.GeneratedMessageLite
createBuilder, createBuilder, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, emptyProtobufList, equals, getDefaultInstanceForType, getParserForType, getSerializedSize, hashCode, isInitialized, makeImmutable, mergeLengthDelimitedField, mergeUnknownFields, mergeVarintField, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBuilderForType, newMessageInfo, newRepeatedGeneratedExtension, newSingularGeneratedExtension, parseDelimitedFrom, parseDelimitedFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parsePartialFrom, parseUnknownField, registerDefaultInstance, toBuilder, toString, writeToMethods inherited from class com.google.protobuf.AbstractMessageLite
addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.MessageLiteOrBuilder
getDefaultInstanceForType, isInitialized
-
Field Details
-
ELEMENT_COUNT_THRESHOLD_FIELD_NUMBER
public static final int ELEMENT_COUNT_THRESHOLD_FIELD_NUMBER- See Also:
-
REQUEST_BYTE_THRESHOLD_FIELD_NUMBER
public static final int REQUEST_BYTE_THRESHOLD_FIELD_NUMBER- See Also:
-
DELAY_THRESHOLD_FIELD_NUMBER
public static final int DELAY_THRESHOLD_FIELD_NUMBER- See Also:
-
ELEMENT_COUNT_LIMIT_FIELD_NUMBER
public static final int ELEMENT_COUNT_LIMIT_FIELD_NUMBER- See Also:
-
REQUEST_BYTE_LIMIT_FIELD_NUMBER
public static final int REQUEST_BYTE_LIMIT_FIELD_NUMBER- See Also:
-
FLOW_CONTROL_ELEMENT_LIMIT_FIELD_NUMBER
public static final int FLOW_CONTROL_ELEMENT_LIMIT_FIELD_NUMBER- See Also:
-
FLOW_CONTROL_BYTE_LIMIT_FIELD_NUMBER
public static final int FLOW_CONTROL_BYTE_LIMIT_FIELD_NUMBER- See Also:
-
FLOW_CONTROL_LIMIT_EXCEEDED_BEHAVIOR_FIELD_NUMBER
public static final int FLOW_CONTROL_LIMIT_EXCEEDED_BEHAVIOR_FIELD_NUMBER- See Also:
-
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
parseFrom
public static BatchingSettingsProto parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static BatchingSettingsProto parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static BatchingSettingsProto parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static BatchingSettingsProto parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static BatchingSettingsProto parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static BatchingSettingsProto parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static BatchingSettingsProto parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static BatchingSettingsProto parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
public static BatchingSettingsProto parseFrom(com.google.protobuf.CodedInputStream input) throws IOException - Throws:
IOException
-
parseFrom
public static BatchingSettingsProto parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilder
-
newBuilder
-
dynamicMethod
protected final Object dynamicMethod(com.google.protobuf.GeneratedMessageLite.MethodToInvoke method, Object arg0, Object arg1) - Specified by:
dynamicMethodin classcom.google.protobuf.GeneratedMessageLite<BatchingSettingsProto,BatchingSettingsProto.Builder>
-
getDefaultInstance
-
parser
-