software.amazon.awssdk.services.kms.model.ListKeysResponse Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of kms Show documentation
Show all versions of kms Show documentation
The AWS Java SDK for AWS KMS module holds the client classes that are used for communicating with AWS
Key Management Service
/*
* 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 ListKeysResponse extends KmsResponse implements ToCopyableBuilder {
private static final SdkField> KEYS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Keys")
.getter(getter(ListKeysResponse::keys))
.setter(setter(Builder::keys))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Keys").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(KeyListEntry::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(ListKeysResponse::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(ListKeysResponse::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(KEYS_FIELD, NEXT_MARKER_FIELD,
TRUNCATED_FIELD));
private final List keys;
private final String nextMarker;
private final Boolean truncated;
private ListKeysResponse(BuilderImpl builder) {
super(builder);
this.keys = builder.keys;
this.nextMarker = builder.nextMarker;
this.truncated = builder.truncated;
}
/**
* Returns true if the Keys property was specified by the sender (it may be empty), or false if the sender did not
* specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
*/
public final boolean hasKeys() {
return keys != null && !(keys instanceof SdkAutoConstructList);
}
/**
*
* A list of customer master keys (CMKs).
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* You can use {@link #hasKeys()} to see if a value was sent in this field.
*
*
* @return A list of customer master keys (CMKs).
*/
public final List keys() {
return keys;
}
/**
*
* 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 thisresponse
* 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
* thisresponse 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(hasKeys() ? keys() : 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 ListKeysResponse)) {
return false;
}
ListKeysResponse other = (ListKeysResponse) obj;
return hasKeys() == other.hasKeys() && Objects.equals(keys(), other.keys())
&& 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("ListKeysResponse").add("Keys", hasKeys() ? keys() : null).add("NextMarker", nextMarker())
.add("Truncated", truncated()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Keys":
return Optional.ofNullable(clazz.cast(keys()));
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((ListKeysResponse) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends KmsResponse.Builder, SdkPojo, CopyableBuilder {
/**
*
* A list of customer master keys (CMKs).
*
*
* @param keys
* A list of customer master keys (CMKs).
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder keys(Collection keys);
/**
*
* A list of customer master keys (CMKs).
*
*
* @param keys
* A list of customer master keys (CMKs).
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder keys(KeyListEntry... keys);
/**
*
* A list of customer master keys (CMKs).
*
* This is a convenience that creates an instance of the {@link List.Builder} avoiding the need to
* create one manually via {@link List#builder()}.
*
* When the {@link Consumer} completes, {@link List.Builder#build()} is called immediately and its
* result is passed to {@link #keys(List)}.
*
* @param keys
* a consumer that will call methods on {@link List.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #keys(List)
*/
Builder keys(Consumer... keys);
/**
*
* 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
* thisresponse 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 thisresponse 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 keys = DefaultSdkAutoConstructList.getInstance();
private String nextMarker;
private Boolean truncated;
private BuilderImpl() {
}
private BuilderImpl(ListKeysResponse model) {
super(model);
keys(model.keys);
nextMarker(model.nextMarker);
truncated(model.truncated);
}
public final List getKeys() {
List result = KeyListCopier.copyToBuilder(this.keys);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
@Override
public final Builder keys(Collection keys) {
this.keys = KeyListCopier.copy(keys);
return this;
}
@Override
@SafeVarargs
public final Builder keys(KeyListEntry... keys) {
keys(Arrays.asList(keys));
return this;
}
@Override
@SafeVarargs
public final Builder keys(Consumer... keys) {
keys(Stream.of(keys).map(c -> KeyListEntry.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
public final void setKeys(Collection keys) {
this.keys = KeyListCopier.copyFromBuilder(keys);
}
public final String getNextMarker() {
return nextMarker;
}
@Override
public final Builder nextMarker(String nextMarker) {
this.nextMarker = nextMarker;
return this;
}
public final void setNextMarker(String nextMarker) {
this.nextMarker = nextMarker;
}
public final Boolean getTruncated() {
return truncated;
}
@Override
public final Builder truncated(Boolean truncated) {
this.truncated = truncated;
return this;
}
public final void setTruncated(Boolean truncated) {
this.truncated = truncated;
}
@Override
public ListKeysResponse build() {
return new ListKeysResponse(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy