Google Cloud Datastream V1 Client - Class DatasetTemplate (1.0.5)

Reference documentation and code samples for the Google Cloud Datastream V1 Client class DatasetTemplate.

Dataset template used for dynamic dataset creation.

Generated from protobuf message google.cloud.datastream.v1.BigQueryDestinationConfig.SourceHierarchyDatasets.DatasetTemplate

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ location string

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

↳ dataset_id_prefix string

If supplied, every created dataset will have its name prefixed by the provided value. The prefix and name will be separated by an underscore. i.e.

↳ kms_key_name string

Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key. i.e. projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{cryptoKey}. See https://cloud.google.com/bigquery/docs/customer-managed-encryption for more information.

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

getDatasetIdPrefix

If supplied, every created dataset will have its name prefixed by the provided value. The prefix and name will be separated by an underscore.

i.e.

Returns
TypeDescription
string

setDatasetIdPrefix

If supplied, every created dataset will have its name prefixed by the provided value. The prefix and name will be separated by an underscore.

i.e.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getKmsKeyName

Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.

i.e. projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{cryptoKey}. See https://cloud.google.com/bigquery/docs/customer-managed-encryption for more information.

Returns
TypeDescription
string

setKmsKeyName

Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.

i.e. projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{cryptoKey}. See https://cloud.google.com/bigquery/docs/customer-managed-encryption for more information.

Parameter
NameDescription
var string
Returns
TypeDescription
$this