Vertex AI V1 API - Class Google::Cloud::AIPlatform::V1::NotebookExecutionJob (v0.59.0)

Reference documentation and code samples for the Vertex AI V1 API class Google::Cloud::AIPlatform::V1::NotebookExecutionJob.

NotebookExecutionJob represents an instance of a notebook execution.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#create_time

def create_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — Output only. Timestamp when this NotebookExecutionJob was created.

#custom_environment_spec

def custom_environment_spec() -> ::Google::Cloud::AIPlatform::V1::NotebookExecutionJob::CustomEnvironmentSpec

Returns

(::Google::Cloud::AIPlatform::V1::NotebookExecutionJob::CustomEnvironmentSpec) — The custom compute configuration for an execution job.

#custom_environment_spec=

def custom_environment_spec=(value) -> ::Google::Cloud::AIPlatform::V1::NotebookExecutionJob::CustomEnvironmentSpec

Parameter

value (::Google::Cloud::AIPlatform::V1::NotebookExecutionJob::CustomEnvironmentSpec) — The custom compute configuration for an execution job.

Returns

(::Google::Cloud::AIPlatform::V1::NotebookExecutionJob::CustomEnvironmentSpec) — The custom compute configuration for an execution job.

#dataform_repository_source

def dataform_repository_source() -> ::Google::Cloud::AIPlatform::V1::NotebookExecutionJob::DataformRepositorySource

Returns

(::Google::Cloud::AIPlatform::V1::NotebookExecutionJob::DataformRepositorySource) — The Dataform Repository pointing to a single file notebook repository.

#dataform_repository_source=

def dataform_repository_source=(value) -> ::Google::Cloud::AIPlatform::V1::NotebookExecutionJob::DataformRepositorySource

Parameter

value (::Google::Cloud::AIPlatform::V1::NotebookExecutionJob::DataformRepositorySource) — The Dataform Repository pointing to a single file notebook repository.

Returns

(::Google::Cloud::AIPlatform::V1::NotebookExecutionJob::DataformRepositorySource) — The Dataform Repository pointing to a single file notebook repository.

#direct_notebook_source

def direct_notebook_source() -> ::Google::Cloud::AIPlatform::V1::NotebookExecutionJob::DirectNotebookSource

Returns

(::Google::Cloud::AIPlatform::V1::NotebookExecutionJob::DirectNotebookSource) — The contents of an input notebook file.

#direct_notebook_source=

def direct_notebook_source=(value) -> ::Google::Cloud::AIPlatform::V1::NotebookExecutionJob::DirectNotebookSource

Parameter

value (::Google::Cloud::AIPlatform::V1::NotebookExecutionJob::DirectNotebookSource) — The contents of an input notebook file.

Returns

(::Google::Cloud::AIPlatform::V1::NotebookExecutionJob::DirectNotebookSource) — The contents of an input notebook file.

#display_name

def display_name() -> ::String

Returns

(::String) — The display name of the NotebookExecutionJob. The name can be up to 128 characters long and can consist of any UTF-8 characters.

#display_name=

def display_name=(value) -> ::String

Parameter

value (::String) — The display name of the NotebookExecutionJob. The name can be up to 128 characters long and can consist of any UTF-8 characters.

Returns

(::String) — The display name of the NotebookExecutionJob. The name can be up to 128 characters long and can consist of any UTF-8 characters.

#encryption_spec

def encryption_spec() -> ::Google::Cloud::AIPlatform::V1::EncryptionSpec

Returns

(::Google::Cloud::AIPlatform::V1::EncryptionSpec) — Customer-managed encryption key spec for the notebook execution job. This field is auto-populated if the [NotebookService.NotebookRuntimeTemplate][] has an encryption spec.

#encryption_spec=

def encryption_spec=(value) -> ::Google::Cloud::AIPlatform::V1::EncryptionSpec

Parameter

value (::Google::Cloud::AIPlatform::V1::EncryptionSpec) — Customer-managed encryption key spec for the notebook execution job. This field is auto-populated if the [NotebookService.NotebookRuntimeTemplate][] has an encryption spec.

Returns

(::Google::Cloud::AIPlatform::V1::EncryptionSpec) — Customer-managed encryption key spec for the notebook execution job. This field is auto-populated if the [NotebookService.NotebookRuntimeTemplate][] has an encryption spec.

#execution_timeout

def execution_timeout() -> ::Google::Protobuf::Duration

Returns

