com.google.api.gax.rpc

Class PagedCallSettings.Builder<RequestT,ResponseT,PagedListResponseT>

java.lang.Object

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

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

Enclosing class:

PagedCallSettings<RequestT,ResponseT,PagedListResponseT>

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

Constructor Summary

Constructors

Constructor and Description
Builder(PagedCallSettings<RequestT,ResponseT,PagedListResponseT> settings)
Builder(PagedListResponseFactory<RequestT,ResponseT,PagedListResponseT> pagedListResponseFactory)

Method Summary

Modifier and Type	Method and Description
PagedCallSettings<RequestT,ResponseT,PagedListResponseT>	build() Builds an instance of the containing class.
PagedListResponseFactory<RequestT,ResponseT,PagedListResponseT>	getPagedListResponseFactory()
PagedCallSettings.Builder<RequestT,ResponseT,PagedListResponseT>	setRetryableCodes(Set<StatusCode.Code> retryableCodes) See the class documentation of UnaryCallSettings for a description of what retryable codes do.
PagedCallSettings.Builder<RequestT,ResponseT,PagedListResponseT>	setRetryableCodes(StatusCode.Code... codes) See the class documentation of UnaryCallSettings for a description of what retryable codes do.
PagedCallSettings.Builder<RequestT,ResponseT,PagedListResponseT>	setRetrySettings(RetrySettings retrySettings) Replaces the RetrySettings for the associated UnaryCallable.

Methods inherited from class com.google.api.gax.rpc.UnaryCallSettings.Builder

getRetryableCodes, getRetrySettings, retrySettings, setSimpleTimeoutNoRetries

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(PagedListResponseFactory<RequestT,ResponseT,PagedListResponseT> pagedListResponseFactory)

Builder

public Builder(PagedCallSettings<RequestT,ResponseT,PagedListResponseT> settings)

Method Detail

setRetryableCodes

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

Description copied from class: UnaryCallSettings.Builder

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

Overrides:

setRetryableCodes in class UnaryCallSettings.Builder<RequestT,ResponseT>

setRetryableCodes

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

Description copied from class: UnaryCallSettings.Builder

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

Overrides:

setRetryableCodes in class UnaryCallSettings.Builder<RequestT,ResponseT>

setRetrySettings

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

Description copied from class: UnaryCallSettings.Builder

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

Overrides:

setRetrySettings in class UnaryCallSettings.Builder<RequestT,ResponseT>

See Also:

UnaryCallSettings.Builder.retrySettings()

getPagedListResponseFactory

public PagedListResponseFactory<RequestT,ResponseT,PagedListResponseT> getPagedListResponseFactory()

build

public PagedCallSettings<RequestT,ResponseT,PagedListResponseT> build()

Description copied from class: UnaryCallSettings.Builder

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

Overrides:

build in class UnaryCallSettings.Builder<RequestT,ResponseT>