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.



13026
13027
13028
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 13026

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) 


12907
12908
12909
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 12907

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) 


12913
12914
12915
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 12913

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:



12919
12920
12921
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 12919

def encryption_spec
  @encryption_spec
end

#end_time ⇒ String

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

Returns:

  • (String) 


12924
12925
12926
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 12924

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:



12934
12935
12936
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 12934

def error
  @error
end

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

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

Returns:



12939
12940
12941
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 12939

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


12950
12951
12952
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 12950

def labels
  @labels
end

#name ⇒ String

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

Returns:

  • (String) 


12955
12956
12957
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 12955

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) 


12969
12970
12971
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 12969

def network
  @network
end

#pipeline_spec ⇒ Hash<String,Object>

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

Returns:

  • (Hash<String,Object>) 


12974
12975
12976
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 12974

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


12983
12984
12985
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 12983

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:



12988
12989
12990
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 12988

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


12997
12998
12999
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 12997

def 
  @service_account
end

#start_time ⇒ String

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

Returns:

  • (String) 


13002
13003
13004
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 13002

def start_time
  @start_time
end

#state ⇒ String

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

Returns:

  • (String) 


13007
13008
13009
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 13007

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:



13013
13014
13015
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 13013

def template_metadata
  @template_metadata
end

#template_uri ⇒ String

A template uri from where the PipelineJob.pipeline_spec, if empty, will be downloaded. Corresponds to the JSON property templateUri

Returns:

  • (String) 


13019
13020
13021
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 13019

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) 


13024
13025
13026
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 13024

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



13031
13032
13033
13034
13035
13036
13037
13038
13039
13040
13041
13042
13043
13044
13045
13046
13047
13048
13049
13050
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 13031

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)
  @reserved_ip_ranges = args[:reserved_ip_ranges] if args.key?(:reserved_ip_ranges)
  @runtime_config = args[:runtime_config] if args.key?(:runtime_config)
  @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