Google Cloud BigQuery Analytics Hub V1 Client - Class DestinationDataset (0.1.6)

Reference documentation and code samples for the Google Cloud BigQuery Analytics Hub V1 Client class DestinationDataset.

Defines the destination bigquery dataset.

Generated from protobuf message google.cloud.bigquery.analyticshub.v1.DestinationDataset

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ dataset_reference Google\Cloud\BigQuery\AnalyticsHub\V1\DestinationDatasetReference

Required. A reference that identifies the destination dataset.

↳ friendly_name Google\Protobuf\StringValue

Optional. A descriptive name for the dataset.

↳ description Google\Protobuf\StringValue

Optional. A user-friendly description of the dataset.

↳ labels array|Google\Protobuf\Internal\MapField

Optional. The labels associated with this dataset. You can use these to organize and group your datasets. You can set this property when inserting or updating a dataset. See https://cloud.google.com/resource-manager/docs/creating-managing-labels for more information.

↳ location string

Required. The geographic location where the dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations.

getDatasetReference

Required. A reference that identifies the destination dataset.

Returns
TypeDescription
Google\Cloud\BigQuery\AnalyticsHub\V1\DestinationDatasetReference|null

hasDatasetReference

clearDatasetReference

setDatasetReference

Required. A reference that identifies the destination dataset.

Parameter
NameDescription
var Google\Cloud\BigQuery\AnalyticsHub\V1\DestinationDatasetReference
Returns
TypeDescription
$this

getFriendlyName

Optional. A descriptive name for the dataset.

Returns
TypeDescription
Google\Protobuf\StringValue|null

hasFriendlyName

clearFriendlyName

getFriendlyNameValue

Returns the unboxed value from getFriendlyName()

Optional. A descriptive name for the dataset.

Returns
TypeDescription
string|null

setFriendlyName

Optional. A descriptive name for the dataset.

Parameter
NameDescription
var Google\Protobuf\StringValue
Returns
TypeDescription
$this

setFriendlyNameValue

Sets the field by wrapping a primitive type in a Google\Protobuf\StringValue object.

Optional. A descriptive name for the dataset.

Parameter
NameDescription
var string|null
Returns
TypeDescription
$this

getDescription

Optional. A user-friendly description of the dataset.

Returns
TypeDescription
Google\Protobuf\StringValue|null

hasDescription

clearDescription

getDescriptionValue

Returns the unboxed value from getDescription()

Optional. A user-friendly description of the dataset.

Returns
TypeDescription
string|null

setDescription

Optional. A user-friendly description of the dataset.

Parameter
NameDescription
var Google\Protobuf\StringValue
Returns
TypeDescription
$this

setDescriptionValue

Sets the field by wrapping a primitive type in a Google\Protobuf\StringValue object.

Optional. A user-friendly description of the dataset.

Parameter
NameDescription
var string|null
Returns
TypeDescription
$this

getLabels

Optional. The labels associated with this dataset. You can use these to organize and group your datasets.

You can set this property when inserting or updating a dataset. See https://cloud.google.com/resource-manager/docs/creating-managing-labels for more information.

Returns
TypeDescription
Google\Protobuf\Internal\MapField

setLabels

Optional. The labels associated with this dataset. You can use these to organize and group your datasets.

You can set this property when inserting or updating a dataset. See https://cloud.google.com/resource-manager/docs/creating-managing-labels for more information.

Parameter
NameDescription
var array|Google\Protobuf\Internal\MapField
Returns
TypeDescription
$this

getLocation

Required. The geographic location where the dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations.

Returns
TypeDescription
string

setLocation

Required. The geographic location where the dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations.

Parameter
NameDescription
var string
Returns
TypeDescription
$this