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.



20655
20656
20657
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20655

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) 


20542
20543
20544
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20542

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:



20547
20548
20549
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20547

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:



20552
20553
20554
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20552

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:



20557
20558
20559
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20557

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) 


20563
20564
20565
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20563

def display_name
  @display_name
end

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

Represents a customer-managed encryption key spec that can be applied to a top- level resource. Corresponds to the JSON property encryptionSpec

Returns:



20569
20570
20571
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20569

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) 


20574
20575
20576
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20574

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) 


20579
20580
20581
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20579

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:



20584
20585
20586
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20584

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) 


20589
20590
20591
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20589

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) 


20594
20595
20596
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20594

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) 


20600
20601
20602
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20600

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>) 


20610
20611
20612
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20610

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) 


20616
20617
20618
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20616

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) 


20621
20622
20623
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20621

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) 


20627
20628
20629
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20627

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) 


20632
20633
20634
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20632

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:



20642
20643
20644
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20642

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) 


20648
20649
20650
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20648

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:



20653
20654
20655
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20653

def workbench_runtime
  @workbench_runtime
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



20660
20661
20662
20663
20664
20665
20666
20667
20668
20669
20670
20671
20672
20673
20674
20675
20676
20677
20678
20679
20680
20681
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 20660

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