Google Cloud Dataplex V1 Client - Class NotebookTaskConfig (1.12.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

Namespace

Google \ Cloud \ Dataplex \ V1 \ Task

Methods

__construct

Constructor.

Parameters
Name Description
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 InfrastructureSpec

Optional. Infrastructure specification for the execution.

↳ file_uris string[]

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

↳ archive_uris string[]

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
Type Description
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
Name Description
var string
Returns
Type Description
$this

getInfrastructureSpec

Optional. Infrastructure specification for the execution.

Returns
Type Description
InfrastructureSpec|null

hasInfrastructureSpec

clearInfrastructureSpec

setInfrastructureSpec

Optional. Infrastructure specification for the execution.

Parameter
Name Description
var InfrastructureSpec
Returns
Type Description
$this

getFileUris

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

Returns
Type Description
Google\Protobuf\RepeatedField<string>

setFileUris

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

Parameter
Name Description
var string[]
Returns
Type Description
$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
Type Description
Google\Protobuf\RepeatedField<string>

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
Name Description
var string[]
Returns
Type Description
$this