Cloud Bigtable Client - Class ResumableStream (1.21.1)

Version 1.21.1

• 1.32.1 (latest)
• 1.32.0
• 1.31.1
• 1.30.0
• 1.29.2
• 1.28.3
• 1.27.0
• 1.26.2
• 1.25.0
• 1.24.1
• 1.23.0
• 1.22.2
• 1.21.1
• 1.20.3

Reference documentation and code samples for the Cloud Bigtable Client class ResumableStream.

User stream which handles failure from upstream, retries if necessary and provides single retrying user stream.

Methods

__construct

Constructs a resumable stream.

Parameters
Name	Description
apiFunction	callable Function to execute to get server stream. Function signature should match: function (...) : Google\ApiCore\ServerStream.
argumentFunction	callable Function which returns the argument to be used while calling $apiFunction.
retryFunction	callable Function which determines whether to retry or not.
retries	int [optional] Number of times to retry. Defaults to 3.

readAll

Starts executing the call and reading elements from server stream.

Returns
Type	Description
Generator

getIterator

Returns
Type	Description
Generator

isRetryable

Checks if code is retryable or not.

Parameter
Name	Description
code	int Code to check.

Returns
Type	Description
bool

Constants

DEFAULT_MAX_RETRIES

Value: 3