Package com.google.bigtable.v2

Class RateLimitInfo

  • All Implemented Interfaces:
    RateLimitInfoOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class RateLimitInfo
extends com.google.protobuf.GeneratedMessageV3
implements RateLimitInfoOrBuilder
     Information about how client should adjust the load to Bigtable.
    Protobuf type google.bigtable.v2.RateLimitInfo
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  RateLimitInfo.Builder
      Information about how client should adjust the load to Bigtable.

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int FACTOR_FIELD_NUMBER  
      static int PERIOD_FIELD_NUMBER  

      • Fields inherited from class com.google.protobuf.GeneratedMessageV3

        alwaysUseFieldBuilders, unknownFields

      • Fields inherited from class com.google.protobuf.AbstractMessage

        memoizedSize

      • Fields inherited from class com.google.protobuf.AbstractMessageLite

        memoizedHashCode

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • 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

      • 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.

      • 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.

      • isInitialized

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

      • 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.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

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

      • 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 RateLimitInfo parseFrom​(ByteBuffer data)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static RateLimitInfo parseFrom​(ByteBuffer data,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static RateLimitInfo parseFrom​(com.google.protobuf.ByteString data)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static RateLimitInfo parseFrom​(com.google.protobuf.ByteString data,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static RateLimitInfo parseFrom​(byte[] data)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static RateLimitInfo parseFrom​(byte[] data,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static RateLimitInfo parseFrom​(com.google.protobuf.CodedInputStream input,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws IOException
        Throws:
        IOException

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

        protected RateLimitInfo.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static RateLimitInfo getDefaultInstance()

      • parser

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

      • getParserForType

        public com.google.protobuf.Parser<RateLimitInfo> 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.GeneratedMessageV3

      • getDefaultInstanceForType

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