Package software.amazon.awssdk.services.wafv2.model

Class APIKeySummary

java.lang.Object

software.amazon.awssdk.services.wafv2.model.APIKeySummary

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<APIKeySummary.Builder,APIKeySummary>

@Generated("software.amazon.awssdk:codegen")
public final class APIKeySummary
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<APIKeySummary.Builder,APIKeySummary>

Information for a single API key.

API keys are required for the integration of the CAPTCHA API in your JavaScript client applications. The API lets you customize the placement and characteristics of the CAPTCHA puzzle for your end users. For more information about the CAPTCHA JavaScript integration, see WAF client application integration in the WAF Developer Guide.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	APIKeySummary.Builder

Method Summary

Modifier and Type	Method	Description
String	apiKey()	The generated, encrypted API key.
static APIKeySummary.Builder	builder()
Instant	creationTimestamp()	The date and time that the key was created.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTokenDomains()	For responses, this returns true if the service returned a value for the TokenDomains property.
List<SdkField<?>>	sdkFields()
static Class<? extends APIKeySummary.Builder>	serializableBuilderClass()
APIKeySummary.Builder	toBuilder()
List<String>	tokenDomains()	The token domains that are defined in this API key.
String	toString()	Returns a string representation of this object.
Integer	version()	Internal value used by WAF to manage the key.

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

hasTokenDomains

public final boolean hasTokenDomains()

For responses, this returns true if the service returned a value for the TokenDomains 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.

tokenDomains

public final List<String> tokenDomains()

The token domains that are defined in this API 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 hasTokenDomains() method.

Returns:

The token domains that are defined in this API key.

apiKey

public final String apiKey()

The generated, encrypted API key. You can copy this for use in your JavaScript CAPTCHA integration.

Returns:

The generated, encrypted API key. You can copy this for use in your JavaScript CAPTCHA integration.

creationTimestamp

public final Instant creationTimestamp()

The date and time that the key was created.

Returns:

The date and time that the key was created.

version

public final Integer version()

Internal value used by WAF to manage the key.

Returns:

Internal value used by WAF to manage the key.

toBuilder

public APIKeySummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<APIKeySummary.Builder,APIKeySummary>

builder

public static APIKeySummary.Builder builder()

serializableBuilderClass

public static Class<? extends APIKeySummary.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo