software.amazon.awssdk.services.kms.model.DescribeCustomKeyStoresRequest 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.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
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.LocationTrait;
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 DescribeCustomKeyStoresRequest extends KmsRequest implements
ToCopyableBuilder {
private static final SdkField CUSTOM_KEY_STORE_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("CustomKeyStoreId").getter(getter(DescribeCustomKeyStoresRequest::customKeyStoreId))
.setter(setter(Builder::customKeyStoreId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("CustomKeyStoreId").build()).build();
private static final SdkField CUSTOM_KEY_STORE_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("CustomKeyStoreName").getter(getter(DescribeCustomKeyStoresRequest::customKeyStoreName))
.setter(setter(Builder::customKeyStoreName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("CustomKeyStoreName").build())
.build();
private static final SdkField LIMIT_FIELD = SdkField. builder(MarshallingType.INTEGER).memberName("Limit")
.getter(getter(DescribeCustomKeyStoresRequest::limit)).setter(setter(Builder::limit))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Limit").build()).build();
private static final SdkField MARKER_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Marker")
.getter(getter(DescribeCustomKeyStoresRequest::marker)).setter(setter(Builder::marker))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Marker").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(CUSTOM_KEY_STORE_ID_FIELD,
CUSTOM_KEY_STORE_NAME_FIELD, LIMIT_FIELD, MARKER_FIELD));
private static final Map> SDK_NAME_TO_FIELD = Collections
.unmodifiableMap(new HashMap>() {
{
put("CustomKeyStoreId", CUSTOM_KEY_STORE_ID_FIELD);
put("CustomKeyStoreName", CUSTOM_KEY_STORE_NAME_FIELD);
put("Limit", LIMIT_FIELD);
put("Marker", MARKER_FIELD);
}
});
private final String customKeyStoreId;
private final String customKeyStoreName;
private final Integer limit;
private final String marker;
private DescribeCustomKeyStoresRequest(BuilderImpl builder) {
super(builder);
this.customKeyStoreId = builder.customKeyStoreId;
this.customKeyStoreName = builder.customKeyStoreName;
this.limit = builder.limit;
this.marker = builder.marker;
}
/**
*
* Gets only information about the specified custom key store. Enter the key store ID.
*
*
* By default, this operation gets information about all custom key stores in the account and Region. To limit the
* output to a particular custom key store, provide either the CustomKeyStoreId or
* CustomKeyStoreName parameter, but not both.
*
*
* @return Gets only information about the specified custom key store. Enter the key store ID.
*
* By default, this operation gets information about all custom key stores in the account and Region. To
* limit the output to a particular custom key store, provide either the CustomKeyStoreId or
* CustomKeyStoreName parameter, but not both.
*/
public final String customKeyStoreId() {
return customKeyStoreId;
}
/**
*
* Gets only information about the specified custom key store. Enter the friendly name of the custom key store.
*
*
* By default, this operation gets information about all custom key stores in the account and Region. To limit the
* output to a particular custom key store, provide either the CustomKeyStoreId or
* CustomKeyStoreName parameter, but not both.
*
*
* @return Gets only information about the specified custom key store. Enter the friendly name of the custom key
* store.
*
* By default, this operation gets information about all custom key stores in the account and Region. To
* limit the output to a particular custom key store, provide either the CustomKeyStoreId or
* CustomKeyStoreName parameter, but not both.
*/
public final String customKeyStoreName() {
return customKeyStoreName;
}
/**
*
* Use this parameter to specify the maximum number of items to return. When this value is present, KMS does not
* return more than the specified number of items, but it might return fewer.
*
*
* @return Use this parameter to specify the maximum number of items to return. When this value is present, KMS does
* not return more than the specified number of items, but it might return fewer.
*/
public final Integer limit() {
return limit;
}
/**
*
* Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the
* value of NextMarker from the truncated response you just received.
*
*
* @return Use this parameter in a subsequent request after you receive a response with truncated results. Set it to
* the value of NextMarker from the truncated response you just received.
*/
public final String marker() {
return marker;
}
@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(customKeyStoreId());
hashCode = 31 * hashCode + Objects.hashCode(customKeyStoreName());
hashCode = 31 * hashCode + Objects.hashCode(limit());
hashCode = 31 * hashCode + Objects.hashCode(marker());
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 DescribeCustomKeyStoresRequest)) {
return false;
}
DescribeCustomKeyStoresRequest other = (DescribeCustomKeyStoresRequest) obj;
return Objects.equals(customKeyStoreId(), other.customKeyStoreId())
&& Objects.equals(customKeyStoreName(), other.customKeyStoreName()) && Objects.equals(limit(), other.limit())
&& Objects.equals(marker(), other.marker());
}
/**
* 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("DescribeCustomKeyStoresRequest").add("CustomKeyStoreId", customKeyStoreId())
.add("CustomKeyStoreName", customKeyStoreName()).add("Limit", limit()).add("Marker", marker()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "CustomKeyStoreId":
return Optional.ofNullable(clazz.cast(customKeyStoreId()));
case "CustomKeyStoreName":
return Optional.ofNullable(clazz.cast(customKeyStoreName()));
case "Limit":
return Optional.ofNullable(clazz.cast(limit()));
case "Marker":
return Optional.ofNullable(clazz.cast(marker()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
@Override
public final Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
private static Function getter(Function g) {
return obj -> g.apply((DescribeCustomKeyStoresRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends KmsRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* Gets only information about the specified custom key store. Enter the key store ID.
*
*
* By default, this operation gets information about all custom key stores in the account and Region. To limit
* the output to a particular custom key store, provide either the CustomKeyStoreId or
* CustomKeyStoreName parameter, but not both.
*
*
* @param customKeyStoreId
* Gets only information about the specified custom key store. Enter the key store ID.
*
* By default, this operation gets information about all custom key stores in the account and Region. To
* limit the output to a particular custom key store, provide either the CustomKeyStoreId or
* CustomKeyStoreName parameter, but not both.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder customKeyStoreId(String customKeyStoreId);
/**
*
* Gets only information about the specified custom key store. Enter the friendly name of the custom key store.
*
*
* By default, this operation gets information about all custom key stores in the account and Region. To limit
* the output to a particular custom key store, provide either the CustomKeyStoreId or
* CustomKeyStoreName parameter, but not both.
*
*
* @param customKeyStoreName
* Gets only information about the specified custom key store. Enter the friendly name of the custom key
* store.
*
* By default, this operation gets information about all custom key stores in the account and Region. To
* limit the output to a particular custom key store, provide either the CustomKeyStoreId or
* CustomKeyStoreName parameter, but not both.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder customKeyStoreName(String customKeyStoreName);
/**
*
* Use this parameter to specify the maximum number of items to return. When this value is present, KMS does not
* return more than the specified number of items, but it might return fewer.
*
*
* @param limit
* Use this parameter to specify the maximum number of items to return. When this value is present, KMS
* does not return more than the specified number of items, but it might return fewer.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder limit(Integer limit);
/**
*
* Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the
* value of NextMarker from the truncated response you just received.
*
*
* @param marker
* Use this parameter in a subsequent request after you receive a response with truncated results. Set it
* to the value of NextMarker from the truncated response you just received.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder marker(String marker);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends KmsRequest.BuilderImpl implements Builder {
private String customKeyStoreId;
private String customKeyStoreName;
private Integer limit;
private String marker;
private BuilderImpl() {
}
private BuilderImpl(DescribeCustomKeyStoresRequest model) {
super(model);
customKeyStoreId(model.customKeyStoreId);
customKeyStoreName(model.customKeyStoreName);
limit(model.limit);
marker(model.marker);
}
public final String getCustomKeyStoreId() {
return customKeyStoreId;
}
public final void setCustomKeyStoreId(String customKeyStoreId) {
this.customKeyStoreId = customKeyStoreId;
}
@Override
public final Builder customKeyStoreId(String customKeyStoreId) {
this.customKeyStoreId = customKeyStoreId;
return this;
}
public final String getCustomKeyStoreName() {
return customKeyStoreName;
}
public final void setCustomKeyStoreName(String customKeyStoreName) {
this.customKeyStoreName = customKeyStoreName;
}
@Override
public final Builder customKeyStoreName(String customKeyStoreName) {
this.customKeyStoreName = customKeyStoreName;
return this;
}
public final Integer getLimit() {
return limit;
}
public final void setLimit(Integer limit) {
this.limit = limit;
}
@Override
public final Builder limit(Integer limit) {
this.limit = limit;
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;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public DescribeCustomKeyStoresRequest build() {
return new DescribeCustomKeyStoresRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
@Override
public Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
}
}