software.amazon.awssdk.services.ecr.model.BatchGetImageResponse 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.ecr.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 BatchGetImageResponse extends EcrResponse implements
ToCopyableBuilder {
private static final SdkField> IMAGES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("images")
.getter(getter(BatchGetImageResponse::images))
.setter(setter(Builder::images))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("images").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(Image::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField> FAILURES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("failures")
.getter(getter(BatchGetImageResponse::failures))
.setter(setter(Builder::failures))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("failures").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(ImageFailure::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(IMAGES_FIELD, FAILURES_FIELD));
private final List images;
private final List failures;
private BatchGetImageResponse(BuilderImpl builder) {
super(builder);
this.images = builder.images;
this.failures = builder.failures;
}
/**
* For responses, this returns true if the service returned a value for the Images 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 hasImages() {
return images != null && !(images instanceof SdkAutoConstructList);
}
/**
*
* A list of image objects corresponding to the image references in the request.
*
*
* 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 #hasImages} method.
*
*
* @return A list of image objects corresponding to the image references in the request.
*/
public final List images() {
return images;
}
/**
* For responses, this returns true if the service returned a value for the Failures 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 hasFailures() {
return failures != null && !(failures instanceof SdkAutoConstructList);
}
/**
*
* Any failures associated with the call.
*
*
* 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 #hasFailures} method.
*
*
* @return Any failures associated with the call.
*/
public final List failures() {
return failures;
}
@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(hasImages() ? images() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasFailures() ? failures() : null);
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 BatchGetImageResponse)) {
return false;
}
BatchGetImageResponse other = (BatchGetImageResponse) obj;
return hasImages() == other.hasImages() && Objects.equals(images(), other.images())
&& hasFailures() == other.hasFailures() && Objects.equals(failures(), other.failures());
}
/**
* 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("BatchGetImageResponse").add("Images", hasImages() ? images() : null)
.add("Failures", hasFailures() ? failures() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "images":
return Optional.ofNullable(clazz.cast(images()));
case "failures":
return Optional.ofNullable(clazz.cast(failures()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((BatchGetImageResponse) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends EcrResponse.Builder, SdkPojo, CopyableBuilder {
/**
*
* A list of image objects corresponding to the image references in the request.
*
*
* @param images
* A list of image objects corresponding to the image references in the request.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder images(Collection images);
/**
*
* A list of image objects corresponding to the image references in the request.
*
*
* @param images
* A list of image objects corresponding to the image references in the request.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder images(Image... images);
/**
*
* A list of image objects corresponding to the image references in the request.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.ecr.model.Image.Builder} avoiding the need to create one manually via
* {@link software.amazon.awssdk.services.ecr.model.Image#builder()}.
*
*
* When the {@link Consumer} completes, {@link software.amazon.awssdk.services.ecr.model.Image.Builder#build()}
* is called immediately and its result is passed to {@link #images(List)}.
*
* @param images
* a consumer that will call methods on {@link software.amazon.awssdk.services.ecr.model.Image.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #images(java.util.Collection)
*/
Builder images(Consumer... images);
/**
*
* Any failures associated with the call.
*
*
* @param failures
* Any failures associated with the call.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder failures(Collection failures);
/**
*
* Any failures associated with the call.
*
*
* @param failures
* Any failures associated with the call.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder failures(ImageFailure... failures);
/**
*
* Any failures associated with the call.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.ecr.model.ImageFailure.Builder} avoiding the need to create one
* manually via {@link software.amazon.awssdk.services.ecr.model.ImageFailure#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.ecr.model.ImageFailure.Builder#build()} is called immediately and its
* result is passed to {@link #failures(List)}.
*
* @param failures
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.ecr.model.ImageFailure.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #failures(java.util.Collection)
*/
Builder failures(Consumer... failures);
}
static final class BuilderImpl extends EcrResponse.BuilderImpl implements Builder {
private List images = DefaultSdkAutoConstructList.getInstance();
private List failures = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(BatchGetImageResponse model) {
super(model);
images(model.images);
failures(model.failures);
}
public final List getImages() {
List result = ImageListCopier.copyToBuilder(this.images);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setImages(Collection images) {
this.images = ImageListCopier.copyFromBuilder(images);
}
@Override
public final Builder images(Collection images) {
this.images = ImageListCopier.copy(images);
return this;
}
@Override
@SafeVarargs
public final Builder images(Image... images) {
images(Arrays.asList(images));
return this;
}
@Override
@SafeVarargs
public final Builder images(Consumer... images) {
images(Stream.of(images).map(c -> Image.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
public final List getFailures() {
List result = ImageFailureListCopier.copyToBuilder(this.failures);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setFailures(Collection failures) {
this.failures = ImageFailureListCopier.copyFromBuilder(failures);
}
@Override
public final Builder failures(Collection failures) {
this.failures = ImageFailureListCopier.copy(failures);
return this;
}
@Override
@SafeVarargs
public final Builder failures(ImageFailure... failures) {
failures(Arrays.asList(failures));
return this;
}
@Override
@SafeVarargs
public final Builder failures(Consumer... failures) {
failures(Stream.of(failures).map(c -> ImageFailure.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
@Override
public BatchGetImageResponse build() {
return new BatchGetImageResponse(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}