com.amazonaws.services.location.model.DescribeKeyResult Maven / Gradle / Ivy
Show all versions of aws-java-sdk-location 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.location.model;
import java.io.Serializable;
import javax.annotation.Generated;
/**
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class DescribeKeyResult extends com.amazonaws.AmazonWebServiceResult implements Serializable, Cloneable {
/**
*
* The key value/string of an API key.
*
*/
private String key;
/**
*
* The Amazon Resource Name (ARN) for the API key resource. Used when you need to specify a resource across all
* Amazon Web Services.
*
*
* -
*
* Format example: arn:aws:geo:region:account-id:key/ExampleKey
*
*
*
*/
private String keyArn;
/**
*
* The name of the API key resource.
*
*/
private String keyName;
private ApiKeyRestrictions restrictions;
/**
*
* The timestamp for when the API key resource was created in ISO 8601 format:
* YYYY-MM-DDThh:mm:ss.sssZ.
*
*/
private java.util.Date createTime;
/**
*
* The timestamp for when the API key resource will expire in ISO 8601 format:
* YYYY-MM-DDThh:mm:ss.sssZ.
*
*/
private java.util.Date expireTime;
/**
*
* The timestamp for when the API key resource was last updated in ISO 8601 format:
* YYYY-MM-DDThh:mm:ss.sssZ.
*
*/
private java.util.Date updateTime;
/**
*
* The optional description for the API key resource.
*
*/
private String description;
/**
*
* Tags associated with the API key resource.
*
*/
private java.util.Map tags;
/**
*
* The key value/string of an API key.
*
*
* @param key
* The key value/string of an API key.
*/
public void setKey(String key) {
this.key = key;
}
/**
*
* The key value/string of an API key.
*
*
* @return The key value/string of an API key.
*/
public String getKey() {
return this.key;
}
/**
*
* The key value/string of an API key.
*
*
* @param key
* The key value/string of an API key.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeKeyResult withKey(String key) {
setKey(key);
return this;
}
/**
*
* The Amazon Resource Name (ARN) for the API key resource. Used when you need to specify a resource across all
* Amazon Web Services.
*
*
* -
*
* Format example: arn:aws:geo:region:account-id:key/ExampleKey
*
*
*
*
* @param keyArn
* The Amazon Resource Name (ARN) for the API key resource. Used when you need to specify a resource across
* all Amazon Web Services.
*
* -
*
* Format example: arn:aws:geo:region:account-id:key/ExampleKey
*
*
*/
public void setKeyArn(String keyArn) {
this.keyArn = keyArn;
}
/**
*
* The Amazon Resource Name (ARN) for the API key resource. Used when you need to specify a resource across all
* Amazon Web Services.
*
*
* -
*
* Format example: arn:aws:geo:region:account-id:key/ExampleKey
*
*
*
*
* @return The Amazon Resource Name (ARN) for the API key resource. Used when you need to specify a resource across
* all Amazon Web Services.
*
* -
*
* Format example: arn:aws:geo:region:account-id:key/ExampleKey
*
*
*/
public String getKeyArn() {
return this.keyArn;
}
/**
*
* The Amazon Resource Name (ARN) for the API key resource. Used when you need to specify a resource across all
* Amazon Web Services.
*
*
* -
*
* Format example: arn:aws:geo:region:account-id:key/ExampleKey
*
*
*
*
* @param keyArn
* The Amazon Resource Name (ARN) for the API key resource. Used when you need to specify a resource across
* all Amazon Web Services.
*
* -
*
* Format example: arn:aws:geo:region:account-id:key/ExampleKey
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeKeyResult withKeyArn(String keyArn) {
setKeyArn(keyArn);
return this;
}
/**
*
* The name of the API key resource.
*
*
* @param keyName
* The name of the API key resource.
*/
public void setKeyName(String keyName) {
this.keyName = keyName;
}
/**
*
* The name of the API key resource.
*
*
* @return The name of the API key resource.
*/
public String getKeyName() {
return this.keyName;
}
/**
*
* The name of the API key resource.
*
*
* @param keyName
* The name of the API key resource.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeKeyResult withKeyName(String keyName) {
setKeyName(keyName);
return this;
}
/**
* @param restrictions
*/
public void setRestrictions(ApiKeyRestrictions restrictions) {
this.restrictions = restrictions;
}
/**
* @return
*/
public ApiKeyRestrictions getRestrictions() {
return this.restrictions;
}
/**
* @param restrictions
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeKeyResult withRestrictions(ApiKeyRestrictions restrictions) {
setRestrictions(restrictions);
return this;
}
/**
*
* The timestamp for when the API key resource was created in ISO 8601 format:
* YYYY-MM-DDThh:mm:ss.sssZ.
*
*
* @param createTime
* The timestamp for when the API key resource was created in ISO 8601 format:
* YYYY-MM-DDThh:mm:ss.sssZ.
*/
public void setCreateTime(java.util.Date createTime) {
this.createTime = createTime;
}
/**
*
* The timestamp for when the API key resource was created in ISO 8601 format:
* YYYY-MM-DDThh:mm:ss.sssZ.
*
*
* @return The timestamp for when the API key resource was created in ISO 8601 format:
* YYYY-MM-DDThh:mm:ss.sssZ.
*/
public java.util.Date getCreateTime() {
return this.createTime;
}
/**
*
* The timestamp for when the API key resource was created in ISO 8601 format:
* YYYY-MM-DDThh:mm:ss.sssZ.
*
*
* @param createTime
* The timestamp for when the API key resource was created in ISO 8601 format:
* YYYY-MM-DDThh:mm:ss.sssZ.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeKeyResult withCreateTime(java.util.Date createTime) {
setCreateTime(createTime);
return this;
}
/**
*
* The timestamp for when the API key resource will expire in ISO 8601 format:
* YYYY-MM-DDThh:mm:ss.sssZ.
*
*
* @param expireTime
* The timestamp for when the API key resource will expire in ISO 8601 format:
* YYYY-MM-DDThh:mm:ss.sssZ.
*/
public void setExpireTime(java.util.Date expireTime) {
this.expireTime = expireTime;
}
/**
*
* The timestamp for when the API key resource will expire in ISO 8601 format:
* YYYY-MM-DDThh:mm:ss.sssZ.
*
*
* @return The timestamp for when the API key resource will expire in ISO 8601 format:
* YYYY-MM-DDThh:mm:ss.sssZ.
*/
public java.util.Date getExpireTime() {
return this.expireTime;
}
/**
*
* The timestamp for when the API key resource will expire in ISO 8601 format:
* YYYY-MM-DDThh:mm:ss.sssZ.
*
*
* @param expireTime
* The timestamp for when the API key resource will expire in ISO 8601 format:
* YYYY-MM-DDThh:mm:ss.sssZ.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeKeyResult withExpireTime(java.util.Date expireTime) {
setExpireTime(expireTime);
return this;
}
/**
*
* The timestamp for when the API key resource was last updated in ISO 8601 format:
* YYYY-MM-DDThh:mm:ss.sssZ.
*
*
* @param updateTime
* The timestamp for when the API key resource was last updated in ISO 8601 format:
* YYYY-MM-DDThh:mm:ss.sssZ.
*/
public void setUpdateTime(java.util.Date updateTime) {
this.updateTime = updateTime;
}
/**
*
* The timestamp for when the API key resource was last updated in ISO 8601 format:
* YYYY-MM-DDThh:mm:ss.sssZ.
*
*
* @return The timestamp for when the API key resource was last updated in ISO 8601 format:
* YYYY-MM-DDThh:mm:ss.sssZ.
*/
public java.util.Date getUpdateTime() {
return this.updateTime;
}
/**
*
* The timestamp for when the API key resource was last updated in ISO 8601 format:
* YYYY-MM-DDThh:mm:ss.sssZ.
*
*
* @param updateTime
* The timestamp for when the API key resource was last updated in ISO 8601 format:
* YYYY-MM-DDThh:mm:ss.sssZ.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeKeyResult withUpdateTime(java.util.Date updateTime) {
setUpdateTime(updateTime);
return this;
}
/**
*
* The optional description for the API key resource.
*
*
* @param description
* The optional description for the API key resource.
*/
public void setDescription(String description) {
this.description = description;
}
/**
*
* The optional description for the API key resource.
*
*
* @return The optional description for the API key resource.
*/
public String getDescription() {
return this.description;
}
/**
*
* The optional description for the API key resource.
*
*
* @param description
* The optional description for the API key resource.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeKeyResult withDescription(String description) {
setDescription(description);
return this;
}
/**
*
* Tags associated with the API key resource.
*
*
* @return Tags associated with the API key resource.
*/
public java.util.Map getTags() {
return tags;
}
/**
*
* Tags associated with the API key resource.
*
*
* @param tags
* Tags associated with the API key resource.
*/
public void setTags(java.util.Map tags) {
this.tags = tags;
}
/**
*
* Tags associated with the API key resource.
*
*
* @param tags
* Tags associated with the API key resource.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeKeyResult withTags(java.util.Map tags) {
setTags(tags);
return this;
}
/**
* Add a single Tags entry
*
* @see DescribeKeyResult#withTags
* @returns a reference to this object so that method calls can be chained together.
*/
public DescribeKeyResult addTagsEntry(String key, String value) {
if (null == this.tags) {
this.tags = new java.util.HashMap();
}
if (this.tags.containsKey(key))
throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided.");
this.tags.put(key, value);
return this;
}
/**
* Removes all the entries added into Tags.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeKeyResult clearTagsEntries() {
this.tags = null;
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 (getKey() != null)
sb.append("Key: ").append("***Sensitive Data Redacted***").append(",");
if (getKeyArn() != null)
sb.append("KeyArn: ").append(getKeyArn()).append(",");
if (getKeyName() != null)
sb.append("KeyName: ").append(getKeyName()).append(",");
if (getRestrictions() != null)
sb.append("Restrictions: ").append(getRestrictions()).append(",");
if (getCreateTime() != null)
sb.append("CreateTime: ").append(getCreateTime()).append(",");
if (getExpireTime() != null)
sb.append("ExpireTime: ").append(getExpireTime()).append(",");
if (getUpdateTime() != null)
sb.append("UpdateTime: ").append(getUpdateTime()).append(",");
if (getDescription() != null)
sb.append("Description: ").append(getDescription()).append(",");
if (getTags() != null)
sb.append("Tags: ").append(getTags());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof DescribeKeyResult == false)
return false;
DescribeKeyResult other = (DescribeKeyResult) obj;
if (other.getKey() == null ^ this.getKey() == null)
return false;
if (other.getKey() != null && other.getKey().equals(this.getKey()) == false)
return false;
if (other.getKeyArn() == null ^ this.getKeyArn() == null)
return false;
if (other.getKeyArn() != null && other.getKeyArn().equals(this.getKeyArn()) == false)
return false;
if (other.getKeyName() == null ^ this.getKeyName() == null)
return false;
if (other.getKeyName() != null && other.getKeyName().equals(this.getKeyName()) == false)
return false;
if (other.getRestrictions() == null ^ this.getRestrictions() == null)
return false;
if (other.getRestrictions() != null && other.getRestrictions().equals(this.getRestrictions()) == false)
return false;
if (other.getCreateTime() == null ^ this.getCreateTime() == null)
return false;
if (other.getCreateTime() != null && other.getCreateTime().equals(this.getCreateTime()) == false)
return false;
if (other.getExpireTime() == null ^ this.getExpireTime() == null)
return false;
if (other.getExpireTime() != null && other.getExpireTime().equals(this.getExpireTime()) == false)
return false;
if (other.getUpdateTime() == null ^ this.getUpdateTime() == null)
return false;
if (other.getUpdateTime() != null && other.getUpdateTime().equals(this.getUpdateTime()) == false)
return false;
if (other.getDescription() == null ^ this.getDescription() == null)
return false;
if (other.getDescription() != null && other.getDescription().equals(this.getDescription()) == false)
return false;
if (other.getTags() == null ^ this.getTags() == null)
return false;
if (other.getTags() != null && other.getTags().equals(this.getTags()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getKey() == null) ? 0 : getKey().hashCode());
hashCode = prime * hashCode + ((getKeyArn() == null) ? 0 : getKeyArn().hashCode());
hashCode = prime * hashCode + ((getKeyName() == null) ? 0 : getKeyName().hashCode());
hashCode = prime * hashCode + ((getRestrictions() == null) ? 0 : getRestrictions().hashCode());
hashCode = prime * hashCode + ((getCreateTime() == null) ? 0 : getCreateTime().hashCode());
hashCode = prime * hashCode + ((getExpireTime() == null) ? 0 : getExpireTime().hashCode());
hashCode = prime * hashCode + ((getUpdateTime() == null) ? 0 : getUpdateTime().hashCode());
hashCode = prime * hashCode + ((getDescription() == null) ? 0 : getDescription().hashCode());
hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode());
return hashCode;
}
@Override
public DescribeKeyResult clone() {
try {
return (DescribeKeyResult) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}