Package 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("software.amazon.awssdk:codegen")
public final class DescribeCustomKeyStoresRequest
extends KmsRequest
implements ToCopyableBuilder<DescribeCustomKeyStoresRequest.Builder,DescribeCustomKeyStoresRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeCustomKeyStoresRequest.Builder

Method Summary

Modifier and Type	Method	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)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
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.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeCustomKeyStoresRequest.Builder>	serializableBuilderClass()
DescribeCustomKeyStoresRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

customKeyStoreId

public final 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, provide 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, provide either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.

customKeyStoreName

public final 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, provide 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, provide either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.

limit

public final Integer 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.

Returns:

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.

marker

public final 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()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeCustomKeyStoresRequest.Builder,DescribeCustomKeyStoresRequest>

Specified by:

toBuilder in class KmsRequest

builder

public static DescribeCustomKeyStoresRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

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.

Overrides:

toString in class Object

getValueForField

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

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo