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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RetireGrantRequest.Builder

Method Summary

Modifier and Type	Method and Description
static RetireGrantRequest.Builder	builder()
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
String	grantId() Unique identifier of the grant to retire.
String	grantToken() Token that identifies the grant to be retired.
int	hashCode()
String	keyId() The Amazon Resource Name (ARN) of the CMK 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 String grantToken()

Token that identifies the grant to be retired.

Returns:

Token that identifies the grant to be retired.

keyId

public String keyId()

The Amazon Resource Name (ARN) of the CMK associated with the grant.

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

Returns:

The Amazon Resource Name (ARN) of the CMK associated with the grant.

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

grantId

public String grantId()

Unique identifier of the grant to retire. The grant ID is returned in the response to a CreateGrant operation.

• Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123

Returns:

Unique identifier of the grant to retire. The grant ID is returned in the response to a CreateGrant operation.

• Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123

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 int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo