Class UnaryCallSettings.Builder<RequestT,ResponseT> (2.7.1)

public static class UnaryCallSettings.Builder<RequestT,ResponseT>

A base builder class for UnaryCallSettings. This class should not be used to create an instance of the base class UnaryCallSettings. See the class documentation of UnaryCallSettings for a description of the different values that can be set, and for a description of when this builder may be used. Builders for concrete derived classes can be used to create instances of those classes.

Inheritance

java.lang.Object > UnaryCallSettings.Builder<RequestT,ResponseT>

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Type Parameters

Name	Description
RequestT
ResponseT

Constructors

Builder()

protected Builder()

Builder(UnaryCallSettings<RequestT,ResponseT> unaryCallSettings)

protected Builder(UnaryCallSettings<RequestT,ResponseT> unaryCallSettings)

Parameter

Name	Description
unaryCallSettings	`UnaryCallSettings<RequestT,ResponseT>`

Methods

build()

public UnaryCallSettings<RequestT,ResponseT> build()

Builds an instance of the containing class. This operation is unsupported on the abstract base class UnaryCallSettings, but is valid on concrete derived classes.

Returns

Type	Description
UnaryCallSettings<RequestT,ResponseT>

getRetrySettings()

public RetrySettings getRetrySettings()

Returns an immutable RetrySettings currently set in this Builder.

Unlike #retrySettings(), objects returned by this method are frozen in time.

Returns

Type	Description
RetrySettings

getRetryableCodes()

public Set<StatusCode.Code> getRetryableCodes()

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

Returns

Type	Description
Set<Code>

retrySettings()

public RetrySettings.Builder retrySettings()

Returns the underlying RetrySettings.Builder, which allows callers to augment the existing RetrySettings.

Returns

Type	Description
RetrySettings.Builder

setRetrySettings(RetrySettings retrySettings)

public UnaryCallSettings.Builder<RequestT,ResponseT> setRetrySettings(RetrySettings retrySettings)

Replaces the RetrySettings for the associated UnaryCallable.

When using the method, make sure that the RetrySettings are complete. For example, the following code will disable retries because the retry delay is not set:


 stubSettings.setRetrySettings(
   RetrySettings.newBuilder()
     .setTotalTimeout(Duration.ofSeconds(10)
 );

Parameter

Name	Description
retrySettings	`RetrySettings`

Returns

Type	Description
Builder<RequestT,ResponseT>

setRetryableCodes(StatusCode.Code[] codes)

public UnaryCallSettings.Builder<RequestT,ResponseT> setRetryableCodes(StatusCode.Code[] codes)

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

Parameter

Name	Description
codes	`Code[]`

Returns

Type	Description
Builder<RequestT,ResponseT>

setRetryableCodes(Set<StatusCode.Code> retryableCodes)

public UnaryCallSettings.Builder<RequestT,ResponseT> setRetryableCodes(Set<StatusCode.Code> retryableCodes)

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

Parameter

Name	Description
retryableCodes	`Set<Code>`

Returns

Type	Description
Builder<RequestT,ResponseT>

setSimpleTimeoutNoRetries(Duration timeout)

public UnaryCallSettings.Builder<RequestT,ResponseT> setSimpleTimeoutNoRetries(Duration timeout)

Disables retries and sets the RPC timeout.

Parameter

Name	Description
timeout	`org.threeten.bp.Duration`

Returns

Type	Description
Builder<RequestT,ResponseT>