com.amazonaws.services.location.model.CreateKeyResult 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 CreateKeyResult extends com.amazonaws.AmazonWebServiceResult implements Serializable, Cloneable {
/**
*
* The key value/string of an API key. This value is used when making API calls to authorize the call. For example,
* see GetMapGlyphs.
*
*/
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;
/**
*
* 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 key value/string of an API key. This value is used when making API calls to authorize the call. For example,
* see GetMapGlyphs.
*
*
* @param key
* The key value/string of an API key. This value is used when making API calls to authorize the call. For
* example, see GetMapGlyphs.
*/
public void setKey(String key) {
this.key = key;
}
/**
*
* The key value/string of an API key. This value is used when making API calls to authorize the call. For example,
* see GetMapGlyphs.
*
*
* @return The key value/string of an API key. This value is used when making API calls to authorize the call. For
* example, see GetMapGlyphs.
*/
public String getKey() {
return this.key;
}
/**
*
* The key value/string of an API key. This value is used when making API calls to authorize the call. For example,
* see GetMapGlyphs.
*
*
* @param key
* The key value/string of an API key. This value is used when making API calls to authorize the call. For
* example, see GetMapGlyphs.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateKeyResult 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 CreateKeyResult 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 CreateKeyResult withKeyName(String keyName) {
setKeyName(keyName);
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 CreateKeyResult withCreateTime(java.util.Date createTime) {
setCreateTime(createTime);
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 (getCreateTime() != null)
sb.append("CreateTime: ").append(getCreateTime());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof CreateKeyResult == false)
return false;
CreateKeyResult other = (CreateKeyResult) 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.getCreateTime() == null ^ this.getCreateTime() == null)
return false;
if (other.getCreateTime() != null && other.getCreateTime().equals(this.getCreateTime()) == 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 + ((getCreateTime() == null) ? 0 : getCreateTime().hashCode());
return hashCode;
}
@Override
public CreateKeyResult clone() {
try {
return (CreateKeyResult) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}