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.



16844
16845
16846
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 16844

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) 


16747
16748
16749
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 16747

def create_time
  @create_time
end

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

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

Returns:



16752
16753
16754
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 16752

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:



16757
16758
16759
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 16757

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) 


16763
16764
16765
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 16763

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:



16769
16770
16771
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 16769

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) 


16774
16775
16776
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 16774

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) 


16779
16780
16781
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 16779

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:



16784
16785
16786
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 16784

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) 


16789
16790
16791
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 16789

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) 


16794
16795
16796
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 16794

def job_state
  @job_state
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>) 


16804
16805
16806
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 16804

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) 


16810
16811
16812
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 16810

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) 


16815
16816
16817
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 16815

def notebook_runtime_template_resource_name
  @notebook_runtime_template_resource_name
end

#schedule_resource_name ⇒ String

Output only. 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) 


16821
16822
16823
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 16821

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) 


16826
16827
16828
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 16826

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:



16836
16837
16838
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 16836

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) 


16842
16843
16844
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 16842

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



16849
16850
16851
16852
16853
16854
16855
16856
16857
16858
16859
16860
16861
16862
16863
16864
16865
16866
16867
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 16849

def update!(**args)
  @create_time = args[:create_time] if args.key?(:create_time)
  @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)
  @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)
end