Google Cloud BigQuery Analytics Hub V1 Client - Class BigQueryDatasetSource (1.3.0)

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

A reference to a shared dataset. It is an existing BigQuery dataset with a collection of objects such as tables and views that you want to share with subscribers.

When subscriber's subscribe to a listing, Analytics Hub creates a linked dataset in the subscriber's project. A Linked dataset is an opaque, read-only BigQuery dataset that serves as a symbolic link to a shared dataset.

Generated from protobuf message google.cloud.bigquery.analyticshub.v1.Listing.BigQueryDatasetSource

Namespace

Google \ Cloud \ BigQuery \ AnalyticsHub \ V1 \ Listing

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ dataset string

Optional. Resource name of the dataset source for this listing. e.g. projects/myproject/datasets/123

↳ selected_resources array<BigQueryDatasetSource\SelectedResource>

Optional. Resource in this dataset that is selectively shared. This field is required for data clean room exchanges.

↳ restricted_export_policy BigQueryDatasetSource\RestrictedExportPolicy

Optional. If set, restricted export policy will be propagated and enforced on the linked dataset.

↳ replica_locations array

Optional. A list of regions where the publisher has created shared dataset replicas.

↳ effective_replicas array<BigQueryDatasetSource\Replica>

Output only. Server-owned effective state of replicas. Contains both primary and secondary replicas. Each replica includes a system-computed (output-only) state and primary designation.

getDataset

Optional. Resource name of the dataset source for this listing.

e.g. projects/myproject/datasets/123

Returns
Type Description
string

setDataset

Optional. Resource name of the dataset source for this listing.

e.g. projects/myproject/datasets/123

Parameter
Name Description
var string
Returns
Type Description
$this

getSelectedResources

Optional. Resource in this dataset that is selectively shared.

This field is required for data clean room exchanges.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setSelectedResources

Optional. Resource in this dataset that is selectively shared.

This field is required for data clean room exchanges.

Parameter
Name Description
var array<BigQueryDatasetSource\SelectedResource>
Returns
Type Description
$this

getRestrictedExportPolicy

Optional. If set, restricted export policy will be propagated and enforced on the linked dataset.

Returns
Type Description
BigQueryDatasetSource\RestrictedExportPolicy|null

hasRestrictedExportPolicy

clearRestrictedExportPolicy

setRestrictedExportPolicy

Optional. If set, restricted export policy will be propagated and enforced on the linked dataset.

Parameter
Name Description
var BigQueryDatasetSource\RestrictedExportPolicy
Returns
Type Description
$this

getReplicaLocations

Optional. A list of regions where the publisher has created shared dataset replicas.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setReplicaLocations

Optional. A list of regions where the publisher has created shared dataset replicas.

Parameter
Name Description
var string[]
Returns
Type Description
$this

getEffectiveReplicas

Output only. Server-owned effective state of replicas.

Contains both primary and secondary replicas. Each replica includes a system-computed (output-only) state and primary designation.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setEffectiveReplicas

Output only. Server-owned effective state of replicas.

Contains both primary and secondary replicas. Each replica includes a system-computed (output-only) state and primary designation.

Parameter
Name Description
var array<BigQueryDatasetSource\Replica>
Returns
Type Description
$this