Class: Google::Cloud::AIPlatform::V1::PipelineJob

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/aiplatform/v1/pipeline_job.rb

Overview

An instance of a machine learning PipelineJob.

Defined Under Namespace

Classes: LabelsEntry, RuntimeConfig

Instance Attribute Summary collapse

Instance Attribute Details

#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. Pipeline creation time.

Returns:



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'proto_docs/google/cloud/aiplatform/v1/pipeline_job.rb', line 132

class PipelineJob
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The runtime config of a PipelineJob.
  # @!attribute [rw] parameters
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::AIPlatform::V1::Value}]
  #     Deprecated. Use
  #     {::Google::Cloud::AIPlatform::V1::PipelineJob::RuntimeConfig#parameter_values RuntimeConfig.parameter_values}
  #     instead. The runtime parameters of the PipelineJob. The parameters will
  #     be passed into
  #     {::Google::Cloud::AIPlatform::V1::PipelineJob#pipeline_spec PipelineJob.pipeline_spec}
  #     to replace the placeholders at runtime. This field is used by pipelines
  #     built using `PipelineJob.pipeline_spec.schema_version` 2.0.0 or lower,
  #     such as pipelines built using Kubeflow Pipelines SDK 1.8 or lower.
  # @!attribute [rw] gcs_output_directory
  #   @return [::String]
  #     Required. A path in a Cloud Storage bucket, which will be treated as the
  #     root output directory of the pipeline. It is used by the system to
  #     generate the paths of output artifacts. The artifact paths are generated
  #     with a sub-path pattern `{job_id}/{task_id}/{output_key}` under the
  #     specified output directory. The service account specified in this
  #     pipeline must have the `storage.objects.get` and `storage.objects.create`
  #     permissions for this bucket.
  # @!attribute [rw] parameter_values
  #   @return [::Google::Protobuf::Map{::String => ::Google::Protobuf::Value}]
  #     The runtime parameters of the PipelineJob. The parameters will be
  #     passed into
  #     {::Google::Cloud::AIPlatform::V1::PipelineJob#pipeline_spec PipelineJob.pipeline_spec}
  #     to replace the placeholders at runtime. This field is used by pipelines
  #     built using `PipelineJob.pipeline_spec.schema_version` 2.1.0, such as
  #     pipelines built using Kubeflow Pipelines SDK 1.9 or higher and the v2
  #     DSL.
  # @!attribute [rw] failure_policy
  #   @return [::Google::Cloud::AIPlatform::V1::PipelineFailurePolicy]
  #     Represents the failure policy of a pipeline. Currently, the default of a
  #     pipeline is that the pipeline will continue to run until no more tasks
  #     can be executed, also known as PIPELINE_FAILURE_POLICY_FAIL_SLOW.
  #     However, if a pipeline is set to PIPELINE_FAILURE_POLICY_FAIL_FAST, it
  #     will stop scheduling any new tasks when a task has failed. Any scheduled
  #     tasks will continue to completion.
  # @!attribute [rw] input_artifacts
  #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::AIPlatform::V1::PipelineJob::RuntimeConfig::InputArtifact}]
  #     The runtime artifacts of the PipelineJob. The key will be the input
  #     artifact name and the value would be one of the InputArtifact.
  class RuntimeConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The type of an input artifact.
    # @!attribute [rw] artifact_id
    #   @return [::String]
    #     Artifact resource id from MLMD. Which is the last portion of an
    #     artifact resource name:
    #     `projects/{project}/locations/{location}/metadataStores/default/artifacts/{artifact_id}`.
    #     The artifact must stay within the same project, location and default
    #     metadatastore as the pipeline.
    class InputArtifact
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Cloud::AIPlatform::V1::Value]
    class ParametersEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Protobuf::Value]
    class ParameterValuesEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Cloud::AIPlatform::V1::PipelineJob::RuntimeConfig::InputArtifact]
    class InputArtifactsEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#display_name ⇒ ::String

Returns The display name of the Pipeline. The name can be up to 128 characters long and can consist of any UTF-8 characters.

Returns:

  • (::String) —

    The display name of the Pipeline. The name can be up to 128 characters long and can consist of any UTF-8 characters.



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'proto_docs/google/cloud/aiplatform/v1/pipeline_job.rb', line 132

class PipelineJob
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The runtime config of a PipelineJob.
  # @!attribute [rw] parameters
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::AIPlatform::V1::Value}]
  #     Deprecated. Use
  #     {::Google::Cloud::AIPlatform::V1::PipelineJob::RuntimeConfig#parameter_values RuntimeConfig.parameter_values}
  #     instead. The runtime parameters of the PipelineJob. The parameters will
  #     be passed into
  #     {::Google::Cloud::AIPlatform::V1::PipelineJob#pipeline_spec PipelineJob.pipeline_spec}
  #     to replace the placeholders at runtime. This field is used by pipelines
  #     built using `PipelineJob.pipeline_spec.schema_version` 2.0.0 or lower,
  #     such as pipelines built using Kubeflow Pipelines SDK 1.8 or lower.
  # @!attribute [rw] gcs_output_directory
  #   @return [::String]
  #     Required. A path in a Cloud Storage bucket, which will be treated as the
  #     root output directory of the pipeline. It is used by the system to
  #     generate the paths of output artifacts. The artifact paths are generated
  #     with a sub-path pattern `{job_id}/{task_id}/{output_key}` under the
  #     specified output directory. The service account specified in this
  #     pipeline must have the `storage.objects.get` and `storage.objects.create`
  #     permissions for this bucket.
  # @!attribute [rw] parameter_values
  #   @return [::Google::Protobuf::Map{::String => ::Google::Protobuf::Value}]
  #     The runtime parameters of the PipelineJob. The parameters will be
  #     passed into
  #     {::Google::Cloud::AIPlatform::V1::PipelineJob#pipeline_spec PipelineJob.pipeline_spec}
  #     to replace the placeholders at runtime. This field is used by pipelines
  #     built using `PipelineJob.pipeline_spec.schema_version` 2.1.0, such as
  #     pipelines built using Kubeflow Pipelines SDK 1.9 or higher and the v2
  #     DSL.
  # @!attribute [rw] failure_policy
  #   @return [::Google::Cloud::AIPlatform::V1::PipelineFailurePolicy]
  #     Represents the failure policy of a pipeline. Currently, the default of a
  #     pipeline is that the pipeline will continue to run until no more tasks
  #     can be executed, also known as PIPELINE_FAILURE_POLICY_FAIL_SLOW.
  #     However, if a pipeline is set to PIPELINE_FAILURE_POLICY_FAIL_FAST, it
  #     will stop scheduling any new tasks when a task has failed. Any scheduled
  #     tasks will continue to completion.
  # @!attribute [rw] input_artifacts
  #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::AIPlatform::V1::PipelineJob::RuntimeConfig::InputArtifact}]
  #     The runtime artifacts of the PipelineJob. The key will be the input
  #     artifact name and the value would be one of the InputArtifact.
  class RuntimeConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The type of an input artifact.
    # @!attribute [rw] artifact_id
    #   @return [::String]
    #     Artifact resource id from MLMD. Which is the last portion of an
    #     artifact resource name:
    #     `projects/{project}/locations/{location}/metadataStores/default/artifacts/{artifact_id}`.
    #     The artifact must stay within the same project, location and default
    #     metadatastore as the pipeline.
    class InputArtifact
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Cloud::AIPlatform::V1::Value]
    class ParametersEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Protobuf::Value]
    class ParameterValuesEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Cloud::AIPlatform::V1::PipelineJob::RuntimeConfig::InputArtifact]
    class InputArtifactsEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#encryption_spec ⇒ ::Google::Cloud::AIPlatform::V1::EncryptionSpec

Returns Customer-managed encryption key spec for a pipelineJob. If set, this PipelineJob and all of its sub-resources will be secured by this key.

Returns:



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'proto_docs/google/cloud/aiplatform/v1/pipeline_job.rb', line 132

