software.amazon.awssdk.services.sagemaker.model.StartPipelineExecutionRequest Maven / Gradle / Ivy
/*
* 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.util.Arrays;
import java.util.Collection;
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 java.util.stream.Collectors;
import java.util.stream.Stream;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
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.DefaultValueTrait;
import software.amazon.awssdk.core.traits.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class StartPipelineExecutionRequest extends SageMakerRequest implements
ToCopyableBuilder {
private static final SdkField PIPELINE_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("PipelineName").getter(getter(StartPipelineExecutionRequest::pipelineName))
.setter(setter(Builder::pipelineName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("PipelineName").build()).build();
private static final SdkField PIPELINE_EXECUTION_DISPLAY_NAME_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("PipelineExecutionDisplayName")
.getter(getter(StartPipelineExecutionRequest::pipelineExecutionDisplayName))
.setter(setter(Builder::pipelineExecutionDisplayName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("PipelineExecutionDisplayName")
.build()).build();
private static final SdkField> PIPELINE_PARAMETERS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("PipelineParameters")
.getter(getter(StartPipelineExecutionRequest::pipelineParameters))
.setter(setter(Builder::pipelineParameters))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("PipelineParameters").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(Parameter::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField PIPELINE_EXECUTION_DESCRIPTION_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("PipelineExecutionDescription")
.getter(getter(StartPipelineExecutionRequest::pipelineExecutionDescription))
.setter(setter(Builder::pipelineExecutionDescription))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("PipelineExecutionDescription")
.build()).build();
private static final SdkField CLIENT_REQUEST_TOKEN_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("ClientRequestToken")
.getter(getter(StartPipelineExecutionRequest::clientRequestToken))
.setter(setter(Builder::clientRequestToken))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ClientRequestToken").build(),
DefaultValueTrait.idempotencyToken()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(PIPELINE_NAME_FIELD,
PIPELINE_EXECUTION_DISPLAY_NAME_FIELD, PIPELINE_PARAMETERS_FIELD, PIPELINE_EXECUTION_DESCRIPTION_FIELD,
CLIENT_REQUEST_TOKEN_FIELD));
private final String pipelineName;
private final String pipelineExecutionDisplayName;
private final List pipelineParameters;
private final String pipelineExecutionDescription;
private final String clientRequestToken;
private StartPipelineExecutionRequest(BuilderImpl builder) {
super(builder);
this.pipelineName = builder.pipelineName;
this.pipelineExecutionDisplayName = builder.pipelineExecutionDisplayName;
this.pipelineParameters = builder.pipelineParameters;
this.pipelineExecutionDescription = builder.pipelineExecutionDescription;
this.clientRequestToken = builder.clientRequestToken;
}
/**
*
* The name of the pipeline.
*
*
* @return The name of the pipeline.
*/
public final String pipelineName() {
return pipelineName;
}
/**
*
* The display name of the pipeline execution.
*
*
* @return The display name of the pipeline execution.
*/
public final String pipelineExecutionDisplayName() {
return pipelineExecutionDisplayName;
}
/**
* Returns true if the PipelineParameters property was specified by the sender (it may be empty), or false if the
* sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS
* service.
*/
public final boolean hasPipelineParameters() {
return pipelineParameters != null && !(pipelineParameters instanceof SdkAutoConstructList);
}
/**
*
* Contains a list of pipeline parameters. This list can be empty.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* You can use {@link #hasPipelineParameters()} to see if a value was sent in this field.
*
*
* @return Contains a list of pipeline parameters. This list can be empty.
*/
public final List pipelineParameters() {
return pipelineParameters;
}
/**
*
* The description of the pipeline execution.
*
*
* @return The description of the pipeline execution.
*/
public final String pipelineExecutionDescription() {
return pipelineExecutionDescription;
}
/**
*
* A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent
* operation completes no more than one time.
*
*
* @return A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An
* idempotent operation completes no more than one time.
*/
public final String clientRequestToken() {
return clientRequestToken;
}
@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 + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(pipelineName());
hashCode = 31 * hashCode + Objects.hashCode(pipelineExecutionDisplayName());
hashCode = 31 * hashCode + Objects.hashCode(hasPipelineParameters() ? pipelineParameters() : null);
hashCode = 31 * hashCode + Objects.hashCode(pipelineExecutionDescription());
hashCode = 31 * hashCode + Objects.hashCode(clientRequestToken());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof StartPipelineExecutionRequest)) {
return false;
}
StartPipelineExecutionRequest other = (StartPipelineExecutionRequest) obj;
return Objects.equals(pipelineName(), other.pipelineName())
&& Objects.equals(pipelineExecutionDisplayName(), other.pipelineExecutionDisplayName())
&& hasPipelineParameters() == other.hasPipelineParameters()
&& Objects.equals(pipelineParameters(), other.pipelineParameters())
&& Objects.equals(pipelineExecutionDescription(), other.pipelineExecutionDescription())
&& Objects.equals(clientRequestToken(), other.clientRequestToken());
}
/**
* 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("StartPipelineExecutionRequest").add("PipelineName", pipelineName())
.add("PipelineExecutionDisplayName", pipelineExecutionDisplayName())
.add("PipelineParameters", hasPipelineParameters() ? pipelineParameters() : null)
.add("PipelineExecutionDescription", pipelineExecutionDescription())
.add("ClientRequestToken", clientRequestToken()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "PipelineName":
return Optional.ofNullable(clazz.cast(pipelineName()));
case "PipelineExecutionDisplayName":
return Optional.ofNullable(clazz.cast(pipelineExecutionDisplayName()));
case "PipelineParameters":
return Optional.ofNullable(clazz.cast(pipelineParameters()));
case "PipelineExecutionDescription":
return Optional.ofNullable(clazz.cast(pipelineExecutionDescription()));
case "ClientRequestToken":
return Optional.ofNullable(clazz.cast(clientRequestToken()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((StartPipelineExecutionRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SageMakerRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The name of the pipeline.
*
*
* @param pipelineName
* The name of the pipeline.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder pipelineName(String pipelineName);
/**
*
* The display name of the pipeline execution.
*
*
* @param pipelineExecutionDisplayName
* The display name of the pipeline execution.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder pipelineExecutionDisplayName(String pipelineExecutionDisplayName);
/**
*
* Contains a list of pipeline parameters. This list can be empty.
*
*
* @param pipelineParameters
* Contains a list of pipeline parameters. This list can be empty.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder pipelineParameters(Collection pipelineParameters);
/**
*
* Contains a list of pipeline parameters. This list can be empty.
*
*
* @param pipelineParameters
* Contains a list of pipeline parameters. This list can be empty.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder pipelineParameters(Parameter... pipelineParameters);
/**
*
* Contains a list of pipeline parameters. This list can be empty.
*
* This is a convenience that creates an instance of the {@link List.Builder} avoiding the need to
* create one manually via {@link List#builder()}.
*
* When the {@link Consumer} completes, {@link List.Builder#build()} is called immediately and its
* result is passed to {@link #pipelineParameters(List)}.
*
* @param pipelineParameters
* a consumer that will call methods on {@link List.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #pipelineParameters(List)
*/
Builder pipelineParameters(Consumer... pipelineParameters);
/**
*
* The description of the pipeline execution.
*
*
* @param pipelineExecutionDescription
* The description of the pipeline execution.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder pipelineExecutionDescription(String pipelineExecutionDescription);
/**
*
* A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An
* idempotent operation completes no more than one time.
*
*
* @param clientRequestToken
* A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An
* idempotent operation completes no more than one time.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder clientRequestToken(String clientRequestToken);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends SageMakerRequest.BuilderImpl implements Builder {
private String pipelineName;
private String pipelineExecutionDisplayName;
private List pipelineParameters = DefaultSdkAutoConstructList.getInstance();
private String pipelineExecutionDescription;
private String clientRequestToken;
private BuilderImpl() {
}
private BuilderImpl(StartPipelineExecutionRequest model) {
super(model);
pipelineName(model.pipelineName);
pipelineExecutionDisplayName(model.pipelineExecutionDisplayName);
pipelineParameters(model.pipelineParameters);
pipelineExecutionDescription(model.pipelineExecutionDescription);
clientRequestToken(model.clientRequestToken);
}
public final String getPipelineName() {
return pipelineName;
}
@Override
public final Builder pipelineName(String pipelineName) {
this.pipelineName = pipelineName;
return this;
}
public final void setPipelineName(String pipelineName) {
this.pipelineName = pipelineName;
}
public final String getPipelineExecutionDisplayName() {
return pipelineExecutionDisplayName;
}
@Override
public final Builder pipelineExecutionDisplayName(String pipelineExecutionDisplayName) {
this.pipelineExecutionDisplayName = pipelineExecutionDisplayName;
return this;
}
public final void setPipelineExecutionDisplayName(String pipelineExecutionDisplayName) {
this.pipelineExecutionDisplayName = pipelineExecutionDisplayName;
}
public final List getPipelineParameters() {
List result = ParameterListCopier.copyToBuilder(this.pipelineParameters);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
@Override
public final Builder pipelineParameters(Collection pipelineParameters) {
this.pipelineParameters = ParameterListCopier.copy(pipelineParameters);
return this;
}
@Override
@SafeVarargs
public final Builder pipelineParameters(Parameter... pipelineParameters) {
pipelineParameters(Arrays.asList(pipelineParameters));
return this;
}
@Override
@SafeVarargs
public final Builder pipelineParameters(Consumer... pipelineParameters) {
pipelineParameters(Stream.of(pipelineParameters).map(c -> Parameter.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
public final void setPipelineParameters(Collection pipelineParameters) {
this.pipelineParameters = ParameterListCopier.copyFromBuilder(pipelineParameters);
}
public final String getPipelineExecutionDescription() {
return pipelineExecutionDescription;
}
@Override
public final Builder pipelineExecutionDescription(String pipelineExecutionDescription) {
this.pipelineExecutionDescription = pipelineExecutionDescription;
return this;
}
public final void setPipelineExecutionDescription(String pipelineExecutionDescription) {
this.pipelineExecutionDescription = pipelineExecutionDescription;
}
public final String getClientRequestToken() {
return clientRequestToken;
}
@Override
public final Builder clientRequestToken(String clientRequestToken) {
this.clientRequestToken = clientRequestToken;
return this;
}
public final void setClientRequestToken(String clientRequestToken) {
this.clientRequestToken = clientRequestToken;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public StartPipelineExecutionRequest build() {
return new StartPipelineExecutionRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy