com.amazonaws.services.apigateway.model.CreateApiKeyRequest Maven / Gradle / Ivy
/*
* Copyright 2017-2022 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.apigateway.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* Request to create an ApiKey resource.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class CreateApiKeyRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The name of the ApiKey.
*
*/
private String name;
/**
*
* The description of the ApiKey.
*
*/
private String description;
/**
*
* Specifies whether the ApiKey can be used by callers.
*
*/
private Boolean enabled;
/**
*
* Specifies whether (true) or not (false) the key identifier is distinct from the created
* API key value. This parameter is deprecated and should not be used.
*
*/
private Boolean generateDistinctId;
/**
*
* Specifies a value of the API key.
*
*/
private String value;
/**
*
* DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.
*
*/
private java.util.List stageKeys;
/**
*
* An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.
*
*/
private String customerId;
/**
*
* The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters
* and must not start with aws:. The tag value can be up to 256 characters.
*
*/
private java.util.Map tags;
/**
*
* The name of the ApiKey.
*
*
* @param name
* The name of the ApiKey.
*/
public void setName(String name) {
this.name = name;
}
/**
*
* The name of the ApiKey.
*
*
* @return The name of the ApiKey.
*/
public String getName() {
return this.name;
}
/**
*
* The name of the ApiKey.
*
*
* @param name
* The name of the ApiKey.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateApiKeyRequest withName(String name) {
setName(name);
return this;
}
/**
*
* The description of the ApiKey.
*
*
* @param description
* The description of the ApiKey.
*/
public void setDescription(String description) {
this.description = description;
}
/**
*
* The description of the ApiKey.
*
*
* @return The description of the ApiKey.
*/
public String getDescription() {
return this.description;
}
/**
*
* The description of the ApiKey.
*
*
* @param description
* The description of the ApiKey.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateApiKeyRequest withDescription(String description) {
setDescription(description);
return this;
}
/**
*
* Specifies whether the ApiKey can be used by callers.
*
*
* @param enabled
* Specifies whether the ApiKey can be used by callers.
*/
public void setEnabled(Boolean enabled) {
this.enabled = enabled;
}
/**
*
* Specifies whether the ApiKey can be used by callers.
*
*
* @return Specifies whether the ApiKey can be used by callers.
*/
public Boolean getEnabled() {
return this.enabled;
}
/**
*
* Specifies whether the ApiKey can be used by callers.
*
*
* @param enabled
* Specifies whether the ApiKey can be used by callers.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateApiKeyRequest withEnabled(Boolean enabled) {
setEnabled(enabled);
return this;
}
/**
*
* Specifies whether the ApiKey can be used by callers.
*
*
* @return Specifies whether the ApiKey can be used by callers.
*/
public Boolean isEnabled() {
return this.enabled;
}
/**
*
* Specifies whether (true) or not (false) the key identifier is distinct from the created
* API key value. This parameter is deprecated and should not be used.
*
*
* @param generateDistinctId
* Specifies whether (true) or not (false) the key identifier is distinct from the
* created API key value. This parameter is deprecated and should not be used.
*/
public void setGenerateDistinctId(Boolean generateDistinctId) {
this.generateDistinctId = generateDistinctId;
}
/**
*
* Specifies whether (true) or not (false) the key identifier is distinct from the created
* API key value. This parameter is deprecated and should not be used.
*
*
* @return Specifies whether (true) or not (false) the key identifier is distinct from the
* created API key value. This parameter is deprecated and should not be used.
*/
public Boolean getGenerateDistinctId() {
return this.generateDistinctId;
}
/**
*
* Specifies whether (true) or not (false) the key identifier is distinct from the created
* API key value. This parameter is deprecated and should not be used.
*
*
* @param generateDistinctId
* Specifies whether (true) or not (false) the key identifier is distinct from the
* created API key value. This parameter is deprecated and should not be used.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateApiKeyRequest withGenerateDistinctId(Boolean generateDistinctId) {
setGenerateDistinctId(generateDistinctId);
return this;
}
/**
*
* Specifies whether (true) or not (false) the key identifier is distinct from the created
* API key value. This parameter is deprecated and should not be used.
*
*
* @return Specifies whether (true) or not (false) the key identifier is distinct from the
* created API key value. This parameter is deprecated and should not be used.
*/
public Boolean isGenerateDistinctId() {
return this.generateDistinctId;
}
/**
*
* Specifies a value of the API key.
*
*
* @param value
* Specifies a value of the API key.
*/
public void setValue(String value) {
this.value = value;
}
/**
*
* Specifies a value of the API key.
*
*
* @return Specifies a value of the API key.
*/
public String getValue() {
return this.value;
}
/**
*
* Specifies a value of the API key.
*
*
* @param value
* Specifies a value of the API key.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateApiKeyRequest withValue(String value) {
setValue(value);
return this;
}
/**
*
* DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.
*
*
* @return DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.
*/
public java.util.List getStageKeys() {
return stageKeys;
}
/**
*
* DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.
*
*
* @param stageKeys
* DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.
*/
public void setStageKeys(java.util.Collection stageKeys) {
if (stageKeys == null) {
this.stageKeys = null;
return;
}
this.stageKeys = new java.util.ArrayList(stageKeys);
}
/**
*
* DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setStageKeys(java.util.Collection)} or {@link #withStageKeys(java.util.Collection)} if you want to
* override the existing values.
*
*
* @param stageKeys
* DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateApiKeyRequest withStageKeys(StageKey... stageKeys) {
if (this.stageKeys == null) {
setStageKeys(new java.util.ArrayList(stageKeys.length));
}
for (StageKey ele : stageKeys) {
this.stageKeys.add(ele);
}
return this;
}
/**
*
* DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.
*
*
* @param stageKeys
* DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateApiKeyRequest withStageKeys(java.util.Collection stageKeys) {
setStageKeys(stageKeys);
return this;
}
/**
*
* An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.
*
*
* @param customerId
* An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.
*/
public void setCustomerId(String customerId) {
this.customerId = customerId;
}
/**
*
* An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.
*
*
* @return An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.
*/
public String getCustomerId() {
return this.customerId;
}
/**
*
* An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.
*
*
* @param customerId
* An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateApiKeyRequest withCustomerId(String customerId) {
setCustomerId(customerId);
return this;
}
/**
*
* The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters
* and must not start with aws:. The tag value can be up to 256 characters.
*
*
* @return The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128
* characters and must not start with aws:. The tag value can be up to 256 characters.
*/
public java.util.Map getTags() {
return tags;
}
/**
*
* The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters
* and must not start with aws:. The tag value can be up to 256 characters.
*
*
* @param tags
* The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128
* characters and must not start with aws:. The tag value can be up to 256 characters.
*/
public void setTags(java.util.Map tags) {
this.tags = tags;
}
/**
*
* The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters
* and must not start with aws:. The tag value can be up to 256 characters.
*
*
* @param tags
* The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128
* characters and must not start with aws:. The tag value can be up to 256 characters.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateApiKeyRequest withTags(java.util.Map tags) {
setTags(tags);
return this;
}
/**
* Add a single Tags entry
*
* @see CreateApiKeyRequest#withTags
* @returns a reference to this object so that method calls can be chained together.
*/
public CreateApiKeyRequest 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 CreateApiKeyRequest 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 (getName() != null)
sb.append("Name: ").append(getName()).append(",");
if (getDescription() != null)
sb.append("Description: ").append(getDescription()).append(",");
if (getEnabled() != null)
sb.append("Enabled: ").append(getEnabled()).append(",");
if (getGenerateDistinctId() != null)
sb.append("GenerateDistinctId: ").append(getGenerateDistinctId()).append(",");
if (getValue() != null)
sb.append("Value: ").append(getValue()).append(",");
if (getStageKeys() != null)
sb.append("StageKeys: ").append(getStageKeys()).append(",");
if (getCustomerId() != null)
sb.append("CustomerId: ").append(getCustomerId()).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 CreateApiKeyRequest == false)
return false;
CreateApiKeyRequest other = (CreateApiKeyRequest) obj;
if (other.getName() == null ^ this.getName() == null)
return false;
if (other.getName() != null && other.getName().equals(this.getName()) == 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.getEnabled() == null ^ this.getEnabled() == null)
return false;
if (other.getEnabled() != null && other.getEnabled().equals(this.getEnabled()) == false)
return false;
if (other.getGenerateDistinctId() == null ^ this.getGenerateDistinctId() == null)
return false;
if (other.getGenerateDistinctId() != null && other.getGenerateDistinctId().equals(this.getGenerateDistinctId()) == false)
return false;
if (other.getValue() == null ^ this.getValue() == null)
return false;
if (other.getValue() != null && other.getValue().equals(this.getValue()) == false)
return false;
if (other.getStageKeys() == null ^ this.getStageKeys() == null)
return false;
if (other.getStageKeys() != null && other.getStageKeys().equals(this.getStageKeys()) == false)
return false;
if (other.getCustomerId() == null ^ this.getCustomerId() == null)
return false;
if (other.getCustomerId() != null && other.getCustomerId().equals(this.getCustomerId()) == 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 + ((getName() == null) ? 0 : getName().hashCode());
hashCode = prime * hashCode + ((getDescription() == null) ? 0 : getDescription().hashCode());
hashCode = prime * hashCode + ((getEnabled() == null) ? 0 : getEnabled().hashCode());
hashCode = prime * hashCode + ((getGenerateDistinctId() == null) ? 0 : getGenerateDistinctId().hashCode());
hashCode = prime * hashCode + ((getValue() == null) ? 0 : getValue().hashCode());
hashCode = prime * hashCode + ((getStageKeys() == null) ? 0 : getStageKeys().hashCode());
hashCode = prime * hashCode + ((getCustomerId() == null) ? 0 : getCustomerId().hashCode());
hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode());
return hashCode;
}
@Override
public CreateApiKeyRequest clone() {
return (CreateApiKeyRequest) super.clone();
}
}