Cloud Bigtable Client - Class ResumableStream (1.25.0)

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.

Namespace

Google \ Cloud \ Bigtable

Methods

__construct

Constructs a resumable stream.

Parameters
NameDescription
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
TypeDescription
Generator

getIterator

Returns
TypeDescription
Generator

static::isRetryable

Checks if code is retryable or not.

Parameter
NameDescription
code int

Code to check.

Returns
TypeDescription
bool

Constants

DEFAULT_MAX_RETRIES

Value: 3