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

Class CreateKeyRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateKeyRequest.Builder,CreateKeyRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateKeyRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CreateKeyRequest.Builder	builder()
String	description()	An optional description for the API key resource.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Instant	expireTime()	The optional timestamp for when the API key resource will expire in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
String	keyName()	A custom name for the API key resource.
Boolean	noExpiry()	Optionally set to true to set no expiration time for the API key.
ApiKeyRestrictions	restrictions()	The API key restrictions for the API key resource.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateKeyRequest.Builder>	serializableBuilderClass()
Map<String,String>	tags()	Applies one or more tags to the map resource.
CreateKeyRequest.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()

An optional description for the API key resource.

Returns:

An optional description for the API key resource.

expireTime

public final Instant expireTime()

The optional timestamp for when the API key resource will expire in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. One of NoExpiry or ExpireTime must be set.

Returns:

The optional timestamp for when the API key resource will expire in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. One of NoExpiry or ExpireTime must be set.

keyName

public final String keyName()

A custom name for the API key resource.

Requirements:

• Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).

• Must be a unique API key name.

• No spaces allowed. For example, ExampleAPIKey.

Returns:

A custom name for the API key resource.

Requirements:

• Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).

• Must be a unique API key name.

• No spaces allowed. For example, ExampleAPIKey.

noExpiry

public final Boolean noExpiry()

Optionally set to true to set no expiration time for the API key. One of NoExpiry or ExpireTime must be set.

Returns:

Optionally set to true to set no expiration time for the API key. One of NoExpiry or ExpireTime must be set.

restrictions

public final ApiKeyRestrictions restrictions()

The API key restrictions for the API key resource.

Returns:

The API key restrictions for the API key resource.

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

tags

public final Map<String,String> tags()

Applies one or more tags to the map resource. A tag is a key-value pair that helps manage, identify, search, and filter your resources by labelling them.

Format: "key" : "value"

Restrictions:

• Maximum 50 tags per resource

• Each resource tag must be unique with a maximum of one value.

• Maximum key length: 128 Unicode characters in UTF-8

• Maximum value length: 256 Unicode characters in UTF-8

• Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @.

• Cannot use "aws:" as a prefix for a key.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

Returns:

Applies one or more tags to the map resource. A tag is a key-value pair that helps manage, identify, search, and filter your resources by labelling them.

Format: "key" : "value"

Restrictions:

• Maximum 50 tags per resource

• Each resource tag must be unique with a maximum of one value.

• Maximum key length: 128 Unicode characters in UTF-8

• Maximum value length: 256 Unicode characters in UTF-8

• Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @.

• Cannot use "aws:" as a prefix for a key.

toBuilder

public CreateKeyRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateKeyRequest.Builder,CreateKeyRequest>

Specified by:

toBuilder in class LocationRequest

builder

public static CreateKeyRequest.Builder builder()

serializableBuilderClass

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