Class: Google::Apis::AiplatformV1::GoogleCloudAiplatformV1PipelineJob

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

An instance of a machine learning PipelineJob.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudAiplatformV1PipelineJob

Returns a new instance of GoogleCloudAiplatformV1PipelineJob.



26232
26233
26234
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 26232

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

Instance Attribute Details

#create_time ⇒ String

Output only. Pipeline creation time. Corresponds to the JSON property createTime

Returns:

  • (String) 


26091
26092
26093
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 26091

def create_time
  @create_time
end

#display_name ⇒ String

The display name of the Pipeline. 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) 


26097
26098
26099
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 26097

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:



26103
26104
26105
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 26103

def encryption_spec
  @encryption_spec
end

#end_time ⇒ String

Output only. Pipeline end time. Corresponds to the JSON property endTime

Returns:

  • (String) 


26108
26109
26110
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 26108

def end_time
  @end_time
end

#error ⇒ 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 error

Returns:



26118
26119
26120
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 26118

def error
  @error
end

#job_detail ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1PipelineJobDetail

The runtime detail of PipelineJob. Corresponds to the JSON property jobDetail

Returns:



26123
26124
26125
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 26123

def job_detail
  @job_detail
end

#labels ⇒ Hash<String,String>

The labels with user-defined metadata to organize PipelineJob. 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. Note there is some reserved label key for Vertex AI Pipelines. - vertex-ai-pipelines-run-billing-id, user set value will get overrided. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


26134
26135
26136
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 26134

def labels
  @labels
end

#name ⇒ String

Output only. The resource name of the PipelineJob. Corresponds to the JSON property name

Returns:

  • (String) 


26139
26140
26141
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 26139

def name
  @name
end

#network ⇒ String

The full name of the Compute Engine network to which the Pipeline Job's workload should be peered. For example, projects/12345/global/networks/myVPC. Format is of the form projects/project/global/ networks/network`. Whereprojectis a project number, as in12345, and networkis a network name. Private services access must already be configured for the network. Pipeline job will apply the network configuration to the Google Cloud resources being launched, if applied, such as Vertex AI Training or Dataflow job. If left unspecified, the workload is not peered with any network. Corresponds to the JSON propertynetwork`

Returns:

  • (String) 


26153
26154
26155
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 26153

def network
  @network
end

#pipeline_spec ⇒ Hash<String,Object>

A compiled definition of a pipeline, represented as a JSON object. Defines the structure of the pipeline, including its components, tasks, and parameters. This specification is generated by compiling a pipeline function defined in Python using the Kubeflow Pipelines SDK. Corresponds to the JSON property pipelineSpec

Returns:

  • (Hash<String,Object>) 


26161
26162
26163
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 26161

def pipeline_spec
  @pipeline_spec
end

#preflight_validations ⇒ Boolean Also known as: preflight_validations?

Optional. Whether to do component level validations before job creation. Corresponds to the JSON property preflightValidations

Returns:

  • (Boolean) 


26166
26167
26168
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 26166

def preflight_validations
  @preflight_validations
end

#psc_interface_config ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1PscInterfaceConfig

Configuration for PSC-I. Corresponds to the JSON property pscInterfaceConfig

Returns:



26172
26173
26174
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 26172

def psc_interface_config
  @psc_interface_config
end

#reserved_ip_ranges ⇒ Array<String>

A list of names for the reserved ip ranges under the VPC network that can be used for this Pipeline Job's workload. If set, we will deploy the Pipeline Job' s workload within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range' ]. Corresponds to the JSON property reservedIpRanges

Returns:

  • (Array<String>) 


26181
26182
26183
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 26181

def reserved_ip_ranges
  @reserved_ip_ranges
end

#runtime_config ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1PipelineJobRuntimeConfig

The runtime config of a PipelineJob. Corresponds to the JSON property runtimeConfig

Returns:



26186
26187
26188
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 26186

def runtime_config
  @runtime_config
end

#schedule_name ⇒ String

Output only. The schedule resource name. Only returned if the Pipeline is created by Schedule API. Corresponds to the JSON property scheduleName

Returns:

  • (String) 


26192
26193
26194
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 26192

def schedule_name
  @schedule_name
end

#service_account ⇒ String

The service account that the pipeline workload runs as. If not specified, the Compute Engine default service account in the project will be used. See https:/ /cloud.google.com/compute/docs/access/service-accounts#default_service_account Users starting the pipeline must have the iam.serviceAccounts.actAs permission on this service account. Corresponds to the JSON property serviceAccount

Returns:

  • (String) 


26201
26202
26203
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 26201

def 
  @service_account
end

#start_time ⇒ String

Output only. Pipeline start time. Corresponds to the JSON property startTime

Returns:

  • (String) 


26206
26207
26208
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 26206

def start_time
  @start_time
end

#state ⇒ String

Output only. The detailed state of the job. Corresponds to the JSON property state

Returns:

  • (String) 


26211
26212
26213
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 26211

def state
  @state
end

#template_metadata ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1PipelineTemplateMetadata

Pipeline template metadata if PipelineJob.template_uri is from supported template registry. Currently, the only supported registry is Artifact Registry. Corresponds to the JSON property templateMetadata

Returns:



26217
26218
26219
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 26217

def template_metadata
  @template_metadata
end

#template_uri ⇒ String

A template uri from where the PipelineJob.pipeline_spec, if empty, will be downloaded. Currently, only uri from Vertex Template Registry & Gallery is supported. Reference to https://cloud.google.com/vertex-ai/docs/pipelines/ create-pipeline-template. Corresponds to the JSON property templateUri

Returns:

  • (String) 


26225
26226
26227
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 26225

def template_uri
  @template_uri
end

#update_time ⇒ String

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

Returns:

  • (String) 


26230
26231
26232
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 26230

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



26237
26238
26239
26240
26241
26242
26243
26244
26245
26246
26247
26248
26249
26250
26251
26252
26253
26254
26255
26256
26257
26258
26259
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 26237

def update!(**args)
  @create_time = args[:create_time] if args.key?(:create_time)
  @display_name = args[:display_name] if args.key?(:display_name)
  @encryption_spec = args[:encryption_spec] if args.key?(:encryption_spec)
  @end_time = args[:end_time] if args.key?(:end_time)
  @error = args[:error] if args.key?(:error)
  @job_detail = args[:job_detail] if args.key?(:job_detail)
  @labels = args[:labels] if args.key?(:labels)
  @name = args[:name] if args.key?(:name)
  @network = args[:network] if args.key?(:network)
  @pipeline_spec = args[:pipeline_spec] if args.key?(:pipeline_spec)
  @preflight_validations = args[:preflight_validations] if args.key?(:preflight_validations)
  @psc_interface_config = args[:psc_interface_config] if args.key?(:psc_interface_config)
  @reserved_ip_ranges = args[:reserved_ip_ranges] if args.key?(:reserved_ip_ranges)
  @runtime_config = args[:runtime_config] if args.key?(:runtime_config)
  @schedule_name = args[:schedule_name] if args.key?(:schedule_name)
  @service_account = args[:service_account] if args.key?(:service_account)
  @start_time = args[:start_time] if args.key?(:start_time)
  @state = args[:state] if args.key?(:state)
  @template_metadata = args[:template_metadata] if args.key?(:template_metadata)
  @template_uri = args[:template_uri] if args.key?(:template_uri)
  @update_time = args[:update_time] if args.key?(:update_time)
end