(::Google::Protobuf::Duration) — Max running time of the execution job in seconds (default 86400s / 24 hrs).

#execution_timeout=

def execution_timeout=(value) -> ::Google::Protobuf::Duration

Parameter

value (::Google::Protobuf::Duration) — Max running time of the execution job in seconds (default 86400s / 24 hrs).

Returns

(::Google::Protobuf::Duration) — Max running time of the execution job in seconds (default 86400s / 24 hrs).

#execution_user

def execution_user() -> ::String

Returns

(::String) — The user email to run the execution as. Only supported by Colab runtimes.

#execution_user=

def execution_user=(value) -> ::String

Parameter

value (::String) — The user email to run the execution as. Only supported by Colab runtimes.

Returns

(::String) — The user email to run the execution as. Only supported by Colab runtimes.

#gcs_notebook_source

def gcs_notebook_source() -> ::Google::Cloud::AIPlatform::V1::NotebookExecutionJob::GcsNotebookSource

Returns

(::Google::Cloud::AIPlatform::V1::NotebookExecutionJob::GcsNotebookSource) — The Cloud Storage url pointing to the ipynb file. Format: gs://bucket/notebook_file.ipynb

#gcs_notebook_source=

def gcs_notebook_source=(value) -> ::Google::Cloud::AIPlatform::V1::NotebookExecutionJob::GcsNotebookSource

Parameter

value (::Google::Cloud::AIPlatform::V1::NotebookExecutionJob::GcsNotebookSource) — The Cloud Storage url pointing to the ipynb file. Format: gs://bucket/notebook_file.ipynb

Returns

(::Google::Cloud::AIPlatform::V1::NotebookExecutionJob::GcsNotebookSource) — The Cloud Storage url pointing to the ipynb file. Format: gs://bucket/notebook_file.ipynb

#gcs_output_uri

def gcs_output_uri() -> ::String

Returns

(::String) — The Cloud Storage location to upload the result to. Format: gs://bucket-name

#gcs_output_uri=

def gcs_output_uri=(value) -> ::String

Parameter

value (::String) — The Cloud Storage location to upload the result to. Format: gs://bucket-name

Returns

(::String) — The Cloud Storage location to upload the result to. Format: gs://bucket-name

#job_state

def job_state() -> ::Google::Cloud::AIPlatform::V1::JobState

Returns

(::Google::Cloud::AIPlatform::V1::JobState) — Output only. The state of the NotebookExecutionJob.

#labels

def labels() -> ::Google::Protobuf::Map{::String => ::String}

Returns

(::Google::Protobuf::Map{::String => ::String}) — The labels with user-defined metadata to organize NotebookExecutionJobs.

Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed.

See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}

Parameter

value (::Google::Protobuf::Map{::String => ::String}) — The labels with user-defined metadata to organize NotebookExecutionJobs.

Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed.

See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.

Returns

(::Google::Protobuf::Map{::String => ::String}) — The labels with user-defined metadata to organize NotebookExecutionJobs.

Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed.

See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.

#name

def name() -> ::String

Returns

(::String) — Output only. The resource name of this NotebookExecutionJob. Format: projects/{project_id}/locations/{location}/notebookExecutionJobs/{job_id}

#notebook_runtime_template_resource_name

def notebook_runtime_template_resource_name() -> ::String

Returns

(::String) — The NotebookRuntimeTemplate to source compute configuration from.

#notebook_runtime_template_resource_name=

def notebook_runtime_template_resource_name=(value) -> ::String

Parameter

value (::String) — The NotebookRuntimeTemplate to source compute configuration from.

Returns

(::String) — The NotebookRuntimeTemplate to source compute configuration from.

#schedule_resource_name

def schedule_resource_name() -> ::String

Returns

(::String) — Output only. The Schedule resource name if this job is triggered by one. Format: projects/{project_id}/locations/{location}/schedules/{schedule_id}

#service_account

def service_account() -> ::String

Returns

(::String) — The service account to run the execution as.

#service_account=

def service_account=(value) -> ::String

Parameter

value (::String) — The service account to run the execution as.

Returns

(::String) — The service account to run the execution as.

#status

def status() -> ::Google::Rpc::Status

Returns

(::Google::Rpc::Status) — Output only. Populated when the NotebookExecutionJob is completed. When there is an error during notebook execution, the error details are populated.

#update_time

def update_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — Output only. Timestamp when this NotebookExecutionJob was most recently updated.