Reference documentation and code samples for the Dataplex V1 API class Google::Cloud::Dataplex::V1::Task::NotebookTaskConfig.
Config for running scheduled notebooks.
Inherits
Object
Extended By
Google::Protobuf::MessageExts::ClassMethods
Includes
Google::Protobuf::MessageExts
Methods
#archive_uris
defarchive_uris()->::Array<::String>
Returns
(::Array<::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.
#archive_uris=
defarchive_uris=(value)->::Array<::String>
Parameter
value (::Array<::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.
Returns
(::Array<::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.
#file_uris
deffile_uris()->::Array<::String>
Returns
(::Array<::String>) — Optional. Cloud Storage URIs of files to be placed in the working
directory of each executor.
#file_uris=
deffile_uris=(value)->::Array<::String>
Parameter
value (::Array<::String>) — Optional. Cloud Storage URIs of files to be placed in the working
directory of each executor.
Returns
(::Array<::String>) — Optional. Cloud Storage URIs of files to be placed in the working
directory of each executor.
(::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).
#notebook=
defnotebook=(value)->::String
Parameter
value (::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).
Returns
(::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).
[[["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-09-04 UTC."],[],[],null,["# Dataplex V1 API - Class Google::Cloud::Dataplex::V1::Task::NotebookTaskConfig (v2.5.0)\n\nVersion latestkeyboard_arrow_down\n\n- [2.5.0 (latest)](/ruby/docs/reference/google-cloud-dataplex-v1/latest/Google-Cloud-Dataplex-V1-Task-NotebookTaskConfig)\n- [2.4.1](/ruby/docs/reference/google-cloud-dataplex-v1/2.4.1/Google-Cloud-Dataplex-V1-Task-NotebookTaskConfig)\n- [2.3.1](/ruby/docs/reference/google-cloud-dataplex-v1/2.3.1/Google-Cloud-Dataplex-V1-Task-NotebookTaskConfig)\n- [2.2.0](/ruby/docs/reference/google-cloud-dataplex-v1/2.2.0/Google-Cloud-Dataplex-V1-Task-NotebookTaskConfig)\n- [2.1.0](/ruby/docs/reference/google-cloud-dataplex-v1/2.1.0/Google-Cloud-Dataplex-V1-Task-NotebookTaskConfig)\n- [2.0.0](/ruby/docs/reference/google-cloud-dataplex-v1/2.0.0/Google-Cloud-Dataplex-V1-Task-NotebookTaskConfig)\n- [1.4.0](/ruby/docs/reference/google-cloud-dataplex-v1/1.4.0/Google-Cloud-Dataplex-V1-Task-NotebookTaskConfig)\n- [1.3.0](/ruby/docs/reference/google-cloud-dataplex-v1/1.3.0/Google-Cloud-Dataplex-V1-Task-NotebookTaskConfig)\n- [1.2.0](/ruby/docs/reference/google-cloud-dataplex-v1/1.2.0/Google-Cloud-Dataplex-V1-Task-NotebookTaskConfig)\n- [1.1.0](/ruby/docs/reference/google-cloud-dataplex-v1/1.1.0/Google-Cloud-Dataplex-V1-Task-NotebookTaskConfig)\n- [1.0.1](/ruby/docs/reference/google-cloud-dataplex-v1/1.0.1/Google-Cloud-Dataplex-V1-Task-NotebookTaskConfig)\n- [0.23.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.23.0/Google-Cloud-Dataplex-V1-Task-NotebookTaskConfig)\n- [0.22.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.22.0/Google-Cloud-Dataplex-V1-Task-NotebookTaskConfig)\n- [0.21.1](/ruby/docs/reference/google-cloud-dataplex-v1/0.21.1/Google-Cloud-Dataplex-V1-Task-NotebookTaskConfig)\n- [0.20.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.20.0/Google-Cloud-Dataplex-V1-Task-NotebookTaskConfig)\n- [0.19.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.19.0/Google-Cloud-Dataplex-V1-Task-NotebookTaskConfig)\n- [0.18.2](/ruby/docs/reference/google-cloud-dataplex-v1/0.18.2/Google-Cloud-Dataplex-V1-Task-NotebookTaskConfig)\n- [0.17.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.17.0/Google-Cloud-Dataplex-V1-Task-NotebookTaskConfig)\n- [0.16.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.16.0/Google-Cloud-Dataplex-V1-Task-NotebookTaskConfig)\n- [0.15.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.15.0/Google-Cloud-Dataplex-V1-Task-NotebookTaskConfig)\n- [0.14.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.14.0/Google-Cloud-Dataplex-V1-Task-NotebookTaskConfig)\n- [0.13.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.13.0/Google-Cloud-Dataplex-V1-Task-NotebookTaskConfig)\n- [0.12.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.12.0/Google-Cloud-Dataplex-V1-Task-NotebookTaskConfig)\n- [0.11.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.11.0/Google-Cloud-Dataplex-V1-Task-NotebookTaskConfig)\n- [0.10.1](/ruby/docs/reference/google-cloud-dataplex-v1/0.10.1/Google-Cloud-Dataplex-V1-Task-NotebookTaskConfig)\n- [0.9.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.9.0/Google-Cloud-Dataplex-V1-Task-NotebookTaskConfig)\n- [0.8.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.8.0/Google-Cloud-Dataplex-V1-Task-NotebookTaskConfig)\n- [0.7.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.7.0/Google-Cloud-Dataplex-V1-Task-NotebookTaskConfig)\n- [0.6.1](/ruby/docs/reference/google-cloud-dataplex-v1/0.6.1/Google-Cloud-Dataplex-V1-Task-NotebookTaskConfig)\n- [0.5.1](/ruby/docs/reference/google-cloud-dataplex-v1/0.5.1/Google-Cloud-Dataplex-V1-Task-NotebookTaskConfig)\n- [0.4.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.4.0/Google-Cloud-Dataplex-V1-Task-NotebookTaskConfig)\n- [0.3.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.3.0/Google-Cloud-Dataplex-V1-Task-NotebookTaskConfig)\n- [0.2.1](/ruby/docs/reference/google-cloud-dataplex-v1/0.2.1/Google-Cloud-Dataplex-V1-Task-NotebookTaskConfig)\n- [0.1.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.1.0/Google-Cloud-Dataplex-V1-Task-NotebookTaskConfig) \nReference documentation and code samples for the Dataplex V1 API class Google::Cloud::Dataplex::V1::Task::NotebookTaskConfig.\n\nConfig for running scheduled notebooks. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #archive_uris\n\n def archive_uris() -\u003e ::Array\u003c::String\u003e\n\n**Returns**\n\n- (::Array\\\u003c::String\\\u003e) --- 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.\n\n### #archive_uris=\n\n def archive_uris=(value) -\u003e ::Array\u003c::String\u003e\n\n**Parameter**\n\n- **value** (::Array\\\u003c::String\\\u003e) --- 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. \n**Returns**\n\n- (::Array\\\u003c::String\\\u003e) --- 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.\n\n### #file_uris\n\n def file_uris() -\u003e ::Array\u003c::String\u003e\n\n**Returns**\n\n- (::Array\\\u003c::String\\\u003e) --- Optional. Cloud Storage URIs of files to be placed in the working directory of each executor.\n\n### #file_uris=\n\n def file_uris=(value) -\u003e ::Array\u003c::String\u003e\n\n**Parameter**\n\n- **value** (::Array\\\u003c::String\\\u003e) --- Optional. Cloud Storage URIs of files to be placed in the working directory of each executor. \n**Returns**\n\n- (::Array\\\u003c::String\\\u003e) --- Optional. Cloud Storage URIs of files to be placed in the working directory of each executor.\n\n### #infrastructure_spec\n\n def infrastructure_spec() -\u003e ::Google::Cloud::Dataplex::V1::Task::InfrastructureSpec\n\n**Returns**\n\n- ([::Google::Cloud::Dataplex::V1::Task::InfrastructureSpec](./Google-Cloud-Dataplex-V1-Task-InfrastructureSpec)) --- Optional. Infrastructure specification for the execution.\n\n### #infrastructure_spec=\n\n def infrastructure_spec=(value) -\u003e ::Google::Cloud::Dataplex::V1::Task::InfrastructureSpec\n\n**Parameter**\n\n- **value** ([::Google::Cloud::Dataplex::V1::Task::InfrastructureSpec](./Google-Cloud-Dataplex-V1-Task-InfrastructureSpec)) --- Optional. Infrastructure specification for the execution. \n**Returns**\n\n- ([::Google::Cloud::Dataplex::V1::Task::InfrastructureSpec](./Google-Cloud-Dataplex-V1-Task-InfrastructureSpec)) --- Optional. Infrastructure specification for the execution.\n\n### #notebook\n\n def notebook() -\u003e ::String\n\n**Returns**\n\n- (::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`).\n\n### #notebook=\n\n def notebook=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::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`). \n**Returns**\n\n- (::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`)."]]
