APIKeySummary (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.wafv2.model.APIKeySummary

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class APIKeySummary
extends Object
implements Serializable, Cloneable, StructuredPojo
```
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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

APIKeySummary()

Constructors
Constructor and Description
`APIKeySummary()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`APIKeySummary`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAPIKey()` The generated, encrypted API key.
`Date`	`getCreationTimestamp()` The date and time that the key was created.
`List<String>`	`getTokenDomains()` The token domains that are defined in this API key.
`Integer`	`getVersion()` Internal value used by WAF to manage the key.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAPIKey(String aPIKey)` The generated, encrypted API key.
`void`	`setCreationTimestamp(Date creationTimestamp)` The date and time that the key was created.
`void`	`setTokenDomains(Collection<String> tokenDomains)` The token domains that are defined in this API key.
`void`	`setVersion(Integer version)` Internal value used by WAF to manage the key.
`String`	`toString()` Returns a string representation of this object.
`APIKeySummary`	`withAPIKey(String aPIKey)` The generated, encrypted API key.
`APIKeySummary`	`withCreationTimestamp(Date creationTimestamp)` The date and time that the key was created.
`APIKeySummary`	`withTokenDomains(Collection<String> tokenDomains)` The token domains that are defined in this API key.
`APIKeySummary`	`withTokenDomains(String... tokenDomains)` The token domains that are defined in this API key.
`APIKeySummary`	`withVersion(Integer version)` Internal value used by WAF to manage the key.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - APIKeySummary
```
public APIKeySummary()
```
- Method Detail
  - getTokenDomains
```
public List<String> getTokenDomains()
```
    The token domains that are defined in this API key.
    
    Returns:
    
    The token domains that are defined in this API key.
  - setTokenDomains
```
public void setTokenDomains(Collection<String> tokenDomains)
```
    The token domains that are defined in this API key.
    
    Parameters:
    
    tokenDomains - The token domains that are defined in this API key.
  - withTokenDomains
```
public APIKeySummary withTokenDomains(String... tokenDomains)
```
    The token domains that are defined in this API key.
    
    NOTE: This method appends the values to the existing list (if any). Use setTokenDomains(java.util.Collection) or withTokenDomains(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    tokenDomains - The token domains that are defined in this API key.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTokenDomains
```
public APIKeySummary withTokenDomains(Collection<String> tokenDomains)
```
    The token domains that are defined in this API key.
    
    Parameters:
    
    tokenDomains - The token domains that are defined in this API key.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAPIKey
```
public void setAPIKey(String aPIKey)
```
    The generated, encrypted API key. You can copy this for use in your JavaScript CAPTCHA integration.
    
    Parameters:
    
    aPIKey - The generated, encrypted API key. You can copy this for use in your JavaScript CAPTCHA integration.
  - getAPIKey
```
public String getAPIKey()
```
    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.
  - withAPIKey
```
public APIKeySummary withAPIKey(String aPIKey)
```
    The generated, encrypted API key. You can copy this for use in your JavaScript CAPTCHA integration.
    
    Parameters:
    
    aPIKey - The generated, encrypted API key. You can copy this for use in your JavaScript CAPTCHA integration.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreationTimestamp
```
public void setCreationTimestamp(Date creationTimestamp)
```
    The date and time that the key was created.
    
    Parameters:
    
    creationTimestamp - The date and time that the key was created.
  - getCreationTimestamp
```
public Date getCreationTimestamp()
```
    The date and time that the key was created.
    
    Returns:
    
    The date and time that the key was created.
  - withCreationTimestamp
```
public APIKeySummary withCreationTimestamp(Date creationTimestamp)
```
    The date and time that the key was created.
    
    Parameters:
    
    creationTimestamp - The date and time that the key was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setVersion
```
public void setVersion(Integer version)
```
    Internal value used by WAF to manage the key.
    
    Parameters:
    
    version - Internal value used by WAF to manage the key.
  - getVersion
```
public Integer getVersion()
```
    Internal value used by WAF to manage the key.
    
    Returns:
    
    Internal value used by WAF to manage the key.
  - withVersion
```
public APIKeySummary withVersion(Integer version)
```
    Internal value used by WAF to manage the key.
    
    Parameters:
    
    version - Internal value used by WAF to manage the key.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public APIKeySummary clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.780

Class APIKeySummary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

APIKeySummary

Method Detail

getTokenDomains

setTokenDomains

withTokenDomains

withTokenDomains

setAPIKey

getAPIKey

withAPIKey

setCreationTimestamp

getCreationTimestamp

withCreationTimestamp

setVersion

getVersion

withVersion

toString

equals

hashCode

clone

marshall