class PipelineJob
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The runtime config of a PipelineJob.
  # @!attribute [rw] parameters
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::AIPlatform::V1::Value}]
  #     Deprecated. Use
  #     {::Google::Cloud::AIPlatform::V1::PipelineJob::RuntimeConfig#parameter_values RuntimeConfig.parameter_values}
  #     instead. The runtime parameters of the PipelineJob. The parameters will
  #     be passed into
  #     {::Google::Cloud::AIPlatform::V1::PipelineJob#pipeline_spec PipelineJob.pipeline_spec}
  #     to replace the placeholders at runtime. This field is used by pipelines
  #     built using `PipelineJob.pipeline_spec.schema_version` 2.0.0 or lower,
  #     such as pipelines built using Kubeflow Pipelines SDK 1.8 or lower.
  # @!attribute [rw] gcs_output_directory
  #   @return [::String]
  #     Required. A path in a Cloud Storage bucket, which will be treated as the
  #     root output directory of the pipeline. It is used by the system to
  #     generate the paths of output artifacts. The artifact paths are generated
  #     with a sub-path pattern `{job_id}/{task_id}/{output_key}` under the
  #     specified output directory. The service account specified in this
  #     pipeline must have the `storage.objects.get` and `storage.objects.create`
  #     permissions for this bucket.
  # @!attribute [rw] parameter_values
  #   @return [::Google::Protobuf::Map{::String => ::Google::Protobuf::Value}]
  #     The runtime parameters of the PipelineJob. The parameters will be
  #     passed into
  #     {::Google::Cloud::AIPlatform::V1::PipelineJob#pipeline_spec PipelineJob.pipeline_spec}
  #     to replace the placeholders at runtime. This field is used by pipelines
  #     built using `PipelineJob.pipeline_spec.schema_version` 2.1.0, such as
  #     pipelines built using Kubeflow Pipelines SDK 1.9 or higher and the v2
  #     DSL.
  # @!attribute [rw] failure_policy
  #   @return [::Google::Cloud::AIPlatform::V1::PipelineFailurePolicy]
  #     Represents the failure policy of a pipeline. Currently, the default of a
  #     pipeline is that the pipeline will continue to run until no more tasks
  #     can be executed, also known as PIPELINE_FAILURE_POLICY_FAIL_SLOW.
  #     However, if a pipeline is set to PIPELINE_FAILURE_POLICY_FAIL_FAST, it
  #     will stop scheduling any new tasks when a task has failed. Any scheduled
  #     tasks will continue to completion.
  # @!attribute [rw] input_artifacts
  #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::AIPlatform::V1::PipelineJob::RuntimeConfig::InputArtifact}]
  #     The runtime artifacts of the PipelineJob. The key will be the input
  #     artifact name and the value would be one of the InputArtifact.
  class RuntimeConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The type of an input artifact.
    # @!attribute [rw] artifact_id
    #   @return [::String]
    #     Artifact resource id from MLMD. Which is the last portion of an
    #     artifact resource name:
    #     `projects/{project}/locations/{location}/metadataStores/default/artifacts/{artifact_id}`.
    #     The artifact must stay within the same project, location and default
    #     metadatastore as the pipeline.
    class InputArtifact
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Cloud::AIPlatform::V1::Value]
    class ParametersEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Protobuf::Value]
    class ParameterValuesEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Cloud::AIPlatform::V1::PipelineJob::RuntimeConfig::InputArtifact]
    class InputArtifactsEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#end_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. Pipeline end time.

Returns:



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'proto_docs/google/cloud/aiplatform/v1/pipeline_job.rb', line 132

class PipelineJob
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The runtime config of a PipelineJob.
  # @!attribute [rw] parameters
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::AIPlatform::V1::Value}]
  #     Deprecated. Use
  #     {::Google::Cloud::AIPlatform::V1::PipelineJob::RuntimeConfig#parameter_values RuntimeConfig.parameter_values}
  #     instead. The runtime parameters of the PipelineJob. The parameters will
  #     be passed into
  #     {::Google::Cloud::AIPlatform::V1::PipelineJob#pipeline_spec PipelineJob.pipeline_spec}
  #     to replace the placeholders at runtime. This field is used by pipelines
  #     built using `PipelineJob.pipeline_spec.schema_version` 2.0.0 or lower,
  #     such as pipelines built using Kubeflow Pipelines SDK 1.8 or lower.
  # @!attribute [rw] gcs_output_directory
  #   @return [::String]
  #     Required. A path in a Cloud Storage bucket, which will be treated as the
  #     root output directory of the pipeline. It is used by the system to
  #     generate the paths of output artifacts. The artifact paths are generated
  #     with a sub-path pattern `{job_id}/{task_id}/{output_key}` under the
  #     specified output directory. The service account specified in this
  #     pipeline must have the `storage.objects.get` and `storage.objects.create`
  #     permissions for this bucket.
  # @!attribute [rw] parameter_values
  #   @return [::Google::Protobuf::Map{::String => ::Google::Protobuf::Value}]
  #     The runtime parameters of the PipelineJob. The parameters will be
  #     passed into
  #     {::Google::Cloud::AIPlatform::V1::PipelineJob#pipeline_spec PipelineJob.pipeline_spec}
  #     to replace the placeholders at runtime. This field is used by pipelines
  #     built using `PipelineJob.pipeline_spec.schema_version` 2.1.0, such as
  #     pipelines built using Kubeflow Pipelines SDK 1.9 or higher and the v2
  #     DSL.
  # @!attribute [rw] failure_policy
  #   @return [::Google::Cloud::AIPlatform::V1::PipelineFailurePolicy]
  #     Represents the failure policy of a pipeline. Currently, the default of a
  #     pipeline is that the pipeline will continue to run until no more tasks
  #     can be executed, also known as PIPELINE_FAILURE_POLICY_FAIL_SLOW.
  #     However, if a pipeline is set to PIPELINE_FAILURE_POLICY_FAIL_FAST, it
  #     will stop scheduling any new tasks when a task has failed. Any scheduled
  #     tasks will continue to completion.
  # @!attribute [rw] input_artifacts
  #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::AIPlatform::V1::PipelineJob::RuntimeConfig::InputArtifact}]
  #     The runtime artifacts of the PipelineJob. The key will be the input
  #     artifact name and the value would be one of the InputArtifact.
  class RuntimeConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The type of an input artifact.
    # @!attribute [rw] artifact_id
    #   @return [::String]
    #     Artifact resource id from MLMD. Which is the last portion of an
    #     artifact resource name:
    #     `projects/{project}/locations/{location}/metadataStores/default/artifacts/{artifact_id}`.
    #     The artifact must stay within the same project, location and default
    #     metadatastore as the pipeline.
    class InputArtifact
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Cloud::AIPlatform::V1::Value]
    class ParametersEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Protobuf::Value]
    class ParameterValuesEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Cloud::AIPlatform::V1::PipelineJob::RuntimeConfig::InputArtifact]
    class InputArtifactsEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#error ⇒ ::Google::Rpc::Status (readonly)

Returns Output only. The error that occurred during pipeline execution. Only populated when the pipeline's state is FAILED or CANCELLED.

Returns:

  • (::Google::Rpc::Status) —

    Output only. The error that occurred during pipeline execution. Only populated when the pipeline's state is FAILED or CANCELLED.



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'proto_docs/google/cloud/aiplatform/v1/pipeline_job.rb', line 132

class PipelineJob
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The runtime config of a PipelineJob.
  # @!attribute [rw] parameters
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::AIPlatform::V1::Value}]
  #     Deprecated. Use
  #     {::Google::Cloud::AIPlatform::V1::PipelineJob::RuntimeConfig#parameter_values RuntimeConfig.parameter_values}
  #     instead. The runtime parameters of the PipelineJob. The parameters will
  #     be passed into
  #     {::Google::Cloud::AIPlatform::V1::PipelineJob#pipeline_spec PipelineJob.pipeline_spec}
  #     to replace the placeholders at runtime. This field is used by pipelines
  #     built using `PipelineJob.pipeline_spec.schema_version` 2.0.0 or lower,
  #     such as pipelines built using Kubeflow Pipelines SDK 1.8 or lower.
  # @!attribute [rw] gcs_output_directory
  #   @return [::String]
  #     Required. A path in a Cloud Storage bucket, which will be treated as the
  #     root output directory of the pipeline. It is used by the system to
  #     generate the paths of output artifacts. The artifact paths are generated
  #     with a sub-path pattern `{job_id}/{task_id}/{output_key}` under the
  #     specified output directory. The service account specified in this
  #     pipeline must have the `storage.objects.get` and `storage.objects.create`
  #     permissions for this bucket.
  # @!attribute [rw] parameter_values
  #   @return [::Google::Protobuf::Map{::String => ::Google::Protobuf::Value}]
  #     The runtime parameters of the PipelineJob. The parameters will be
  #     passed into
  #     {::Google::Cloud::AIPlatform::V1::PipelineJob#pipeline_spec PipelineJob.pipeline_spec}
  #     to replace the placeholders at runtime. This field is used by pipelines
  #     built using `PipelineJob.pipeline_spec.schema_version` 2.1.0, such as
  #     pipelines built using Kubeflow Pipelines SDK 1.9 or higher and the v2
  #     DSL.
  # @!attribute [rw] failure_policy
  #   @return [::Google::Cloud::AIPlatform::V1::PipelineFailurePolicy]
  #     Represents the failure policy of a pipeline. Currently, the default of a
  #     pipeline is that the pipeline will continue to run until no more tasks
  #     can be executed, also known as PIPELINE_FAILURE_POLICY_FAIL_SLOW.
  #     However, if a pipeline is set to PIPELINE_FAILURE_POLICY_FAIL_FAST, it
  #     will stop scheduling any new tasks when a task has failed. Any scheduled
  #     tasks will continue to completion.
  # @!attribute [rw] input_artifacts
  #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::AIPlatform::V1::PipelineJob::RuntimeConfig::InputArtifact}]
  #     The runtime artifacts of the PipelineJob. The key will be the input
  #     artifact name and the value would be one of the InputArtifact.
  class RuntimeConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The type of an input artifact.
    # @!attribute [rw] artifact_id
    #   @return [::String]
    #     Artifact resource id from MLMD. Which is the last portion of an
    #     artifact resource name:
    #     `projects/{project}/locations/{location}/metadataStores/default/artifacts/{artifact_id}`.
    #     The artifact must stay within the same project, location and default
    #     metadatastore as the pipeline.
    class InputArtifact
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Cloud::AIPlatform::V1::Value]
    class ParametersEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Protobuf::Value]
    class ParameterValuesEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Cloud::AIPlatform::V1::PipelineJob::RuntimeConfig::InputArtifact]
    class InputArtifactsEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#job_detail ⇒ ::Google::Cloud::AIPlatform::V1::PipelineJobDetail (readonly)

