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 | |
|---|---|
| Name | Description |
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 | |
|---|---|
| Type | Description |
Google\Cloud\BigQuery\AnalyticsHub\V1\DestinationDatasetReference|null | |
hasDatasetReference
clearDatasetReference
setDatasetReference
Required. A reference that identifies the destination dataset.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\BigQuery\AnalyticsHub\V1\DestinationDatasetReference
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getFriendlyName
Optional. A descriptive name for the dataset.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\StringValue|null | |
hasFriendlyName
clearFriendlyName
getFriendlyNameValue
Returns the unboxed value from getFriendlyName()
Optional. A descriptive name for the dataset.
| Returns | |
|---|---|
| Type | Description |
string|null | |
setFriendlyName
Optional. A descriptive name for the dataset.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\StringValue
|
| Returns | |
|---|---|
| Type | Description |
$this | |
setFriendlyNameValue
Sets the field by wrapping a primitive type in a Google\Protobuf\StringValue object.
Optional. A descriptive name for the dataset.
| Parameter | |
|---|---|
| Name | Description |
var |
string|null
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDescription
Optional. A user-friendly description of the dataset.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\StringValue|null | |
hasDescription
clearDescription
getDescriptionValue
Returns the unboxed value from getDescription()
Optional. A user-friendly description of the dataset.
| Returns | |
|---|---|
| Type | Description |
string|null | |
setDescription
Optional. A user-friendly description of the dataset.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\StringValue
|
| Returns | |
|---|---|
| Type | Description |
$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 | |
|---|---|
| Name | Description |
var |
string|null
|
| Returns | |
|---|---|
| Type | Description |
$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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getLocation
Required. The geographic location where the dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations.
| Returns | |
|---|---|
| Type | Description |
string | |
setLocation
Required. The geographic location where the dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |