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).
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
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.
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.
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[],[],null,["# Google Cloud Dataplex V1 Client - Class NotebookTaskConfig (1.7.1)\n\nVersion latestkeyboard_arrow_down\n\n- [1.7.1 (latest)](/php/docs/reference/cloud-dataplex/latest/V1.Task.NotebookTaskConfig)\n- [1.7.0](/php/docs/reference/cloud-dataplex/1.7.0/V1.Task.NotebookTaskConfig)\n- [1.6.1](/php/docs/reference/cloud-dataplex/1.6.1/V1.Task.NotebookTaskConfig)\n- [1.4.0](/php/docs/reference/cloud-dataplex/1.4.0/V1.Task.NotebookTaskConfig)\n- [1.3.0](/php/docs/reference/cloud-dataplex/1.3.0/V1.Task.NotebookTaskConfig)\n- [1.2.1](/php/docs/reference/cloud-dataplex/1.2.1/V1.Task.NotebookTaskConfig)\n- [1.1.1](/php/docs/reference/cloud-dataplex/1.1.1/V1.Task.NotebookTaskConfig)\n- [1.0.1](/php/docs/reference/cloud-dataplex/1.0.1/V1.Task.NotebookTaskConfig)\n- [0.16.1](/php/docs/reference/cloud-dataplex/0.16.1/V1.Task.NotebookTaskConfig)\n- [0.15.1](/php/docs/reference/cloud-dataplex/0.15.1/V1.Task.NotebookTaskConfig)\n- [0.14.0](/php/docs/reference/cloud-dataplex/0.14.0/V1.Task.NotebookTaskConfig)\n- [0.13.0](/php/docs/reference/cloud-dataplex/0.13.0/V1.Task.NotebookTaskConfig)\n- [0.12.0](/php/docs/reference/cloud-dataplex/0.12.0/V1.Task.NotebookTaskConfig)\n- [0.11.1](/php/docs/reference/cloud-dataplex/0.11.1/V1.Task.NotebookTaskConfig)\n- [0.10.0](/php/docs/reference/cloud-dataplex/0.10.0/V1.Task.NotebookTaskConfig)\n- [0.9.0](/php/docs/reference/cloud-dataplex/0.9.0/V1.Task.NotebookTaskConfig)\n- [0.8.0](/php/docs/reference/cloud-dataplex/0.8.0/V1.Task.NotebookTaskConfig)\n- [0.7.0](/php/docs/reference/cloud-dataplex/0.7.0/V1.Task.NotebookTaskConfig)\n- [0.6.0](/php/docs/reference/cloud-dataplex/0.6.0/V1.Task.NotebookTaskConfig)\n- [0.5.1](/php/docs/reference/cloud-dataplex/0.5.1/V1.Task.NotebookTaskConfig)\n- [0.4.0](/php/docs/reference/cloud-dataplex/0.4.0/V1.Task.NotebookTaskConfig)\n- [0.3.0](/php/docs/reference/cloud-dataplex/0.3.0/V1.Task.NotebookTaskConfig)\n- [0.2.3](/php/docs/reference/cloud-dataplex/0.2.3/V1.Task.NotebookTaskConfig)\n- [0.1.6](/php/docs/reference/cloud-dataplex/0.1.6/V1.Task.NotebookTaskConfig) \nReference documentation and code samples for the Google Cloud Dataplex V1 Client class NotebookTaskConfig.\n\nConfig for running scheduled notebooks.\n\nGenerated from protobuf message `google.cloud.dataplex.v1.Task.NotebookTaskConfig`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Dataplex \\\\ V1 \\\\ Task\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getNotebook\n\nRequired. Path to input notebook. This can be the Cloud Storage URI of\nthe notebook file or the path to a Notebook Content. The execution args\nare accessible as environment variables\n(`TASK_key=value`).\n\n### setNotebook\n\nRequired. Path to input notebook. This can be the Cloud Storage URI of\nthe notebook file or the path to a Notebook Content. The execution args\nare accessible as environment variables\n(`TASK_key=value`).\n\n### getInfrastructureSpec\n\nOptional. Infrastructure specification for the execution.\n\n### hasInfrastructureSpec\n\n### clearInfrastructureSpec\n\n### setInfrastructureSpec\n\nOptional. Infrastructure specification for the execution.\n\n### getFileUris\n\nOptional. Cloud Storage URIs of files to be placed in the working\ndirectory of each executor.\n\n### setFileUris\n\nOptional. Cloud Storage URIs of files to be placed in the working\ndirectory of each executor.\n\n### getArchiveUris\n\nOptional. Cloud Storage URIs of archives to be extracted into the working\ndirectory of each executor. Supported file types: .jar, .tar, .tar.gz,\n.tgz, and .zip.\n\n### setArchiveUris\n\nOptional. Cloud Storage URIs of archives to be extracted into the working\ndirectory of each executor. Supported file types: .jar, .tar, .tar.gz,\n.tgz, and .zip."]]
