Class: Google::Apis::AiplatformV1::GoogleCloudAiplatformV1NotebookExecutionJob

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/aiplatform_v1/classes.rb,
lib/google/apis/aiplatform_v1/representations.rb,
lib/google/apis/aiplatform_v1/representations.rb

Overview

NotebookExecutionJob represents an instance of a notebook execution.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudAiplatformV1NotebookExecutionJob

Returns a new instance of GoogleCloudAiplatformV1NotebookExecutionJob.



27556
27557
27558
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 27556

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#create_time ⇒ String

Output only. Timestamp when this NotebookExecutionJob was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


27443
27444
27445
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 27443

def create_time
  @create_time
end

#custom_environment_spec ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1NotebookExecutionJobCustomEnvironmentSpec

Compute configuration to use for an execution job. Corresponds to the JSON property customEnvironmentSpec

Returns:



27448
27449
27450
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 27448

def custom_environment_spec
  @custom_environment_spec
end

#dataform_repository_source ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1NotebookExecutionJobDataformRepositorySource

The Dataform Repository containing the input notebook. Corresponds to the JSON property dataformRepositorySource

Returns:



27453
27454
27455
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 27453

def dataform_repository_source
  @dataform_repository_source
end

#direct_notebook_source ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1NotebookExecutionJobDirectNotebookSource

The content of the input notebook in ipynb format. Corresponds to the JSON property directNotebookSource

Returns:



27458
27459
27460
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 27458

def direct_notebook_source
  @direct_notebook_source
end

#display_name ⇒ String

The display name of the NotebookExecutionJob. The name can be up to 128 characters long and can consist of any UTF-8 characters. Corresponds to the JSON property displayName

Returns:

  • (String) 


27464
27465
27466
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 27464

def display_name
  @display_name
end

#encryption_spec ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EncryptionSpec

Represents a customer-managed encryption key specification that can be applied to a Vertex AI resource. Corresponds to the JSON property encryptionSpec

Returns:



27470
27471
27472
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 27470

def encryption_spec
  @encryption_spec
end

#execution_timeout ⇒ String

Max running time of the execution job in seconds (default 86400s / 24 hrs). Corresponds to the JSON property executionTimeout

Returns:

  • (String) 


27475
27476
27477
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 27475

def execution_timeout
  @execution_timeout
end

#execution_user ⇒ String

The user email to run the execution as. Only supported by Colab runtimes. Corresponds to the JSON property executionUser

Returns:

  • (String) 


27480
27481
27482
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 27480

def execution_user
  @execution_user
end

#gcs_notebook_source ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1NotebookExecutionJobGcsNotebookSource

The Cloud Storage uri for the input notebook. Corresponds to the JSON property gcsNotebookSource

Returns:



27485
27486
27487
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 27485

def gcs_notebook_source
  @gcs_notebook_source
end

#gcs_output_uri ⇒ String

The Cloud Storage location to upload the result to. Format: gs://bucket-name Corresponds to the JSON property gcsOutputUri

Returns:

  • (String) 


27490
27491
27492
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 27490

def gcs_output_uri
  @gcs_output_uri
end

#job_state ⇒ String

Output only. The state of the NotebookExecutionJob. Corresponds to the JSON property jobState

Returns:

  • (String) 


27495
27496
27497
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 27495

def job_state
  @job_state
end

#kernel_name ⇒ String

The name of the kernel to use during notebook execution. If unset, the default kernel is used. Corresponds to the JSON property kernelName

Returns:

  • (String) 


27501
27502
27503
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 27501

def kernel_name
  @kernel_name
end

#labels ⇒ Hash<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. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


27511
27512
27513
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 27511

def labels
  @labels
end

#name ⇒ String

Output only. The resource name of this NotebookExecutionJob. Format: projects/ project_id/locations/location/notebookExecutionJobs/job_id` Corresponds to the JSON propertyname`

Returns:

  • (String) 


27517
27518
27519
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 27517

def name
  @name
end

#notebook_runtime_template_resource_name ⇒ String

The NotebookRuntimeTemplate to source compute configuration from. Corresponds to the JSON property notebookRuntimeTemplateResourceName

Returns:

  • (String) 


27522
27523
27524
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 27522

def notebook_runtime_template_resource_name
  @notebook_runtime_template_resource_name
end

#schedule_resource_name ⇒ String

The Schedule resource name if this job is triggered by one. Format: projects/ project_id/locations/location/schedules/schedule_id` Corresponds to the JSON propertyscheduleResourceName`

Returns:

  • (String) 


27528
27529
27530
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 27528

def schedule_resource_name
  @schedule_resource_name
end

#service_account ⇒ String

The service account to run the execution as. Corresponds to the JSON property serviceAccount

Returns:

  • (String) 


27533
27534
27535
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 27533

def 
  @service_account
end

#status ⇒ Google::Apis::AiplatformV1::GoogleRpcStatus

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide. Corresponds to the JSON property status

Returns:



27543
27544
27545
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 27543

def status
  @status
end

#update_time ⇒ String

Output only. Timestamp when this NotebookExecutionJob was most recently updated. Corresponds to the JSON property updateTime

Returns:

  • (String) 


27549
27550
27551
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 27549

def update_time
  @update_time
end

#workbench_runtime ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1NotebookExecutionJobWorkbenchRuntime

Configuration for a Workbench Instances-based environment. Corresponds to the JSON property workbenchRuntime

Returns:



27554
27555
27556
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 27554

def workbench_runtime
  @workbench_runtime
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



27561
27562
27563
27564
27565
27566
27567
27568
27569
27570
27571
27572
27573
27574
27575
27576
27577
27578
27579
27580
27581
27582
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 27561

def update!(**args)
  @create_time = args[:create_time] if args.key?(:create_time)
  @custom_environment_spec = args[:custom_environment_spec] if args.key?(:custom_environment_spec)
  @dataform_repository_source = args[:dataform_repository_source] if args.key?(:dataform_repository_source)
  @direct_notebook_source = args[:direct_notebook_source] if args.key?(:direct_notebook_source)
  @display_name = args[:display_name] if args.key?(:display_name)
  @encryption_spec = args[:encryption_spec] if args.key?(:encryption_spec)
  @execution_timeout = args[:execution_timeout] if args.key?(:execution_timeout)
  @execution_user = args[:execution_user] if args.key?(:execution_user)
  @gcs_notebook_source = args[:gcs_notebook_source] if args.key?(:gcs_notebook_source)
  @gcs_output_uri = args[:gcs_output_uri] if args.key?(:gcs_output_uri)
  @job_state = args[:job_state] if args.key?(:job_state)
  @kernel_name = args[:kernel_name] if args.key?(:kernel_name)
  @labels = args[:labels] if args.key?(:labels)
  @name = args[:name] if args.key?(:name)
  @notebook_runtime_template_resource_name = args[:notebook_runtime_template_resource_name] if args.key?(:notebook_runtime_template_resource_name)
  @schedule_resource_name = args[:schedule_resource_name] if args.key?(:schedule_resource_name)
  @service_account = args[:service_account] if args.key?(:service_account)
  @status = args[:status] if args.key?(:status)
  @update_time = args[:update_time] if args.key?(:update_time)
  @workbench_runtime = args[:workbench_runtime] if args.key?(:workbench_runtime)
end