com.google.api.gax.rpc

Class UnaryCallSettings

java.lang.Object

com.google.api.gax.rpc.UnaryCallSettings

Direct Known Subclasses:

UnaryCallSettingsTyped

@BetaApi
public abstract class UnaryCallSettings
extends Object

A base settings class to configure a UnaryCallable. An instance of UnaryCallSettings is not sufficient on its own to construct a UnaryCallable; a concrete derived type is necessary.

This base class includes settings that are applicable to all calls, which currently is just retry settings.

Retry configuration is composed of two parts: the retryable codes, and the retry settings. The retryable codes indicate which codes cause a retry to occur, and the retry settings configure the retry logic when the retry needs to happen. To turn off retries, set the retryable codes needs to be set to the empty set.

UnaryCallSettings contains a concrete builder class, UnaryCallSettings.Builder. This builder class cannot be used to create an instance of UnaryCallSettings, because UnaryCallSettings is an abstract class.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UnaryCallSettings.Builder A base builder class for UnaryCallSettings.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	UnaryCallSettings(Set<StatusCode> retryableCodes, RetrySettings retrySettings)

Method Summary

Modifier and Type	Method and Description
Set<StatusCode>	getRetryableCodes() See the class documentation of UnaryCallSettings for a description of what retryable codes do.
RetrySettings	getRetrySettings() See the class documentation of UnaryCallSettings for a description of what retry settings do.
static UnaryCallSettings.Builder	newUnaryCallSettingsBuilder()
abstract UnaryCallSettings.Builder	toBuilder()

Methods inherited from class java.lang.Object

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

Constructor Detail

UnaryCallSettings

protected UnaryCallSettings(Set<StatusCode> retryableCodes,
                            RetrySettings retrySettings)

Method Detail

getRetryableCodes

public final Set<StatusCode> getRetryableCodes()

See the class documentation of UnaryCallSettings for a description of what retryable codes do.

getRetrySettings

public final RetrySettings getRetrySettings()

See the class documentation of UnaryCallSettings for a description of what retry settings do.

newUnaryCallSettingsBuilder

public static UnaryCallSettings.Builder newUnaryCallSettingsBuilder()

toBuilder

public abstract UnaryCallSettings.Builder toBuilder()