Class: Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1PipelineJob

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

An instance of a machine learning PipelineJob.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudAiplatformV1beta1PipelineJob

Returns a new instance of GoogleCloudAiplatformV1beta1PipelineJob.



16941
16942
16943
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 16941

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) 


16808
16809
16810
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 16808

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) 


16814
16815
16816
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 16814

def display_name
  @display_name
end

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

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

Returns:



16820
16821
16822
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 16820

def encryption_spec
  @encryption_spec
end

#end_time ⇒ String

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

Returns:

  • (String) 


16825
16826
16827
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 16825

def end_time
  @end_time
end

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

Returns:



16835
16836
16837
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 16835

def error
  @error
end

#job_detail ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1PipelineJobDetail

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

Returns:



16840
16841
16842
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 16840

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


16851
16852
16853
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 16851

def labels
  @labels
end

#name ⇒ String

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

Returns:

  • (String) 


16856
16857
16858
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 16856

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) 


16870
16871
16872
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 16870

def network
  @network
end

#pipeline_spec ⇒ Hash<String,Object>

The spec of the pipeline. Corresponds to the JSON property pipelineSpec

Returns:

  • (Hash<String,Object>) 


16875
16876
16877
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 16875

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) 


16880
16881
16882
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 16880

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


16890
16891
16892
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 16890

def reserved_ip_ranges
  @reserved_ip_ranges
end

#runtime_config ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1PipelineJobRuntimeConfig

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

Returns:



16895
16896
16897
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 16895

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) 


16901
16902
16903
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 16901

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) 


16910
16911
16912
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 16910

def 
  @service_account
end

#start_time ⇒ String

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

Returns:

  • (String) 


16915
16916
16917
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 16915

def start_time
  @start_time
end

#state ⇒ String

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

Returns:

  • (String) 


16920
16921
16922
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 16920

def state
  @state
end

#template_metadata ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1PipelineTemplateMetadata

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:



16926
16927
16928
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 16926

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) 


16934
16935
16936
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 16934

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) 


16939
16940
16941
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 16939

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



16946
16947
16948
16949
16950
16951
16952
16953
16954
16955
16956
16957
16958
16959
16960
16961
16962
16963
16964
16965
16966
16967
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 16946

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