Google Cloud Dataplex V1 Client - Class NotebookTaskConfig (0.3.0)

Reference documentation and code samples for the Google Cloud Dataplex V1 Client class NotebookTaskConfig.

Config for running scheduled notebooks.

Generated from protobuf message google.cloud.dataplex.v1.Task.NotebookTaskConfig

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ notebook string

Required. Path to input notebook. This can be the Cloud Storage URI of the notebook file or the path to a Notebook Content. The execution args are accessible as environment variables (TASK_key=value).

↳ infrastructure_spec Google\Cloud\Dataplex\V1\Task\InfrastructureSpec

Optional. Infrastructure specification for the execution.

↳ file_uris array

Optional. Cloud Storage URIs of files to be placed in the working directory of each executor.

↳ archive_uris array

Optional. Cloud Storage URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.

getNotebook

Required. Path to input notebook. This can be the Cloud Storage URI of the notebook file or the path to a Notebook Content. The execution args are accessible as environment variables (TASK_key=value).

Returns
TypeDescription
string

setNotebook

Required. Path to input notebook. This can be the Cloud Storage URI of the notebook file or the path to a Notebook Content. The execution args are accessible as environment variables (TASK_key=value).

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getInfrastructureSpec

Optional. Infrastructure specification for the execution.

Returns
TypeDescription
Google\Cloud\Dataplex\V1\Task\InfrastructureSpec|null

hasInfrastructureSpec

clearInfrastructureSpec

setInfrastructureSpec

Optional. Infrastructure specification for the execution.

Parameter
NameDescription
var Google\Cloud\Dataplex\V1\Task\InfrastructureSpec
Returns
TypeDescription
$this

getFileUris

Optional. Cloud Storage URIs of files to be placed in the working directory of each executor.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setFileUris

Optional. Cloud Storage URIs of files to be placed in the working directory of each executor.

Parameter
NameDescription
var string[]
Returns
TypeDescription
$this

getArchiveUris

Optional. Cloud Storage URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setArchiveUris

Optional. Cloud Storage URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.

Parameter
NameDescription
var string[]
Returns
TypeDescription
$this