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

Version 2.51.0

• 2.55.0 (latest)
• 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 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()

Obsolete

Use getIdleTimeoutDuration() instead

This feature is stable for usage in this major version, but may be deprecated in a future release.

This method is obsolete. Use #getIdleTimeoutDuration() instead.

Returns
Type	Description
org.threeten.bp.Duration

getIdleTimeoutDuration()

public Duration getIdleTimeoutDuration()

Returns
Type	Description
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()

Obsolete

Use getWaitTimeoutDuration() instead

This feature is stable for usage in this major version, but may be deprecated in a future release.

This method is obsolete. Use #getWaitTimeoutDuration() instead.

Returns
Type	Description
org.threeten.bp.Duration

getWaitTimeoutDuration()

public Duration getWaitTimeoutDuration()

Returns
Type	Description
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)

Obsolete

Use setIdleTimeoutDuration(java.time.Duration) instead

This feature is stable for usage in this major version, but may be deprecated in a future release.

This method is obsolete. Use #setIdleTimeoutDuration(Duration) instead.

Parameter
Name	Description
idleTimeout	org.threeten.bp.Duration

Returns
Type	Description
Builder<RequestT,ResponseT>

setIdleTimeoutDuration(Duration idleTimeout)

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

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

Parameter
Name	Description
idleTimeout	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)

Obsolete

Use setSimpleTimeoutNoRetriesDuration(java.time.Duration) instead

This feature is stable for usage in this major version, but may be deprecated in a future release.

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

Parameter
Name	Description
timeout	org.threeten.bp.Duration

Returns
Type	Description
Builder<RequestT,ResponseT>

setSimpleTimeoutNoRetriesDuration(Duration timeout)

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

Disables retries and sets the overall timeout.

Parameter
Name	Description
timeout	Duration

Returns
Type	Description
Builder<RequestT,ResponseT>

setWaitTimeout(Duration waitTimeout)

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

Obsolete

Use setWaitTimeoutDuration(java.time.Duration) instead

This feature is stable for usage in this major version, but may be deprecated in a future release.

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

Parameter
Name	Description
waitTimeout	org.threeten.bp.Duration

Returns
Type	Description
Builder<RequestT,ResponseT>

setWaitTimeoutDuration(Duration waitTimeout)

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

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

Parameter
Name	Description
waitTimeout	Duration

Returns
Type	Description
Builder<RequestT,ResponseT>