org.apache.mesos

Class Protos.RateLimit.Builder

java.lang.Object

<any>

org.apache.mesos.Protos.RateLimit.Builder

All Implemented Interfaces:

Protos.RateLimitOrBuilder

Enclosing class:

Protos.RateLimit

public static final class Protos.RateLimit.Builder
extends <any>
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.
 

Protobuf type mesos.RateLimit

Method Summary

Modifier and Type	Method and Description
Protos.RateLimit.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)
Protos.RateLimit	build()
Protos.RateLimit	buildPartial()
Protos.RateLimit.Builder	clear()
Protos.RateLimit.Builder	clearCapacity() 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.
Protos.RateLimit.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
Protos.RateLimit.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
Protos.RateLimit.Builder	clearPrincipal() Principal of framework(s) to be throttled.
Protos.RateLimit.Builder	clearQps() Leaving QPS unset gives it unlimited rate (i.e., not throttled), which also implies unlimited capacity.
Protos.RateLimit.Builder	clone()
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.
Protos.RateLimit	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
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.
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.
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()
Protos.RateLimit.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
Protos.RateLimit.Builder	mergeFrom(com.google.protobuf.Message other)
Protos.RateLimit.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
Protos.RateLimit.Builder	setCapacity(long value) 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.
Protos.RateLimit.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)
Protos.RateLimit.Builder	setPrincipal(java.lang.String value) Principal of framework(s) to be throttled.
Protos.RateLimit.Builder	setPrincipalBytes(com.google.protobuf.ByteString value) Principal of framework(s) to be throttled.
Protos.RateLimit.Builder	setQps(double value) Leaving QPS unset gives it unlimited rate (i.e., not throttled), which also implies unlimited capacity.
Protos.RateLimit.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, java.lang.Object value)
Protos.RateLimit.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Methods inherited from class java.lang.Object

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

Method Detail

getDescriptor

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

internalGetFieldAccessorTable

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

clear

public Protos.RateLimit.Builder clear()

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

getDefaultInstanceForType

public Protos.RateLimit getDefaultInstanceForType()

build

public Protos.RateLimit build()

buildPartial

public Protos.RateLimit buildPartial()

clone

public Protos.RateLimit.Builder clone()

setField

public Protos.RateLimit.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                         java.lang.Object value)

clearField

public Protos.RateLimit.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

clearOneof

public Protos.RateLimit.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

setRepeatedField

public Protos.RateLimit.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                 int index,
                                                 java.lang.Object value)

addRepeatedField

public Protos.RateLimit.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                 java.lang.Object value)

mergeFrom

public Protos.RateLimit.Builder mergeFrom(com.google.protobuf.Message other)

isInitialized

public final boolean isInitialized()

mergeFrom

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

Throws:

java.io.IOException

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

setQps

public Protos.RateLimit.Builder setQps(double value)

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

optional double qps = 1;

clearQps

public Protos.RateLimit.Builder clearQps()

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

optional double qps = 1;

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

setPrincipal

public Protos.RateLimit.Builder setPrincipal(java.lang.String value)

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

required string principal = 2;

clearPrincipal

public Protos.RateLimit.Builder clearPrincipal()

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

required string principal = 2;

setPrincipalBytes

public Protos.RateLimit.Builder setPrincipalBytes(com.google.protobuf.ByteString value)

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

required string principal = 2;

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

setCapacity

public Protos.RateLimit.Builder setCapacity(long value)

 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;

clearCapacity

public Protos.RateLimit.Builder clearCapacity()

 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;

setUnknownFields

public final Protos.RateLimit.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

mergeUnknownFields

public final Protos.RateLimit.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)