com.amazonaws.services.codepipeline.model.EncryptionKey Maven / Gradle / Ivy
Show all versions of aws-java-sdk-osgi Show documentation
/*
 * Copyright 2010-2016 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.codepipeline.model;
import java.io.Serializable;
/**
 * 
 * Represents information about the key used to encrypt data in the artifact
 * store, such as an AWS Key Management Service (AWS KMS) key.
 * 
 */
public class EncryptionKey implements Serializable, Cloneable {
    /**
     * 
     * The ID used to identify the key. For an AWS KMS key, this is the key ID
     * or key ARN.
     * 
     */
    private String id;
    /**
     * 
     * The type of encryption key, such as an AWS Key Management Service (AWS
     * KMS) key. When creating or updating a pipeline, the value must be set to
     * 'KMS'.
     * 
     */
    private String type;
    /**
     * 
     * The ID used to identify the key. For an AWS KMS key, this is the key ID
     * or key ARN.
     * 
     * 
     * @param id
     *        The ID used to identify the key. For an AWS KMS key, this is the
     *        key ID or key ARN.
     */
    public void setId(String id) {
        this.id = id;
    }
    /**
     * 
     * The ID used to identify the key. For an AWS KMS key, this is the key ID
     * or key ARN.
     * 
     * 
     * @return The ID used to identify the key. For an AWS KMS key, this is the
     *         key ID or key ARN.
     */
    public String getId() {
        return this.id;
    }
    /**
     * 
     * The ID used to identify the key. For an AWS KMS key, this is the key ID
     * or key ARN.
     * 
     * 
     * @param id
     *        The ID used to identify the key. For an AWS KMS key, this is the
     *        key ID or key ARN.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public EncryptionKey withId(String id) {
        setId(id);
        return this;
    }
    /**
     * 
     * The type of encryption key, such as an AWS Key Management Service (AWS
     * KMS) key. When creating or updating a pipeline, the value must be set to
     * 'KMS'.
     * 
     * 
     * @param type
     *        The type of encryption key, such as an AWS Key Management Service
     *        (AWS KMS) key. When creating or updating a pipeline, the value
     *        must be set to 'KMS'.
     * @see EncryptionKeyType
     */
    public void setType(String type) {
        this.type = type;
    }
    /**
     * 
     * The type of encryption key, such as an AWS Key Management Service (AWS
     * KMS) key. When creating or updating a pipeline, the value must be set to
     * 'KMS'.
     * 
     * 
     * @return The type of encryption key, such as an AWS Key Management Service
     *         (AWS KMS) key. When creating or updating a pipeline, the value
     *         must be set to 'KMS'.
     * @see EncryptionKeyType
     */
    public String getType() {
        return this.type;
    }
    /**
     * 
     * The type of encryption key, such as an AWS Key Management Service (AWS
     * KMS) key. When creating or updating a pipeline, the value must be set to
     * 'KMS'.
     * 
     * 
     * @param type
     *        The type of encryption key, such as an AWS Key Management Service
     *        (AWS KMS) key. When creating or updating a pipeline, the value
     *        must be set to 'KMS'.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     * @see EncryptionKeyType
     */
    public EncryptionKey withType(String type) {
        setType(type);
        return this;
    }
    /**
     * 
     * The type of encryption key, such as an AWS Key Management Service (AWS
     * KMS) key. When creating or updating a pipeline, the value must be set to
     * 'KMS'.
     * 
     * 
     * @param type
     *        The type of encryption key, such as an AWS Key Management Service
     *        (AWS KMS) key. When creating or updating a pipeline, the value
     *        must be set to 'KMS'.
     * @see EncryptionKeyType
     */
    public void setType(EncryptionKeyType type) {
        this.type = type.toString();
    }
    /**
     * 
     * The type of encryption key, such as an AWS Key Management Service (AWS
     * KMS) key. When creating or updating a pipeline, the value must be set to
     * 'KMS'.
     * 
     * 
     * @param type
     *        The type of encryption key, such as an AWS Key Management Service
     *        (AWS KMS) key. When creating or updating a pipeline, the value
     *        must be set to 'KMS'.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     * @see EncryptionKeyType
     */
    public EncryptionKey withType(EncryptionKeyType type) {
        setType(type);
        return this;
    }
    /**
     * Returns a string representation of this object; useful for testing and
     * debugging.
     *
     * @return A string representation of this object.
     *
     * @see java.lang.Object#toString()
     */
    @Override
    public String toString() {
        StringBuilder sb = new StringBuilder();
        sb.append("{");
        if (getId() != null)
            sb.append("Id: " + getId() + ",");
        if (getType() != null)
            sb.append("Type: " + getType());
        sb.append("}");
        return sb.toString();
    }
    @Override
    public boolean equals(Object obj) {
        if (this == obj)
            return true;
        if (obj == null)
            return false;
        if (obj instanceof EncryptionKey == false)
            return false;
        EncryptionKey other = (EncryptionKey) obj;
        if (other.getId() == null ^ this.getId() == null)
            return false;
        if (other.getId() != null
                && other.getId().equals(this.getId()) == false)
            return false;
        if (other.getType() == null ^ this.getType() == null)
            return false;
        if (other.getType() != null
                && other.getType().equals(this.getType()) == false)
            return false;
        return true;
    }
    @Override
    public int hashCode() {
        final int prime = 31;
        int hashCode = 1;
        hashCode = prime * hashCode
                + ((getId() == null) ? 0 : getId().hashCode());
        hashCode = prime * hashCode
                + ((getType() == null) ? 0 : getType().hashCode());
        return hashCode;
    }
    @Override
    public EncryptionKey clone() {
        try {
            return (EncryptionKey) super.clone();
        } catch (CloneNotSupportedException e) {
            throw new IllegalStateException(
                    "Got a CloneNotSupportedException from Object.clone() "
                            + "even though we're Cloneable!", e);
        }
    }
}