Class DeleteKeyRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.location.model.LocationRequest
software.amazon.awssdk.services.location.model.DeleteKeyRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DeleteKeyRequest.Builder,DeleteKeyRequest>
@Generated("software.amazon.awssdk:codegen") public final class DeleteKeyRequest extends LocationRequest implements ToCopyableBuilder<DeleteKeyRequest.Builder,DeleteKeyRequest>

  • Method Details

    • keyName

      public final String keyName()

      The name of the API key to delete.

      Returns:
      The name of the API key to delete.

    • forceDelete

      public final Boolean forceDelete()

      ForceDelete bypasses an API key's expiry conditions and deletes the key. Set the parameter true to delete the key or to false to not preemptively delete the API key.

      Valid values: true, or false.

      Required: No

      This action is irreversible. Only use ForceDelete if you are certain the key is no longer in use.

      Returns:
      ForceDelete bypasses an API key's expiry conditions and deletes the key. Set the parameter true to delete the key or to false to not preemptively delete the API key.

      Valid values: true, or false.

      Required: No

      This action is irreversible. Only use ForceDelete if you are certain the key is no longer in use.

    • toBuilder

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

    • builder

      public static DeleteKeyRequest.Builder builder()

    • serializableBuilderClass

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