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
BigQueryWriteClient::writeStreamName() for help formatting this field.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google BigQuery Storage V1 Client - Class GetWriteStreamRequest (2.1.5)\n\nVersion latestkeyboard_arrow_down\n\n- [2.1.5 (latest)](/php/docs/reference/cloud-bigquery-storage/latest/V1.GetWriteStreamRequest)\n- [2.1.4](/php/docs/reference/cloud-bigquery-storage/2.1.4/V1.GetWriteStreamRequest)\n- [2.0.0](/php/docs/reference/cloud-bigquery-storage/2.0.0/V1.GetWriteStreamRequest)\n- [1.10.4](/php/docs/reference/cloud-bigquery-storage/1.10.4/V1.GetWriteStreamRequest)\n- [1.9.0](/php/docs/reference/cloud-bigquery-storage/1.9.0/V1.GetWriteStreamRequest)\n- [1.8.0](/php/docs/reference/cloud-bigquery-storage/1.8.0/V1.GetWriteStreamRequest)\n- [1.7.1](/php/docs/reference/cloud-bigquery-storage/1.7.1/V1.GetWriteStreamRequest)\n- [1.6.0](/php/docs/reference/cloud-bigquery-storage/1.6.0/V1.GetWriteStreamRequest)\n- [1.5.0](/php/docs/reference/cloud-bigquery-storage/1.5.0/V1.GetWriteStreamRequest)\n- [1.4.1](/php/docs/reference/cloud-bigquery-storage/1.4.1/V1.GetWriteStreamRequest)\n- [1.3.2](/php/docs/reference/cloud-bigquery-storage/1.3.2/V1.GetWriteStreamRequest)\n- [1.2.12](/php/docs/reference/cloud-bigquery-storage/1.2.12/V1.GetWriteStreamRequest) \nReference documentation and code samples for the Google BigQuery Storage V1 Client class GetWriteStreamRequest.\n\nRequest message for `GetWriteStreamRequest`.\n\nGenerated from protobuf message `google.cloud.bigquery.storage.v1.GetWriteStreamRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ BigQuery \\\\ Storage \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getName\n\nRequired. Name of the stream to get, in the form of\n`projects/{project}/datasets/{dataset}/tables/{table}/streams/{stream}`.\n\n### setName\n\nRequired. Name of the stream to get, in the form of\n`projects/{project}/datasets/{dataset}/tables/{table}/streams/{stream}`.\n\n### getView\n\nIndicates whether to get full or partial view of the WriteStream. If\nnot set, view returned will be basic.\n\n### setView\n\nIndicates whether to get full or partial view of the WriteStream. If\nnot set, view returned will be basic.\n\n### static::build"]]
