Google BigQuery Storage V1 Client - Class GetWriteStreamRequest (1.10.2)

Reference documentation and code samples for the Google BigQuery Storage V1 Client class GetWriteStreamRequest.

Request message for GetWriteStreamRequest.

Generated from protobuf message google.cloud.bigquery.storage.v1.GetWriteStreamRequest

Namespace

Google \ Cloud \ BigQuery \ Storage \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ name string

Required. Name of the stream to get, in the form of projects/{project}/datasets/{dataset}/tables/{table}/streams/{stream}.
↳ view int

Indicates whether to get full or partial view of the WriteStream. If not set, view returned will be basic.

getName

Required. Name of the stream to get, in the form of projects/{project}/datasets/{dataset}/tables/{table}/streams/{stream}.

Returns
Type Description
string

setName

Required. Name of the stream to get, in the form of projects/{project}/datasets/{dataset}/tables/{table}/streams/{stream}.

Parameter
Name Description
var string
Returns
Type Description
$this

getView

Indicates whether to get full or partial view of the WriteStream. If not set, view returned will be basic.

Returns
Type Description
int

setView

Indicates whether to get full or partial view of the WriteStream. If not set, view returned will be basic.

Parameter
Name Description
var int
Returns
Type Description
$this

static::build

Parameter
Name Description
name string

Required. Name of the stream to get, in the form of projects/{project}/datasets/{dataset}/tables/{table}/streams/{stream}. Please see Google\Cloud\BigQuery\Storage\V1\BigQueryWriteClient::writeStreamName() for help formatting this field.
Returns
Type Description
Google\Cloud\BigQuery\Storage\V1\GetWriteStreamRequest