com.amazonaws.services.wafv2.model.APIKeySummary Maven / Gradle / Ivy
Show all versions of aws-java-sdk-wafv2 Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.wafv2.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* 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 AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class APIKeySummary implements Serializable, Cloneable, StructuredPojo {
/**
*
* The token domains that are defined in this API key.
*
*/
private java.util.List tokenDomains;
/**
*
* The generated, encrypted API key. You can copy this for use in your JavaScript CAPTCHA integration.
*
*/
private String aPIKey;
/**
*
* The date and time that the key was created.
*
*/
private java.util.Date creationTimestamp;
/**
*
* Internal value used by WAF to manage the key.
*
*/
private Integer version;
/**
*
* The token domains that are defined in this API key.
*
*
* @return The token domains that are defined in this API key.
*/
public java.util.List getTokenDomains() {
return tokenDomains;
}
/**
*
* The token domains that are defined in this API key.
*
*
* @param tokenDomains
* The token domains that are defined in this API key.
*/
public void setTokenDomains(java.util.Collection tokenDomains) {
if (tokenDomains == null) {
this.tokenDomains = null;
return;
}
this.tokenDomains = new java.util.ArrayList(tokenDomains);
}
/**
*
* The token domains that are defined in this API key.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setTokenDomains(java.util.Collection)} or {@link #withTokenDomains(java.util.Collection)} if you want to
* override the existing values.
*
*
* @param tokenDomains
* The token domains that are defined in this API key.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public APIKeySummary withTokenDomains(String... tokenDomains) {
if (this.tokenDomains == null) {
setTokenDomains(new java.util.ArrayList(tokenDomains.length));
}
for (String ele : tokenDomains) {
this.tokenDomains.add(ele);
}
return this;
}
/**
*
* The token domains that are defined in this API key.
*
*
* @param tokenDomains
* The token domains that are defined in this API key.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public APIKeySummary withTokenDomains(java.util.Collection tokenDomains) {
setTokenDomains(tokenDomains);
return this;
}
/**
*
* The generated, encrypted API key. You can copy this for use in your JavaScript CAPTCHA integration.
*
*
* @param aPIKey
* The generated, encrypted API key. You can copy this for use in your JavaScript CAPTCHA integration.
*/
public void setAPIKey(String aPIKey) {
this.aPIKey = aPIKey;
}
/**
*
* The generated, encrypted API key. You can copy this for use in your JavaScript CAPTCHA integration.
*
*
* @return The generated, encrypted API key. You can copy this for use in your JavaScript CAPTCHA integration.
*/
public String getAPIKey() {
return this.aPIKey;
}
/**
*
* The generated, encrypted API key. You can copy this for use in your JavaScript CAPTCHA integration.
*
*
* @param aPIKey
* The generated, encrypted API key. You can copy this for use in your JavaScript CAPTCHA integration.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public APIKeySummary withAPIKey(String aPIKey) {
setAPIKey(aPIKey);
return this;
}
/**
*
* The date and time that the key was created.
*
*
* @param creationTimestamp
* The date and time that the key was created.
*/
public void setCreationTimestamp(java.util.Date creationTimestamp) {
this.creationTimestamp = creationTimestamp;
}
/**
*
* The date and time that the key was created.
*
*
* @return The date and time that the key was created.
*/
public java.util.Date getCreationTimestamp() {
return this.creationTimestamp;
}
/**
*
* The date and time that the key was created.
*
*
* @param creationTimestamp
* The date and time that the key was created.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public APIKeySummary withCreationTimestamp(java.util.Date creationTimestamp) {
setCreationTimestamp(creationTimestamp);
return this;
}
/**
*
* Internal value used by WAF to manage the key.
*
*
* @param version
* Internal value used by WAF to manage the key.
*/
public void setVersion(Integer version) {
this.version = version;
}
/**
*
* Internal value used by WAF to manage the key.
*
*
* @return Internal value used by WAF to manage the key.
*/
public Integer getVersion() {
return this.version;
}
/**
*
* Internal value used by WAF to manage the key.
*
*
* @param version
* Internal value used by WAF to manage the key.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public APIKeySummary withVersion(Integer version) {
setVersion(version);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getTokenDomains() != null)
sb.append("TokenDomains: ").append(getTokenDomains()).append(",");
if (getAPIKey() != null)
sb.append("APIKey: ").append(getAPIKey()).append(",");
if (getCreationTimestamp() != null)
sb.append("CreationTimestamp: ").append(getCreationTimestamp()).append(",");
if (getVersion() != null)
sb.append("Version: ").append(getVersion());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof APIKeySummary == false)
return false;
APIKeySummary other = (APIKeySummary) obj;
if (other.getTokenDomains() == null ^ this.getTokenDomains() == null)
return false;
if (other.getTokenDomains() != null && other.getTokenDomains().equals(this.getTokenDomains()) == false)
return false;
if (other.getAPIKey() == null ^ this.getAPIKey() == null)
return false;
if (other.getAPIKey() != null && other.getAPIKey().equals(this.getAPIKey()) == false)
return false;
if (other.getCreationTimestamp() == null ^ this.getCreationTimestamp() == null)
return false;
if (other.getCreationTimestamp() != null && other.getCreationTimestamp().equals(this.getCreationTimestamp()) == false)
return false;
if (other.getVersion() == null ^ this.getVersion() == null)
return false;
if (other.getVersion() != null && other.getVersion().equals(this.getVersion()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getTokenDomains() == null) ? 0 : getTokenDomains().hashCode());
hashCode = prime * hashCode + ((getAPIKey() == null) ? 0 : getAPIKey().hashCode());
hashCode = prime * hashCode + ((getCreationTimestamp() == null) ? 0 : getCreationTimestamp().hashCode());
hashCode = prime * hashCode + ((getVersion() == null) ? 0 : getVersion().hashCode());
return hashCode;
}
@Override
public APIKeySummary clone() {
try {
return (APIKeySummary) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.wafv2.model.transform.APIKeySummaryMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}