Google BigQuery Storage V1 Client - Class GetWriteStreamRequest (1.6.0)

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
NameDescription
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
TypeDescription
string

setName

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getView

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

Returns
TypeDescription
int

setView

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

Parameter
NameDescription
var int
Returns
TypeDescription
$this

static::build

Parameter
NameDescription
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
TypeDescription
Google\Cloud\BigQuery\Storage\V1\GetWriteStreamRequest