- 0.55.0 (latest)
- 0.54.0
- 0.53.0
- 0.52.0
- 0.51.0
- 0.50.0
- 0.49.0
- 0.48.0
- 0.47.0
- 0.46.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.37.0
- 0.36.0
- 0.35.0
- 0.34.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.0
- 0.25.0
- 0.24.0
- 0.23.0
- 0.22.0
- 0.21.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.0
- 0.13.0
- 0.12.0
- 0.11.0
- 0.10.0
- 0.9.1
- 0.8.0
- 0.7.0
- 0.6.0
- 0.5.0
- 0.4.0
- 0.3.0
- 0.2.0
- 0.1.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
- (::Google::Protobuf::Timestamp) — Output only. Timestamp when this NotebookExecutionJob was created.
#dataform_repository_source
def dataform_repository_source() -> ::Google::Cloud::AIPlatform::V1::NotebookExecutionJob::DataformRepositorySource
- (::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
- value (::Google::Cloud::AIPlatform::V1::NotebookExecutionJob::DataformRepositorySource) — The Dataform Repository pointing to a single file notebook repository.
- (::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
- (::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
- value (::Google::Cloud::AIPlatform::V1::NotebookExecutionJob::DirectNotebookSource) — The contents of an input notebook file.
- (::Google::Cloud::AIPlatform::V1::NotebookExecutionJob::DirectNotebookSource) — The contents of an input notebook file.
#display_name
def display_name() -> ::String
- (::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
- 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.
- (::String) — The display name of the NotebookExecutionJob. The name can be up to 128 characters long and can consist of any UTF-8 characters.
#execution_timeout
def execution_timeout() -> ::Google::Protobuf::Duration
- (::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
- value (::Google::Protobuf::Duration) — Max running time of the execution job in seconds (default 86400s / 24 hrs).
- (::Google::Protobuf::Duration) — Max running time of the execution job in seconds (default 86400s / 24 hrs).
#execution_user
def execution_user() -> ::String
- (::String) — The user email to run the execution as. Only supported by Colab runtimes.
#execution_user=
def execution_user=(value) -> ::String
- value (::String) — The user email to run the execution as. Only supported by Colab runtimes.
- (::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
-
(::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
-
value (::Google::Cloud::AIPlatform::V1::NotebookExecutionJob::GcsNotebookSource) — The Cloud Storage url pointing to the ipynb file. Format:
gs://bucket/notebook_file.ipynb
-
(::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
-
(::String) — The Cloud Storage location to upload the result to. Format:
gs://bucket-name
#gcs_output_uri=
def gcs_output_uri=(value) -> ::String
-
value (::String) — The Cloud Storage location to upload the result to. Format:
gs://bucket-name
-
(::String) — The Cloud Storage location to upload the result to. Format:
gs://bucket-name
#job_state
def job_state() -> ::Google::Cloud::AIPlatform::V1::JobState
- (::Google::Cloud::AIPlatform::V1::JobState) — Output only. The state of the NotebookExecutionJob.
#labels
def labels() -> ::Google::Protobuf::Map{::String => ::String}
-
(::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}
-
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.
-
(::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
-
(::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
- (::String) — The NotebookRuntimeTemplate to source compute configuration from.
#notebook_runtime_template_resource_name=
def notebook_runtime_template_resource_name=(value) -> ::String
- value (::String) — The NotebookRuntimeTemplate to source compute configuration from.
- (::String) — The NotebookRuntimeTemplate to source compute configuration from.
#schedule_resource_name
def schedule_resource_name() -> ::String
-
(::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
- (::String) — The service account to run the execution as.
#service_account=
def service_account=(value) -> ::String
- value (::String) — The service account to run the execution as.
- (::String) — The service account to run the execution as.
#status
def status() -> ::Google::Rpc::Status
- (::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
- (::Google::Protobuf::Timestamp) — Output only. Timestamp when this NotebookExecutionJob was most recently updated.