Class ServerStreamingCallSettings.Builder<RequestT,ResponseT> (2.48.0)

public static class ServerStreamingCallSettings.Builder<RequestT,ResponseT> extends StreamingCallSettings.Builder<RequestT,ResponseT>

Inheritance

java.lang.Object > StreamingCallSettings.Builder > ServerStreamingCallSettings.Builder<RequestT,ResponseT>

Inherited Members

StreamingCallSettings.Builder.build()

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`

Methods

build()

public ServerStreamingCallSettings<RequestT,ResponseT> build()

Returns
Type	Description
`ServerStreamingCallSettings<RequestT,ResponseT>`

Overrides

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

getIdleTimeout()

public Duration getIdleTimeout()

Returns
Type	Description
`org.threeten.bp.Duration`

getResumptionStrategy()

public StreamResumptionStrategy<RequestT,ResponseT> getResumptionStrategy()

Returns
Type	Description
`StreamResumptionStrategy<RequestT,ResponseT>`

getRetrySettings()

public RetrySettings getRetrySettings()

Returns
Type	Description
`RetrySettings`

getRetryableCodes()

public Set<StatusCode.Code> getRetryableCodes()

Returns
Type	Description
`Set<Code>`

getWaitTimeout()

public Duration getWaitTimeout()

Returns
Type	Description
`org.threeten.bp.Duration`

retrySettings()

public RetrySettings.Builder retrySettings()

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

Returns
Type	Description
`RetrySettings.Builder`

setIdleTimeout(Duration idleTimeout)

public ServerStreamingCallSettings.Builder<RequestT,ResponseT> setIdleTimeout(Duration idleTimeout)

Set how long to wait before considering the stream orphaned by the user and closing it. Duration#ZERO disables the check for abandoned streams.

Parameter
Name	Description
`idleTimeout`	`org.threeten.bp.Duration`

Returns
Type	Description
`Builder<RequestT,ResponseT>`

setResumptionStrategy(StreamResumptionStrategy<RequestT,ResponseT> resumptionStrategy)

public ServerStreamingCallSettings.Builder<RequestT,ResponseT> setResumptionStrategy(StreamResumptionStrategy<RequestT,ResponseT> resumptionStrategy)

See the class documentation of ServerStreamingCallSettings for a description of what StreamResumptionStrategy does.

Parameter
Name	Description
`resumptionStrategy`	`StreamResumptionStrategy<RequestT,ResponseT>`

Returns
Type	Description
`Builder<RequestT,ResponseT>`

setRetrySettings(RetrySettings retrySettings)

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

Replaces the RetrySettings for the associated ServerStreamingCallable.

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

setRetryableCodes(StatusCode.Code[] codes)

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

See the class documentation of ServerStreamingCallSettings for a description of what retryableCodes do.

Parameter
Name	Description
`codes`	`Code[]`

Returns
Type	Description
`Builder<RequestT,ResponseT>`

setRetryableCodes(Set<StatusCode.Code> retryableCodes)

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