Package software.amazon.awssdk.services.location.model

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>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DeleteKeyRequest.Builder

Method Summary

Modifier and Type	Method	Description
static DeleteKeyRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Boolean	forceDelete()	ForceDelete bypasses an API key's expiry conditions and deletes the key.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	keyName()	The name of the API key to delete.
List<SdkField<?>>	sdkFields()
static Class<? extends DeleteKeyRequest.Builder>	serializableBuilderClass()
DeleteKeyRequest.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

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.

keyName

public final String keyName()

The name of the API key to delete.

Returns:

The name of the API key to delete.

toBuilder

public DeleteKeyRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DeleteKeyRequest.Builder,DeleteKeyRequest>

Specified by:

toBuilder in class LocationRequest

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)

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