Class PagedCallSettings.Builder<RequestT,ResponseT,PagedListResponseT> (2.71.0)

Version latest

• 2.71.0 (latest)
• 2.70.3
• 2.69.0
• 2.68.2
• 2.67.0
• 2.66.0
• 2.65.0
• 2.63.1
• 2.62.0
• 2.61.0
• 2.60.0
• 2.59.1
• 2.58.0
• 2.57.0
• 2.55.0
• 2.54.1
• 2.53.0
• 2.52.0
• 2.51.0
• 2.50.0
• 2.49.0
• 2.48.1
• 2.47.0
• 2.46.1
• 2.45.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.39.0
• 2.38.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.1
• 2.33.0
• 2.32.1
• 2.31.1
• 2.30.1
• 2.24.0
• 2.23.3
• 2.22.0
• 2.21.0
• 2.20.1
• 2.19.6
• 2.18.7
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.2
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.1
• 2.7.1

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

Inheritance

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

Inherited Members

UnaryCallSettings.Builder.build()

UnaryCallSettings.Builder.getRetrySettings()

UnaryCallSettings.Builder.getRetryableCodes()

UnaryCallSettings.Builder.retrySettings()

UnaryCallSettings.Builder.setRetrySettings(RetrySettings)

UnaryCallSettings.Builder.setRetryableCodes(StatusCode.Code)

UnaryCallSettings.Builder.setRetryableCodes(Set<StatusCode.Code>)

UnaryCallSettings.Builder.setSimpleTimeoutNoRetries(Duration)

UnaryCallSettings.Builder.setSimpleTimeoutNoRetriesDuration(Duration)

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
PagedListResponseT

Constructors

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

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

Parameter
Name	Description
settings	PagedCallSettings<RequestT,ResponseT,PagedListResponseT>

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

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

Parameter
Name	Description
pagedListResponseFactory	PagedListResponseFactory<RequestT,ResponseT,PagedListResponseT>

Methods

build()

public PagedCallSettings<RequestT,ResponseT,PagedListResponseT> 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
PagedCallSettings<RequestT,ResponseT,PagedListResponseT>

Overrides

UnaryCallSettings.Builder<RequestT,ResponseT>.build()

getPagedListResponseFactory()

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

Returns
Type	Description
PagedListResponseFactory<RequestT,ResponseT,PagedListResponseT>

setRetrySettings(RetrySettings retrySettings)

public PagedCallSettings.Builder<RequestT,ResponseT,PagedListResponseT> 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,PagedListResponseT>

Overrides

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

setRetryableCodes(StatusCode.Code[] codes)

public PagedCallSettings.Builder<RequestT,ResponseT,PagedListResponseT> 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,PagedListResponseT>

Overrides

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

setRetryableCodes(Set<StatusCode.Code> retryableCodes)

public PagedCallSettings.Builder<RequestT,ResponseT,PagedListResponseT> 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,PagedListResponseT>

Overrides

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