software.amazon.awssdk.services.kms.model

Class DescribeCustomKeyStoresRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.kms.model.KmsRequest

software.amazon.awssdk.services.kms.model.DescribeCustomKeyStoresRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeCustomKeyStoresRequest.Builder,DescribeCustomKeyStoresRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class DescribeCustomKeyStoresRequest
extends KmsRequest
implements ToCopyableBuilder<DescribeCustomKeyStoresRequest.Builder,DescribeCustomKeyStoresRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeCustomKeyStoresRequest.Builder

Method Summary

Modifier and Type	Method and Description
static DescribeCustomKeyStoresRequest.Builder	builder()
String	customKeyStoreId() Gets only information about the specified custom key store.
String	customKeyStoreName() Gets only information about the specified custom key store.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
Integer	limit() Use this parameter to specify the maximum number of items to return.
String	marker() Use this parameter in a subsequent request after you receive a response with truncated results.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeCustomKeyStoresRequest.Builder>	serializableBuilderClass()
DescribeCustomKeyStoresRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

customKeyStoreId

public String 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, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.

Returns:

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, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.

customKeyStoreName

public String 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, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.

Returns:

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, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.

limit

public Integer limit()

Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not return more than the specified number of items, but it might return fewer.

Returns:

Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not return more than the specified number of items, but it might return fewer.

marker

public String 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.

Returns:

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.

toBuilder

public DescribeCustomKeyStoresRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeCustomKeyStoresRequest.Builder,DescribeCustomKeyStoresRequest>

Specified by:

toBuilder in class KmsRequest

Returns:

a builder for type T

builder

public static DescribeCustomKeyStoresRequest.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeCustomKeyStoresRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.