Package software.amazon.awssdk.services.kms.model

Class RetireGrantRequest

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.RetireGrantRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<RetireGrantRequest.Builder,RetireGrantRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RetireGrantRequest.Builder

Method Summary

Modifier and Type	Method	Description
static RetireGrantRequest.Builder	builder()
Boolean	dryRun()	Checks if your request will succeed.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
String	grantId()	Identifies the grant to retire.
String	grantToken()	Identifies the grant to be retired.
int	hashCode()
String	keyId()	The key ARN KMS key associated with the grant.
List<SdkField<?>>	sdkFields()
static Class<? extends RetireGrantRequest.Builder>	serializableBuilderClass()
RetireGrantRequest.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

grantToken

public final String grantToken()

Identifies the grant to be retired. You can use a grant token to identify a new grant even before it has achieved eventual consistency.

Only the CreateGrant operation returns a grant token. For details, see Grant token and Eventual consistency in the Key Management Service Developer Guide.

Returns:

Identifies the grant to be retired. You can use a grant token to identify a new grant even before it has achieved eventual consistency.

Only the CreateGrant operation returns a grant token. For details, see Grant token and Eventual consistency in the Key Management Service Developer Guide.

keyId

public final String keyId()

The key ARN KMS key associated with the grant. To find the key ARN, use the ListKeys operation.

For example: arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab

Returns:

The key ARN KMS key associated with the grant. To find the key ARN, use the ListKeys operation.

For example: arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab

grantId

public final String grantId()

Identifies the grant to retire. To get the grant ID, use CreateGrant, ListGrants, or ListRetirableGrants.

• Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123

Returns:

Identifies the grant to retire. To get the grant ID, use CreateGrant, ListGrants, or ListRetirableGrants.

• Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123

dryRun

public final Boolean dryRun()

Checks if your request will succeed. DryRun is an optional parameter.

To learn more about how to use this parameter, see Testing your KMS API calls in the Key Management Service Developer Guide.

Returns:

Checks if your request will succeed. DryRun is an optional parameter.

To learn more about how to use this parameter, see Testing your KMS API calls in the Key Management Service Developer Guide.

toBuilder

public RetireGrantRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RetireGrantRequest.Builder,RetireGrantRequest>

Specified by:

toBuilder in class KmsRequest

builder

public static RetireGrantRequest.Builder builder()

serializableBuilderClass

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