Send feedback
Class ServerStreamingCallSettings.Builder<RequestT,ResponseT> (2.63.1)
bookmark_border bookmark
Stay organized with collections
Save and categorize content based on your preferences.
Version latest keyboard_arrow_down
public static class ServerStreamingCallSettings . Builder<RequestT , ResponseT > extends StreamingCallSettings . Builder<RequestT , ResponseT >
Inherited Members
Type Parameters
Name Description
RequestT
ResponseT
Methods
build()
public ServerStreamingCallSettings<RequestT , ResponseT > build ()
Overrides
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 ()
getResumptionStrategy()
public StreamResumptionStrategy<RequestT , ResponseT > getResumptionStrategy ()
getRetrySettings()
public RetrySettings getRetrySettings ()
getRetryableCodes()
public Set<StatusCode . Code > getRetryableCodes ()
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 ()
retrySettings()
public RetrySettings . Builder retrySettings ()
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
idleTimeoutorg.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
idleTimeoutDuration
Returns
Type Description
Builder <RequestT ,ResponseT >
setResumptionStrategy(StreamResumptionStrategy<RequestT,ResponseT> resumptionStrategy)
public ServerStreamingCallSettings . Builder<RequestT , ResponseT > setResumptionStrategy ( StreamResumptionStrategy<RequestT , ResponseT > resumptionStrategy )
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()
Returns
Type Description
Builder <RequestT ,ResponseT >
setRetryableCodes(StatusCode.Code[] codes)
public ServerStreamingCallSettings . Builder<RequestT , ResponseT > setRetryableCodes ( StatusCode . Code [] codes )
Parameter
Name Description
codesCode []
Returns
Type Description
Builder <RequestT ,ResponseT >
setRetryableCodes(Set<StatusCode.Code> retryableCodes)
public ServerStreamingCallSettings . Builder<RequestT , ResponseT > setRetryableCodes ( Set<StatusCode . Code > retryableCodes )
Parameter
Name Description
retryableCodesSet <Code >
Returns
Type Description
Builder <RequestT ,ResponseT >
setSimpleTimeoutNoRetries(Duration timeout)
public ServerStreamingCallSettings . Builder<RequestT , ResponseT > setSimpleTimeoutNoRetries ( Duration timeout )
Parameter
Name Description
timeoutorg.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
timeoutDuration
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
waitTimeoutorg.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
waitTimeoutDuration
Returns
Type Description
Builder <RequestT ,ResponseT >
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-03-21 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-03-21 UTC."],[[["This page provides documentation for the `ServerStreamingCallSettings.Builder` class, which is part of the Google API Client Libraries for Java (gax)."],["The latest version of `ServerStreamingCallSettings.Builder` is 2.63.1, with a comprehensive list of previous versions available for reference."],["`ServerStreamingCallSettings.Builder` extends `StreamingCallSettings.Builder` and inherits its members, allowing for building configurations for server-streaming RPC calls."],["Key functionalities include setting timeouts, defining retry behavior, and configuring stream resumption strategies, with most options having an alternative to support `java.time.Duration`."],["The `build()` method is used to finalize the `ServerStreamingCallSettings` configuration, and there are methods available for direct manipulation of the underlying `RetrySettings`."]]],[]]
