software.amazon.awssdk.services.sagemaker.model.ListPipelineExecutionStepsRequest Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of sagemaker Show documentation
Show all versions of sagemaker Show documentation
The AWS Java SDK for Amazon SageMaker module holds the client classes that are used for communicating
with Amazon SageMaker Service
/*
* 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.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.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.LocationTrait;
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 ListPipelineExecutionStepsRequest extends SageMakerRequest implements
ToCopyableBuilder {
private static final SdkField PIPELINE_EXECUTION_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("PipelineExecutionArn").getter(getter(ListPipelineExecutionStepsRequest::pipelineExecutionArn))
.setter(setter(Builder::pipelineExecutionArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("PipelineExecutionArn").build())
.build();
private static final SdkField NEXT_TOKEN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("NextToken").getter(getter(ListPipelineExecutionStepsRequest::nextToken))
.setter(setter(Builder::nextToken))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("NextToken").build()).build();
private static final SdkField MAX_RESULTS_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("MaxResults").getter(getter(ListPipelineExecutionStepsRequest::maxResults))
.setter(setter(Builder::maxResults))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MaxResults").build()).build();
private static final SdkField SORT_ORDER_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("SortOrder").getter(getter(ListPipelineExecutionStepsRequest::sortOrderAsString))
.setter(setter(Builder::sortOrder))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SortOrder").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(PIPELINE_EXECUTION_ARN_FIELD,
NEXT_TOKEN_FIELD, MAX_RESULTS_FIELD, SORT_ORDER_FIELD));
private final String pipelineExecutionArn;
private final String nextToken;
private final Integer maxResults;
private final String sortOrder;
private ListPipelineExecutionStepsRequest(BuilderImpl builder) {
super(builder);
this.pipelineExecutionArn = builder.pipelineExecutionArn;
this.nextToken = builder.nextToken;
this.maxResults = builder.maxResults;
this.sortOrder = builder.sortOrder;
}
/**
*
* The Amazon Resource Name (ARN) of the pipeline execution.
*
*
* @return The Amazon Resource Name (ARN) of the pipeline execution.
*/
public final String pipelineExecutionArn() {
return pipelineExecutionArn;
}
/**
*
* If the result of the previous ListPipelineExecutionSteps request was truncated, the response
* includes a NextToken. To retrieve the next set of pipeline execution steps, use the token in the
* next request.
*
*
* @return If the result of the previous ListPipelineExecutionSteps request was truncated, the response
* includes a NextToken. To retrieve the next set of pipeline execution steps, use the token in
* the next request.
*/
public final String nextToken() {
return nextToken;
}
/**
*
* The maximum number of pipeline execution steps to return in the response.
*
*
* @return The maximum number of pipeline execution steps to return in the response.
*/
public final Integer maxResults() {
return maxResults;
}
/**
*
* The field by which to sort results. The default is CreatedTime.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #sortOrder} will
* return {@link SortOrder#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #sortOrderAsString}.
*
*
* @return The field by which to sort results. The default is CreatedTime.
* @see SortOrder
*/
public final SortOrder sortOrder() {
return SortOrder.fromValue(sortOrder);
}
/**
*
* The field by which to sort results. The default is CreatedTime.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #sortOrder} will
* return {@link SortOrder#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #sortOrderAsString}.
*
*
* @return The field by which to sort results. The default is CreatedTime.
* @see SortOrder
*/
public final String sortOrderAsString() {
return sortOrder;
}
@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(pipelineExecutionArn());
hashCode = 31 * hashCode + Objects.hashCode(nextToken());
hashCode = 31 * hashCode + Objects.hashCode(maxResults());
hashCode = 31 * hashCode + Objects.hashCode(sortOrderAsString());
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 ListPipelineExecutionStepsRequest)) {
return false;
}
ListPipelineExecutionStepsRequest other = (ListPipelineExecutionStepsRequest) obj;
return Objects.equals(pipelineExecutionArn(), other.pipelineExecutionArn())
&& Objects.equals(nextToken(), other.nextToken()) && Objects.equals(maxResults(), other.maxResults())
&& Objects.equals(sortOrderAsString(), other.sortOrderAsString());
}
/**
* 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("ListPipelineExecutionStepsRequest").add("PipelineExecutionArn", pipelineExecutionArn())
.add("NextToken", nextToken()).add("MaxResults", maxResults()).add("SortOrder", sortOrderAsString()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "PipelineExecutionArn":
return Optional.ofNullable(clazz.cast(pipelineExecutionArn()));
case "NextToken":
return Optional.ofNullable(clazz.cast(nextToken()));
case "MaxResults":
return Optional.ofNullable(clazz.cast(maxResults()));
case "SortOrder":
return Optional.ofNullable(clazz.cast(sortOrderAsString()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((ListPipelineExecutionStepsRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SageMakerRequest.Builder, SdkPojo,
CopyableBuilder {
/**
*
* The Amazon Resource Name (ARN) of the pipeline execution.
*
*
* @param pipelineExecutionArn
* The Amazon Resource Name (ARN) of the pipeline execution.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder pipelineExecutionArn(String pipelineExecutionArn);
/**
*
* If the result of the previous ListPipelineExecutionSteps request was truncated, the response
* includes a NextToken. To retrieve the next set of pipeline execution steps, use the token in the
* next request.
*
*
* @param nextToken
* If the result of the previous ListPipelineExecutionSteps request was truncated, the
* response includes a NextToken. To retrieve the next set of pipeline execution steps, use
* the token in the next request.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder nextToken(String nextToken);
/**
*
* The maximum number of pipeline execution steps to return in the response.
*
*
* @param maxResults
* The maximum number of pipeline execution steps to return in the response.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder maxResults(Integer maxResults);
/**
*
* The field by which to sort results. The default is CreatedTime.
*
*
* @param sortOrder
* The field by which to sort results. The default is CreatedTime.
* @see SortOrder
* @return Returns a reference to this object so that method calls can be chained together.
* @see SortOrder
*/
Builder sortOrder(String sortOrder);
/**
*
* The field by which to sort results. The default is CreatedTime.
*
*
* @param sortOrder
* The field by which to sort results. The default is CreatedTime.
* @see SortOrder
* @return Returns a reference to this object so that method calls can be chained together.
* @see SortOrder
*/
Builder sortOrder(SortOrder sortOrder);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends SageMakerRequest.BuilderImpl implements Builder {
private String pipelineExecutionArn;
private String nextToken;
private Integer maxResults;
private String sortOrder;
private BuilderImpl() {
}
private BuilderImpl(ListPipelineExecutionStepsRequest model) {
super(model);
pipelineExecutionArn(model.pipelineExecutionArn);
nextToken(model.nextToken);
maxResults(model.maxResults);
sortOrder(model.sortOrder);
}
public final String getPipelineExecutionArn() {
return pipelineExecutionArn;
}
@Override
public final Builder pipelineExecutionArn(String pipelineExecutionArn) {
this.pipelineExecutionArn = pipelineExecutionArn;
return this;
}
public final void setPipelineExecutionArn(String pipelineExecutionArn) {
this.pipelineExecutionArn = pipelineExecutionArn;
}
public final String getNextToken() {
return nextToken;
}
@Override
public final Builder nextToken(String nextToken) {
this.nextToken = nextToken;
return this;
}
public final void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
public final Integer getMaxResults() {
return maxResults;
}
@Override
public final Builder maxResults(Integer maxResults) {
this.maxResults = maxResults;
return this;
}
public final void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
public final String getSortOrder() {
return sortOrder;
}
@Override
public final Builder sortOrder(String sortOrder) {
this.sortOrder = sortOrder;
return this;
}
@Override
public final Builder sortOrder(SortOrder sortOrder) {
this.sortOrder(sortOrder == null ? null : sortOrder.toString());
return this;
}
public final void setSortOrder(String sortOrder) {
this.sortOrder = sortOrder;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public ListPipelineExecutionStepsRequest build() {
return new ListPipelineExecutionStepsRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy