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

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

The runtime config of a PipelineJob.

Defined Under Namespace

Classes: InputArtifact, InputArtifactsEntry, ParameterValuesEntry, ParametersEntry

Instance Attribute Summary collapse

Instance Attribute Details

#failure_policy ⇒ ::Google::Cloud::AIPlatform::V1::PipelineFailurePolicy

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

Returns:

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



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
 
# File 'proto_docs/google/cloud/aiplatform/v1/pipeline_job.rb', line 178

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

#gcs_output_directory ⇒ ::String

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

Returns:

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



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
 
# File 'proto_docs/google/cloud/aiplatform/v1/pipeline_job.rb', line 178

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

#input_artifacts ⇒ ::Google::Protobuf::Map{::String => ::Google::Cloud::AIPlatform::V1::PipelineJob::RuntimeConfig::InputArtifact}

Returns The runtime artifacts of the PipelineJob. The key will be the input artifact name and the value would be one of the InputArtifact.

Returns:



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
 
# File 'proto_docs/google/cloud/aiplatform/v1/pipeline_job.rb', line 178

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

#parameter_values ⇒ ::Google::Protobuf::Map{::String => ::Google::Protobuf::Value}

Returns The runtime parameters of the PipelineJob. The parameters will be passed into 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.

Returns:

  • (::Google::Protobuf::Map{::String => ::Google::Protobuf::Value}) —

    The runtime parameters of the PipelineJob. The parameters will be passed into 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.



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
 
# File 'proto_docs/google/cloud/aiplatform/v1/pipeline_job.rb', line 178

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

#parameters ⇒ ::Google::Protobuf::Map{::String => ::Google::Cloud::AIPlatform::V1::Value}

Deprecated.

This field is deprecated and may be removed in the next major version update.

Returns Deprecated. Use RuntimeConfig.parameter_values instead. The runtime parameters of the PipelineJob. The parameters will be passed into 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.

Returns:



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
 
# File 'proto_docs/google/cloud/aiplatform/v1/pipeline_job.rb', line 178

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