Package com.google.api.gax.rpc

Class UnaryCallSettings.Builder<RequestT,ResponseT>

java.lang.Object

com.google.api.gax.rpc.UnaryCallSettings.Builder<RequestT,ResponseT>

Direct Known Subclasses:

BatchingCallSettings.Builder, BatchingCallSettings.Builder, PagedCallSettings.Builder

Enclosing class:

UnaryCallSettings<RequestT,ResponseT>

public static class UnaryCallSettings.Builder<RequestT,ResponseT>
extends Object

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.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder()
protected	Builder(UnaryCallSettings<RequestT,ResponseT> unaryCallSettings)

Method Summary

Modifier and Type	Method	Description
UnaryCallSettings<RequestT,ResponseT>	build()	Builds an instance of the containing class.
Set<StatusCode.Code>	getRetryableCodes()	See the class documentation of UnaryCallSettings for a description of what retryable codes do.
RetrySettings	getRetrySettings()	Returns an immutable RetrySettings currently set in this Builder.
RetrySettings.Builder	retrySettings()	Returns the underlying RetrySettings.Builder, which allows callers to augment the existing RetrySettings.
UnaryCallSettings.Builder<RequestT,ResponseT>	setRetryableCodes(StatusCode.Code... codes)	See the class documentation of UnaryCallSettings for a description of what retryable codes do.
UnaryCallSettings.Builder<RequestT,ResponseT>	setRetryableCodes(Set<StatusCode.Code> retryableCodes)	See the class documentation of UnaryCallSettings for a description of what retryable codes do.
UnaryCallSettings.Builder<RequestT,ResponseT>	setRetrySettings(RetrySettings retrySettings)	Replaces the RetrySettings for the associated UnaryCallable.
UnaryCallSettings.Builder<RequestT,ResponseT>	setSimpleTimeoutNoRetries(org.threeten.bp.Duration timeout)	This method is obsolete.
UnaryCallSettings.Builder<RequestT,ResponseT>	setSimpleTimeoutNoRetriesDuration(Duration timeout)	Disables retries and sets the RPC timeout.

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

protected Builder()

Builder

protected Builder(UnaryCallSettings<RequestT,ResponseT> unaryCallSettings)

Method Details

setRetryableCodes

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

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

setRetryableCodes

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

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

retrySettings

public RetrySettings.Builder retrySettings()

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

setRetrySettings

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)
 );
 

See Also:

• retrySettings()

setSimpleTimeoutNoRetries

@ObsoleteApi("Use setSimpleTimeoutNoRetriesDuration(java.time.Duration) instead")
public UnaryCallSettings.Builder<RequestT,ResponseT> setSimpleTimeoutNoRetries(org.threeten.bp.Duration timeout)

This method is obsolete. Use setSimpleTimeoutNoRetriesDuration(java.time.Duration) instead.

setSimpleTimeoutNoRetriesDuration

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

Disables retries and sets the RPC timeout.

getRetryableCodes

public Set<StatusCode.Code> getRetryableCodes()

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

getRetrySettings

public RetrySettings getRetrySettings()

Returns an immutable RetrySettings currently set in this Builder.

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

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.