Package io.grpc.serviceconfig

Class ServiceConfig.RetryThrottlingPolicy.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderType>

com.google.protobuf.GeneratedMessageV3.Builder<ServiceConfig.RetryThrottlingPolicy.Builder>

io.grpc.serviceconfig.ServiceConfig.RetryThrottlingPolicy.Builder

All Implemented Interfaces:

com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ServiceConfig.RetryThrottlingPolicyOrBuilder, Cloneable

Enclosing class:

ServiceConfig.RetryThrottlingPolicy

public static final class ServiceConfig.RetryThrottlingPolicy.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<ServiceConfig.RetryThrottlingPolicy.Builder>
implements ServiceConfig.RetryThrottlingPolicyOrBuilder

 If a RetryThrottlingPolicy is provided, gRPC will automatically throttle
 retry attempts and hedged RPCs when the client's ratio of failures to
 successes exceeds a threshold.
 For each server name, the gRPC client will maintain a token_count which is
 initially set to max_tokens. Every outgoing RPC (regardless of service or
 method invoked) will change token_count as follows:
   - Every failed RPC will decrement the token_count by 1.
   - Every successful RPC will increment the token_count by token_ratio.
 If token_count is less than or equal to max_tokens / 2, then RPCs will not
 be retried and hedged RPCs will not be sent.
 

Protobuf type grpc.service_config.ServiceConfig.RetryThrottlingPolicy

Method Summary

Modifier and Type	Method	Description
ServiceConfig.RetryThrottlingPolicy.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
ServiceConfig.RetryThrottlingPolicy	build()
ServiceConfig.RetryThrottlingPolicy	buildPartial()
ServiceConfig.RetryThrottlingPolicy.Builder	clear()
ServiceConfig.RetryThrottlingPolicy.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
ServiceConfig.RetryThrottlingPolicy.Builder	clearMaxTokens()	The number of tokens starts at max_tokens.
ServiceConfig.RetryThrottlingPolicy.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
ServiceConfig.RetryThrottlingPolicy.Builder	clearTokenRatio()	The amount of tokens to add on each successful RPC.
ServiceConfig.RetryThrottlingPolicy.Builder	clone()
ServiceConfig.RetryThrottlingPolicy	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
int	getMaxTokens()	The number of tokens starts at max_tokens.
float	getTokenRatio()	The amount of tokens to add on each successful RPC.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
ServiceConfig.RetryThrottlingPolicy.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
ServiceConfig.RetryThrottlingPolicy.Builder	mergeFrom(com.google.protobuf.Message other)
ServiceConfig.RetryThrottlingPolicy.Builder	mergeFrom(ServiceConfig.RetryThrottlingPolicy other)
ServiceConfig.RetryThrottlingPolicy.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
ServiceConfig.RetryThrottlingPolicy.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
ServiceConfig.RetryThrottlingPolicy.Builder	setMaxTokens(int value)	The number of tokens starts at max_tokens.
ServiceConfig.RetryThrottlingPolicy.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
ServiceConfig.RetryThrottlingPolicy.Builder	setTokenRatio(float value)	The amount of tokens to add on each successful RPC.
ServiceConfig.RetryThrottlingPolicy.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, internalGetMutableMapField, 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 Detail

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<ServiceConfig.RetryThrottlingPolicy.Builder>

clear

public ServiceConfig.RetryThrottlingPolicy.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<ServiceConfig.RetryThrottlingPolicy.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<ServiceConfig.RetryThrottlingPolicy.Builder>

getDefaultInstanceForType

public ServiceConfig.RetryThrottlingPolicy getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public ServiceConfig.RetryThrottlingPolicy build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public ServiceConfig.RetryThrottlingPolicy buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public ServiceConfig.RetryThrottlingPolicy.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<ServiceConfig.RetryThrottlingPolicy.Builder>

setField

public ServiceConfig.RetryThrottlingPolicy.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<ServiceConfig.RetryThrottlingPolicy.Builder>

clearField

public ServiceConfig.RetryThrottlingPolicy.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<ServiceConfig.RetryThrottlingPolicy.Builder>

clearOneof

public ServiceConfig.RetryThrottlingPolicy.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<ServiceConfig.RetryThrottlingPolicy.Builder>

setRepeatedField

public ServiceConfig.RetryThrottlingPolicy.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<ServiceConfig.RetryThrottlingPolicy.Builder>

addRepeatedField

public ServiceConfig.RetryThrottlingPolicy.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<ServiceConfig.RetryThrottlingPolicy.Builder>

mergeFrom

public ServiceConfig.RetryThrottlingPolicy.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<ServiceConfig.RetryThrottlingPolicy.Builder>

mergeFrom

public ServiceConfig.RetryThrottlingPolicy.Builder mergeFrom(ServiceConfig.RetryThrottlingPolicy other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<ServiceConfig.RetryThrottlingPolicy.Builder>

mergeFrom

public ServiceConfig.RetryThrottlingPolicy.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<ServiceConfig.RetryThrottlingPolicy.Builder>

Throws:

IOException

getMaxTokens

public int getMaxTokens()

 The number of tokens starts at max_tokens. The token_count will always be
 between 0 and max_tokens.
 This field is required and must be greater than zero.
 

uint32 max_tokens = 1;

Specified by:

getMaxTokens in interface ServiceConfig.RetryThrottlingPolicyOrBuilder

Returns:

The maxTokens.

setMaxTokens

public ServiceConfig.RetryThrottlingPolicy.Builder setMaxTokens(int value)

 The number of tokens starts at max_tokens. The token_count will always be
 between 0 and max_tokens.
 This field is required and must be greater than zero.
 

uint32 max_tokens = 1;

Parameters:

value - The maxTokens to set.

Returns:

This builder for chaining.

clearMaxTokens

public ServiceConfig.RetryThrottlingPolicy.Builder clearMaxTokens()

 The number of tokens starts at max_tokens. The token_count will always be
 between 0 and max_tokens.
 This field is required and must be greater than zero.
 

uint32 max_tokens = 1;

Returns:

This builder for chaining.

getTokenRatio

public float getTokenRatio()

 The amount of tokens to add on each successful RPC. Typically this will
 be some number between 0 and 1, e.g., 0.1.
 This field is required and must be greater than zero. Up to 3 decimal
 places are supported.
 

float token_ratio = 2;

Specified by:

getTokenRatio in interface ServiceConfig.RetryThrottlingPolicyOrBuilder

Returns:

The tokenRatio.

setTokenRatio

public ServiceConfig.RetryThrottlingPolicy.Builder setTokenRatio(float value)

 The amount of tokens to add on each successful RPC. Typically this will
 be some number between 0 and 1, e.g., 0.1.
 This field is required and must be greater than zero. Up to 3 decimal
 places are supported.
 

float token_ratio = 2;

Parameters:

value - The tokenRatio to set.

Returns:

This builder for chaining.

clearTokenRatio

public ServiceConfig.RetryThrottlingPolicy.Builder clearTokenRatio()

 The amount of tokens to add on each successful RPC. Typically this will
 be some number between 0 and 1, e.g., 0.1.
 This field is required and must be greater than zero. Up to 3 decimal
 places are supported.
 

float token_ratio = 2;

Returns:

This builder for chaining.

setUnknownFields

public final ServiceConfig.RetryThrottlingPolicy.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<ServiceConfig.RetryThrottlingPolicy.Builder>

mergeUnknownFields

public final ServiceConfig.RetryThrottlingPolicy.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<ServiceConfig.RetryThrottlingPolicy.Builder>