software.amazon.awssdk.services.kms.model.DescribeCustomKeyStoresResponse Maven / Gradle / Ivy
Show all versions of kms 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.kms.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 DescribeCustomKeyStoresResponse extends KmsResponse implements
ToCopyableBuilder {
private static final SdkField> CUSTOM_KEY_STORES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("CustomKeyStores")
.getter(getter(DescribeCustomKeyStoresResponse::customKeyStores))
.setter(setter(Builder::customKeyStores))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("CustomKeyStores").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(CustomKeyStoresListEntry::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField NEXT_MARKER_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("NextMarker").getter(getter(DescribeCustomKeyStoresResponse::nextMarker))
.setter(setter(Builder::nextMarker))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("NextMarker").build()).build();
private static final SdkField TRUNCATED_FIELD = SdkField. builder(MarshallingType.BOOLEAN)
.memberName("Truncated").getter(getter(DescribeCustomKeyStoresResponse::truncated))
.setter(setter(Builder::truncated))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Truncated").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(CUSTOM_KEY_STORES_FIELD,
NEXT_MARKER_FIELD, TRUNCATED_FIELD));
private final List customKeyStores;
private final String nextMarker;
private final Boolean truncated;
private DescribeCustomKeyStoresResponse(BuilderImpl builder) {
super(builder);
this.customKeyStores = builder.customKeyStores;
this.nextMarker = builder.nextMarker;
this.truncated = builder.truncated;
}
/**
* For responses, this returns true if the service returned a value for the CustomKeyStores 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 hasCustomKeyStores() {
return customKeyStores != null && !(customKeyStores instanceof SdkAutoConstructList);
}
/**
*
* Contains metadata about each custom key store.
*
*
* 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 #hasCustomKeyStores} method.
*
*
* @return Contains metadata about each custom key store.
*/
public final List customKeyStores() {
return customKeyStores;
}
/**
*
* When Truncated is true, this element is present and contains the value to use for the
* Marker parameter in a subsequent request.
*
*
* @return When Truncated is true, this element is present and contains the value to use for the
* Marker parameter in a subsequent request.
*/
public final String nextMarker() {
return nextMarker;
}
/**
*
* A flag that indicates whether there are more items in the list. When this value is true, the list in this
* response is truncated. To get more items, pass the value of the NextMarker element in this response
* to the Marker parameter in a subsequent request.
*
*
* @return A flag that indicates whether there are more items in the list. When this value is true, the list in this
* response is truncated. To get more items, pass the value of the NextMarker element in this
* response to the Marker parameter in a subsequent request.
*/
public final Boolean truncated() {
return truncated;
}
@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(hasCustomKeyStores() ? customKeyStores() : null);
hashCode = 31 * hashCode + Objects.hashCode(nextMarker());
hashCode = 31 * hashCode + Objects.hashCode(truncated());
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 DescribeCustomKeyStoresResponse)) {
return false;
}
DescribeCustomKeyStoresResponse other = (DescribeCustomKeyStoresResponse) obj;
return hasCustomKeyStores() == other.hasCustomKeyStores() && Objects.equals(customKeyStores(), other.customKeyStores())
&& Objects.equals(nextMarker(), other.nextMarker()) && Objects.equals(truncated(), other.truncated());
}
/**
* 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("DescribeCustomKeyStoresResponse")
.add("CustomKeyStores", hasCustomKeyStores() ? customKeyStores() : null).add("NextMarker", nextMarker())
.add("Truncated", truncated()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "CustomKeyStores":
return Optional.ofNullable(clazz.cast(customKeyStores()));
case "NextMarker":
return Optional.ofNullable(clazz.cast(nextMarker()));
case "Truncated":
return Optional.ofNullable(clazz.cast(truncated()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((DescribeCustomKeyStoresResponse) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends KmsResponse.Builder, SdkPojo, CopyableBuilder {
/**
*
* Contains metadata about each custom key store.
*
*
* @param customKeyStores
* Contains metadata about each custom key store.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder customKeyStores(Collection customKeyStores);
/**
*
* Contains metadata about each custom key store.
*
*
* @param customKeyStores
* Contains metadata about each custom key store.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder customKeyStores(CustomKeyStoresListEntry... customKeyStores);
/**
*
* Contains metadata about each custom key store.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.kms.model.CustomKeyStoresListEntry.Builder} avoiding the need to
* create one manually via {@link software.amazon.awssdk.services.kms.model.CustomKeyStoresListEntry#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.kms.model.CustomKeyStoresListEntry.Builder#build()} is called
* immediately and its result is passed to {@link #customKeyStores(List)}.
*
* @param customKeyStores
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.kms.model.CustomKeyStoresListEntry.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #customKeyStores(java.util.Collection)
*/
Builder customKeyStores(Consumer... customKeyStores);
/**
*
* When Truncated is true, this element is present and contains the value to use for the
* Marker parameter in a subsequent request.
*
*
* @param nextMarker
* When Truncated is true, this element is present and contains the value to use for the
* Marker parameter in a subsequent request.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder nextMarker(String nextMarker);
/**
*
* A flag that indicates whether there are more items in the list. When this value is true, the list in this
* response is truncated. To get more items, pass the value of the NextMarker element in this
* response to the Marker parameter in a subsequent request.
*
*
* @param truncated
* A flag that indicates whether there are more items in the list. When this value is true, the list in
* this response is truncated. To get more items, pass the value of the NextMarker element
* in this response to the Marker parameter in a subsequent request.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder truncated(Boolean truncated);
}
static final class BuilderImpl extends KmsResponse.BuilderImpl implements Builder {
private List customKeyStores = DefaultSdkAutoConstructList.getInstance();
private String nextMarker;
private Boolean truncated;
private BuilderImpl() {
}
private BuilderImpl(DescribeCustomKeyStoresResponse model) {
super(model);
customKeyStores(model.customKeyStores);
nextMarker(model.nextMarker);
truncated(model.truncated);
}
public final List getCustomKeyStores() {
List result = CustomKeyStoresListCopier.copyToBuilder(this.customKeyStores);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setCustomKeyStores(Collection customKeyStores) {
this.customKeyStores = CustomKeyStoresListCopier.copyFromBuilder(customKeyStores);
}
@Override
public final Builder customKeyStores(Collection customKeyStores) {
this.customKeyStores = CustomKeyStoresListCopier.copy(customKeyStores);
return this;
}
@Override
@SafeVarargs
public final Builder customKeyStores(CustomKeyStoresListEntry... customKeyStores) {
customKeyStores(Arrays.asList(customKeyStores));
return this;
}
@Override
@SafeVarargs
public final Builder customKeyStores(Consumer... customKeyStores) {
customKeyStores(Stream.of(customKeyStores).map(c -> CustomKeyStoresListEntry.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
public final String getNextMarker() {
return nextMarker;
}
public final void setNextMarker(String nextMarker) {
this.nextMarker = nextMarker;
}
@Override
public final Builder nextMarker(String nextMarker) {
this.nextMarker = nextMarker;
return this;
}
public final Boolean getTruncated() {
return truncated;
}
public final void setTruncated(Boolean truncated) {
this.truncated = truncated;
}
@Override
public final Builder truncated(Boolean truncated) {
this.truncated = truncated;
return this;
}
@Override
public DescribeCustomKeyStoresResponse build() {
return new DescribeCustomKeyStoresResponse(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}