Package com.google.bigtable.v2

Class RateLimitInfo.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<RateLimitInfo.Builder>
com.google.bigtable.v2.RateLimitInfo.Builder
All Implemented Interfaces:
RateLimitInfoOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
RateLimitInfo
public static final class RateLimitInfo.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<RateLimitInfo.Builder> implements RateLimitInfoOrBuilder
 Information about how client should adjust the load to Bigtable.
Protobuf type google.bigtable.v2.RateLimitInfo

  • Method Summary

    Modifier and Type
    Method
    Description
    RateLimitInfo.Builder
    addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
     
    RateLimitInfo
    build()
     
    RateLimitInfo
    buildPartial()
     
    RateLimitInfo.Builder
    clear()
     
    RateLimitInfo.Builder
    clearFactor()
    If it has been at least one `period` since the last load adjustment, the client should multiply the current load by this value to get the new target load.
    RateLimitInfo.Builder
    clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
     
    RateLimitInfo.Builder
    clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
     
    RateLimitInfo.Builder
    clearPeriod()
    Time that clients should wait before adjusting the target rate again.
    RateLimitInfo.Builder
    clone()
     
    RateLimitInfo
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Descriptors.Descriptor
    getDescriptorForType()
     
    double
    getFactor()
    If it has been at least one `period` since the last load adjustment, the client should multiply the current load by this value to get the new target load.
    com.google.protobuf.Duration
    getPeriod()
    Time that clients should wait before adjusting the target rate again.
    com.google.protobuf.Duration.Builder
    getPeriodBuilder()
    Time that clients should wait before adjusting the target rate again.
    com.google.protobuf.DurationOrBuilder
    getPeriodOrBuilder()
    Time that clients should wait before adjusting the target rate again.
    boolean
    hasPeriod()
    Time that clients should wait before adjusting the target rate again.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    RateLimitInfo.Builder
    mergeFrom(RateLimitInfo other)
     
    RateLimitInfo.Builder
    mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    RateLimitInfo.Builder
    mergeFrom(com.google.protobuf.Message other)
     
    RateLimitInfo.Builder
    mergePeriod(com.google.protobuf.Duration value)
    Time that clients should wait before adjusting the target rate again.
    final RateLimitInfo.Builder
    mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
     
    RateLimitInfo.Builder
    setFactor(double value)
    If it has been at least one `period` since the last load adjustment, the client should multiply the current load by this value to get the new target load.
    RateLimitInfo.Builder
    setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
     
    RateLimitInfo.Builder
    setPeriod(com.google.protobuf.Duration value)
    Time that clients should wait before adjusting the target rate again.
    RateLimitInfo.Builder
    setPeriod(com.google.protobuf.Duration.Builder builderForValue)
    Time that clients should wait before adjusting the target rate again.
    RateLimitInfo.Builder
    setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
     
    final RateLimitInfo.Builder
    setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

    getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

    Methods inherited from class com.google.protobuf.AbstractMessage.Builder

    findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

    addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

    Methods inherited from class java.lang.Object

    equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.Message.Builder

    mergeDelimitedFrom, mergeDelimitedFrom

    Methods inherited from interface com.google.protobuf.MessageLite.Builder

    mergeFrom

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<RateLimitInfo.Builder>

    • clear

      public RateLimitInfo.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessageV3.Builder<RateLimitInfo.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<RateLimitInfo.Builder>

    • getDefaultInstanceForType

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

    • build

      public RateLimitInfo build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public RateLimitInfo buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • clone

      public RateLimitInfo.Builder clone()
      Specified by:
      clone in interface com.google.protobuf.Message.Builder
      Specified by:
      clone in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clone in class com.google.protobuf.GeneratedMessageV3.Builder<RateLimitInfo.Builder>

    • setField

      public RateLimitInfo.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      setField in interface com.google.protobuf.Message.Builder
      Overrides:
      setField in class com.google.protobuf.GeneratedMessageV3.Builder<RateLimitInfo.Builder>

    • clearField

      public RateLimitInfo.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
      Specified by:
      clearField in interface com.google.protobuf.Message.Builder
      Overrides:
      clearField in class com.google.protobuf.GeneratedMessageV3.Builder<RateLimitInfo.Builder>

    • clearOneof

      public RateLimitInfo.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
      Specified by:
      clearOneof in interface com.google.protobuf.Message.Builder
      Overrides:
      clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<RateLimitInfo.Builder>

    • setRepeatedField

      public RateLimitInfo.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
      Specified by:
      setRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<RateLimitInfo.Builder>

    • addRepeatedField

      public RateLimitInfo.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      addRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<RateLimitInfo.Builder>

    • mergeFrom

      public RateLimitInfo.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<RateLimitInfo.Builder>

    • mergeFrom

      public RateLimitInfo.Builder mergeFrom(RateLimitInfo other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<RateLimitInfo.Builder>

    • mergeFrom

      public RateLimitInfo.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<RateLimitInfo.Builder>
      Throws:
      IOException

    • hasPeriod

      public boolean hasPeriod()
       Time that clients should wait before adjusting the target rate again.
 If clients adjust rate too frequently, the impact of the previous
 adjustment may not have been taken into account and may
 over-throttle or under-throttle. If clients adjust rate too slowly, they
 will not be responsive to load changes on server side, and may
 over-throttle or under-throttle.
      .google.protobuf.Duration period = 1;
      Specified by:
      hasPeriod in interface RateLimitInfoOrBuilder
      Returns:
      Whether the period field is set.

    • getPeriod

      public com.google.protobuf.Duration getPeriod()
       Time that clients should wait before adjusting the target rate again.
 If clients adjust rate too frequently, the impact of the previous
 adjustment may not have been taken into account and may
 over-throttle or under-throttle. If clients adjust rate too slowly, they
 will not be responsive to load changes on server side, and may
 over-throttle or under-throttle.
      .google.protobuf.Duration period = 1;
      Specified by:
      getPeriod in interface RateLimitInfoOrBuilder
      Returns:
      The period.

    • setPeriod

      public RateLimitInfo.Builder setPeriod(com.google.protobuf.Duration value)
       Time that clients should wait before adjusting the target rate again.
 If clients adjust rate too frequently, the impact of the previous
 adjustment may not have been taken into account and may
 over-throttle or under-throttle. If clients adjust rate too slowly, they
 will not be responsive to load changes on server side, and may
 over-throttle or under-throttle.
      .google.protobuf.Duration period = 1;

    • setPeriod

      public RateLimitInfo.Builder setPeriod(com.google.protobuf.Duration.Builder builderForValue)
       Time that clients should wait before adjusting the target rate again.
 If clients adjust rate too frequently, the impact of the previous
 adjustment may not have been taken into account and may
 over-throttle or under-throttle. If clients adjust rate too slowly, they
 will not be responsive to load changes on server side, and may
 over-throttle or under-throttle.
      .google.protobuf.Duration period = 1;

    • mergePeriod

      public RateLimitInfo.Builder mergePeriod(com.google.protobuf.Duration value)
       Time that clients should wait before adjusting the target rate again.
 If clients adjust rate too frequently, the impact of the previous
 adjustment may not have been taken into account and may
 over-throttle or under-throttle. If clients adjust rate too slowly, they
 will not be responsive to load changes on server side, and may
 over-throttle or under-throttle.
      .google.protobuf.Duration period = 1;

    • clearPeriod

      public RateLimitInfo.Builder clearPeriod()
       Time that clients should wait before adjusting the target rate again.
 If clients adjust rate too frequently, the impact of the previous
 adjustment may not have been taken into account and may
 over-throttle or under-throttle. If clients adjust rate too slowly, they
 will not be responsive to load changes on server side, and may
 over-throttle or under-throttle.
      .google.protobuf.Duration period = 1;

    • getPeriodBuilder

      public com.google.protobuf.Duration.Builder getPeriodBuilder()
       Time that clients should wait before adjusting the target rate again.
 If clients adjust rate too frequently, the impact of the previous
 adjustment may not have been taken into account and may
 over-throttle or under-throttle. If clients adjust rate too slowly, they
 will not be responsive to load changes on server side, and may
 over-throttle or under-throttle.
      .google.protobuf.Duration period = 1;

    • getPeriodOrBuilder

      public com.google.protobuf.DurationOrBuilder getPeriodOrBuilder()
       Time that clients should wait before adjusting the target rate again.
 If clients adjust rate too frequently, the impact of the previous
 adjustment may not have been taken into account and may
 over-throttle or under-throttle. If clients adjust rate too slowly, they
 will not be responsive to load changes on server side, and may
 over-throttle or under-throttle.
      .google.protobuf.Duration period = 1;
      Specified by:
      getPeriodOrBuilder in interface RateLimitInfoOrBuilder

    • getFactor

      public double getFactor()
       If it has been at least one `period` since the last load adjustment, the
 client should multiply the current load by this value to get the new target
 load. For example, if the current load is 100 and `factor` is 0.8, the new
 target load should be 80. After adjusting, the client should ignore
 `factor` until another `period` has passed.

 The client can measure its load using any unit that's comparable over time.
 For example, QPS can be used as long as each request involves a similar
 amount of work.
      double factor = 2;
      Specified by:
      getFactor in interface RateLimitInfoOrBuilder
      Returns:
      The factor.

    • setFactor

      public RateLimitInfo.Builder setFactor(double value)
       If it has been at least one `period` since the last load adjustment, the
 client should multiply the current load by this value to get the new target
 load. For example, if the current load is 100 and `factor` is 0.8, the new
 target load should be 80. After adjusting, the client should ignore
 `factor` until another `period` has passed.

 The client can measure its load using any unit that's comparable over time.
 For example, QPS can be used as long as each request involves a similar
 amount of work.
      double factor = 2;
      Parameters:
      value - The factor to set.
      Returns:
      This builder for chaining.

    • clearFactor

      public RateLimitInfo.Builder clearFactor()
       If it has been at least one `period` since the last load adjustment, the
 client should multiply the current load by this value to get the new target
 load. For example, if the current load is 100 and `factor` is 0.8, the new
 target load should be 80. After adjusting, the client should ignore
 `factor` until another `period` has passed.

 The client can measure its load using any unit that's comparable over time.
 For example, QPS can be used as long as each request involves a similar
 amount of work.
      double factor = 2;
      Returns:
      This builder for chaining.

    • setUnknownFields

      public final RateLimitInfo.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      setUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<RateLimitInfo.Builder>

    • mergeUnknownFields

      public final RateLimitInfo.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      mergeUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<RateLimitInfo.Builder>