Returns Output only. The details of pipeline run. Not available in the list view.

Returns:



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'proto_docs/google/cloud/aiplatform/v1/pipeline_job.rb', line 132

class PipelineJob
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The runtime config of a PipelineJob.
  # @!attribute [rw] parameters
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::AIPlatform::V1::Value}]
  #     Deprecated. Use
  #     {::Google::Cloud::AIPlatform::V1::PipelineJob::RuntimeConfig#parameter_values RuntimeConfig.parameter_values}
  #     instead. The runtime parameters of the PipelineJob. The parameters will
  #     be passed into
  #     {::Google::Cloud::AIPlatform::V1::PipelineJob#pipeline_spec PipelineJob.pipeline_spec}
  #     to replace the placeholders at runtime. This field is used by pipelines
  #     built using `PipelineJob.pipeline_spec.schema_version` 2.0.0 or lower,
  #     such as pipelines built using Kubeflow Pipelines SDK 1.8 or lower.
  # @!attribute [rw] gcs_output_directory
  #   @return [::String]
  #     Required. A path in a Cloud Storage bucket, which will be treated as the
  #     root output directory of the pipeline. It is used by the system to
  #     generate the paths of output artifacts. The artifact paths are generated
  #     with a sub-path pattern `{job_id}/{task_id}/{output_key}` under the
  #     specified output directory. The service account specified in this
  #     pipeline must have the `storage.objects.get` and `storage.objects.create`
  #     permissions for this bucket.
  # @!attribute [rw] parameter_values
  #   @return [::Google::Protobuf::Map{::String => ::Google::Protobuf::Value}]
  #     The runtime parameters of the PipelineJob. The parameters will be
  #     passed into
  #     {::Google::Cloud::AIPlatform::V1::PipelineJob#pipeline_spec PipelineJob.pipeline_spec}
  #     to replace the placeholders at runtime. This field is used by pipelines
  #     built using `PipelineJob.pipeline_spec.schema_version` 2.1.0, such as
  #     pipelines built using Kubeflow Pipelines SDK 1.9 or higher and the v2
  #     DSL.
  # @!attribute [rw] failure_policy
  #   @return [::Google::Cloud::AIPlatform::V1::PipelineFailurePolicy]
  #     Represents the failure policy of a pipeline. Currently, the default of a
  #     pipeline is that the pipeline will continue to run until no more tasks
  #     can be executed, also known as PIPELINE_FAILURE_POLICY_FAIL_SLOW.
  #     However, if a pipeline is set to PIPELINE_FAILURE_POLICY_FAIL_FAST, it
  #     will stop scheduling any new tasks when a task has failed. Any scheduled
  #     tasks will continue to completion.
  # @!attribute [rw] input_artifacts
  #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::AIPlatform::V1::PipelineJob::RuntimeConfig::InputArtifact}]
  #     The runtime artifacts of the PipelineJob. The key will be the input
  #     artifact name and the value would be one of the InputArtifact.
  class RuntimeConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The type of an input artifact.
    # @!attribute [rw] artifact_id
    #   @return [::String]
    #     Artifact resource id from MLMD. Which is the last portion of an
    #     artifact resource name:
    #     `projects/{project}/locations/{location}/metadataStores/default/artifacts/{artifact_id}`.
    #     The artifact must stay within the same project, location and default
    #     metadatastore as the pipeline.
    class InputArtifact
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Cloud::AIPlatform::V1::Value]
    class ParametersEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Protobuf::Value]
    class ParameterValuesEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Cloud::AIPlatform::V1::PipelineJob::RuntimeConfig::InputArtifact]
    class InputArtifactsEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#labels ⇒ ::Google::Protobuf::Map{::String => ::String}

Returns 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.

Returns:

  • (::Google::Protobuf::Map{::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.


132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'proto_docs/google/cloud/aiplatform/v1/pipeline_job.rb', line 132

class PipelineJob
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The runtime config of a PipelineJob.
  # @!attribute [rw] parameters
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::AIPlatform::V1::Value}]
  #     Deprecated. Use
  #     {::Google::Cloud::AIPlatform::V1::PipelineJob::RuntimeConfig#parameter_values RuntimeConfig.parameter_values}
  #     instead. The runtime parameters of the PipelineJob. The parameters will
  #     be passed into
  #     {::Google::Cloud::AIPlatform::V1::PipelineJob#pipeline_spec PipelineJob.pipeline_spec}
  #     to replace the placeholders at runtime. This field is used by pipelines
  #     built using `PipelineJob.pipeline_spec.schema_version` 2.0.0 or lower,
  #     such as pipelines built using Kubeflow Pipelines SDK 1.8 or lower.
  # @!attribute [rw] gcs_output_directory
  #   @return [::String]
  #     Required. A path in a Cloud Storage bucket, which will be treated as the
  #     root output directory of the pipeline. It is used by the system to
  #     generate the paths of output artifacts. The artifact paths are generated
  #     with a sub-path pattern `{job_id}/{task_id}/{output_key}` under the
  #     specified output directory. The service account specified in this
  #     pipeline must have the `storage.objects.get` and `storage.objects.create`
  #     permissions for this bucket.
  # @!attribute [rw] parameter_values
  #   @return [::Google::Protobuf::Map{::String => ::Google::Protobuf::Value}]
  #     The runtime parameters of the PipelineJob. The parameters will be
  #     passed into
  #     {::Google::Cloud::AIPlatform::V1::PipelineJob#pipeline_spec PipelineJob.pipeline_spec}
  #     to replace the placeholders at runtime. This field is used by pipelines
  #     built using `PipelineJob.pipeline_spec.schema_version` 2.1.0, such as
  #     pipelines built using Kubeflow Pipelines SDK 1.9 or higher and the v2
  #     DSL.
  # @!attribute [rw] failure_policy
  #   @return [::Google::Cloud::AIPlatform::V1::PipelineFailurePolicy]
  #     Represents the failure policy of a pipeline. Currently, the default of a
  #     pipeline is that the pipeline will continue to run until no more tasks
  #     can be executed, also known as PIPELINE_FAILURE_POLICY_FAIL_SLOW.
  #     However, if a pipeline is set to PIPELINE_FAILURE_POLICY_FAIL_FAST, it
  #     will stop scheduling any new tasks when a task has failed. Any scheduled
  #     tasks will continue to completion.
  # @!attribute [rw] input_artifacts
  #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::AIPlatform::V1::PipelineJob::RuntimeConfig::InputArtifact}]
  #     The runtime artifacts of the PipelineJob. The key will be the input
  #     artifact name and the value would be one of the InputArtifact.
  class RuntimeConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The type of an input artifact.
    # @!attribute [rw] artifact_id
    #   @return [::String]
    #     Artifact resource id from MLMD. Which is the last portion of an
    #     artifact resource name:
    #     `projects/{project}/locations/{location}/metadataStores/default/artifacts/{artifact_id}`.
    #     The artifact must stay within the same project, location and default
    #     metadatastore as the pipeline.
    class InputArtifact
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Cloud::AIPlatform::V1::Value]
    class ParametersEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Protobuf::Value]
    class ParameterValuesEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Cloud::AIPlatform::V1::PipelineJob::RuntimeConfig::InputArtifact]
    class InputArtifactsEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#name ⇒ ::String (readonly)

Returns Output only. The resource name of the PipelineJob.

Returns:

  • (::String) —

    Output only. The resource name of the PipelineJob.



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'proto_docs/google/cloud/aiplatform/v1/pipeline_job.rb', line 132

class PipelineJob
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The runtime config of a PipelineJob.
  # @!attribute [rw] parameters
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::AIPlatform::V1::Value}]
  #     Deprecated. Use
  #     {::Google::Cloud::AIPlatform::V1::PipelineJob::RuntimeConfig#parameter_values RuntimeConfig.parameter_values}
  #     instead. The runtime parameters of the PipelineJob. The parameters will
  #     be passed into
  #     {::Google::Cloud::AIPlatform::V1::PipelineJob#pipeline_spec PipelineJob.pipeline_spec}
  #     to replace the placeholders at runtime. This field is used by pipelines
  #     built using `PipelineJob.pipeline_spec.schema_version` 2.0.0 or lower,
  #     such as pipelines built using Kubeflow Pipelines SDK 1.8 or lower.
  # @!attribute [rw] gcs_output_directory
  #   @return [::String]
  #     Required. A path in a Cloud Storage bucket, which will be treated as the
  #     root output directory of the pipeline. It is used by the system to
  #     generate the paths of output artifacts. The artifact paths are generated
  #     with a sub-path pattern `{job_id}/{task_id}/{output_key}` under the
  #     specified output directory. The service account specified in this
  #     pipeline must have the `storage.objects.get` and `storage.objects.create`
  #     permissions for this bucket.
  # @!attribute [rw] parameter_values
  #   @return [::Google::Protobuf::Map{::String => ::Google::Protobuf::Value}]
  #     The runtime parameters of the PipelineJob. The parameters will be
  #     passed into
  #     {::Google::Cloud::AIPlatform::V1::PipelineJob#pipeline_spec PipelineJob.pipeline_spec}
  #     to replace the placeholders at runtime. This field is used by pipelines
  #     built using `PipelineJob.pipeline_spec.schema_version` 2.1.0, such as
  #     pipelines built using Kubeflow Pipelines SDK 1.9 or higher and the v2
  #     DSL.
  # @!attribute [rw] failure_policy
  #   @return [::Google::Cloud::AIPlatform::V1::PipelineFailurePolicy]
  #     Represents the failure policy of a pipeline. Currently, the default of a
  #     pipeline is that the pipeline will continue to run until no more tasks
  #     can be executed, also known as PIPELINE_FAILURE_POLICY_FAIL_SLOW.
  #     However, if a pipeline is set to PIPELINE_FAILURE_POLICY_FAIL_FAST, it
  #     will stop scheduling any new tasks when a task has failed. Any scheduled
  #     tasks will continue to completion.
  # @!attribute [rw] input_artifacts
  #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::AIPlatform::V1::PipelineJob::RuntimeConfig::InputArtifact}]
  #     The runtime artifacts of the PipelineJob. The key will be the input
  #     artifact name and the value would be one of the InputArtifact.
  class RuntimeConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The type of an input artifact.
    # @!attribute [rw] artifact_id
    #   @return [::String]
    #     Artifact resource id from MLMD. Which is the last portion of an
    #     artifact resource name:
    #     `projects/{project}/locations/{location}/metadataStores/default/artifacts/{artifact_id}`.
    #     The artifact must stay within the same project, location and default
    #     metadatastore as the pipeline.
    class InputArtifact
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Cloud::AIPlatform::V1::Value]
    class ParametersEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Protobuf::Value]
    class ParameterValuesEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Cloud::AIPlatform::V1::PipelineJob::RuntimeConfig::InputArtifact]
    class InputArtifactsEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#network ⇒ ::String

Returns 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}. Where {project} is a project number, as in 12345, and {network} is 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.

Returns:

  • (::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}. Where {project} is a project number, as in 12345, and {network} is 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.



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'proto_docs/google/cloud/aiplatform/v1/pipeline_job.rb', line 132

class PipelineJob
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The runtime config of a PipelineJob.
  # @!attribute [rw] parameters
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::AIPlatform::V1::Value}]
  #     Deprecated. Use
  #     {::Google::Cloud::AIPlatform::V1::PipelineJob::RuntimeConfig#parameter_values RuntimeConfig.parameter_values}
  #     instead. The runtime parameters of the PipelineJob. The parameters will
  #     be passed into
  #     {::Google::Cloud::AIPlatform::V1::PipelineJob#pipeline_spec PipelineJob.pipeline_spec}
  #     to replace the placeholders at runtime. This field is used by pipelines
  #     built using `PipelineJob.pipeline_spec.schema_version` 2.0.0 or lower,
  #     such as pipelines built using Kubeflow Pipelines SDK 1.8 or lower.
  # @!attribute [rw] gcs_output_directory
  #   @return [::String]
  #     Required. A path in a Cloud Storage bucket, which will be treated as the
  #     root output directory of the pipeline. It is used by the system to
  #     generate the paths of output artifacts. The artifact paths are generated
  #     with a sub-path pattern `{job_id}/{task_id}/{output_key}` under the
  #     specified output directory. The service account specified in this
  #     pipeline must have the `storage.objects.get` and `storage.objects.create`
  #     permissions for this bucket.
  # @!attribute [rw] parameter_values
  #   @return [::Google::Protobuf::Map{::String => ::Google::Protobuf::Value}]
  #     The runtime parameters of the PipelineJob. The parameters will be
  #     passed into
  #     {::Google::Cloud::AIPlatform::V1::PipelineJob#pipeline_spec PipelineJob.pipeline_spec}
  #     to replace the placeholders at runtime. This field is used by pipelines
  #     built using `PipelineJob.pipeline_spec.schema_version` 2.1.0, such as
  #     pipelines built using Kubeflow Pipelines SDK 1.9 or higher and the v2
  #     DSL.
  # @!attribute [rw] failure_policy
  #   @return [::Google::Cloud::AIPlatform::V1::PipelineFailurePolicy]
  #     Represents the failure policy of a pipeline. Currently, the default of a
  #     pipeline is that the pipeline will continue to run until no more tasks
  #     can be executed, also known as PIPELINE_FAILURE_POLICY_FAIL_SLOW.
  #     However, if a pipeline is set to PIPELINE_FAILURE_POLICY_FAIL_FAST, it
  #     will stop scheduling any new tasks when a task has failed. Any scheduled
  #     tasks will continue to completion.
  # @!attribute [rw] input_artifacts
  #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::AIPlatform::V1::PipelineJob::RuntimeConfig::InputArtifact}]
  #     The runtime artifacts of the PipelineJob. The key will be the input
  #     artifact name and the value would be one of the InputArtifact.
  class RuntimeConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The type of an input artifact.
    # @!attribute [rw] artifact_id
    #   @return [::String]
    #     Artifact resource id from MLMD. Which is the last portion of an
    #     artifact resource name:
    #     `projects/{project}/locations/{location}/metadataStores/default/artifacts/{artifact_id}`.
    #     The artifact must stay within the same project, location and default
    #     metadatastore as the pipeline.
    class InputArtifact
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Cloud::AIPlatform::V1::Value]
    class ParametersEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Protobuf::Value]
    class ParameterValuesEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Cloud::AIPlatform::V1::PipelineJob::RuntimeConfig::InputArtifact]
    class InputArtifactsEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#pipeline_spec ⇒ ::Google::Protobuf::Struct

Returns The spec of the pipeline.

Returns:



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'proto_docs/google/cloud/aiplatform/v1/pipeline_job.rb', line 132

class PipelineJob
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The runtime config of a PipelineJob.
  # @!attribute [rw] parameters
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::AIPlatform::V1::Value}]
  #     Deprecated. Use
  #     {::Google::Cloud::AIPlatform::V1::PipelineJob::RuntimeConfig#parameter_values RuntimeConfig.parameter_values}
  #     instead. The runtime parameters of the PipelineJob. The parameters will
  #     be passed into
  #     {::Google::Cloud::AIPlatform::V1::PipelineJob#pipeline_spec PipelineJob.pipeline_spec}
  #     to replace the placeholders at runtime. This field is used by pipelines
  #     built using `PipelineJob.pipeline_spec.schema_version` 2.0.0 or lower,
  #     such as pipelines built using Kubeflow Pipelines SDK 1.8 or lower.
  # @!attribute [rw] gcs_output_directory
  #   @return [::String]
  #     Required. A path in a Cloud Storage bucket, which will be treated as the
  #     root output directory of the pipeline. It is used by the system to
  #     generate the paths of output artifacts. The artifact paths are generated
  #     with a sub-path pattern `{job_id}/{task_id}/{output_key}` under the
  #     specified output directory. The service account specified in this
  #     pipeline must have the `storage.objects.get` and `storage.objects.create`
  #     permissions for this bucket.
  # @!attribute [rw] parameter_values
  #   @return [::Google::Protobuf::Map{::String => ::Google::Protobuf::Value}]
  #     The runtime parameters of the PipelineJob. The parameters will be
  #     passed into
  #     {::Google::Cloud::AIPlatform::V1::PipelineJob#pipeline_spec PipelineJob.pipeline_spec}
  #     to replace the placeholders at runtime. This field is used by pipelines
  #     built using `PipelineJob.pipeline_spec.schema_version` 2.1.0, such as
  #     pipelines built using Kubeflow Pipelines SDK 1.9 or higher and the v2
  #     DSL.
  # @!attribute [rw] failure_policy
  #   @return [::Google::Cloud::AIPlatform::V1::PipelineFailurePolicy]
  #     Represents the failure policy of a pipeline. Currently, the default of a
  #     pipeline is that the pipeline will continue to run until no more tasks
  #     can be executed, also known as PIPELINE_FAILURE_POLICY_FAIL_SLOW.
  #     However, if a pipeline is set to PIPELINE_FAILURE_POLICY_FAIL_FAST, it
  #     will stop scheduling any new tasks when a task has failed. Any scheduled
  #     tasks will continue to completion.
  # @!attribute [rw] input_artifacts
  #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::AIPlatform::V1::PipelineJob::RuntimeConfig::InputArtifact}]
  #     The runtime artifacts of the PipelineJob. The key will be the input
  #     artifact name and the value would be one of the InputArtifact.
  class RuntimeConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The type of an input artifact.
    # @!attribute [rw] artifact_id
    #   @return [::String]
    #     Artifact resource id from MLMD. Which is the last portion of an
    #     artifact resource name:
    #     `projects/{project}/locations/{location}/metadataStores/default/artifacts/{artifact_id}`.
    #     The artifact must stay within the same project, location and default
    #     metadatastore as the pipeline.
    class InputArtifact
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Cloud::AIPlatform::V1::Value]
    class ParametersEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Protobuf::Value]
    class ParameterValuesEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Cloud::AIPlatform::V1::PipelineJob::RuntimeConfig::InputArtifact]
    class InputArtifactsEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#preflight_validations ⇒ ::Boolean

