Package software.amazon.awssdk.services.paymentcryptography.model

Class ListKeysRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.paymentcryptography.model.PaymentCryptographyRequest

software.amazon.awssdk.services.paymentcryptography.model.ListKeysRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListKeysRequest.Builder,ListKeysRequest>

@Generated("software.amazon.awssdk:codegen")
public final class ListKeysRequest
extends PaymentCryptographyRequest
implements ToCopyableBuilder<ListKeysRequest.Builder,ListKeysRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListKeysRequest.Builder

Method Summary

Modifier and Type	Method	Description
static ListKeysRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
KeyState	keyState()	The key state of the keys you want to list.
String	keyStateAsString()	The key state of the keys you want to list.
Integer	maxResults()	Use this parameter to specify the maximum number of items to return.
String	nextToken()	Use this parameter in a subsequent request after you receive a response with truncated results.
List<SdkField<?>>	sdkFields()
static Class<? extends ListKeysRequest.Builder>	serializableBuilderClass()
ListKeysRequest.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

keyState

public final KeyState keyState()

The key state of the keys you want to list.

If the service returns an enum value that is not available in the current SDK version, keyState will return KeyState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from keyStateAsString().

Returns:

The key state of the keys you want to list.

See Also:

KeyState

keyStateAsString

public final String keyStateAsString()

The key state of the keys you want to list.

If the service returns an enum value that is not available in the current SDK version, keyState will return KeyState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from keyStateAsString().

Returns:

The key state of the keys you want to list.

See Also:

KeyState

maxResults

public final Integer maxResults()

Use this parameter to specify the maximum number of items to return. When this value is present, Amazon Web Services Payment Cryptography does not return more than the specified number of items, but it might return fewer.

This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not include a value, it defaults to 50.

Returns:

Use this parameter to specify the maximum number of items to return. When this value is present, Amazon Web Services Payment Cryptography does not return more than the specified number of items, but it might return fewer.

This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not include a value, it defaults to 50.

nextToken

public final String nextToken()

Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextToken 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 NextToken from the truncated response you just received.

toBuilder

public ListKeysRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListKeysRequest.Builder,ListKeysRequest>

Specified by:

toBuilder in class PaymentCryptographyRequest

builder

public static ListKeysRequest.Builder builder()

serializableBuilderClass

public static Class<? extends ListKeysRequest.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