Class: Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1NotebookExecutionJob

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

Overview

NotebookExecutionJob represents an instance of a notebook execution.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudAiplatformV1beta1NotebookExecutionJob

Returns a new instance of GoogleCloudAiplatformV1beta1NotebookExecutionJob.



38094
38095
38096
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 38094

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) 


37981
37982
37983
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 37981

def create_time
  @create_time
end

#custom_environment_spec ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1NotebookExecutionJobCustomEnvironmentSpec

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

Returns:



37986
37987
37988
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 37986

def custom_environment_spec
  @custom_environment_spec
end

#dataform_repository_source ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1NotebookExecutionJobDataformRepositorySource

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

Returns:



37991
37992
37993
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 37991

def dataform_repository_source
  @dataform_repository_source
end

#direct_notebook_source ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1NotebookExecutionJobDirectNotebookSource

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

Returns:



37996
37997
37998
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 37996

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) 


38002
38003
38004
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 38002

def display_name
  @display_name
end

#encryption_spec ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EncryptionSpec

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

Returns:



38008
38009
38010
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 38008

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) 


38013
38014
38015
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 38013

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) 


38018
38019
38020
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 38018

def execution_user
  @execution_user
end

#gcs_notebook_source ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1NotebookExecutionJobGcsNotebookSource

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

Returns:



38023
38024
38025
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 38023

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) 


38028
38029
38030
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 38028

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) 


38033
38034
38035
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 38033

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) 


38039
38040
38041
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 38039

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


38049
38050
38051
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 38049

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) 


38055
38056
38057
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 38055

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) 


38060
38061
38062
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 38060

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) 


38066
38067
38068
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 38066

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) 


38071
38072
38073
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 38071

def 
  @service_account
end

#status ⇒ Google::Apis::AiplatformV1beta1::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:



38081
38082
38083
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 38081

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) 


38087
38088
38089
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 38087

def update_time
  @update_time
end

#workbench_runtime ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1NotebookExecutionJobWorkbenchRuntime

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

Returns:



38092
38093
38094
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 38092

def workbench_runtime
  @workbench_runtime
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



38099
38100
38101
38102
38103
38104
38105
38106
38107
38108
38109
38110
38111
38112
38113
38114
38115
38116
38117
38118
38119
38120
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 38099

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