Package com.google.api

Class BatchingSettingsProto

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.api.BatchingSettingsProto
All Implemented Interfaces:
BatchingSettingsProtoOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class BatchingSettingsProto extends com.google.protobuf.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
See Also:

  • 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

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • 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;
      Specified by:
      getElementCountThreshold in interface BatchingSettingsProtoOrBuilder
      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;
      Specified by:
      getRequestByteThreshold in interface BatchingSettingsProtoOrBuilder
      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;
      Specified by:
      hasDelayThreshold in interface BatchingSettingsProtoOrBuilder
      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;
      Specified by:
      getDelayThreshold in interface BatchingSettingsProtoOrBuilder
      Returns:
      The delayThreshold.

    • getDelayThresholdOrBuilder

      public com.google.protobuf.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;
      Specified by:
      getDelayThresholdOrBuilder in interface BatchingSettingsProtoOrBuilder

    • getElementCountLimit

      public int getElementCountLimit()
       The maximum number of elements collected in a batch that could be accepted
 by server.
      int32 element_count_limit = 4;
      Specified by:
      getElementCountLimit in interface BatchingSettingsProtoOrBuilder
      Returns:
      The elementCountLimit.

    • getRequestByteLimit

      public int getRequestByteLimit()
       The maximum size of the request that could be accepted by server.
      int32 request_byte_limit = 5;
      Specified by:
      getRequestByteLimit in interface BatchingSettingsProtoOrBuilder
      Returns:
      The requestByteLimit.

    • getFlowControlElementLimit

      public int getFlowControlElementLimit()
       The maximum number of elements allowed by flow control.
      int32 flow_control_element_limit = 6;
      Specified by:
      getFlowControlElementLimit in interface BatchingSettingsProtoOrBuilder
      Returns:
      The flowControlElementLimit.

    • getFlowControlByteLimit

      public int getFlowControlByteLimit()
       The maximum size of data allowed by flow control.
      int32 flow_control_byte_limit = 7;
      Specified by:
      getFlowControlByteLimit in interface BatchingSettingsProtoOrBuilder
      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;
      Specified by:
      getFlowControlLimitExceededBehaviorValue in interface BatchingSettingsProtoOrBuilder
      Returns:
      The enum numeric value on the wire for flowControlLimitExceededBehavior.

    • getFlowControlLimitExceededBehavior

      public FlowControlLimitExceededBehaviorProto getFlowControlLimitExceededBehavior()
       The behavior to take when the flow control limit is exceeded.
      .google.api.FlowControlLimitExceededBehaviorProto flow_control_limit_exceeded_behavior = 8;
      Specified by:
      getFlowControlLimitExceededBehavior in interface BatchingSettingsProtoOrBuilder
      Returns:
      The flowControlLimitExceededBehavior.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • 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

      public static BatchingSettingsProto parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static BatchingSettingsProto parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static BatchingSettingsProto parseDelimitedFrom(InputStream input) throws IOException
      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

    • newBuilderForType

      public BatchingSettingsProto.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static BatchingSettingsProto.Builder newBuilder()

    • newBuilder

      public static BatchingSettingsProto.Builder newBuilder(BatchingSettingsProto prototype)

    • toBuilder

      public BatchingSettingsProto.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected BatchingSettingsProto.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static BatchingSettingsProto getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<BatchingSettingsProto> parser()

    • getParserForType

      public com.google.protobuf.Parser<BatchingSettingsProto> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public BatchingSettingsProto getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder