software.amazon.awssdk.services.sagemaker.model.SendPipelineExecutionStepSuccessRequest 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 SendPipelineExecutionStepSuccessRequest extends SageMakerRequest implements
ToCopyableBuilder {
private static final SdkField CALLBACK_TOKEN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("CallbackToken").getter(getter(SendPipelineExecutionStepSuccessRequest::callbackToken))
.setter(setter(Builder::callbackToken))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("CallbackToken").build()).build();
private static final SdkField> OUTPUT_PARAMETERS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("OutputParameters")
.getter(getter(SendPipelineExecutionStepSuccessRequest::outputParameters))
.setter(setter(Builder::outputParameters))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("OutputParameters").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(OutputParameter::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField CLIENT_REQUEST_TOKEN_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("ClientRequestToken")
.getter(getter(SendPipelineExecutionStepSuccessRequest::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(CALLBACK_TOKEN_FIELD,
OUTPUT_PARAMETERS_FIELD, CLIENT_REQUEST_TOKEN_FIELD));
private final String callbackToken;
private final List outputParameters;
private final String clientRequestToken;
private SendPipelineExecutionStepSuccessRequest(BuilderImpl builder) {
super(builder);
this.callbackToken = builder.callbackToken;
this.outputParameters = builder.outputParameters;
this.clientRequestToken = builder.clientRequestToken;
}
/**
*
* The pipeline generated token from the Amazon SQS queue.
*
*
* @return The pipeline generated token from the Amazon SQS queue.
*/
public final String callbackToken() {
return callbackToken;
}
/**
* For responses, this returns true if the service returned a value for the OutputParameters property. This DOES NOT
* check that the value is non-empty (for which, you should check the {@code isEmpty()} method on the property).
* This is useful because the SDK will never return a null collection or map, but you may need to differentiate
* between the service returning nothing (or null) and the service returning an empty collection or map. For
* requests, this returns true if a value for the property was specified in the request builder, and false if a
* value was not specified.
*/
public final boolean hasOutputParameters() {
return outputParameters != null && !(outputParameters instanceof SdkAutoConstructList);
}
/**
*
* A list of the output parameters of the callback step.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* This method will never return null. If you would like to know whether the service returned this field (so that
* you can differentiate between null and empty), you can use the {@link #hasOutputParameters} method.
*
*
* @return A list of the output parameters of the callback step.
*/
public final List outputParameters() {
return outputParameters;
}
/**
*
* 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(callbackToken());
hashCode = 31 * hashCode + Objects.hashCode(hasOutputParameters() ? outputParameters() : null);
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 SendPipelineExecutionStepSuccessRequest)) {
return false;
}
SendPipelineExecutionStepSuccessRequest other = (SendPipelineExecutionStepSuccessRequest) obj;
return Objects.equals(callbackToken(), other.callbackToken()) && hasOutputParameters() == other.hasOutputParameters()
&& Objects.equals(outputParameters(), other.outputParameters())
&& 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("SendPipelineExecutionStepSuccessRequest").add("CallbackToken", callbackToken())
.add("OutputParameters", hasOutputParameters() ? outputParameters() : null)
.add("ClientRequestToken", clientRequestToken()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "CallbackToken":
return Optional.ofNullable(clazz.cast(callbackToken()));
case "OutputParameters":
return Optional.ofNullable(clazz.cast(outputParameters()));
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((SendPipelineExecutionStepSuccessRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SageMakerRequest.Builder, SdkPojo,
CopyableBuilder {
/**
*
* The pipeline generated token from the Amazon SQS queue.
*
*
* @param callbackToken
* The pipeline generated token from the Amazon SQS queue.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder callbackToken(String callbackToken);
/**
*
* A list of the output parameters of the callback step.
*
*
* @param outputParameters
* A list of the output parameters of the callback step.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder outputParameters(Collection outputParameters);
/**
*
* A list of the output parameters of the callback step.
*
*
* @param outputParameters
* A list of the output parameters of the callback step.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder outputParameters(OutputParameter... outputParameters);
/**
*
* A list of the output parameters of the callback step.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.sagemaker.model.OutputParameter.Builder} avoiding the need to create
* one manually via {@link software.amazon.awssdk.services.sagemaker.model.OutputParameter#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.sagemaker.model.OutputParameter.Builder#build()} is called immediately
* and its result is passed to {@link #outputParameters(List)}.
*
* @param outputParameters
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.sagemaker.model.OutputParameter.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #outputParameters(java.util.Collection)
*/
Builder outputParameters(Consumer... outputParameters);
/**
*
* 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 callbackToken;
private List outputParameters = DefaultSdkAutoConstructList.getInstance();
private String clientRequestToken;
private BuilderImpl() {
}
private BuilderImpl(SendPipelineExecutionStepSuccessRequest model) {
super(model);
callbackToken(model.callbackToken);
outputParameters(model.outputParameters);
clientRequestToken(model.clientRequestToken);
}
public final String getCallbackToken() {
return callbackToken;
}
public final void setCallbackToken(String callbackToken) {
this.callbackToken = callbackToken;
}
@Override
public final Builder callbackToken(String callbackToken) {
this.callbackToken = callbackToken;
return this;
}
public final List getOutputParameters() {
List result = OutputParameterListCopier.copyToBuilder(this.outputParameters);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setOutputParameters(Collection outputParameters) {
this.outputParameters = OutputParameterListCopier.copyFromBuilder(outputParameters);
}
@Override
public final Builder outputParameters(Collection outputParameters) {
this.outputParameters = OutputParameterListCopier.copy(outputParameters);
return this;
}
@Override
@SafeVarargs
public final Builder outputParameters(OutputParameter... outputParameters) {
outputParameters(Arrays.asList(outputParameters));
return this;
}
@Override
@SafeVarargs
public final Builder outputParameters(Consumer... outputParameters) {
outputParameters(Stream.of(outputParameters).map(c -> OutputParameter.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
public final String getClientRequestToken() {
return clientRequestToken;
}
public final void setClientRequestToken(String clientRequestToken) {
this.clientRequestToken = clientRequestToken;
}
@Override
public final Builder clientRequestToken(String clientRequestToken) {
this.clientRequestToken = clientRequestToken;
return this;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public SendPipelineExecutionStepSuccessRequest build() {
return new SendPipelineExecutionStepSuccessRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}