software.amazon.awssdk.services.datapipeline.model.DescribeObjectsResponse Maven / Gradle / Ivy
Show all versions of datapipeline 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.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 DescribeObjects.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class DescribeObjectsResponse extends DataPipelineResponse implements
ToCopyableBuilder {
private static final SdkField> PIPELINE_OBJECTS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("pipelineObjects")
.getter(getter(DescribeObjectsResponse::pipelineObjects))
.setter(setter(Builder::pipelineObjects))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("pipelineObjects").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(PipelineObject::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(DescribeObjectsResponse::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(DescribeObjectsResponse::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_OBJECTS_FIELD,
MARKER_FIELD, HAS_MORE_RESULTS_FIELD));
private final List pipelineObjects;
private final String marker;
private final Boolean hasMoreResults;
private DescribeObjectsResponse(BuilderImpl builder) {
super(builder);
this.pipelineObjects = builder.pipelineObjects;
this.marker = builder.marker;
this.hasMoreResults = builder.hasMoreResults;
}
/**
* For responses, this returns true if the service returned a value for the PipelineObjects 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 hasPipelineObjects() {
return pipelineObjects != null && !(pipelineObjects instanceof SdkAutoConstructList);
}
/**
*
* An array of object definitions.
*
*
* 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 #hasPipelineObjects} method.
*
*
* @return An array of object definitions.
*/
public final List pipelineObjects() {
return pipelineObjects;
}
/**
*
* The starting point for the next page of results. To view the next page of results, call
* DescribeObjects 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
* DescribeObjects 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 to return.
*
*
* @return Indicates whether there are more results to return.
*/
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(hasPipelineObjects() ? pipelineObjects() : 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 DescribeObjectsResponse)) {
return false;
}
DescribeObjectsResponse other = (DescribeObjectsResponse) obj;
return hasPipelineObjects() == other.hasPipelineObjects() && Objects.equals(pipelineObjects(), other.pipelineObjects())
&& 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("DescribeObjectsResponse")
.add("PipelineObjects", hasPipelineObjects() ? pipelineObjects() : null).add("Marker", marker())
.add("HasMoreResults", hasMoreResults()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "pipelineObjects":
return Optional.ofNullable(clazz.cast(pipelineObjects()));
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((DescribeObjectsResponse) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends DataPipelineResponse.Builder, SdkPojo, CopyableBuilder {
/**
*
* An array of object definitions.
*
*
* @param pipelineObjects
* An array of object definitions.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder pipelineObjects(Collection pipelineObjects);
/**
*
* An array of object definitions.
*
*
* @param pipelineObjects
* An array of object definitions.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder pipelineObjects(PipelineObject... pipelineObjects);
/**
*
* An array of object definitions.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.datapipeline.model.PipelineObject.Builder} avoiding the need to create
* one manually via {@link software.amazon.awssdk.services.datapipeline.model.PipelineObject#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.datapipeline.model.PipelineObject.Builder#build()} is called
* immediately and its result is passed to {@link #pipelineObjects(List)}.
*
* @param pipelineObjects
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.datapipeline.model.PipelineObject.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #pipelineObjects(java.util.Collection)
*/
Builder pipelineObjects(Consumer... pipelineObjects);
/**
*
* The starting point for the next page of results. To view the next page of results, call
* DescribeObjects 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
* DescribeObjects 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 to return.
*
*
* @param hasMoreResults
* Indicates whether there are more results to return.
* @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 pipelineObjects = DefaultSdkAutoConstructList.getInstance();
private String marker;
private Boolean hasMoreResults;
private BuilderImpl() {
}
private BuilderImpl(DescribeObjectsResponse model) {
super(model);
pipelineObjects(model.pipelineObjects);
marker(model.marker);
hasMoreResults(model.hasMoreResults);
}
public final List getPipelineObjects() {
List result = PipelineObjectListCopier.copyToBuilder(this.pipelineObjects);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setPipelineObjects(Collection pipelineObjects) {
this.pipelineObjects = PipelineObjectListCopier.copyFromBuilder(pipelineObjects);
}
@Override
public final Builder pipelineObjects(Collection pipelineObjects) {
this.pipelineObjects = PipelineObjectListCopier.copy(pipelineObjects);
return this;
}
@Override
@SafeVarargs
public final Builder pipelineObjects(PipelineObject... pipelineObjects) {
pipelineObjects(Arrays.asList(pipelineObjects));
return this;
}
@Override
@SafeVarargs
public final Builder pipelineObjects(Consumer... pipelineObjects) {
pipelineObjects(Stream.of(pipelineObjects).map(c -> PipelineObject.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 DescribeObjectsResponse build() {
return new DescribeObjectsResponse(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}