Returns Optional. Whether to do component level validations before job creation.

Returns:

  • (::Boolean) —

    Optional. Whether to do component level validations before job creation.



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'proto_docs/google/cloud/aiplatform/v1/pipeline_job.rb', line 132

class PipelineJob
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The runtime config of a PipelineJob.
  # @!attribute [rw] parameters
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::AIPlatform::V1::Value}]
  #     Deprecated. Use
  #     {::Google::Cloud::AIPlatform::V1::PipelineJob::RuntimeConfig#parameter_values RuntimeConfig.parameter_values}
  #     instead. The runtime parameters of the PipelineJob. The parameters will
  #     be passed into
  #     {::Google::Cloud::AIPlatform::V1::PipelineJob#pipeline_spec PipelineJob.pipeline_spec}
  #     to replace the placeholders at runtime. This field is used by pipelines
  #     built using `PipelineJob.pipeline_spec.schema_version` 2.0.0 or lower,
  #     such as pipelines built using Kubeflow Pipelines SDK 1.8 or lower.
  # @!attribute [rw] gcs_output_directory
  #   @return [::String]
  #     Required. A path in a Cloud Storage bucket, which will be treated as the
  #     root output directory of the pipeline. It is used by the system to
  #     generate the paths of output artifacts. The artifact paths are generated
  #     with a sub-path pattern `{job_id}/{task_id}/{output_key}` under the
  #     specified output directory. The service account specified in this
  #     pipeline must have the `storage.objects.get` and `storage.objects.create`
  #     permissions for this bucket.
  # @!attribute [rw] parameter_values
  #   @return [::Google::Protobuf::Map{::String => ::Google::Protobuf::Value}]
  #     The runtime parameters of the PipelineJob. The parameters will be
  #     passed into
  #     {::Google::Cloud::AIPlatform::V1::PipelineJob#pipeline_spec PipelineJob.pipeline_spec}
  #     to replace the placeholders at runtime. This field is used by pipelines
  #     built using `PipelineJob.pipeline_spec.schema_version` 2.1.0, such as
  #     pipelines built using Kubeflow Pipelines SDK 1.9 or higher and the v2
  #     DSL.
  # @!attribute [rw] failure_policy
  #   @return [::Google::Cloud::AIPlatform::V1::PipelineFailurePolicy]
  #     Represents the failure policy of a pipeline. Currently, the default of a
  #     pipeline is that the pipeline will continue to run until no more tasks
  #     can be executed, also known as PIPELINE_FAILURE_POLICY_FAIL_SLOW.
  #     However, if a pipeline is set to PIPELINE_FAILURE_POLICY_FAIL_FAST, it
  #     will stop scheduling any new tasks when a task has failed. Any scheduled
  #     tasks will continue to completion.
  # @!attribute [rw] input_artifacts
  #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::AIPlatform::V1::PipelineJob::RuntimeConfig::InputArtifact}]
  #     The runtime artifacts of the PipelineJob. The key will be the input
  #     artifact name and the value would be one of the InputArtifact.
  class RuntimeConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The type of an input artifact.
    # @!attribute [rw] artifact_id
    #   @return [::String]
    #     Artifact resource id from MLMD. Which is the last portion of an
    #     artifact resource name:
    #     `projects/{project}/locations/{location}/metadataStores/default/artifacts/{artifact_id}`.
    #     The artifact must stay within the same project, location and default
    #     metadatastore as the pipeline.
    class InputArtifact
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Cloud::AIPlatform::V1::Value]
    class ParametersEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Protobuf::Value]
    class ParameterValuesEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Cloud::AIPlatform::V1::PipelineJob::RuntimeConfig::InputArtifact]
    class InputArtifactsEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#reserved_ip_ranges ⇒ ::Array<::String>

Returns 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'].

Returns:

  • (::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'].



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'proto_docs/google/cloud/aiplatform/v1/pipeline_job.rb', line 132

class PipelineJob
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The runtime config of a PipelineJob.
  # @!attribute [rw] parameters
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::AIPlatform::V1::Value}]
  #     Deprecated. Use
  #     {::Google::Cloud::AIPlatform::V1::PipelineJob::RuntimeConfig#parameter_values RuntimeConfig.parameter_values}
  #     instead. The runtime parameters of the PipelineJob. The parameters will
  #     be passed into
  #     {::Google::Cloud::AIPlatform::V1::PipelineJob#pipeline_spec PipelineJob.pipeline_spec}
  #     to replace the placeholders at runtime. This field is used by pipelines
  #     built using `PipelineJob.pipeline_spec.schema_version` 2.0.0 or lower,
  #     such as pipelines built using Kubeflow Pipelines SDK 1.8 or lower.
  # @!attribute [rw] gcs_output_directory
  #   @return [::String]
  #     Required. A path in a Cloud Storage bucket, which will be treated as the
  #     root output directory of the pipeline. It is used by the system to
  #     generate the paths of output artifacts. The artifact paths are generated
  #     with a sub-path pattern `{job_id}/{task_id}/{output_key}` under the
  #     specified output directory. The service account specified in this
  #     pipeline must have the `storage.objects.get` and `storage.objects.create`
  #     permissions for this bucket.
  # @!attribute [rw] parameter_values
  #   @return [::Google::Protobuf::Map{::String => ::Google::Protobuf::Value}]
  #     The runtime parameters of the PipelineJob. The parameters will be
  #     passed into
  #     {::Google::Cloud::AIPlatform::V1::PipelineJob#pipeline_spec PipelineJob.pipeline_spec}
  #     to replace the placeholders at runtime. This field is used by pipelines
  #     built using `PipelineJob.pipeline_spec.schema_version` 2.1.0, such as
  #     pipelines built using Kubeflow Pipelines SDK 1.9 or higher and the v2
  #     DSL.
  # @!attribute [rw] failure_policy
  #   @return [::Google::Cloud::AIPlatform::V1::PipelineFailurePolicy]
  #     Represents the failure policy of a pipeline. Currently, the default of a
  #     pipeline is that the pipeline will continue to run until no more tasks
  #     can be executed, also known as PIPELINE_FAILURE_POLICY_FAIL_SLOW.
  #     However, if a pipeline is set to PIPELINE_FAILURE_POLICY_FAIL_FAST, it
  #     will stop scheduling any new tasks when a task has failed. Any scheduled
  #     tasks will continue to completion.
  # @!attribute [rw] input_artifacts
  #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::AIPlatform::V1::PipelineJob::RuntimeConfig::InputArtifact}]
  #     The runtime artifacts of the PipelineJob. The key will be the input
  #     artifact name and the value would be one of the InputArtifact.
  class RuntimeConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The type of an input artifact.
    # @!attribute [rw] artifact_id
    #   @return [::String]
    #     Artifact resource id from MLMD. Which is the last portion of an
    #     artifact resource name:
    #     `projects/{project}/locations/{location}/metadataStores/default/artifacts/{artifact_id}`.
    #     The artifact must stay within the same project, location and default
    #     metadatastore as the pipeline.
    class InputArtifact
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Cloud::AIPlatform::V1::Value]
    class ParametersEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Protobuf::Value]
    class ParameterValuesEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Cloud::AIPlatform::V1::PipelineJob::RuntimeConfig::InputArtifact]
    class InputArtifactsEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#runtime_config ⇒ ::Google::Cloud::AIPlatform::V1::PipelineJob::RuntimeConfig

Returns Runtime config of the pipeline.

Returns:



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'proto_docs/google/cloud/aiplatform/v1/pipeline_job.rb', line 132

