All Implemented Interfaces:

Protos.RateLimitOrBuilder

Enclosing class:

Protos

public static final class Protos.RateLimit
extends com.google.protobuf.GeneratedMessageV3
implements Protos.RateLimitOrBuilder 

 Rate (queries per second, QPS) limit for messages from a framework to master.
 Strictly speaking they are the combined rate from all frameworks of the same
 principal.
 

• Nested Class Summary

  Nested Classes

  Modifier and Type	Class and Description
  static class	Protos.RateLimit.Builder Rate (queries per second, QPS) limit for messages from a framework to master.

• Field Summary

  Fields

  Modifier and Type	Field and Description
  static int	CAPACITY_FIELD_NUMBER
  static <any>	PARSER Deprecated.
  static int	PRINCIPAL_FIELD_NUMBER
  static int	QPS_FIELD_NUMBER

• Method Summary

  All Methods

  Modifier and Type	Method and Description
  boolean	equals (java.lang.Object obj)
  long	getCapacity () Max number of outstanding messages from frameworks of this principal allowed by master before the next message is dropped and an error is sent back to the sender.
  static Protos.RateLimit	getDefaultInstance ()
  Protos.RateLimit	getDefaultInstanceForType ()
  static com.google.protobuf.Descriptors.Descriptor	getDescriptor ()
  <any>	getParserForType ()
  java.lang.String	getPrincipal () Principal of framework(s) to be throttled.
  com.google.protobuf.ByteString	getPrincipalBytes () Principal of framework(s) to be throttled.
  double	getQps () Leaving QPS unset gives it unlimited rate (i.e., not throttled), which also implies unlimited capacity.
  int	getSerializedSize ()
  com.google.protobuf.UnknownFieldSet	getUnknownFields ()
  boolean	hasCapacity () Max number of outstanding messages from frameworks of this principal allowed by master before the next message is dropped and an error is sent back to the sender.
  int	hashCode ()
  boolean	hasPrincipal () Principal of framework(s) to be throttled.
  boolean	hasQps () Leaving QPS unset gives it unlimited rate (i.e., not throttled), which also implies unlimited capacity.
  protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable ()
  boolean	isInitialized ()
  static Protos.RateLimit.Builder	newBuilder ()
  static Protos.RateLimit.Builder	newBuilder (Protos.RateLimit prototype)
  Protos.RateLimit.Builder	newBuilderForType ()
  protected Protos.RateLimit.Builder	newBuilderForType (com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
  static Protos.RateLimit	parseDelimitedFrom (java.io.InputStream input)
  static Protos.RateLimit	parseDelimitedFrom (java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
  static Protos.RateLimit	parseFrom (byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
  static Protos.RateLimit	parseFrom (java.nio.ByteBuffer data)
  static Protos.RateLimit	parseFrom (java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
  static Protos.RateLimit	parseFrom (com.google.protobuf.ByteString data)
  static Protos.RateLimit	parseFrom (com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
  static Protos.RateLimit	parseFrom (com.google.protobuf.CodedInputStream input)
  static Protos.RateLimit	parseFrom (com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
  static Protos.RateLimit	parseFrom (java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
  static <any>	parser ()
  Protos.RateLimit.Builder	toBuilder ()
  void	writeTo (com.google.protobuf.CodedOutputStream output)

  • Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

• Field Detail

  • QPS_FIELD_NUMBER

    public static final int QPS_FIELD_NUMBER

    See Also:

    Constant Field Values

  • PRINCIPAL_FIELD_NUMBER

    public static final int PRINCIPAL_FIELD_NUMBER

    See Also:

    Constant Field Values

  • CAPACITY_FIELD_NUMBER

    public static final int CAPACITY_FIELD_NUMBER

    See Also:

    Constant Field Values

  • PARSER

    @Deprecated
    public static final <any> PARSER

    Deprecated.

• Method Detail

  • getUnknownFields

    public final com.google.protobuf.UnknownFieldSet getUnknownFields()

  • getDescriptor

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

  • internalGetFieldAccessorTable

    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

  • hasQps

    public boolean hasQps()

     Leaving QPS unset gives it unlimited rate (i.e., not throttled),
     which also implies unlimited capacity.
     

    optional double qps = 1;

    Specified by:

    hasQps in interface Protos.RateLimitOrBuilder

  • getQps

    public double getQps()

     Leaving QPS unset gives it unlimited rate (i.e., not throttled),
     which also implies unlimited capacity.
     

    optional double qps = 1;

    Specified by:

    getQps in interface Protos.RateLimitOrBuilder

  • hasPrincipal

    public boolean hasPrincipal()

     Principal of framework(s) to be throttled. Should match
     FrameworkInfo.principal and Credential.principal (if using authentication).
     

    required string principal = 2;

    Specified by:

    hasPrincipal in interface Protos.RateLimitOrBuilder

  • getPrincipal

    public java.lang.String getPrincipal()

     Principal of framework(s) to be throttled. Should match
     FrameworkInfo.principal and Credential.principal (if using authentication).
     

    required string principal = 2;

    Specified by:

    getPrincipal in interface Protos.RateLimitOrBuilder

  • getPrincipalBytes

    public com.google.protobuf.ByteString getPrincipalBytes()

     Principal of framework(s) to be throttled. Should match
     FrameworkInfo.principal and Credential.principal (if using authentication).
     

    required string principal = 2;

    Specified by:

    getPrincipalBytes in interface Protos.RateLimitOrBuilder

  • hasCapacity

    public boolean hasCapacity()

     Max number of outstanding messages from frameworks of this principal
     allowed by master before the next message is dropped and an error is sent
     back to the sender. Messages received before the capacity is reached are
     still going to be processed after the error is sent.
     If unspecified, this principal is assigned unlimited capacity.
     NOTE: This value is ignored if 'qps' is not set.
     

    optional uint64 capacity = 3;

    Specified by:

    hasCapacity in interface Protos.RateLimitOrBuilder

  • getCapacity

    public long getCapacity()

     Max number of outstanding messages from frameworks of this principal
     allowed by master before the next message is dropped and an error is sent
     back to the sender. Messages received before the capacity is reached are
     still going to be processed after the error is sent.
     If unspecified, this principal is assigned unlimited capacity.
     NOTE: This value is ignored if 'qps' is not set.
     

    optional uint64 capacity = 3;

    Specified by:

    getCapacity in interface Protos.RateLimitOrBuilder

  • isInitialized

    public final boolean isInitialized()

  • writeTo

    public void writeTo(com.google.protobuf.CodedOutputStream output)
     throws java.io.IOException

    Throws:

    java.io.IOException

  • getSerializedSize

    public int getSerializedSize()

  • equals

    public boolean equals(java.lang.Object obj)

  • hashCode

    public int hashCode()

  • parseFrom

    public static Protos.RateLimit parseFrom(java.nio.ByteBuffer data)
     throws com.google.protobuf.InvalidProtocolBufferException

    Throws:

    com.google.protobuf.InvalidProtocolBufferException

  • parseFrom

    public static Protos.RateLimit parseFrom(java.nio.ByteBuffer data,
     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     throws com.google.protobuf.InvalidProtocolBufferException

    Throws:

    com.google.protobuf.InvalidProtocolBufferException

  • parseFrom

    public static Protos.RateLimit parseFrom(com.google.protobuf.ByteString data)
     throws com.google.protobuf.InvalidProtocolBufferException

    Throws:

    com.google.protobuf.InvalidProtocolBufferException

  • parseFrom

    public static Protos.RateLimit parseFrom(com.google.protobuf.ByteString data,
     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     throws com.google.protobuf.InvalidProtocolBufferException

    Throws:

    com.google.protobuf.InvalidProtocolBufferException

  • parseFrom

    public static Protos.RateLimit parseFrom(byte[] data,
     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     throws com.google.protobuf.InvalidProtocolBufferException

    Throws:

    com.google.protobuf.InvalidProtocolBufferException

  • parseFrom

    public static Protos.RateLimit parseFrom(java.io.InputStream input,
     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     throws java.io.IOException

    Throws:

    java.io.IOException

  • parseDelimitedFrom

    public static Protos.RateLimit parseDelimitedFrom(java.io.InputStream input)
     throws java.io.IOException

    Throws:

    java.io.IOException

  • parseDelimitedFrom

    public static Protos.RateLimit parseDelimitedFrom(java.io.InputStream input,
     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     throws java.io.IOException

    Throws:

    java.io.IOException

  • parseFrom

    public static Protos.RateLimit parseFrom(com.google.protobuf.CodedInputStream input)
     throws java.io.IOException

    Throws:

    java.io.IOException

  • parseFrom

    public static Protos.RateLimit parseFrom(com.google.protobuf.CodedInputStream input,
     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     throws java.io.IOException

    Throws:

    java.io.IOException

  • newBuilderForType

    public Protos.RateLimit.Builder newBuilderForType()

  • newBuilder

    public static Protos.RateLimit.Builder newBuilder()

  • newBuilder

    public static Protos.RateLimit.Builder newBuilder(Protos.RateLimit prototype)

  • toBuilder

    public Protos.RateLimit.Builder toBuilder()

  • newBuilderForType

    protected Protos.RateLimit.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

  • getDefaultInstance

    public static Protos.RateLimit getDefaultInstance()

  • parser

    public static <any> parser()

  • getParserForType

    public <any> getParserForType()

  • getDefaultInstanceForType

    public Protos.RateLimit getDefaultInstanceForType()