/* * Copyright 2018-2023 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; import com.amazonaws.AmazonWebServiceRequest; /** * * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class CreateKeyRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** *

* An optional description for the API key resource. *

*/ private String description; /** *

* The optional timestamp for when the API key resource will expire in ISO 8601 format: * YYYY-MM-DDThh:mm:ss.sssZ. One of NoExpiry or ExpireTime must be set. *

*/ private java.util.Date expireTime; /** *

* A custom name for the API key resource. *

* Requirements: *

*
* Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_). *
*
*
* Must be a unique API key name. *
*
*
* No spaces allowed. For example, ExampleAPIKey. *
*

*/ private String keyName; /** *

* Optionally set to true to set no expiration time for the API key. One of NoExpiry or * ExpireTime must be set. *

*/ private Boolean noExpiry; /** *

* The API key restrictions for the API key resource. *

*/ private ApiKeyRestrictions restrictions; /** *

* Applies one or more tags to the map resource. A tag is a key-value pair that helps manage, identify, search, and * filter your resources by labelling them. *

* Format: "key" : "value" *

* Restrictions: *

*
* Maximum 50 tags per resource *
*
*
* Each resource tag must be unique with a maximum of one value. *
*
*
* Maximum key length: 128 Unicode characters in UTF-8 *
*
*
* Maximum value length: 256 Unicode characters in UTF-8 *
*
*
* Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @. *
*
*
* Cannot use "aws:" as a prefix for a key. *
*

*/ private java.util.Map tags; /** *

* An optional description for the API key resource. *

* * @param description * An optional description for the API key resource. */ public void setDescription(String description) { this.description = description; } /** *

* An optional description for the API key resource. *

* * @return An optional description for the API key resource. */ public String getDescription() { return this.description; } /** *

* An optional description for the API key resource. *

* * @param description * An optional description for the API key resource. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateKeyRequest withDescription(String description) { setDescription(description); return this; } /** *

* The optional timestamp for when the API key resource will expire in ISO 8601 format: * YYYY-MM-DDThh:mm:ss.sssZ. One of NoExpiry or ExpireTime must be set. *

* * @param expireTime * The optional timestamp for when the API key resource will expire in ISO 8601 format: * YYYY-MM-DDThh:mm:ss.sssZ. One of NoExpiry or ExpireTime must be * set. */ public void setExpireTime(java.util.Date expireTime) { this.expireTime = expireTime; } /** *

* The optional timestamp for when the API key resource will expire in ISO 8601 format: * YYYY-MM-DDThh:mm:ss.sssZ. One of NoExpiry or ExpireTime must be set. *

* * @return The optional timestamp for when the API key resource will expire in ISO 8601 format: * YYYY-MM-DDThh:mm:ss.sssZ. One of NoExpiry or ExpireTime must be * set. */ public java.util.Date getExpireTime() { return this.expireTime; } /** *

* The optional timestamp for when the API key resource will expire in ISO 8601 format: * YYYY-MM-DDThh:mm:ss.sssZ. One of NoExpiry or ExpireTime must be set. *

* * @param expireTime * The optional timestamp for when the API key resource will expire in ISO 8601 format: * YYYY-MM-DDThh:mm:ss.sssZ. One of NoExpiry or ExpireTime must be * set. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateKeyRequest withExpireTime(java.util.Date expireTime) { setExpireTime(expireTime); return this; } /** *

* A custom name for the API key resource. *

* Requirements: *

*
* Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_). *
*
*
* Must be a unique API key name. *
*
*
* No spaces allowed. For example, ExampleAPIKey. *
*

* * @param keyName * A custom name for the API key resource.

* Requirements: *

*
* Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_). *
*
*
* Must be a unique API key name. *
*
*
* No spaces allowed. For example, ExampleAPIKey. *
*

* A custom name for the API key resource. *

* Requirements: *

*
* Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_). *
*
*
* Must be a unique API key name. *
*
*
* No spaces allowed. For example, ExampleAPIKey. *
*

* Requirements: *

*
* Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_). *
*
*
* Must be a unique API key name. *
*
*
* No spaces allowed. For example, ExampleAPIKey. *
*

* A custom name for the API key resource. *

* Requirements: *

*
* Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_). *
*
*
* Must be a unique API key name. *
*
*
* No spaces allowed. For example, ExampleAPIKey. *
*

* Requirements: *

*
* Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_). *
*
*
* Must be a unique API key name. *
*
*
* No spaces allowed. For example, ExampleAPIKey. *
*

* Optionally set to true to set no expiration time for the API key. One of NoExpiry or * ExpireTime must be set. *

true

NoExpiry

ExpireTime

* Optionally set to true to set no expiration time for the API key. One of NoExpiry or * ExpireTime must be set. *

true

NoExpiry

ExpireTime

* Optionally set to true to set no expiration time for the API key. One of NoExpiry or * ExpireTime must be set. *

true

NoExpiry

ExpireTime

* Optionally set to true to set no expiration time for the API key. One of NoExpiry or * ExpireTime must be set. *

true

NoExpiry

ExpireTime

* The API key restrictions for the API key resource. *

* Applies one or more tags to the map resource. A tag is a key-value pair that helps manage, identify, search, and * filter your resources by labelling them. *

* Format: "key" : "value" *

* Restrictions: *

*
* Maximum 50 tags per resource *
*
*
* Each resource tag must be unique with a maximum of one value. *
*
*
* Maximum key length: 128 Unicode characters in UTF-8 *
*
*
* Maximum value length: 256 Unicode characters in UTF-8 *
*
*
* Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @. *
*
*
* Cannot use "aws:" as a prefix for a key. *
*

* Format: "key" : "value" *

* Restrictions: *

*
* Maximum 50 tags per resource *
*
*
* Each resource tag must be unique with a maximum of one value. *
*
*
* Maximum key length: 128 Unicode characters in UTF-8 *
*
*
* Maximum value length: 256 Unicode characters in UTF-8 *
*
*
* Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @. *
*
*
* Cannot use "aws:" as a prefix for a key. *
*

getTags() { return tags; } /** *

* Applies one or more tags to the map resource. A tag is a key-value pair that helps manage, identify, search, and * filter your resources by labelling them. *

* Format: "key" : "value" *

* Restrictions: *

*
* Maximum 50 tags per resource *
*
*
* Each resource tag must be unique with a maximum of one value. *
*
*
* Maximum key length: 128 Unicode characters in UTF-8 *
*
*
* Maximum value length: 256 Unicode characters in UTF-8 *
*
*
* Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @. *
*
*
* Cannot use "aws:" as a prefix for a key. *
*

* * @param tags * Applies one or more tags to the map resource. A tag is a key-value pair that helps manage, identify, * search, and filter your resources by labelling them.

* Format: "key" : "value" *

* Restrictions: *

*
* Maximum 50 tags per resource *
*
*
* Each resource tag must be unique with a maximum of one value. *
*
*
* Maximum key length: 128 Unicode characters in UTF-8 *
*
*
* Maximum value length: 256 Unicode characters in UTF-8 *
*
*
* Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @. *
*
*
* Cannot use "aws:" as a prefix for a key. *
*

tags) { this.tags = tags; } /** *

* Applies one or more tags to the map resource. A tag is a key-value pair that helps manage, identify, search, and * filter your resources by labelling them. *

* Format: "key" : "value" *

* Restrictions: *

*
* Maximum 50 tags per resource *
*
*
* Each resource tag must be unique with a maximum of one value. *
*
*
* Maximum key length: 128 Unicode characters in UTF-8 *
*
*
* Maximum value length: 256 Unicode characters in UTF-8 *
*
*
* Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @. *
*
*
* Cannot use "aws:" as a prefix for a key. *
*

* * @param tags * Applies one or more tags to the map resource. A tag is a key-value pair that helps manage, identify, * search, and filter your resources by labelling them.

* Format: "key" : "value" *

* Restrictions: *

*
* Maximum 50 tags per resource *
*
*
* Each resource tag must be unique with a maximum of one value. *
*
*
* Maximum key length: 128 Unicode characters in UTF-8 *
*
*
* Maximum value length: 256 Unicode characters in UTF-8 *
*
*
* Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @. *
*
*
* Cannot use "aws:" as a prefix for a key. *
*

tags) { setTags(tags); return this; } /** * Add a single Tags entry * * @see CreateKeyRequest#withTags * @returns a reference to this object so that method calls can be chained together. */ public CreateKeyRequest 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 CreateKeyRequest 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 (getDescription() != null) sb.append("Description: ").append(getDescription()).append(","); if (getExpireTime() != null) sb.append("ExpireTime: ").append(getExpireTime()).append(","); if (getKeyName() != null) sb.append("KeyName: ").append(getKeyName()).append(","); if (getNoExpiry() != null) sb.append("NoExpiry: ").append(getNoExpiry()).append(","); if (getRestrictions() != null) sb.append("Restrictions: ").append(getRestrictions()).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 CreateKeyRequest == false) return false; CreateKeyRequest other = (CreateKeyRequest) obj; if (other.getDescription() == null ^ this.getDescription() == null) return false; if (other.getDescription() != null && other.getDescription().equals(this.getDescription()) == 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.getKeyName() == null ^ this.getKeyName() == null) return false; if (other.getKeyName() != null && other.getKeyName().equals(this.getKeyName()) == false) return false; if (other.getNoExpiry() == null ^ this.getNoExpiry() == null) return false; if (other.getNoExpiry() != null && other.getNoExpiry().equals(this.getNoExpiry()) == 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.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 + ((getDescription() == null) ? 0 : getDescription().hashCode()); hashCode = prime * hashCode + ((getExpireTime() == null) ? 0 : getExpireTime().hashCode()); hashCode = prime * hashCode + ((getKeyName() == null) ? 0 : getKeyName().hashCode()); hashCode = prime * hashCode + ((getNoExpiry() == null) ? 0 : getNoExpiry().hashCode()); hashCode = prime * hashCode + ((getRestrictions() == null) ? 0 : getRestrictions().hashCode()); hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode()); return hashCode; } @Override public CreateKeyRequest clone() { return (CreateKeyRequest) super.clone(); } }