class PipelineJob
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The runtime config of a PipelineJob.
  # @!attribute [rw] parameters
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::AIPlatform::V1::Value}]
  #     Deprecated. Use
  #     {::Google::Cloud::AIPlatform::V1::PipelineJob::RuntimeConfig#parameter_values RuntimeConfig.parameter_values}
  #     instead. The runtime parameters of the PipelineJob. The parameters will
  #     be passed into
  #     {::Google::Cloud::AIPlatform::V1::PipelineJob#pipeline_spec PipelineJob.pipeline_spec}
  #     to replace the placeholders at runtime. This field is used by pipelines
  #     built using `PipelineJob.pipeline_spec.schema_version` 2.0.0 or lower,
  #     such as pipelines built using Kubeflow Pipelines SDK 1.8 or lower.
  # @!attribute [rw] gcs_output_directory
  #   @return [::String]
  #     Required. A path in a Cloud Storage bucket, which will be treated as the
  #     root output directory of the pipeline. It is used by the system to
  #     generate the paths of output artifacts. The artifact paths are generated
  #     with a sub-path pattern `{job_id}/{task_id}/{output_key}` under the
  #     specified output directory. The service account specified in this
  #     pipeline must have the `storage.objects.get` and `storage.objects.create`
  #     permissions for this bucket.
  # @!attribute [rw] parameter_values
  #   @return [::Google::Protobuf::Map{::String => ::Google::Protobuf::Value}]
  #     The runtime parameters of the PipelineJob. The parameters will be
  #     passed into
  #     {::Google::Cloud::AIPlatform::V1::PipelineJob#pipeline_spec PipelineJob.pipeline_spec}
  #     to replace the placeholders at runtime. This field is used by pipelines
  #     built using `PipelineJob.pipeline_spec.schema_version` 2.1.0, such as
  #     pipelines built using Kubeflow Pipelines SDK 1.9 or higher and the v2
  #     DSL.
  # @!attribute [rw] failure_policy
  #   @return [::Google::Cloud::AIPlatform::V1::PipelineFailurePolicy]
  #     Represents the failure policy of a pipeline. Currently, the default of a
  #     pipeline is that the pipeline will continue to run until no more tasks
  #     can be executed, also known as PIPELINE_FAILURE_POLICY_FAIL_SLOW.
  #     However, if a pipeline is set to PIPELINE_FAILURE_POLICY_FAIL_FAST, it
  #     will stop scheduling any new tasks when a task has failed. Any scheduled
  #     tasks will continue to completion.
  # @!attribute [rw] input_artifacts
  #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::AIPlatform::V1::PipelineJob::RuntimeConfig::InputArtifact}]
  #     The runtime artifacts of the PipelineJob. The key will be the input
  #     artifact name and the value would be one of the InputArtifact.
  class RuntimeConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The type of an input artifact.
    # @!attribute [rw] artifact_id
    #   @return [::String]
    #     Artifact resource id from MLMD. Which is the last portion of an
    #     artifact resource name:
    #     `projects/{project}/locations/{location}/metadataStores/default/artifacts/{artifact_id}`.
    #     The artifact must stay within the same project, location and default
    #     metadatastore as the pipeline.
    class InputArtifact
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Cloud::AIPlatform::V1::Value]
    class ParametersEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Protobuf::Value]
    class ParameterValuesEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Cloud::AIPlatform::V1::PipelineJob::RuntimeConfig::InputArtifact]
    class InputArtifactsEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#schedule_name ⇒ ::String (readonly)

Returns Output only. The schedule resource name. Only returned if the Pipeline is created by Schedule API.

Returns:

  • (::String) —

    Output only. The schedule resource name. Only returned if the Pipeline is created by Schedule API.



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'proto_docs/google/cloud/aiplatform/v1/pipeline_job.rb', line 132

class PipelineJob
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The runtime config of a PipelineJob.
  # @!attribute [rw] parameters
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::AIPlatform::V1::Value}]
  #     Deprecated. Use
  #     {::Google::Cloud::AIPlatform::V1::PipelineJob::RuntimeConfig#parameter_values RuntimeConfig.parameter_values}
  #     instead. The runtime parameters of the PipelineJob. The parameters will
  #     be passed into
  #     {::Google::Cloud::AIPlatform::V1::PipelineJob#pipeline_spec PipelineJob.pipeline_spec}
  #     to replace the placeholders at runtime. This field is used by pipelines
  #     built using `PipelineJob.pipeline_spec.schema_version` 2.0.0 or lower,
  #     such as pipelines built using Kubeflow Pipelines SDK 1.8 or lower.
  # @!attribute [rw] gcs_output_directory
  #   @return [::String]
  #     Required. A path in a Cloud Storage bucket, which will be treated as the
  #     root output directory of the pipeline. It is used by the system to
  #     generate the paths of output artifacts. The artifact paths are generated
  #     with a sub-path pattern `{job_id}/{task_id}/{output_key}` under the
  #     specified output directory. The service account specified in this
  #     pipeline must have the `storage.objects.get` and `storage.objects.create`
  #     permissions for this bucket.
  # @!attribute [rw] parameter_values
  #   @return [::Google::Protobuf::Map{::String => ::Google::Protobuf::Value}]
  #     The runtime parameters of the PipelineJob. The parameters will be
  #     passed into
  #     {::Google::Cloud::AIPlatform::V1::PipelineJob#pipeline_spec PipelineJob.pipeline_spec}
  #     to replace the placeholders at runtime. This field is used by pipelines
  #     built using `PipelineJob.pipeline_spec.schema_version` 2.1.0, such as
  #     pipelines built using Kubeflow Pipelines SDK 1.9 or higher and the v2
  #     DSL.
  # @!attribute [rw] failure_policy
  #   @return [::Google::Cloud::AIPlatform::V1::PipelineFailurePolicy]
  #     Represents the failure policy of a pipeline. Currently, the default of a
  #     pipeline is that the pipeline will continue to run until no more tasks
  #     can be executed, also known as PIPELINE_FAILURE_POLICY_FAIL_SLOW.
  #     However, if a pipeline is set to PIPELINE_FAILURE_POLICY_FAIL_FAST, it
  #     will stop scheduling any new tasks when a task has failed. Any scheduled
  #     tasks will continue to completion.
  # @!attribute [rw] input_artifacts
  #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::AIPlatform::V1::PipelineJob::RuntimeConfig::InputArtifact}]
  #     The runtime artifacts of the PipelineJob. The key will be the input
  #     artifact name and the value would be one of the InputArtifact.
  class RuntimeConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The type of an input artifact.
    # @!attribute [rw] artifact_id
    #   @return [::String]
    #     Artifact resource id from MLMD. Which is the last portion of an
    #     artifact resource name:
    #     `projects/{project}/locations/{location}/metadataStores/default/artifacts/{artifact_id}`.
    #     The artifact must stay within the same project, location and default
    #     metadatastore as the pipeline.
    class InputArtifact
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Cloud::AIPlatform::V1::Value]
    class ParametersEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Protobuf::Value]
    class ParameterValuesEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Cloud::AIPlatform::V1::PipelineJob::RuntimeConfig::InputArtifact]
    class InputArtifactsEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#service_account ⇒ ::String

Returns 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.

Returns:



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'proto_docs/google/cloud/aiplatform/v1/pipeline_job.rb', line 132

class PipelineJob
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The runtime config of a PipelineJob.
  # @!attribute [rw] parameters
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::AIPlatform::V1::Value}]
  #     Deprecated. Use
  #     {::Google::Cloud::AIPlatform::V1::PipelineJob::RuntimeConfig#parameter_values RuntimeConfig.parameter_values}
  #     instead. The runtime parameters of the PipelineJob. The parameters will
  #     be passed into
  #     {::Google::Cloud::AIPlatform::V1::PipelineJob#pipeline_spec PipelineJob.pipeline_spec}
  #     to replace the placeholders at runtime. This field is used by pipelines
  #     built using `PipelineJob.pipeline_spec.schema_version` 2.0.0 or lower,
  #     such as pipelines built using Kubeflow Pipelines SDK 1.8 or lower.
  # @!attribute [rw] gcs_output_directory
  #   @return [::String]
  #     Required. A path in a Cloud Storage bucket, which will be treated as the
  #     root output directory of the pipeline. It is used by the system to
  #     generate the paths of output artifacts. The artifact paths are generated
  #     with a sub-path pattern `{job_id}/{task_id}/{output_key}` under the
  #     specified output directory. The service account specified in this
  #     pipeline must have the `storage.objects.get` and `storage.objects.create`
  #     permissions for this bucket.
  # @!attribute [rw] parameter_values
  #   @return [::Google::Protobuf::Map{::String => ::Google::Protobuf::Value}]
  #     The runtime parameters of the PipelineJob. The parameters will be
  #     passed into
  #     {::Google::Cloud::AIPlatform::V1::PipelineJob#pipeline_spec PipelineJob.pipeline_spec}
  #     to replace the placeholders at runtime. This field is used by pipelines
  #     built using `PipelineJob.pipeline_spec.schema_version` 2.1.0, such as
  #     pipelines built using Kubeflow Pipelines SDK 1.9 or higher and the v2
  #     DSL.
  # @!attribute [rw] failure_policy
  #   @return [::Google::Cloud::AIPlatform::V1::PipelineFailurePolicy]
  #     Represents the failure policy of a pipeline. Currently, the default of a
  #     pipeline is that the pipeline will continue to run until no more tasks
  #     can be executed, also known as PIPELINE_FAILURE_POLICY_FAIL_SLOW.
  #     However, if a pipeline is set to PIPELINE_FAILURE_POLICY_FAIL_FAST, it
  #     will stop scheduling any new tasks when a task has failed. Any scheduled
  #     tasks will continue to completion.
  # @!attribute [rw] input_artifacts
  #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::AIPlatform::V1::PipelineJob::RuntimeConfig::InputArtifact}]
  #     The runtime artifacts of the PipelineJob. The key will be the input
  #     artifact name and the value would be one of the InputArtifact.
  class RuntimeConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The type of an input artifact.
    # @!attribute [rw] artifact_id
    #   @return [::String]
    #     Artifact resource id from MLMD. Which is the last portion of an
    #     artifact resource name:
    #     `projects/{project}/locations/{location}/metadataStores/default/artifacts/{artifact_id}`.
    #     The artifact must stay within the same project, location and default
    #     metadatastore as the pipeline.
    class InputArtifact
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Cloud::AIPlatform::V1::Value]
    class ParametersEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Protobuf::Value]
    class ParameterValuesEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Cloud::AIPlatform::V1::PipelineJob::RuntimeConfig::InputArtifact]
    class InputArtifactsEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#start_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. Pipeline start time.

