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

Class UpdateKeyRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateKeyRequest.Builder,UpdateKeyRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UpdateKeyRequest.Builder

Method Summary

Modifier and Type	Method	Description
static UpdateKeyRequest.Builder	builder()
String	description()	Updates the description for the API key resource.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Instant	expireTime()	Updates the timestamp for when the API key resource will expire in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
Boolean	forceUpdate()	The boolean flag to be included for updating ExpireTime or Restrictions details.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	keyName()	The name of the API key resource to update.
Boolean	noExpiry()	Whether the API key should expire.
ApiKeyRestrictions	restrictions()	Updates the API key restrictions for the API key resource.
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateKeyRequest.Builder>	serializableBuilderClass()
UpdateKeyRequest.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

description

public final String description()

Updates the description for the API key resource.

Returns:

Updates the description for the API key resource.

expireTime

public final Instant expireTime()

Updates the timestamp for when the API key resource will expire in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

Returns:

Updates the timestamp for when the API key resource will expire in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

forceUpdate

public final Boolean forceUpdate()

The boolean flag to be included for updating ExpireTime or Restrictions details.

Must be set to true to update an API key resource that has been used in the past 7 days.

False if force update is not preferred

Default value: False

Returns:

The boolean flag to be included for updating ExpireTime or Restrictions details.

Must be set to true to update an API key resource that has been used in the past 7 days.

False if force update is not preferred

Default value: False

keyName

public final String keyName()

The name of the API key resource to update.

Returns:

The name of the API key resource to update.

noExpiry

public final Boolean noExpiry()

Whether the API key should expire. Set to true to set the API key to have no expiration time.

Returns:

Whether the API key should expire. Set to true to set the API key to have no expiration time.

restrictions

public final ApiKeyRestrictions restrictions()

Updates the API key restrictions for the API key resource.

Returns:

Updates the API key restrictions for the API key resource.

toBuilder

public UpdateKeyRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateKeyRequest.Builder,UpdateKeyRequest>

Specified by:

toBuilder in class LocationRequest

builder

public static UpdateKeyRequest.Builder builder()

serializableBuilderClass

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