io.grpc.serviceconfig

Class ServiceConfig.RetryThrottlingPolicy

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

io.grpc.serviceconfig.ServiceConfig.RetryThrottlingPolicy

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ServiceConfig.RetryThrottlingPolicyOrBuilder, Serializable

Enclosing class:

ServiceConfig

public static final class ServiceConfig.RetryThrottlingPolicy
extends com.google.protobuf.GeneratedMessageV3
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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ServiceConfig.RetryThrottlingPolicy.Builder 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.

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

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, 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 and Description
static int	MAX_TOKENS_FIELD_NUMBER
static int	TOKEN_RATIO_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 Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static ServiceConfig.RetryThrottlingPolicy	getDefaultInstance()
ServiceConfig.RetryThrottlingPolicy	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
int	getMaxTokens() The number of tokens starts at max_tokens.
com.google.protobuf.Parser<ServiceConfig.RetryThrottlingPolicy>	getParserForType()
int	getSerializedSize()
float	getTokenRatio() The amount of tokens to add on each successful RPC.
com.google.protobuf.UnknownFieldSet	getUnknownFields()
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static ServiceConfig.RetryThrottlingPolicy.Builder	newBuilder()
static ServiceConfig.RetryThrottlingPolicy.Builder	newBuilder(ServiceConfig.RetryThrottlingPolicy prototype)
ServiceConfig.RetryThrottlingPolicy.Builder	newBuilderForType()
protected ServiceConfig.RetryThrottlingPolicy.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static ServiceConfig.RetryThrottlingPolicy	parseDelimitedFrom(InputStream input)
static ServiceConfig.RetryThrottlingPolicy	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ServiceConfig.RetryThrottlingPolicy	parseFrom(byte[] data)
static ServiceConfig.RetryThrottlingPolicy	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ServiceConfig.RetryThrottlingPolicy	parseFrom(ByteBuffer data)
static ServiceConfig.RetryThrottlingPolicy	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ServiceConfig.RetryThrottlingPolicy	parseFrom(com.google.protobuf.ByteString data)
static ServiceConfig.RetryThrottlingPolicy	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ServiceConfig.RetryThrottlingPolicy	parseFrom(com.google.protobuf.CodedInputStream input)
static ServiceConfig.RetryThrottlingPolicy	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ServiceConfig.RetryThrottlingPolicy	parseFrom(InputStream input)
static ServiceConfig.RetryThrottlingPolicy	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<ServiceConfig.RetryThrottlingPolicy>	parser()
ServiceConfig.RetryThrottlingPolicy.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

MAX_TOKENS_FIELD_NUMBER

public static final int MAX_TOKENS_FIELD_NUMBER

See Also:

Constant Field Values

TOKEN_RATIO_FIELD_NUMBER

public static final int TOKEN_RATIO_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getUnknownFields

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

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields 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

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.

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.

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 ServiceConfig.RetryThrottlingPolicy parseFrom(ByteBuffer data)
                                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ServiceConfig.RetryThrottlingPolicy parseFrom(ByteBuffer data,
                                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ServiceConfig.RetryThrottlingPolicy parseFrom(com.google.protobuf.ByteString data)
                                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ServiceConfig.RetryThrottlingPolicy parseFrom(byte[] data)
                                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ServiceConfig.RetryThrottlingPolicy parseFrom(InputStream input)
                                                     throws IOException

Throws:

IOException

parseFrom

public static ServiceConfig.RetryThrottlingPolicy parseFrom(InputStream input,
                                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                     throws IOException

Throws:

IOException

parseDelimitedFrom

public static ServiceConfig.RetryThrottlingPolicy parseDelimitedFrom(InputStream input)
                                                              throws IOException

Throws:

IOException

parseDelimitedFrom

public static ServiceConfig.RetryThrottlingPolicy parseDelimitedFrom(InputStream input,
                                                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                              throws IOException

Throws:

IOException

parseFrom

public static ServiceConfig.RetryThrottlingPolicy parseFrom(com.google.protobuf.CodedInputStream input)
                                                     throws IOException

Throws:

IOException

parseFrom

public static ServiceConfig.RetryThrottlingPolicy parseFrom(com.google.protobuf.CodedInputStream input,
                                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                     throws IOException

Throws:

IOException

newBuilderForType

public ServiceConfig.RetryThrottlingPolicy.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static ServiceConfig.RetryThrottlingPolicy.Builder newBuilder()

newBuilder

public static ServiceConfig.RetryThrottlingPolicy.Builder newBuilder(ServiceConfig.RetryThrottlingPolicy prototype)

toBuilder

public ServiceConfig.RetryThrottlingPolicy.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected ServiceConfig.RetryThrottlingPolicy.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static ServiceConfig.RetryThrottlingPolicy getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<ServiceConfig.RetryThrottlingPolicy> 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 ServiceConfig.RetryThrottlingPolicy getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder