Skip to content

[Bigtable] Documented defaults timeout values in the EnhancedBigtableStubSettings #5126

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
igorbernstein2 merged 5 commits into from
Jun 19, 2019
Merged

[Bigtable] Documented defaults timeout values in the EnhancedBigtableStubSettings #5126

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
00a69c7
Documented defaults timeout values in the Bigtable Settings
rahulKQL May 7, 2019
bdd4421
javadoc fix
rahulKQL May 8, 2019
6ca6923
Addressing feedback comments
rahulKQL May 31, 2019
d62e034
Updated Javadoc according to feedback
rahulKQL Jun 13, 2019
c467bea
addressing feedback comments
rahulKQL Jun 18, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
144 changes: 138 additions & 6 deletions ...le/src/main/java/com/google/cloud/bigtable/data/v2/stub/EnhancedBigtableStubSettings.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -185,22 +185,100 @@ public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilde
.setJwtEnabledScopes(JWT_ENABLED_SCOPES);
}

/** Returns the object with the settings used for calls to ReadRows. */
/**
* Returns the object with the settings used for calls to ReadRows.
*
* <p>This is idempotent and streaming operation.
*
* <p>Default retry and timeout settings:
*
* <ul>
* <li>{@link ServerStreamingCallSettings.Builder#setIdleTimeout Default idle timeout} is set to
* 5 mins.
* <li>Retry {@link ServerStreamingCallSettings.Builder#setRetryableCodes error codes} are:
* {@link Code#DEADLINE_EXCEEDED} and {@link Code#UNAVAILABLE}.
* <li>RetryDelay between failed attempts {@link RetrySettings.Builder#setInitialRetryDelay
* starts} at 100ms and {@link RetrySettings.Builder#setRetryDelayMultiplier increases
* exponentially} by a factor of 1.3 until a {@link RetrySettings.Builder#setMaxRetryDelay
* maximum of} 60 seconds.
* <li>The default read timeout for {@link RetrySettings.Builder#setMaxRpcTimeout each row} in a
* response stream is 20 seconds and the timeout to read the {@link
* RetrySettings.Builder#setTotalTimeout entire stream} is 1 hour.
* </ul>
*/
public ServerStreamingCallSettings<Query, Row> readRowsSettings() {
return readRowsSettings;
}

/** Returns the object with the settings used for calls to SampleRowKeys. */
/**
* Returns the object with the settings used for calls to SampleRowKeys.
*
* <p>This is idempotent and non-streaming operation.
*
* <p>Default retry and timeout settings:
*
* <ul>
* <li>Retry {@link UnaryCallSettings.Builder#setRetryableCodes error codes} are: {@link
* Code#DEADLINE_EXCEEDED} and {@link Code#UNAVAILABLE}.
* <li>RetryDelay between failed attempts {@link RetrySettings.Builder#setInitialRetryDelay
* starts} at 100ms and {@link RetrySettings.Builder#setRetryDelayMultiplier increases
* exponentially} by a factor of 1.3 until a {@link RetrySettings.Builder#setMaxRetryDelay
* maximum of} 60 seconds.
* <li>The default timeout for {@link RetrySettings.Builder#setMaxRpcTimeout each attempt} is 20
* seconds and the timeout for the {@link RetrySettings.Builder#setTotalTimeout entire
* operation} across all of the attempts is 10 mins.
* </ul>
*/
public UnaryCallSettings<String, List<KeyOffset>> sampleRowKeysSettings() {
return sampleRowKeysSettings;
}

/** Returns the object with the settings used for point reads via ReadRows. */
/**
* Returns the object with the settings used for point reads via ReadRows.
*
* <p>This is an idempotent and non-streaming operation.
*
* <p>Default retry and timeout settings:
*
* <ul>
* <li>Retry {@link UnaryCallSettings.Builder#setRetryableCodes error codes} are: {@link
* Code#DEADLINE_EXCEEDED} and {@link Code#UNAVAILABLE}.
* <li>RetryDelay between failed attempts {@link RetrySettings.Builder#setInitialRetryDelay
* starts} at 100ms and {@link RetrySettings.Builder#setRetryDelayMultiplier increases
* exponentially} by a factor of 1.3 until a {@link RetrySettings.Builder#setMaxRetryDelay
* maximum of} 60 seconds.
* <li>The default timeout for {@link RetrySettings.Builder#setMaxRpcTimeout each attempt} is 20
* seconds and the timeout for the {@link RetrySettings.Builder#setTotalTimeout entire
* operation} across all of the attempts is 10 mins.
* </ul>
*
* @see RetrySettings for more explanation.
*/
public UnaryCallSettings<Query, Row> readRowSettings() {
return readRowSettings;
}

