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

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

Inheritance

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

Type Parameters
Name Description
RequestT
ResponseT

Methods

build()

public ServerStreamingCallSettings<RequestT,ResponseT> build()
Returns
Type Description
ServerStreamingCallSettings<RequestT,ResponseT>
Overrides

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

See Also: #retrySettings()

Parameter
Name Description
retrySettings RetrySettings
Returns
Type Description
Builder<RequestT,ResponseT>

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)

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

Parameter
Name Description
retryableCodes Set<Code>
Returns
Type Description
Builder<RequestT,ResponseT>

setSimpleTimeoutNoRetries(Duration timeout)

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

Disables retries and sets the overall timeout.

Parameter
Name Description
timeout org.threeten.bp.Duration
Returns
Type Description
Builder<RequestT,ResponseT>

setWaitTimeout(Duration waitTimeout)

public ServerStreamingCallSettings.Builder<RequestT,ResponseT> setWaitTimeout(Duration waitTimeout)

Set the maximum amount of time to wait for the next message from the server. Duration#ZERO disables the check for abandoned streams.

Parameter
Name Description
waitTimeout org.threeten.bp.Duration
Returns
Type Description
Builder<RequestT,ResponseT>