Vertex AI V1 API - Class Google::Cloud::AIPlatform::V1::NotebookExecutionJob (v0.58.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

#dataform_repository_source

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

#dataform_repository_source=

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

#direct_notebook_source

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

#direct_notebook_source=

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

#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

#encryption_spec=

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

#execution_timeout

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

#execution_timeout=

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

#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

#gcs_notebook_source=

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

#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

#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