/** Returns the object with the settings used for calls to MutateRow. */
/**
* Returns the object with the settings used for calls to MutateRow.
*
* <p>This is an idempotent and non-streaming operation.
*
* <p>Default retry and timeout settings:
*
* <ul>
* <li>Retry {@link UnaryCallSettings.Builder#setRetryableCodes error codes} are: {@link
* Code#DEADLINE_EXCEEDED} and {@link Code#UNAVAILABLE}.
* <li>RetryDelay between failed attempts {@link RetrySettings.Builder#setInitialRetryDelay
* starts} at 100ms and {@link RetrySettings.Builder#setRetryDelayMultiplier increases
* exponentially} by a factor of 1.3 until a {@link RetrySettings.Builder#setMaxRetryDelay
* maximum of} 60 seconds.
* <li>The default timeout for {@link RetrySettings.Builder#setMaxRpcTimeout each attempt} is 20
* seconds and the timeout for the {@link RetrySettings.Builder#setTotalTimeout entire
* operation} across all of the attempts is 10 mins.
* </ul>
*
* @see RetrySettings for more explanation.
*/
public UnaryCallSettings<RowMutation, Void> mutateRowSettings() {
return mutateRowSettings;
}
Expand All @@ -211,17 +289,71 @@ public UnaryCallSettings<RowMutation, Void> mutateRowSettings() {
* <p>Please note that these settings will affect both manually batched calls
* (bulkMutateRowsCallable) and automatic batched calls (bulkMutateRowsBatchingCallable). The
* {@link RowMutation} request signature is ignored for the manual batched calls.
*
* <p>Default retry and timeout settings:
*
* <ul>
* <li>Retry {@link UnaryCallSettings.Builder#setRetryableCodes error codes} are: {@link
* Code#DEADLINE_EXCEEDED}, {@link Code#UNAVAILABLE} and {@link Code#ABORTED}.
* <li>RetryDelay between failed attempts {@link RetrySettings.Builder#setInitialRetryDelay
* starts} at 100ms and {@link RetrySettings.Builder#setRetryDelayMultiplier increases
* exponentially} by a factor of 1.3 until a {@link RetrySettings.Builder#setMaxRetryDelay
* maximum of} 60 seconds.
* <li>The default timeout for {@link RetrySettings.Builder#setMaxRpcTimeout each attempt} is 20
* seconds and the timeout for the {@link RetrySettings.Builder#setTotalTimeout entire
* operation} across all of the attempts is 10 mins.
* </ul>
*
* <p>On breach of certain triggers, the operation initiates processing of accumulated request for
* which the default settings are:
*
* <ul>
* <li>When the {@link BatchingSettings.Builder#setElementCountThreshold request count} reaches
* 100.
* <li>When accumulated {@link BatchingSettings.Builder#setRequestByteThreshold request size}
* reaches to 20MB.
* <li>When an {@link BatchingSettings.Builder#setDelayThreshold interval of} 1 second passes
* after batching initialization or last processed batch.
* </ul>
*
* <p>When the pending {@link FlowControlSettings.Builder#setMaxOutstandingElementCount request
* count} reaches a default of 1000 or their {@link
* FlowControlSettings.Builder#setMaxOutstandingRequestBytes accumulated size} reaches default
* value of 100MB, then this operation will by default be {@link
* FlowControlSettings.Builder#setLimitExceededBehavior blocked} until some of the pending batch
* are resolved.
*
* @see RetrySettings for more explanation.
* @see BatchingSettings for batch related configuration explanation.
*/
public BatchingCallSettings<RowMutation, Void> bulkMutateRowsSettings() {
return bulkMutateRowsSettings;
}

/** Returns the object with the settings used for calls to CheckAndMutateRow. */
/**
* Returns the object with the settings used for calls to CheckAndMutateRow.
*
* <p>This is a non-idempotent and non-streaming operation.
*
* <p>By default this operation does not reattempt in case of RPC failure. The default timeout for
* the {@link RetrySettings.Builder#setTotalTimeout entire operation} is 10 mins.
*
* @see RetrySettings for more explanation.
*/
public UnaryCallSettings<ConditionalRowMutation, Boolean> checkAndMutateRowSettings() {
return checkAndMutateRowSettings;
}

/** Returns the object with the settings used for calls to ReadModifyWriteRow. */
/**
* Returns the object with the settings used for calls to ReadModifyWriteRow.
*
* <p>This is a non-idempotent and non-streaming operation.
*
* <p>By default this operation does not reattempt in case of RPC failure. The default timeout for
* the {@link RetrySettings.Builder#setTotalTimeout entire operation} is 10 mins.
*
* @see RetrySettings for more explanation.
*/
public UnaryCallSettings<ReadModifyWriteRow, Row> readModifyWriteRowSettings() {
return readModifyWriteRowSettings;
}
Expand Down