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>

  • Method Details

    • 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 permissions 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 permissions in the Key Management Service Developer Guide.

    • toBuilder

      public RetireGrantRequest.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<RetireGrantRequest.Builder,RetireGrantRequest>
      Specified by:
      toBuilder in class KmsRequest
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      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 final 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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.