Returns:



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'proto_docs/google/cloud/aiplatform/v1/pipeline_job.rb', line 132

class PipelineJob
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The runtime config of a PipelineJob.
  # @!attribute [rw] parameters
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::AIPlatform::V1::Value}]
  #     Deprecated. Use
  #     {::Google::Cloud::AIPlatform::V1::PipelineJob::RuntimeConfig#parameter_values RuntimeConfig.parameter_values}
  #     instead. The runtime parameters of the PipelineJob. The parameters will
  #     be passed into
  #     {::Google::Cloud::AIPlatform::V1::PipelineJob#pipeline_spec PipelineJob.pipeline_spec}
  #     to replace the placeholders at runtime. This field is used by pipelines
  #     built using `PipelineJob.pipeline_spec.schema_version` 2.0.0 or lower,
  #     such as pipelines built using Kubeflow Pipelines SDK 1.8 or lower.
  # @!attribute [rw] gcs_output_directory
  #   @return [::String]
  #     Required. A path in a Cloud Storage bucket, which will be treated as the
  #     root output directory of the pipeline. It is used by the system to
  #     generate the paths of output artifacts. The artifact paths are generated
  #     with a sub-path pattern `{job_id}/{task_id}/{output_key}` under the
  #     specified output directory. The service account specified in this
  #     pipeline must have the `storage.objects.get` and `storage.objects.create`
  #     permissions for this bucket.
  # @!attribute [rw] parameter_values
  #   @return [::Google::Protobuf::Map{::String => ::Google::Protobuf::Value}]
  #     The runtime parameters of the PipelineJob. The parameters will be
  #     passed into
  #     {::Google::Cloud::AIPlatform::V1::PipelineJob#pipeline_spec PipelineJob.pipeline_spec}
  #     to replace the placeholders at runtime. This field is used by pipelines
  #     built using `PipelineJob.pipeline_spec.schema_version` 2.1.0, such as
  #     pipelines built using Kubeflow Pipelines SDK 1.9 or higher and the v2
  #     DSL.
  # @!attribute [rw] failure_policy
  #   @return [::Google::Cloud::AIPlatform::V1::PipelineFailurePolicy]
  #     Represents the failure policy of a pipeline. Currently, the default of a
  #     pipeline is that the pipeline will continue to run until no more tasks
  #     can be executed, also known as PIPELINE_FAILURE_POLICY_FAIL_SLOW.
  #     However, if a pipeline is set to PIPELINE_FAILURE_POLICY_FAIL_FAST, it
  #     will stop scheduling any new tasks when a task has failed. Any scheduled
  #     tasks will continue to completion.
  # @!attribute [rw] input_artifacts
  #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::AIPlatform::V1::PipelineJob::RuntimeConfig::InputArtifact}]
  #     The runtime artifacts of the PipelineJob. The key will be the input
  #     artifact name and the value would be one of the InputArtifact.
  class RuntimeConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The type of an input artifact.
    # @!attribute [rw] artifact_id
    #   @return [::String]
    #     Artifact resource id from MLMD. Which is the last portion of an
    #     artifact resource name:
    #     `projects/{project}/locations/{location}/metadataStores/default/artifacts/{artifact_id}`.
    #     The artifact must stay within the same project, location and default
    #     metadatastore as the pipeline.
    class InputArtifact
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Cloud::AIPlatform::V1::Value]
    class ParametersEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Protobuf::Value]
    class ParameterValuesEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Cloud::AIPlatform::V1::PipelineJob::RuntimeConfig::InputArtifact]
    class InputArtifactsEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#state ⇒ ::Google::Cloud::AIPlatform::V1::PipelineState (readonly)

Returns Output only. The detailed state of the job.

Returns:



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'proto_docs/google/cloud/aiplatform/v1/pipeline_job.rb', line 132

class PipelineJob
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The runtime config of a PipelineJob.
  # @!attribute [rw] parameters
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::AIPlatform::V1::Value}]
  #     Deprecated. Use
  #     {::Google::Cloud::AIPlatform::V1::PipelineJob::RuntimeConfig#parameter_values RuntimeConfig.parameter_values}
  #     instead. The runtime parameters of the PipelineJob. The parameters will
  #     be passed into
  #     {::Google::Cloud::AIPlatform::V1::PipelineJob#pipeline_spec PipelineJob.pipeline_spec}
  #     to replace the placeholders at runtime. This field is used by pipelines
  #     built using `PipelineJob.pipeline_spec.schema_version` 2.0.0 or lower,
  #     such as pipelines built using Kubeflow Pipelines SDK 1.8 or lower.
  # @!attribute [rw] gcs_output_directory
  #   @return [::String]
  #     Required. A path in a Cloud Storage bucket, which will be treated as the
  #     root output directory of the pipeline. It is used by the system to
  #     generate the paths of output artifacts. The artifact paths are generated
  #     with a sub-path pattern `{job_id}/{task_id}/{output_key}` under the
  #     specified output directory. The service account specified in this
  #     pipeline must have the `storage.objects.get` and `storage.objects.create`
  #     permissions for this bucket.
  # @!attribute [rw] parameter_values
  #   @return [::Google::Protobuf::Map{::String => ::Google::Protobuf::Value}]
  #     The runtime parameters of the PipelineJob. The parameters will be
  #     passed into
  #     {::Google::Cloud::AIPlatform::V1::PipelineJob#pipeline_spec PipelineJob.pipeline_spec}
  #     to replace the placeholders at runtime. This field is used by pipelines
  #     built using `PipelineJob.pipeline_spec.schema_version` 2.1.0, such as
  #     pipelines built using Kubeflow Pipelines SDK 1.9 or higher and the v2
  #     DSL.
  # @!attribute [rw] failure_policy
  #   @return [::Google::Cloud::AIPlatform::V1::PipelineFailurePolicy]
  #     Represents the failure policy of a pipeline. Currently, the default of a
  #     pipeline is that the pipeline will continue to run until no more tasks
  #     can be executed, also known as PIPELINE_FAILURE_POLICY_FAIL_SLOW.
  #     However, if a pipeline is set to PIPELINE_FAILURE_POLICY_FAIL_FAST, it
  #     will stop scheduling any new tasks when a task has failed. Any scheduled
  #     tasks will continue to completion.
  # @!attribute [rw] input_artifacts
  #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::AIPlatform::V1::PipelineJob::RuntimeConfig::InputArtifact}]
  #     The runtime artifacts of the PipelineJob. The key will be the input
  #     artifact name and the value would be one of the InputArtifact.
  class RuntimeConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The type of an input artifact.
    # @!attribute [rw] artifact_id
    #   @return [::String]
    #     Artifact resource id from MLMD. Which is the last portion of an
    #     artifact resource name:
    #     `projects/{project}/locations/{location}/metadataStores/default/artifacts/{artifact_id}`.
    #     The artifact must stay within the same project, location and default
    #     metadatastore as the pipeline.
    class InputArtifact
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Cloud::AIPlatform::V1::Value]
    class ParametersEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Protobuf::Value]
    class ParameterValuesEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Cloud::AIPlatform::V1::PipelineJob::RuntimeConfig::InputArtifact]
    class InputArtifactsEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#template_metadata ⇒ ::Google::Cloud::AIPlatform::V1::PipelineTemplateMetadata (readonly)

Returns Output only. Pipeline template metadata. Will fill up fields if PipelineJob.template_uri is from supported template registry.

Returns:



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'proto_docs/google/cloud/aiplatform/v1/pipeline_job.rb', line 132

class PipelineJob
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The runtime config of a PipelineJob.
  # @!attribute [rw] parameters
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::AIPlatform::V1::Value}]
  #     Deprecated. Use
  #     {::Google::Cloud::AIPlatform::V1::PipelineJob::RuntimeConfig#parameter_values RuntimeConfig.parameter_values}
  #     instead. The runtime parameters of the PipelineJob. The parameters will
  #     be passed into
  #     {::Google::Cloud::AIPlatform::V1::PipelineJob#pipeline_spec PipelineJob.pipeline_spec}
  #     to replace the placeholders at runtime. This field is used by pipelines
  #     built using `PipelineJob.pipeline_spec.schema_version` 2.0.0 or lower,
  #     such as pipelines built using Kubeflow Pipelines SDK 1.8 or lower.
  # @!attribute [rw] gcs_output_directory
  #   @return [::String]
  #     Required. A path in a Cloud Storage bucket, which will be treated as the
  #     root output directory of the pipeline. It is used by the system to
  #     generate the paths of output artifacts. The artifact paths are generated
  #     with a sub-path pattern `{job_id}/{task_id}/{output_key}` under the
  #     specified output directory. The service account specified in this
  #     pipeline must have the `storage.objects.get` and `storage.objects.create`
  #     permissions for this bucket.
  # @!attribute [rw] parameter_values
  #   @return [::Google::Protobuf::Map{::String => ::Google::Protobuf::Value}]
  #     The runtime parameters of the PipelineJob. The parameters will be
  #     passed into
  #     {::Google::Cloud::AIPlatform::V1::PipelineJob#pipeline_spec PipelineJob.pipeline_spec}
  #     to replace the placeholders at runtime. This field is used by pipelines
  #     built using `PipelineJob.pipeline_spec.schema_version` 2.1.0, such as
  #     pipelines built using Kubeflow Pipelines SDK 1.9 or higher and the v2
  #     DSL.
  # @!attribute [rw] failure_policy
  #   @return [::Google::Cloud::AIPlatform::V1::PipelineFailurePolicy]
  #     Represents the failure policy of a pipeline. Currently, the default of a
  #     pipeline is that the pipeline will continue to run until no more tasks
  #     can be executed, also known as PIPELINE_FAILURE_POLICY_FAIL_SLOW.
  #     However, if a pipeline is set to PIPELINE_FAILURE_POLICY_FAIL_FAST, it
  #     will stop scheduling any new tasks when a task has failed. Any scheduled
  #     tasks will continue to completion.
  # @!attribute [rw] input_artifacts
  #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::AIPlatform::V1::PipelineJob::RuntimeConfig::InputArtifact}]
  #     The runtime artifacts of the PipelineJob. The key will be the input
  #     artifact name and the value would be one of the InputArtifact.
  class RuntimeConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The type of an input artifact.
    # @!attribute [rw] artifact_id
    #   @return [::String]
    #     Artifact resource id from MLMD. Which is the last portion of an
    #     artifact resource name:
    #     `projects/{project}/locations/{location}/metadataStores/default/artifacts/{artifact_id}`.
    #     The artifact must stay within the same project, location and default
    #     metadatastore as the pipeline.
    class InputArtifact
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Cloud::AIPlatform::V1::Value]
    class ParametersEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Protobuf::Value]
    class ParameterValuesEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Cloud::AIPlatform::V1::PipelineJob::RuntimeConfig::InputArtifact]
    class InputArtifactsEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#template_uri ⇒ ::String

Returns 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.

Returns:



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'proto_docs/google/cloud/aiplatform/v1/pipeline_job.rb', line 132

class PipelineJob
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The runtime config of a PipelineJob.
  # @!attribute [rw] parameters
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::AIPlatform::V1::Value}]
  #     Deprecated. Use
  #     {::Google::Cloud::AIPlatform::V1::PipelineJob::RuntimeConfig#parameter_values RuntimeConfig.parameter_values}
  #     instead. The runtime parameters of the PipelineJob. The parameters will
  #     be passed into
  #     {::Google::Cloud::AIPlatform::V1::PipelineJob#pipeline_spec PipelineJob.pipeline_spec}
  #     to replace the placeholders at runtime. This field is used by pipelines
  #     built using `PipelineJob.pipeline_spec.schema_version` 2.0.0 or lower,
  #     such as pipelines built using Kubeflow Pipelines SDK 1.8 or lower.
  # @!attribute [rw] gcs_output_directory
  #   @return [::String]
  #     Required. A path in a Cloud Storage bucket, which will be treated as the
  #     root output directory of the pipeline. It is used by the system to
  #     generate the paths of output artifacts. The artifact paths are generated
  #     with a sub-path pattern `{job_id}/{task_id}/{output_key}` under the
  #     specified output directory. The service account specified in this
  #     pipeline must have the `storage.objects.get` and `storage.objects.create`
  #     permissions for this bucket.
  # @!attribute [rw] parameter_values
  #   @return [::Google::Protobuf::Map{::String => ::Google::Protobuf::Value}]
  #     The runtime parameters of the PipelineJob. The parameters will be
  #     passed into
  #     {::Google::Cloud::AIPlatform::V1::PipelineJob#pipeline_spec PipelineJob.pipeline_spec}
  #     to replace the placeholders at runtime. This field is used by pipelines
  #     built using `PipelineJob.pipeline_spec.schema_version` 2.1.0, such as
  #     pipelines built using Kubeflow Pipelines SDK 1.9 or higher and the v2
  #     DSL.
  # @!attribute [rw] failure_policy
  #   @return [::Google::Cloud::AIPlatform::V1::PipelineFailurePolicy]
  #     Represents the failure policy of a pipeline. Currently, the default of a
  #     pipeline is that the pipeline will continue to run until no more tasks
  #     can be executed, also known as PIPELINE_FAILURE_POLICY_FAIL_SLOW.
  #     However, if a pipeline is set to PIPELINE_FAILURE_POLICY_FAIL_FAST, it
  #     will stop scheduling any new tasks when a task has failed. Any scheduled
  #     tasks will continue to completion.
  # @!attribute [rw] input_artifacts
  #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::AIPlatform::V1::PipelineJob::RuntimeConfig::InputArtifact}]
  #     The runtime artifacts of the PipelineJob. The key will be the input
  #     artifact name and the value would be one of the InputArtifact.
  class RuntimeConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The type of an input artifact.
    # @!attribute [rw] artifact_id
    #   @return [::String]
    #     Artifact resource id from MLMD. Which is the last portion of an
    #     artifact resource name:
    #     `projects/{project}/locations/{location}/metadataStores/default/artifacts/{artifact_id}`.
    #     The artifact must stay within the same project, location and default
    #     metadatastore as the pipeline.
    class InputArtifact
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Cloud::AIPlatform::V1::Value]
    class ParametersEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Protobuf::Value]
    class ParameterValuesEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Cloud::AIPlatform::V1::PipelineJob::RuntimeConfig::InputArtifact]
    class InputArtifactsEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#update_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. Timestamp when this PipelineJob was most recently updated.

Returns:



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'proto_docs/google/cloud/aiplatform/v1/pipeline_job.rb', line 132

class PipelineJob
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The runtime config of a PipelineJob.
  # @!attribute [rw] parameters
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::AIPlatform::V1::Value}]
  #     Deprecated. Use
  #     {::Google::Cloud::AIPlatform::V1::PipelineJob::RuntimeConfig#parameter_values RuntimeConfig.parameter_values}
  #     instead. The runtime parameters of the PipelineJob. The parameters will
  #     be passed into
  #     {::Google::Cloud::AIPlatform::V1::PipelineJob#pipeline_spec PipelineJob.pipeline_spec}
  #     to replace the placeholders at runtime. This field is used by pipelines
  #     built using `PipelineJob.pipeline_spec.schema_version` 2.0.0 or lower,
  #     such as pipelines built using Kubeflow Pipelines SDK 1.8 or lower.
  # @!attribute [rw] gcs_output_directory
  #   @return [::String]
  #     Required. A path in a Cloud Storage bucket, which will be treated as the
  #     root output directory of the pipeline. It is used by the system to
  #     generate the paths of output artifacts. The artifact paths are generated
  #     with a sub-path pattern `{job_id}/{task_id}/{output_key}` under the
  #     specified output directory. The service account specified in this
  #     pipeline must have the `storage.objects.get` and `storage.objects.create`
  #     permissions for this bucket.
  # @!attribute [rw] parameter_values
  #   @return [::Google::Protobuf::Map{::String => ::Google::Protobuf::Value}]
  #     The runtime parameters of the PipelineJob. The parameters will be
  #     passed into
  #     {::Google::Cloud::AIPlatform::V1::PipelineJob#pipeline_spec PipelineJob.pipeline_spec}
  #     to replace the placeholders at runtime. This field is used by pipelines
  #     built using `PipelineJob.pipeline_spec.schema_version` 2.1.0, such as
  #     pipelines built using Kubeflow Pipelines SDK 1.9 or higher and the v2
  #     DSL.
  # @!attribute [rw] failure_policy
  #   @return [::Google::Cloud::AIPlatform::V1::PipelineFailurePolicy]
  #     Represents the failure policy of a pipeline. Currently, the default of a
  #     pipeline is that the pipeline will continue to run until no more tasks
  #     can be executed, also known as PIPELINE_FAILURE_POLICY_FAIL_SLOW.
  #     However, if a pipeline is set to PIPELINE_FAILURE_POLICY_FAIL_FAST, it
  #     will stop scheduling any new tasks when a task has failed. Any scheduled
  #     tasks will continue to completion.
  # @!attribute [rw] input_artifacts
  #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::AIPlatform::V1::PipelineJob::RuntimeConfig::InputArtifact}]
  #     The runtime artifacts of the PipelineJob. The key will be the input
  #     artifact name and the value would be one of the InputArtifact.
  class RuntimeConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The type of an input artifact.
    # @!attribute [rw] artifact_id
    #   @return [::String]
    #     Artifact resource id from MLMD. Which is the last portion of an
    #     artifact resource name:
    #     `projects/{project}/locations/{location}/metadataStores/default/artifacts/{artifact_id}`.
    #     The artifact must stay within the same project, location and default
    #     metadatastore as the pipeline.
    class InputArtifact
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Cloud::AIPlatform::V1::Value]
    class ParametersEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Protobuf::Value]
    class ParameterValuesEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Cloud::AIPlatform::V1::PipelineJob::RuntimeConfig::InputArtifact]
    class InputArtifactsEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end