software.amazon.awssdk.services.sagemaker.model.PipelineExecutionStepMetadata Maven / Gradle / Ivy
Show all versions of sagemaker Show documentation
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.sagemaker.model;
import java.beans.Transient;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Metadata for a step execution.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class PipelineExecutionStepMetadata implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField TRAINING_JOB_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("TrainingJob")
.getter(getter(PipelineExecutionStepMetadata::trainingJob)).setter(setter(Builder::trainingJob))
.constructor(TrainingJobStepMetadata::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("TrainingJob").build()).build();
private static final SdkField PROCESSING_JOB_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("ProcessingJob")
.getter(getter(PipelineExecutionStepMetadata::processingJob)).setter(setter(Builder::processingJob))
.constructor(ProcessingJobStepMetadata::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ProcessingJob").build()).build();
private static final SdkField TRANSFORM_JOB_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("TransformJob")
.getter(getter(PipelineExecutionStepMetadata::transformJob)).setter(setter(Builder::transformJob))
.constructor(TransformJobStepMetadata::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("TransformJob").build()).build();
private static final SdkField TUNING_JOB_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("TuningJob")
.getter(getter(PipelineExecutionStepMetadata::tuningJob)).setter(setter(Builder::tuningJob))
.constructor(TuningJobStepMetaData::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("TuningJob").build()).build();
private static final SdkField MODEL_FIELD = SdkField. builder(MarshallingType.SDK_POJO)
.memberName("Model").getter(getter(PipelineExecutionStepMetadata::model)).setter(setter(Builder::model))
.constructor(ModelStepMetadata::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Model").build()).build();
private static final SdkField REGISTER_MODEL_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("RegisterModel")
.getter(getter(PipelineExecutionStepMetadata::registerModel)).setter(setter(Builder::registerModel))
.constructor(RegisterModelStepMetadata::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("RegisterModel").build()).build();
private static final SdkField CONDITION_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("Condition")
.getter(getter(PipelineExecutionStepMetadata::condition)).setter(setter(Builder::condition))
.constructor(ConditionStepMetadata::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Condition").build()).build();
private static final SdkField CALLBACK_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("Callback")
.getter(getter(PipelineExecutionStepMetadata::callback)).setter(setter(Builder::callback))
.constructor(CallbackStepMetadata::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Callback").build()).build();
private static final SdkField LAMBDA_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("Lambda")
.getter(getter(PipelineExecutionStepMetadata::lambda)).setter(setter(Builder::lambda))
.constructor(LambdaStepMetadata::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Lambda").build()).build();
private static final SdkField QUALITY_CHECK_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("QualityCheck")
.getter(getter(PipelineExecutionStepMetadata::qualityCheck)).setter(setter(Builder::qualityCheck))
.constructor(QualityCheckStepMetadata::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("QualityCheck").build()).build();
private static final SdkField CLARIFY_CHECK_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("ClarifyCheck")
.getter(getter(PipelineExecutionStepMetadata::clarifyCheck)).setter(setter(Builder::clarifyCheck))
.constructor(ClarifyCheckStepMetadata::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ClarifyCheck").build()).build();
private static final SdkField EMR_FIELD = SdkField. builder(MarshallingType.SDK_POJO)
.memberName("EMR").getter(getter(PipelineExecutionStepMetadata::emr)).setter(setter(Builder::emr))
.constructor(EMRStepMetadata::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("EMR").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(TRAINING_JOB_FIELD,
PROCESSING_JOB_FIELD, TRANSFORM_JOB_FIELD, TUNING_JOB_FIELD, MODEL_FIELD, REGISTER_MODEL_FIELD, CONDITION_FIELD,
CALLBACK_FIELD, LAMBDA_FIELD, QUALITY_CHECK_FIELD, CLARIFY_CHECK_FIELD, EMR_FIELD));
private static final long serialVersionUID = 1L;
private final TrainingJobStepMetadata trainingJob;
private final ProcessingJobStepMetadata processingJob;
private final TransformJobStepMetadata transformJob;
private final TuningJobStepMetaData tuningJob;
private final ModelStepMetadata model;
private final RegisterModelStepMetadata registerModel;
private final ConditionStepMetadata condition;
private final CallbackStepMetadata callback;
private final LambdaStepMetadata lambda;
private final QualityCheckStepMetadata qualityCheck;
private final ClarifyCheckStepMetadata clarifyCheck;
private final EMRStepMetadata emr;
private PipelineExecutionStepMetadata(BuilderImpl builder) {
this.trainingJob = builder.trainingJob;
this.processingJob = builder.processingJob;
this.transformJob = builder.transformJob;
this.tuningJob = builder.tuningJob;
this.model = builder.model;
this.registerModel = builder.registerModel;
this.condition = builder.condition;
this.callback = builder.callback;
this.lambda = builder.lambda;
this.qualityCheck = builder.qualityCheck;
this.clarifyCheck = builder.clarifyCheck;
this.emr = builder.emr;
}
/**
*
* The Amazon Resource Name (ARN) of the training job that was run by this step execution.
*
*
* @return The Amazon Resource Name (ARN) of the training job that was run by this step execution.
*/
public final TrainingJobStepMetadata trainingJob() {
return trainingJob;
}
/**
*
* The Amazon Resource Name (ARN) of the processing job that was run by this step execution.
*
*
* @return The Amazon Resource Name (ARN) of the processing job that was run by this step execution.
*/
public final ProcessingJobStepMetadata processingJob() {
return processingJob;
}
/**
*
* The Amazon Resource Name (ARN) of the transform job that was run by this step execution.
*
*
* @return The Amazon Resource Name (ARN) of the transform job that was run by this step execution.
*/
public final TransformJobStepMetadata transformJob() {
return transformJob;
}
/**
*
* The Amazon Resource Name (ARN) of the tuning job that was run by this step execution.
*
*
* @return The Amazon Resource Name (ARN) of the tuning job that was run by this step execution.
*/
public final TuningJobStepMetaData tuningJob() {
return tuningJob;
}
/**
*
* The Amazon Resource Name (ARN) of the model that was created by this step execution.
*
*
* @return The Amazon Resource Name (ARN) of the model that was created by this step execution.
*/
public final ModelStepMetadata model() {
return model;
}
/**
*
* The Amazon Resource Name (ARN) of the model package the model was registered to by this step execution.
*
*
* @return The Amazon Resource Name (ARN) of the model package the model was registered to by this step execution.
*/
public final RegisterModelStepMetadata registerModel() {
return registerModel;
}
/**
*
* The outcome of the condition evaluation that was run by this step execution.
*
*
* @return The outcome of the condition evaluation that was run by this step execution.
*/
public final ConditionStepMetadata condition() {
return condition;
}
/**
*
* The URL of the Amazon SQS queue used by this step execution, the pipeline generated token, and a list of output
* parameters.
*
*
* @return The URL of the Amazon SQS queue used by this step execution, the pipeline generated token, and a list of
* output parameters.
*/
public final CallbackStepMetadata callback() {
return callback;
}
/**
*
* The Amazon Resource Name (ARN) of the Lambda function that was run by this step execution and a list of output
* parameters.
*
*
* @return The Amazon Resource Name (ARN) of the Lambda function that was run by this step execution and a list of
* output parameters.
*/
public final LambdaStepMetadata lambda() {
return lambda;
}
/**
*
* The configurations and outcomes of the check step execution. This includes:
*
*
* -
*
* The type of the check conducted,
*
*
* -
*
* The Amazon S3 URIs of baseline constraints and statistics files to be used for the drift check.
*
*
* -
*
* The Amazon S3 URIs of newly calculated baseline constraints and statistics.
*
*
* -
*
* The model package group name provided.
*
*
* -
*
* The Amazon S3 URI of the violation report if violations detected.
*
*
* -
*
* The Amazon Resource Name (ARN) of check processing job initiated by the step execution.
*
*
* -
*
* The boolean flags indicating if the drift check is skipped.
*
*
* -
*
* If step property BaselineUsedForDriftCheck is set the same as CalculatedBaseline.
*
*
*
*
* @return The configurations and outcomes of the check step execution. This includes:
*
* -
*
* The type of the check conducted,
*
*
* -
*
* The Amazon S3 URIs of baseline constraints and statistics files to be used for the drift check.
*
*
* -
*
* The Amazon S3 URIs of newly calculated baseline constraints and statistics.
*
*
* -
*
* The model package group name provided.
*
*
* -
*
* The Amazon S3 URI of the violation report if violations detected.
*
*
* -
*
* The Amazon Resource Name (ARN) of check processing job initiated by the step execution.
*
*
* -
*
* The boolean flags indicating if the drift check is skipped.
*
*
* -
*
* If step property BaselineUsedForDriftCheck is set the same as
* CalculatedBaseline.
*
*
*/
public final QualityCheckStepMetadata qualityCheck() {
return qualityCheck;
}
/**
*
* Container for the metadata for a Clarify check step. The configurations and outcomes of the check step execution.
* This includes:
*
*
* -
*
* The type of the check conducted,
*
*
* -
*
* The Amazon S3 URIs of baseline constraints and statistics files to be used for the drift check.
*
*
* -
*
* The Amazon S3 URIs of newly calculated baseline constraints and statistics.
*
*
* -
*
* The model package group name provided.
*
*
* -
*
* The Amazon S3 URI of the violation report if violations detected.
*
*
* -
*
* The Amazon Resource Name (ARN) of check processing job initiated by the step execution.
*
*
* -
*
* The boolean flags indicating if the drift check is skipped.
*
*
* -
*
* If step property BaselineUsedForDriftCheck is set the same as CalculatedBaseline.
*
*
*
*
* @return Container for the metadata for a Clarify check step. The configurations and outcomes of the check step
* execution. This includes:
*
* -
*
* The type of the check conducted,
*
*
* -
*
* The Amazon S3 URIs of baseline constraints and statistics files to be used for the drift check.
*
*
* -
*
* The Amazon S3 URIs of newly calculated baseline constraints and statistics.
*
*
* -
*
* The model package group name provided.
*
*
* -
*
* The Amazon S3 URI of the violation report if violations detected.
*
*
* -
*
* The Amazon Resource Name (ARN) of check processing job initiated by the step execution.
*
*
* -
*
* The boolean flags indicating if the drift check is skipped.
*
*
* -
*
* If step property BaselineUsedForDriftCheck is set the same as
* CalculatedBaseline.
*
*
*/
public final ClarifyCheckStepMetadata clarifyCheck() {
return clarifyCheck;
}
/**
*
* The configurations and outcomes of an EMR step execution.
*
*
* @return The configurations and outcomes of an EMR step execution.
*/
public final EMRStepMetadata emr() {
return emr;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(trainingJob());
hashCode = 31 * hashCode + Objects.hashCode(processingJob());
hashCode = 31 * hashCode + Objects.hashCode(transformJob());
hashCode = 31 * hashCode + Objects.hashCode(tuningJob());
hashCode = 31 * hashCode + Objects.hashCode(model());
hashCode = 31 * hashCode + Objects.hashCode(registerModel());
hashCode = 31 * hashCode + Objects.hashCode(condition());
hashCode = 31 * hashCode + Objects.hashCode(callback());
hashCode = 31 * hashCode + Objects.hashCode(lambda());
hashCode = 31 * hashCode + Objects.hashCode(qualityCheck());
hashCode = 31 * hashCode + Objects.hashCode(clarifyCheck());
hashCode = 31 * hashCode + Objects.hashCode(emr());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof PipelineExecutionStepMetadata)) {
return false;
}
PipelineExecutionStepMetadata other = (PipelineExecutionStepMetadata) obj;
return Objects.equals(trainingJob(), other.trainingJob()) && Objects.equals(processingJob(), other.processingJob())
&& Objects.equals(transformJob(), other.transformJob()) && Objects.equals(tuningJob(), other.tuningJob())
&& Objects.equals(model(), other.model()) && Objects.equals(registerModel(), other.registerModel())
&& Objects.equals(condition(), other.condition()) && Objects.equals(callback(), other.callback())
&& Objects.equals(lambda(), other.lambda()) && Objects.equals(qualityCheck(), other.qualityCheck())
&& Objects.equals(clarifyCheck(), other.clarifyCheck()) && Objects.equals(emr(), other.emr());
}
/**
* Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
* redacted from this string using a placeholder value.
*/
@Override
public final String toString() {
return ToString.builder("PipelineExecutionStepMetadata").add("TrainingJob", trainingJob())
.add("ProcessingJob", processingJob()).add("TransformJob", transformJob()).add("TuningJob", tuningJob())
.add("Model", model()).add("RegisterModel", registerModel()).add("Condition", condition())
.add("Callback", callback()).add("Lambda", lambda()).add("QualityCheck", qualityCheck())
.add("ClarifyCheck", clarifyCheck()).add("EMR", emr()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "TrainingJob":
return Optional.ofNullable(clazz.cast(trainingJob()));
case "ProcessingJob":
return Optional.ofNullable(clazz.cast(processingJob()));
case "TransformJob":
return Optional.ofNullable(clazz.cast(transformJob()));
case "TuningJob":
return Optional.ofNullable(clazz.cast(tuningJob()));
case "Model":
return Optional.ofNullable(clazz.cast(model()));
case "RegisterModel":
return Optional.ofNullable(clazz.cast(registerModel()));
case "Condition":
return Optional.ofNullable(clazz.cast(condition()));
case "Callback":
return Optional.ofNullable(clazz.cast(callback()));
case "Lambda":
return Optional.ofNullable(clazz.cast(lambda()));
case "QualityCheck":
return Optional.ofNullable(clazz.cast(qualityCheck()));
case "ClarifyCheck":
return Optional.ofNullable(clazz.cast(clarifyCheck()));
case "EMR":
return Optional.ofNullable(clazz.cast(emr()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((PipelineExecutionStepMetadata) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The Amazon Resource Name (ARN) of the training job that was run by this step execution.
*
*
* @param trainingJob
* The Amazon Resource Name (ARN) of the training job that was run by this step execution.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder trainingJob(TrainingJobStepMetadata trainingJob);
/**
*
* The Amazon Resource Name (ARN) of the training job that was run by this step execution.
*
* This is a convenience that creates an instance of the {@link TrainingJobStepMetadata.Builder} avoiding the
* need to create one manually via {@link TrainingJobStepMetadata#builder()}.
*
* When the {@link Consumer} completes, {@link TrainingJobStepMetadata.Builder#build()} is called immediately
* and its result is passed to {@link #trainingJob(TrainingJobStepMetadata)}.
*
* @param trainingJob
* a consumer that will call methods on {@link TrainingJobStepMetadata.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #trainingJob(TrainingJobStepMetadata)
*/
default Builder trainingJob(Consumer trainingJob) {
return trainingJob(TrainingJobStepMetadata.builder().applyMutation(trainingJob).build());
}
/**
*
* The Amazon Resource Name (ARN) of the processing job that was run by this step execution.
*
*
* @param processingJob
* The Amazon Resource Name (ARN) of the processing job that was run by this step execution.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder processingJob(ProcessingJobStepMetadata processingJob);
/**
*
* The Amazon Resource Name (ARN) of the processing job that was run by this step execution.
*
* This is a convenience that creates an instance of the {@link ProcessingJobStepMetadata.Builder} avoiding the
* need to create one manually via {@link ProcessingJobStepMetadata#builder()}.
*
* When the {@link Consumer} completes, {@link ProcessingJobStepMetadata.Builder#build()} is called immediately
* and its result is passed to {@link #processingJob(ProcessingJobStepMetadata)}.
*
* @param processingJob
* a consumer that will call methods on {@link ProcessingJobStepMetadata.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #processingJob(ProcessingJobStepMetadata)
*/
default Builder processingJob(Consumer processingJob) {
return processingJob(ProcessingJobStepMetadata.builder().applyMutation(processingJob).build());
}
/**
*
* The Amazon Resource Name (ARN) of the transform job that was run by this step execution.
*
*
* @param transformJob
* The Amazon Resource Name (ARN) of the transform job that was run by this step execution.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder transformJob(TransformJobStepMetadata transformJob);
/**
*
* The Amazon Resource Name (ARN) of the transform job that was run by this step execution.
*
* This is a convenience that creates an instance of the {@link TransformJobStepMetadata.Builder} avoiding the
* need to create one manually via {@link TransformJobStepMetadata#builder()}.
*
* When the {@link Consumer} completes, {@link TransformJobStepMetadata.Builder#build()} is called immediately
* and its result is passed to {@link #transformJob(TransformJobStepMetadata)}.
*
* @param transformJob
* a consumer that will call methods on {@link TransformJobStepMetadata.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #transformJob(TransformJobStepMetadata)
*/
default Builder transformJob(Consumer transformJob) {
return transformJob(TransformJobStepMetadata.builder().applyMutation(transformJob).build());
}
/**
*
* The Amazon Resource Name (ARN) of the tuning job that was run by this step execution.
*
*
* @param tuningJob
* The Amazon Resource Name (ARN) of the tuning job that was run by this step execution.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tuningJob(TuningJobStepMetaData tuningJob);
/**
*
* The Amazon Resource Name (ARN) of the tuning job that was run by this step execution.
*
* This is a convenience that creates an instance of the {@link TuningJobStepMetaData.Builder} avoiding the need
* to create one manually via {@link TuningJobStepMetaData#builder()}.
*
* When the {@link Consumer} completes, {@link TuningJobStepMetaData.Builder#build()} is called immediately and
* its result is passed to {@link #tuningJob(TuningJobStepMetaData)}.
*
* @param tuningJob
* a consumer that will call methods on {@link TuningJobStepMetaData.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #tuningJob(TuningJobStepMetaData)
*/
default Builder tuningJob(Consumer tuningJob) {
return tuningJob(TuningJobStepMetaData.builder().applyMutation(tuningJob).build());
}
/**
*
* The Amazon Resource Name (ARN) of the model that was created by this step execution.
*
*
* @param model
* The Amazon Resource Name (ARN) of the model that was created by this step execution.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder model(ModelStepMetadata model);
/**
*
* The Amazon Resource Name (ARN) of the model that was created by this step execution.
*
* This is a convenience that creates an instance of the {@link ModelStepMetadata.Builder} avoiding the need to
* create one manually via {@link ModelStepMetadata#builder()}.
*
* When the {@link Consumer} completes, {@link ModelStepMetadata.Builder#build()} is called immediately and its
* result is passed to {@link #model(ModelStepMetadata)}.
*
* @param model
* a consumer that will call methods on {@link ModelStepMetadata.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #model(ModelStepMetadata)
*/
default Builder model(Consumer model) {
return model(ModelStepMetadata.builder().applyMutation(model).build());
}
/**
*
* The Amazon Resource Name (ARN) of the model package the model was registered to by this step execution.
*
*
* @param registerModel
* The Amazon Resource Name (ARN) of the model package the model was registered to by this step
* execution.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder registerModel(RegisterModelStepMetadata registerModel);
/**
*
* The Amazon Resource Name (ARN) of the model package the model was registered to by this step execution.
*
* This is a convenience that creates an instance of the {@link RegisterModelStepMetadata.Builder} avoiding the
* need to create one manually via {@link RegisterModelStepMetadata#builder()}.
*
* When the {@link Consumer} completes, {@link RegisterModelStepMetadata.Builder#build()} is called immediately
* and its result is passed to {@link #registerModel(RegisterModelStepMetadata)}.
*
* @param registerModel
* a consumer that will call methods on {@link RegisterModelStepMetadata.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #registerModel(RegisterModelStepMetadata)
*/
default Builder registerModel(Consumer registerModel) {
return registerModel(RegisterModelStepMetadata.builder().applyMutation(registerModel).build());
}
/**
*
* The outcome of the condition evaluation that was run by this step execution.
*
*
* @param condition
* The outcome of the condition evaluation that was run by this step execution.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder condition(ConditionStepMetadata condition);
/**
*
* The outcome of the condition evaluation that was run by this step execution.
*
* This is a convenience that creates an instance of the {@link ConditionStepMetadata.Builder} avoiding the need
* to create one manually via {@link ConditionStepMetadata#builder()}.
*
* When the {@link Consumer} completes, {@link ConditionStepMetadata.Builder#build()} is called immediately and
* its result is passed to {@link #condition(ConditionStepMetadata)}.
*
* @param condition
* a consumer that will call methods on {@link ConditionStepMetadata.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #condition(ConditionStepMetadata)
*/
default Builder condition(Consumer condition) {
return condition(ConditionStepMetadata.builder().applyMutation(condition).build());
}
/**
*
* The URL of the Amazon SQS queue used by this step execution, the pipeline generated token, and a list of
* output parameters.
*
*
* @param callback
* The URL of the Amazon SQS queue used by this step execution, the pipeline generated token, and a list
* of output parameters.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder callback(CallbackStepMetadata callback);
/**
*
* The URL of the Amazon SQS queue used by this step execution, the pipeline generated token, and a list of
* output parameters.
*
* This is a convenience that creates an instance of the {@link CallbackStepMetadata.Builder} avoiding the need
* to create one manually via {@link CallbackStepMetadata#builder()}.
*
* When the {@link Consumer} completes, {@link CallbackStepMetadata.Builder#build()} is called immediately and
* its result is passed to {@link #callback(CallbackStepMetadata)}.
*
* @param callback
* a consumer that will call methods on {@link CallbackStepMetadata.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #callback(CallbackStepMetadata)
*/
default Builder callback(Consumer callback) {
return callback(CallbackStepMetadata.builder().applyMutation(callback).build());
}
/**
*
* The Amazon Resource Name (ARN) of the Lambda function that was run by this step execution and a list of
* output parameters.
*
*
* @param lambda
* The Amazon Resource Name (ARN) of the Lambda function that was run by this step execution and a list
* of output parameters.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder lambda(LambdaStepMetadata lambda);
/**
*
* The Amazon Resource Name (ARN) of the Lambda function that was run by this step execution and a list of
* output parameters.
*
* This is a convenience that creates an instance of the {@link LambdaStepMetadata.Builder} avoiding the need to
* create one manually via {@link LambdaStepMetadata#builder()}.
*
* When the {@link Consumer} completes, {@link LambdaStepMetadata.Builder#build()} is called immediately and its
* result is passed to {@link #lambda(LambdaStepMetadata)}.
*
* @param lambda
* a consumer that will call methods on {@link LambdaStepMetadata.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #lambda(LambdaStepMetadata)
*/
default Builder lambda(Consumer lambda) {
return lambda(LambdaStepMetadata.builder().applyMutation(lambda).build());
}
/**
*
* The configurations and outcomes of the check step execution. This includes:
*
*
* -
*
* The type of the check conducted,
*
*
* -
*
* The Amazon S3 URIs of baseline constraints and statistics files to be used for the drift check.
*
*
* -
*
* The Amazon S3 URIs of newly calculated baseline constraints and statistics.
*
*
* -
*
* The model package group name provided.
*
*
* -
*
* The Amazon S3 URI of the violation report if violations detected.
*
*
* -
*
* The Amazon Resource Name (ARN) of check processing job initiated by the step execution.
*
*
* -
*
* The boolean flags indicating if the drift check is skipped.
*
*
* -
*
* If step property BaselineUsedForDriftCheck is set the same as CalculatedBaseline.
*
*
*
*
* @param qualityCheck
* The configurations and outcomes of the check step execution. This includes:
*
* -
*
* The type of the check conducted,
*
*
* -
*
* The Amazon S3 URIs of baseline constraints and statistics files to be used for the drift check.
*
*
* -
*
* The Amazon S3 URIs of newly calculated baseline constraints and statistics.
*
*
* -
*
* The model package group name provided.
*
*
* -
*
* The Amazon S3 URI of the violation report if violations detected.
*
*
* -
*
* The Amazon Resource Name (ARN) of check processing job initiated by the step execution.
*
*
* -
*
* The boolean flags indicating if the drift check is skipped.
*
*
* -
*
* If step property BaselineUsedForDriftCheck is set the same as
* CalculatedBaseline.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder qualityCheck(QualityCheckStepMetadata qualityCheck);
/**
*
* The configurations and outcomes of the check step execution. This includes:
*
*
* -
*
* The type of the check conducted,
*
*
* -
*
* The Amazon S3 URIs of baseline constraints and statistics files to be used for the drift check.
*
*
* -
*
* The Amazon S3 URIs of newly calculated baseline constraints and statistics.
*
*
* -
*
* The model package group name provided.
*
*
* -
*
* The Amazon S3 URI of the violation report if violations detected.
*
*
* -
*
* The Amazon Resource Name (ARN) of check processing job initiated by the step execution.
*
*
* -
*
* The boolean flags indicating if the drift check is skipped.
*
*
* -
*
* If step property BaselineUsedForDriftCheck is set the same as CalculatedBaseline.
*
*
*
* This is a convenience that creates an instance of the {@link QualityCheckStepMetadata.Builder} avoiding the
* need to create one manually via {@link QualityCheckStepMetadata#builder()}.
*
* When the {@link Consumer} completes, {@link QualityCheckStepMetadata.Builder#build()} is called immediately
* and its result is passed to {@link #qualityCheck(QualityCheckStepMetadata)}.
*
* @param qualityCheck
* a consumer that will call methods on {@link QualityCheckStepMetadata.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #qualityCheck(QualityCheckStepMetadata)
*/
default Builder qualityCheck(Consumer qualityCheck) {
return qualityCheck(QualityCheckStepMetadata.builder().applyMutation(qualityCheck).build());
}
/**
*
* Container for the metadata for a Clarify check step. The configurations and outcomes of the check step
* execution. This includes:
*
*
* -
*
* The type of the check conducted,
*
*
* -
*
* The Amazon S3 URIs of baseline constraints and statistics files to be used for the drift check.
*
*
* -
*
* The Amazon S3 URIs of newly calculated baseline constraints and statistics.
*
*
* -
*
* The model package group name provided.
*
*
* -
*
* The Amazon S3 URI of the violation report if violations detected.
*
*
* -
*
* The Amazon Resource Name (ARN) of check processing job initiated by the step execution.
*
*
* -
*
* The boolean flags indicating if the drift check is skipped.
*
*
* -
*
* If step property BaselineUsedForDriftCheck is set the same as CalculatedBaseline.
*
*
*
*
* @param clarifyCheck
* Container for the metadata for a Clarify check step. The configurations and outcomes of the check step
* execution. This includes:
*
* -
*
* The type of the check conducted,
*
*
* -
*
* The Amazon S3 URIs of baseline constraints and statistics files to be used for the drift check.
*
*
* -
*
* The Amazon S3 URIs of newly calculated baseline constraints and statistics.
*
*
* -
*
* The model package group name provided.
*
*
* -
*
* The Amazon S3 URI of the violation report if violations detected.
*
*
* -
*
* The Amazon Resource Name (ARN) of check processing job initiated by the step execution.
*
*
* -
*
* The boolean flags indicating if the drift check is skipped.
*
*
* -
*
* If step property BaselineUsedForDriftCheck is set the same as
* CalculatedBaseline.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder clarifyCheck(ClarifyCheckStepMetadata clarifyCheck);
/**
*
* Container for the metadata for a Clarify check step. The configurations and outcomes of the check step
* execution. This includes:
*
*
* -
*
* The type of the check conducted,
*
*
* -
*
* The Amazon S3 URIs of baseline constraints and statistics files to be used for the drift check.
*
*
* -
*
* The Amazon S3 URIs of newly calculated baseline constraints and statistics.
*
*
* -
*
* The model package group name provided.
*
*
* -
*
* The Amazon S3 URI of the violation report if violations detected.
*
*
* -
*
* The Amazon Resource Name (ARN) of check processing job initiated by the step execution.
*
*
* -
*
* The boolean flags indicating if the drift check is skipped.
*
*
* -
*
* If step property BaselineUsedForDriftCheck is set the same as CalculatedBaseline.
*
*
*
* This is a convenience that creates an instance of the {@link ClarifyCheckStepMetadata.Builder} avoiding the
* need to create one manually via {@link ClarifyCheckStepMetadata#builder()}.
*
* When the {@link Consumer} completes, {@link ClarifyCheckStepMetadata.Builder#build()} is called immediately
* and its result is passed to {@link #clarifyCheck(ClarifyCheckStepMetadata)}.
*
* @param clarifyCheck
* a consumer that will call methods on {@link ClarifyCheckStepMetadata.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #clarifyCheck(ClarifyCheckStepMetadata)
*/
default Builder clarifyCheck(Consumer clarifyCheck) {
return clarifyCheck(ClarifyCheckStepMetadata.builder().applyMutation(clarifyCheck).build());
}
/**
*
* The configurations and outcomes of an EMR step execution.
*
*
* @param emr
* The configurations and outcomes of an EMR step execution.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder emr(EMRStepMetadata emr);
/**
*
* The configurations and outcomes of an EMR step execution.
*
* This is a convenience that creates an instance of the {@link EMRStepMetadata.Builder} avoiding the need to
* create one manually via {@link EMRStepMetadata#builder()}.
*
* When the {@link Consumer} completes, {@link EMRStepMetadata.Builder#build()} is called immediately and its
* result is passed to {@link #emr(EMRStepMetadata)}.
*
* @param emr
* a consumer that will call methods on {@link EMRStepMetadata.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #emr(EMRStepMetadata)
*/
default Builder emr(Consumer emr) {
return emr(EMRStepMetadata.builder().applyMutation(emr).build());
}
}
static final class BuilderImpl implements Builder {
private TrainingJobStepMetadata trainingJob;
private ProcessingJobStepMetadata processingJob;
private TransformJobStepMetadata transformJob;
private TuningJobStepMetaData tuningJob;
private ModelStepMetadata model;
private RegisterModelStepMetadata registerModel;
private ConditionStepMetadata condition;
private CallbackStepMetadata callback;
private LambdaStepMetadata lambda;
private QualityCheckStepMetadata qualityCheck;
private ClarifyCheckStepMetadata clarifyCheck;
private EMRStepMetadata emr;
private BuilderImpl() {
}
private BuilderImpl(PipelineExecutionStepMetadata model) {
trainingJob(model.trainingJob);
processingJob(model.processingJob);
transformJob(model.transformJob);
tuningJob(model.tuningJob);
model(model.model);
registerModel(model.registerModel);
condition(model.condition);
callback(model.callback);
lambda(model.lambda);
qualityCheck(model.qualityCheck);
clarifyCheck(model.clarifyCheck);
emr(model.emr);
}
public final TrainingJobStepMetadata.Builder getTrainingJob() {
return trainingJob != null ? trainingJob.toBuilder() : null;
}
public final void setTrainingJob(TrainingJobStepMetadata.BuilderImpl trainingJob) {
this.trainingJob = trainingJob != null ? trainingJob.build() : null;
}
@Override
@Transient
public final Builder trainingJob(TrainingJobStepMetadata trainingJob) {
this.trainingJob = trainingJob;
return this;
}
public final ProcessingJobStepMetadata.Builder getProcessingJob() {
return processingJob != null ? processingJob.toBuilder() : null;
}
public final void setProcessingJob(ProcessingJobStepMetadata.BuilderImpl processingJob) {
this.processingJob = processingJob != null ? processingJob.build() : null;
}
@Override
@Transient
public final Builder processingJob(ProcessingJobStepMetadata processingJob) {
this.processingJob = processingJob;
return this;
}
public final TransformJobStepMetadata.Builder getTransformJob() {
return transformJob != null ? transformJob.toBuilder() : null;
}
public final void setTransformJob(TransformJobStepMetadata.BuilderImpl transformJob) {
this.transformJob = transformJob != null ? transformJob.build() : null;
}
@Override
@Transient
public final Builder transformJob(TransformJobStepMetadata transformJob) {
this.transformJob = transformJob;
return this;
}
public final TuningJobStepMetaData.Builder getTuningJob() {
return tuningJob != null ? tuningJob.toBuilder() : null;
}
public final void setTuningJob(TuningJobStepMetaData.BuilderImpl tuningJob) {
this.tuningJob = tuningJob != null ? tuningJob.build() : null;
}
@Override
@Transient
public final Builder tuningJob(TuningJobStepMetaData tuningJob) {
this.tuningJob = tuningJob;
return this;
}
public final ModelStepMetadata.Builder getModel() {
return model != null ? model.toBuilder() : null;
}
public final void setModel(ModelStepMetadata.BuilderImpl model) {
this.model = model != null ? model.build() : null;
}
@Override
@Transient
public final Builder model(ModelStepMetadata model) {
this.model = model;
return this;
}
public final RegisterModelStepMetadata.Builder getRegisterModel() {
return registerModel != null ? registerModel.toBuilder() : null;
}
public final void setRegisterModel(RegisterModelStepMetadata.BuilderImpl registerModel) {
this.registerModel = registerModel != null ? registerModel.build() : null;
}
@Override
@Transient
public final Builder registerModel(RegisterModelStepMetadata registerModel) {
this.registerModel = registerModel;
return this;
}
public final ConditionStepMetadata.Builder getCondition() {
return condition != null ? condition.toBuilder() : null;
}
public final void setCondition(ConditionStepMetadata.BuilderImpl condition) {
this.condition = condition != null ? condition.build() : null;
}
@Override
@Transient
public final Builder condition(ConditionStepMetadata condition) {
this.condition = condition;
return this;
}
public final CallbackStepMetadata.Builder getCallback() {
return callback != null ? callback.toBuilder() : null;
}
public final void setCallback(CallbackStepMetadata.BuilderImpl callback) {
this.callback = callback != null ? callback.build() : null;
}
@Override
@Transient
public final Builder callback(CallbackStepMetadata callback) {
this.callback = callback;
return this;
}
public final LambdaStepMetadata.Builder getLambda() {
return lambda != null ? lambda.toBuilder() : null;
}
public final void setLambda(LambdaStepMetadata.BuilderImpl lambda) {
this.lambda = lambda != null ? lambda.build() : null;
}
@Override
@Transient
public final Builder lambda(LambdaStepMetadata lambda) {
this.lambda = lambda;
return this;
}
public final QualityCheckStepMetadata.Builder getQualityCheck() {
return qualityCheck != null ? qualityCheck.toBuilder() : null;
}
public final void setQualityCheck(QualityCheckStepMetadata.BuilderImpl qualityCheck) {
this.qualityCheck = qualityCheck != null ? qualityCheck.build() : null;
}
@Override
@Transient
public final Builder qualityCheck(QualityCheckStepMetadata qualityCheck) {
this.qualityCheck = qualityCheck;
return this;
}
public final ClarifyCheckStepMetadata.Builder getClarifyCheck() {
return clarifyCheck != null ? clarifyCheck.toBuilder() : null;
}
public final void setClarifyCheck(ClarifyCheckStepMetadata.BuilderImpl clarifyCheck) {
this.clarifyCheck = clarifyCheck != null ? clarifyCheck.build() : null;
}
@Override
@Transient
public final Builder clarifyCheck(ClarifyCheckStepMetadata clarifyCheck) {
this.clarifyCheck = clarifyCheck;
return this;
}
public final EMRStepMetadata.Builder getEmr() {
return emr != null ? emr.toBuilder() : null;
}
public final void setEmr(EMRStepMetadata.BuilderImpl emr) {
this.emr = emr != null ? emr.build() : null;
}
@Override
@Transient
public final Builder emr(EMRStepMetadata emr) {
this.emr = emr;
return this;
}
@Override
public PipelineExecutionStepMetadata build() {
return new PipelineExecutionStepMetadata(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}