com.amazonaws.services.lightsail.model.KeyPair Maven / Gradle / Ivy
/*
* 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.lightsail.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Describes an SSH key pair.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class KeyPair implements Serializable, Cloneable, StructuredPojo {
/**
*
* The friendly name of the SSH key pair.
*
*/
private String name;
/**
*
* The Amazon Resource Name (ARN) of the key pair (e.g.,
* arn:aws:lightsail:us-east-2:123456789101:KeyPair/05859e3d-331d-48ba-9034-12345EXAMPLE).
*
*/
private String arn;
/**
*
* The support code. Include this code in your email to support when you have questions about an instance or another
* resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.
*
*/
private String supportCode;
/**
*
* The timestamp when the key pair was created (e.g., 1479816991.349).
*
*/
private java.util.Date createdAt;
/**
*
* The region name and Availability Zone where the key pair was created.
*
*/
private ResourceLocation location;
/**
*
* The resource type (usually KeyPair).
*
*/
private String resourceType;
/**
*
* The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer
* Guide.
*
*/
private java.util.List tags;
/**
*
* The RSA fingerprint of the key pair.
*
*/
private String fingerprint;
/**
*
* The friendly name of the SSH key pair.
*
*
* @param name
* The friendly name of the SSH key pair.
*/
public void setName(String name) {
this.name = name;
}
/**
*
* The friendly name of the SSH key pair.
*
*
* @return The friendly name of the SSH key pair.
*/
public String getName() {
return this.name;
}
/**
*
* The friendly name of the SSH key pair.
*
*
* @param name
* The friendly name of the SSH key pair.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public KeyPair withName(String name) {
setName(name);
return this;
}
/**
*
* The Amazon Resource Name (ARN) of the key pair (e.g.,
* arn:aws:lightsail:us-east-2:123456789101:KeyPair/05859e3d-331d-48ba-9034-12345EXAMPLE).
*
*
* @param arn
* The Amazon Resource Name (ARN) of the key pair (e.g.,
* arn:aws:lightsail:us-east-2:123456789101:KeyPair/05859e3d-331d-48ba-9034-12345EXAMPLE).
*/
public void setArn(String arn) {
this.arn = arn;
}
/**
*
* The Amazon Resource Name (ARN) of the key pair (e.g.,
* arn:aws:lightsail:us-east-2:123456789101:KeyPair/05859e3d-331d-48ba-9034-12345EXAMPLE).
*
*
* @return The Amazon Resource Name (ARN) of the key pair (e.g.,
* arn:aws:lightsail:us-east-2:123456789101:KeyPair/05859e3d-331d-48ba-9034-12345EXAMPLE).
*/
public String getArn() {
return this.arn;
}
/**
*
* The Amazon Resource Name (ARN) of the key pair (e.g.,
* arn:aws:lightsail:us-east-2:123456789101:KeyPair/05859e3d-331d-48ba-9034-12345EXAMPLE).
*
*
* @param arn
* The Amazon Resource Name (ARN) of the key pair (e.g.,
* arn:aws:lightsail:us-east-2:123456789101:KeyPair/05859e3d-331d-48ba-9034-12345EXAMPLE).
* @return Returns a reference to this object so that method calls can be chained together.
*/
public KeyPair withArn(String arn) {
setArn(arn);
return this;
}
/**
*
* The support code. Include this code in your email to support when you have questions about an instance or another
* resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.
*
*
* @param supportCode
* The support code. Include this code in your email to support when you have questions about an instance or
* another resource in Lightsail. This code enables our support team to look up your Lightsail information
* more easily.
*/
public void setSupportCode(String supportCode) {
this.supportCode = supportCode;
}
/**
*
* The support code. Include this code in your email to support when you have questions about an instance or another
* resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.
*
*
* @return The support code. Include this code in your email to support when you have questions about an instance or
* another resource in Lightsail. This code enables our support team to look up your Lightsail information
* more easily.
*/
public String getSupportCode() {
return this.supportCode;
}
/**
*
* The support code. Include this code in your email to support when you have questions about an instance or another
* resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.
*
*
* @param supportCode
* The support code. Include this code in your email to support when you have questions about an instance or
* another resource in Lightsail. This code enables our support team to look up your Lightsail information
* more easily.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public KeyPair withSupportCode(String supportCode) {
setSupportCode(supportCode);
return this;
}
/**
*
* The timestamp when the key pair was created (e.g., 1479816991.349).
*
*
* @param createdAt
* The timestamp when the key pair was created (e.g., 1479816991.349).
*/
public void setCreatedAt(java.util.Date createdAt) {
this.createdAt = createdAt;
}
/**
*
* The timestamp when the key pair was created (e.g., 1479816991.349).
*
*
* @return The timestamp when the key pair was created (e.g., 1479816991.349).
*/
public java.util.Date getCreatedAt() {
return this.createdAt;
}
/**
*
* The timestamp when the key pair was created (e.g., 1479816991.349).
*
*
* @param createdAt
* The timestamp when the key pair was created (e.g., 1479816991.349).
* @return Returns a reference to this object so that method calls can be chained together.
*/
public KeyPair withCreatedAt(java.util.Date createdAt) {
setCreatedAt(createdAt);
return this;
}
/**
*
* The region name and Availability Zone where the key pair was created.
*
*
* @param location
* The region name and Availability Zone where the key pair was created.
*/
public void setLocation(ResourceLocation location) {
this.location = location;
}
/**
*
* The region name and Availability Zone where the key pair was created.
*
*
* @return The region name and Availability Zone where the key pair was created.
*/
public ResourceLocation getLocation() {
return this.location;
}
/**
*
* The region name and Availability Zone where the key pair was created.
*
*
* @param location
* The region name and Availability Zone where the key pair was created.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public KeyPair withLocation(ResourceLocation location) {
setLocation(location);
return this;
}
/**
*
* The resource type (usually KeyPair).
*
*
* @param resourceType
* The resource type (usually KeyPair).
* @see ResourceType
*/
public void setResourceType(String resourceType) {
this.resourceType = resourceType;
}
/**
*
* The resource type (usually KeyPair).
*
*
* @return The resource type (usually KeyPair).
* @see ResourceType
*/
public String getResourceType() {
return this.resourceType;
}
/**
*
* The resource type (usually KeyPair).
*
*
* @param resourceType
* The resource type (usually KeyPair).
* @return Returns a reference to this object so that method calls can be chained together.
* @see ResourceType
*/
public KeyPair withResourceType(String resourceType) {
setResourceType(resourceType);
return this;
}
/**
*
* The resource type (usually KeyPair).
*
*
* @param resourceType
* The resource type (usually KeyPair).
* @see ResourceType
*/
public void setResourceType(ResourceType resourceType) {
withResourceType(resourceType);
}
/**
*
* The resource type (usually KeyPair).
*
*
* @param resourceType
* The resource type (usually KeyPair).
* @return Returns a reference to this object so that method calls can be chained together.
* @see ResourceType
*/
public KeyPair withResourceType(ResourceType resourceType) {
this.resourceType = resourceType.toString();
return this;
}
/**
*
* The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer
* Guide.
*
*
* @return The tag keys and optional values for the resource. For more information about tags in Lightsail, see the
* Amazon Lightsail
* Developer Guide.
*/
public java.util.List getTags() {
return tags;
}
/**
*
* The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer
* Guide.
*
*
* @param tags
* The tag keys and optional values for the resource. For more information about tags in Lightsail, see the
* Amazon Lightsail
* Developer Guide.
*/
public void setTags(java.util.Collection tags) {
if (tags == null) {
this.tags = null;
return;
}
this.tags = new java.util.ArrayList(tags);
}
/**
*
* The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer
* Guide.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setTags(java.util.Collection)} or {@link #withTags(java.util.Collection)} if you want to override the
* existing values.
*
*
* @param tags
* The tag keys and optional values for the resource. For more information about tags in Lightsail, see the
* Amazon Lightsail
* Developer Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public KeyPair withTags(Tag... tags) {
if (this.tags == null) {
setTags(new java.util.ArrayList(tags.length));
}
for (Tag ele : tags) {
this.tags.add(ele);
}
return this;
}
/**
*
* The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Amazon Lightsail Developer
* Guide.
*
*
* @param tags
* The tag keys and optional values for the resource. For more information about tags in Lightsail, see the
* Amazon Lightsail
* Developer Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public KeyPair withTags(java.util.Collection tags) {
setTags(tags);
return this;
}
/**
*
* The RSA fingerprint of the key pair.
*
*
* @param fingerprint
* The RSA fingerprint of the key pair.
*/
public void setFingerprint(String fingerprint) {
this.fingerprint = fingerprint;
}
/**
*
* The RSA fingerprint of the key pair.
*
*
* @return The RSA fingerprint of the key pair.
*/
public String getFingerprint() {
return this.fingerprint;
}
/**
*
* The RSA fingerprint of the key pair.
*
*
* @param fingerprint
* The RSA fingerprint of the key pair.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public KeyPair withFingerprint(String fingerprint) {
setFingerprint(fingerprint);
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 (getArn() != null)
sb.append("Arn: ").append(getArn()).append(",");
if (getSupportCode() != null)
sb.append("SupportCode: ").append(getSupportCode()).append(",");
if (getCreatedAt() != null)
sb.append("CreatedAt: ").append(getCreatedAt()).append(",");
if (getLocation() != null)
sb.append("Location: ").append(getLocation()).append(",");
if (getResourceType() != null)
sb.append("ResourceType: ").append(getResourceType()).append(",");
if (getTags() != null)
sb.append("Tags: ").append(getTags()).append(",");
if (getFingerprint() != null)
sb.append("Fingerprint: ").append(getFingerprint());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof KeyPair == false)
return false;
KeyPair other = (KeyPair) obj;
if (other.getName() == null ^ this.getName() == null)
return false;
if (other.getName() != null && other.getName().equals(this.getName()) == false)
return false;
if (other.getArn() == null ^ this.getArn() == null)
return false;
if (other.getArn() != null && other.getArn().equals(this.getArn()) == false)
return false;
if (other.getSupportCode() == null ^ this.getSupportCode() == null)
return false;
if (other.getSupportCode() != null && other.getSupportCode().equals(this.getSupportCode()) == false)
return false;
if (other.getCreatedAt() == null ^ this.getCreatedAt() == null)
return false;
if (other.getCreatedAt() != null && other.getCreatedAt().equals(this.getCreatedAt()) == false)
return false;
if (other.getLocation() == null ^ this.getLocation() == null)
return false;
if (other.getLocation() != null && other.getLocation().equals(this.getLocation()) == false)
return false;
if (other.getResourceType() == null ^ this.getResourceType() == null)
return false;
if (other.getResourceType() != null && other.getResourceType().equals(this.getResourceType()) == false)
return false;
if (other.getTags() == null ^ this.getTags() == null)
return false;
if (other.getTags() != null && other.getTags().equals(this.getTags()) == false)
return false;
if (other.getFingerprint() == null ^ this.getFingerprint() == null)
return false;
if (other.getFingerprint() != null && other.getFingerprint().equals(this.getFingerprint()) == 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 + ((getArn() == null) ? 0 : getArn().hashCode());
hashCode = prime * hashCode + ((getSupportCode() == null) ? 0 : getSupportCode().hashCode());
hashCode = prime * hashCode + ((getCreatedAt() == null) ? 0 : getCreatedAt().hashCode());
hashCode = prime * hashCode + ((getLocation() == null) ? 0 : getLocation().hashCode());
hashCode = prime * hashCode + ((getResourceType() == null) ? 0 : getResourceType().hashCode());
hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode());
hashCode = prime * hashCode + ((getFingerprint() == null) ? 0 : getFingerprint().hashCode());
return hashCode;
}
@Override
public KeyPair clone() {
try {
return (KeyPair) 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.lightsail.model.transform.KeyPairMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}