software.amazon.awssdk.services.datapipeline.model.ListPipelinesResponse 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.datapipeline.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;
/**
*
* Contains the output of ListPipelines.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class ListPipelinesResponse extends DataPipelineResponse implements
ToCopyableBuilder {
private static final SdkField> PIPELINE_ID_LIST_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("pipelineIdList")
.getter(getter(ListPipelinesResponse::pipelineIdList))
.setter(setter(Builder::pipelineIdList))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("pipelineIdList").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(PipelineIdName::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField MARKER_FIELD = SdkField. builder(MarshallingType.STRING).memberName("marker")
.getter(getter(ListPipelinesResponse::marker)).setter(setter(Builder::marker))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("marker").build()).build();
private static final SdkField HAS_MORE_RESULTS_FIELD = SdkField. builder(MarshallingType.BOOLEAN)
.memberName("hasMoreResults").getter(getter(ListPipelinesResponse::hasMoreResults))
.setter(setter(Builder::hasMoreResults))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("hasMoreResults").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(PIPELINE_ID_LIST_FIELD,
MARKER_FIELD, HAS_MORE_RESULTS_FIELD));
private final List pipelineIdList;
private final String marker;
private final Boolean hasMoreResults;
private ListPipelinesResponse(BuilderImpl builder) {
super(builder);
this.pipelineIdList = builder.pipelineIdList;
this.marker = builder.marker;
this.hasMoreResults = builder.hasMoreResults;
}
/**
* For responses, this returns true if the service returned a value for the PipelineIdList 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 hasPipelineIdList() {
return pipelineIdList != null && !(pipelineIdList instanceof SdkAutoConstructList);
}
/**
*
* The pipeline identifiers. If you require additional information about the pipelines, you can use these
* identifiers to call DescribePipelines and GetPipelineDefinition.
*
*
* 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 #hasPipelineIdList} method.
*
*
* @return The pipeline identifiers. If you require additional information about the pipelines, you can use these
* identifiers to call DescribePipelines and GetPipelineDefinition.
*/
public final List pipelineIdList() {
return pipelineIdList;
}
/**
*
* The starting point for the next page of results. To view the next page of results, call
* ListPipelinesOutput again with this marker value. If the value is null, there are no more results.
*
*
* @return The starting point for the next page of results. To view the next page of results, call
* ListPipelinesOutput again with this marker value. If the value is null, there are no more
* results.
*/
public final String marker() {
return marker;
}
/**
*
* Indicates whether there are more results that can be obtained by a subsequent call.
*
*
* @return Indicates whether there are more results that can be obtained by a subsequent call.
*/
public final Boolean hasMoreResults() {
return hasMoreResults;
}
@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(hasPipelineIdList() ? pipelineIdList() : null);
hashCode = 31 * hashCode + Objects.hashCode(marker());
hashCode = 31 * hashCode + Objects.hashCode(hasMoreResults());
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 ListPipelinesResponse)) {
return false;
}
ListPipelinesResponse other = (ListPipelinesResponse) obj;
return hasPipelineIdList() == other.hasPipelineIdList() && Objects.equals(pipelineIdList(), other.pipelineIdList())
&& Objects.equals(marker(), other.marker()) && Objects.equals(hasMoreResults(), other.hasMoreResults());
}
/**
* 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("ListPipelinesResponse").add("PipelineIdList", hasPipelineIdList() ? pipelineIdList() : null)
.add("Marker", marker()).add("HasMoreResults", hasMoreResults()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "pipelineIdList":
return Optional.ofNullable(clazz.cast(pipelineIdList()));
case "marker":
return Optional.ofNullable(clazz.cast(marker()));
case "hasMoreResults":
return Optional.ofNullable(clazz.cast(hasMoreResults()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((ListPipelinesResponse) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends DataPipelineResponse.Builder, SdkPojo, CopyableBuilder {
/**
*
* The pipeline identifiers. If you require additional information about the pipelines, you can use these
* identifiers to call DescribePipelines and GetPipelineDefinition.
*
*
* @param pipelineIdList
* The pipeline identifiers. If you require additional information about the pipelines, you can use these
* identifiers to call DescribePipelines and GetPipelineDefinition.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder pipelineIdList(Collection pipelineIdList);
/**
*
* The pipeline identifiers. If you require additional information about the pipelines, you can use these
* identifiers to call DescribePipelines and GetPipelineDefinition.
*
*
* @param pipelineIdList
* The pipeline identifiers. If you require additional information about the pipelines, you can use these
* identifiers to call DescribePipelines and GetPipelineDefinition.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder pipelineIdList(PipelineIdName... pipelineIdList);
/**
*
* The pipeline identifiers. If you require additional information about the pipelines, you can use these
* identifiers to call DescribePipelines and GetPipelineDefinition.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.datapipeline.model.PipelineIdName.Builder} avoiding the need to create
* one manually via {@link software.amazon.awssdk.services.datapipeline.model.PipelineIdName#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.datapipeline.model.PipelineIdName.Builder#build()} is called
* immediately and its result is passed to {@link #pipelineIdList(List)}.
*
* @param pipelineIdList
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.datapipeline.model.PipelineIdName.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #pipelineIdList(java.util.Collection)
*/
Builder pipelineIdList(Consumer... pipelineIdList);
/**
*
* The starting point for the next page of results. To view the next page of results, call
* ListPipelinesOutput again with this marker value. If the value is null, there are no more
* results.
*
*
* @param marker
* The starting point for the next page of results. To view the next page of results, call
* ListPipelinesOutput again with this marker value. If the value is null, there are no more
* results.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder marker(String marker);
/**
*
* Indicates whether there are more results that can be obtained by a subsequent call.
*
*
* @param hasMoreResults
* Indicates whether there are more results that can be obtained by a subsequent call.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder hasMoreResults(Boolean hasMoreResults);
}
static final class BuilderImpl extends DataPipelineResponse.BuilderImpl implements Builder {
private List pipelineIdList = DefaultSdkAutoConstructList.getInstance();
private String marker;
private Boolean hasMoreResults;
private BuilderImpl() {
}
private BuilderImpl(ListPipelinesResponse model) {
super(model);
pipelineIdList(model.pipelineIdList);
marker(model.marker);
hasMoreResults(model.hasMoreResults);
}
public final List getPipelineIdList() {
List result = _pipelineListCopier.copyToBuilder(this.pipelineIdList);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setPipelineIdList(Collection pipelineIdList) {
this.pipelineIdList = _pipelineListCopier.copyFromBuilder(pipelineIdList);
}
@Override
public final Builder pipelineIdList(Collection pipelineIdList) {
this.pipelineIdList = _pipelineListCopier.copy(pipelineIdList);
return this;
}
@Override
@SafeVarargs
public final Builder pipelineIdList(PipelineIdName... pipelineIdList) {
pipelineIdList(Arrays.asList(pipelineIdList));
return this;
}
@Override
@SafeVarargs
public final Builder pipelineIdList(Consumer... pipelineIdList) {
pipelineIdList(Stream.of(pipelineIdList).map(c -> PipelineIdName.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
public final String getMarker() {
return marker;
}
public final void setMarker(String marker) {
this.marker = marker;
}
@Override
public final Builder marker(String marker) {
this.marker = marker;
return this;
}
public final Boolean getHasMoreResults() {
return hasMoreResults;
}
public final void setHasMoreResults(Boolean hasMoreResults) {
this.hasMoreResults = hasMoreResults;
}
@Override
public final Builder hasMoreResults(Boolean hasMoreResults) {
this.hasMoreResults = hasMoreResults;
return this;
}
@Override
public ListPipelinesResponse build() {
return new ListPipelinesResponse(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}