software.amazon.awssdk.services.sagemaker.model.ListPipelineExecutionsResponse 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.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.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.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 ListPipelineExecutionsResponse extends SageMakerResponse implements
ToCopyableBuilder {
private static final SdkField> PIPELINE_EXECUTION_SUMMARIES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("PipelineExecutionSummaries")
.getter(getter(ListPipelineExecutionsResponse::pipelineExecutionSummaries))
.setter(setter(Builder::pipelineExecutionSummaries))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("PipelineExecutionSummaries").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(PipelineExecutionSummary::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField NEXT_TOKEN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("NextToken").getter(getter(ListPipelineExecutionsResponse::nextToken)).setter(setter(Builder::nextToken))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("NextToken").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(
PIPELINE_EXECUTION_SUMMARIES_FIELD, NEXT_TOKEN_FIELD));
private final List pipelineExecutionSummaries;
private final String nextToken;
private ListPipelineExecutionsResponse(BuilderImpl builder) {
super(builder);
this.pipelineExecutionSummaries = builder.pipelineExecutionSummaries;
this.nextToken = builder.nextToken;
}
/**
* For responses, this returns true if the service returned a value for the PipelineExecutionSummaries 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 hasPipelineExecutionSummaries() {
return pipelineExecutionSummaries != null && !(pipelineExecutionSummaries instanceof SdkAutoConstructList);
}
/**
*
* Contains a sorted list of pipeline execution summary objects matching the specified filters. Each run summary
* includes the Amazon Resource Name (ARN) of the pipeline execution, the run date, and the status. This list can be
* empty.
*
*
* 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 #hasPipelineExecutionSummaries} method.
*
*
* @return Contains a sorted list of pipeline execution summary objects matching the specified filters. Each run
* summary includes the Amazon Resource Name (ARN) of the pipeline execution, the run date, and the status.
* This list can be empty.
*/
public final List pipelineExecutionSummaries() {
return pipelineExecutionSummaries;
}
/**
*
* If the result of the previous ListPipelineExecutions request was truncated, the response includes a
* NextToken. To retrieve the next set of pipeline executions, use the token in the next request.
*
*
* @return If the result of the previous ListPipelineExecutions request was truncated, the response
* includes a NextToken. To retrieve the next set of pipeline executions, use the token in the
* next request.
*/
public final String nextToken() {
return nextToken;
}
@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(hasPipelineExecutionSummaries() ? pipelineExecutionSummaries() : null);
hashCode = 31 * hashCode + Objects.hashCode(nextToken());
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 ListPipelineExecutionsResponse)) {
return false;
}
ListPipelineExecutionsResponse other = (ListPipelineExecutionsResponse) obj;
return hasPipelineExecutionSummaries() == other.hasPipelineExecutionSummaries()
&& Objects.equals(pipelineExecutionSummaries(), other.pipelineExecutionSummaries())
&& Objects.equals(nextToken(), other.nextToken());
}
/**
* 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("ListPipelineExecutionsResponse")
.add("PipelineExecutionSummaries", hasPipelineExecutionSummaries() ? pipelineExecutionSummaries() : null)
.add("NextToken", nextToken()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "PipelineExecutionSummaries":
return Optional.ofNullable(clazz.cast(pipelineExecutionSummaries()));
case "NextToken":
return Optional.ofNullable(clazz.cast(nextToken()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((ListPipelineExecutionsResponse) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SageMakerResponse.Builder, SdkPojo, CopyableBuilder {
/**
*
* Contains a sorted list of pipeline execution summary objects matching the specified filters. Each run summary
* includes the Amazon Resource Name (ARN) of the pipeline execution, the run date, and the status. This list
* can be empty.
*
*
* @param pipelineExecutionSummaries
* Contains a sorted list of pipeline execution summary objects matching the specified filters. Each run
* summary includes the Amazon Resource Name (ARN) of the pipeline execution, the run date, and the
* status. This list can be empty.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder pipelineExecutionSummaries(Collection pipelineExecutionSummaries);
/**
*
* Contains a sorted list of pipeline execution summary objects matching the specified filters. Each run summary
* includes the Amazon Resource Name (ARN) of the pipeline execution, the run date, and the status. This list
* can be empty.
*
*
* @param pipelineExecutionSummaries
* Contains a sorted list of pipeline execution summary objects matching the specified filters. Each run
* summary includes the Amazon Resource Name (ARN) of the pipeline execution, the run date, and the
* status. This list can be empty.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder pipelineExecutionSummaries(PipelineExecutionSummary... pipelineExecutionSummaries);
/**
*
* Contains a sorted list of pipeline execution summary objects matching the specified filters. Each run summary
* includes the Amazon Resource Name (ARN) of the pipeline execution, the run date, and the status. This list
* can be empty.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.sagemaker.model.PipelineExecutionSummary.Builder} avoiding the need to
* create one manually via
* {@link software.amazon.awssdk.services.sagemaker.model.PipelineExecutionSummary#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.sagemaker.model.PipelineExecutionSummary.Builder#build()} is called
* immediately and its result is passed to {@link #pipelineExecutionSummaries(List)}.
*
* @param pipelineExecutionSummaries
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.sagemaker.model.PipelineExecutionSummary.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #pipelineExecutionSummaries(java.util.Collection)
*/
Builder pipelineExecutionSummaries(Consumer... pipelineExecutionSummaries);
/**
*
* If the result of the previous ListPipelineExecutions request was truncated, the response
* includes a NextToken. To retrieve the next set of pipeline executions, use the token in the next
* request.
*
*
* @param nextToken
* If the result of the previous ListPipelineExecutions request was truncated, the response
* includes a NextToken. To retrieve the next set of pipeline executions, 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);
}
static final class BuilderImpl extends SageMakerResponse.BuilderImpl implements Builder {
private List pipelineExecutionSummaries = DefaultSdkAutoConstructList.getInstance();
private String nextToken;
private BuilderImpl() {
}
private BuilderImpl(ListPipelineExecutionsResponse model) {
super(model);
pipelineExecutionSummaries(model.pipelineExecutionSummaries);
nextToken(model.nextToken);
}
public final List getPipelineExecutionSummaries() {
List result = PipelineExecutionSummaryListCopier
.copyToBuilder(this.pipelineExecutionSummaries);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setPipelineExecutionSummaries(
Collection pipelineExecutionSummaries) {
this.pipelineExecutionSummaries = PipelineExecutionSummaryListCopier.copyFromBuilder(pipelineExecutionSummaries);
}
@Override
public final Builder pipelineExecutionSummaries(Collection pipelineExecutionSummaries) {
this.pipelineExecutionSummaries = PipelineExecutionSummaryListCopier.copy(pipelineExecutionSummaries);
return this;
}
@Override
@SafeVarargs
public final Builder pipelineExecutionSummaries(PipelineExecutionSummary... pipelineExecutionSummaries) {
pipelineExecutionSummaries(Arrays.asList(pipelineExecutionSummaries));
return this;
}
@Override
@SafeVarargs
public final Builder pipelineExecutionSummaries(Consumer... pipelineExecutionSummaries) {
pipelineExecutionSummaries(Stream.of(pipelineExecutionSummaries)
.map(c -> PipelineExecutionSummary.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
public final String getNextToken() {
return nextToken;
}
public final void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
@Override
public final Builder nextToken(String nextToken) {
this.nextToken = nextToken;
return this;
}
@Override
public ListPipelineExecutionsResponse build() {
return new ListPipelineExecutionsResponse(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}