com.amazonaws.services.codepipeline.model.EncryptionKey.java Source code

Java tutorial

Introduction

Here is the source code for com.amazonaws.services.codepipeline.model.EncryptionKey.java

Source

/*
 * Copyright 2014-2019 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;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;

/**
 * <p>
 * Represents information about the key used to encrypt data in the artifact store, such as an AWS Key Management
 * Service (AWS KMS) key.
 * </p>
 * 
 * @see <a href="http://docs.aws.amazon.com/goto/WebAPI/codepipeline-2015-07-09/EncryptionKey" target="_top">AWS API
 *      Documentation</a>
 */
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class EncryptionKey implements Serializable, Cloneable, StructuredPojo {

    /**
     * <p>
     * The ID used to identify the key. For an AWS KMS key, you can use the key ID, the key ARN, or the alias ARN.
     * </p>
     * <note>
     * <p>
     * Aliases are recognized only in the account that created the customer master key (CMK). For cross-account actions,
     * you can only use the key ID or key ARN to identify the key.
     * </p>
     * </note>
     */
    private String id;
    /**
     * <p>
     * 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'.
     * </p>
     */
    private String type;

    /**
     * <p>
     * The ID used to identify the key. For an AWS KMS key, you can use the key ID, the key ARN, or the alias ARN.
     * </p>
     * <note>
     * <p>
     * Aliases are recognized only in the account that created the customer master key (CMK). For cross-account actions,
     * you can only use the key ID or key ARN to identify the key.
     * </p>
     * </note>
     * 
     * @param id
     *        The ID used to identify the key. For an AWS KMS key, you can use the key ID, the key ARN, or the alias
     *        ARN.</p> <note>
     *        <p>
     *        Aliases are recognized only in the account that created the customer master key (CMK). For cross-account
     *        actions, you can only use the key ID or key ARN to identify the key.
     *        </p>
     */

    public void setId(String id) {
        this.id = id;
    }

    /**
     * <p>
     * The ID used to identify the key. For an AWS KMS key, you can use the key ID, the key ARN, or the alias ARN.
     * </p>
     * <note>
     * <p>
     * Aliases are recognized only in the account that created the customer master key (CMK). For cross-account actions,
     * you can only use the key ID or key ARN to identify the key.
     * </p>
     * </note>
     * 
     * @return The ID used to identify the key. For an AWS KMS key, you can use the key ID, the key ARN, or the alias
     *         ARN.</p> <note>
     *         <p>
     *         Aliases are recognized only in the account that created the customer master key (CMK). For cross-account
     *         actions, you can only use the key ID or key ARN to identify the key.
     *         </p>
     */

    public String getId() {
        return this.id;
    }

    /**
     * <p>
     * The ID used to identify the key. For an AWS KMS key, you can use the key ID, the key ARN, or the alias ARN.
     * </p>
     * <note>
     * <p>
     * Aliases are recognized only in the account that created the customer master key (CMK). For cross-account actions,
     * you can only use the key ID or key ARN to identify the key.
     * </p>
     * </note>
     * 
     * @param id
     *        The ID used to identify the key. For an AWS KMS key, you can use the key ID, the key ARN, or the alias
     *        ARN.</p> <note>
     *        <p>
     *        Aliases are recognized only in the account that created the customer master key (CMK). For cross-account
     *        actions, you can only use the key ID or key ARN to identify the key.
     *        </p>
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public EncryptionKey withId(String id) {
        setId(id);
        return this;
    }

    /**
     * <p>
     * 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'.
     * </p>
     * 
     * @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;
    }

    /**
     * <p>
     * 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'.
     * </p>
     * 
     * @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;
    }

    /**
     * <p>
     * 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'.
     * </p>
     * 
     * @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;
    }

    /**
     * <p>
     * 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'.
     * </p>
     * 
     * @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) {
        withType(type);
    }

    /**
     * <p>
     * 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'.
     * </p>
     * 
     * @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) {
        this.type = type.toString();
        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 (getId() != null)
            sb.append("Id: ").append(getId()).append(",");
        if (getType() != null)
            sb.append("Type: ").append(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);
        }
    }

    @com.amazonaws.annotation.SdkInternalApi
    @Override
    public void marshall(ProtocolMarshaller protocolMarshaller) {
        com.amazonaws.services.codepipeline.model.transform.EncryptionKeyMarshaller.getInstance().marshall(this,
                protocolMarshaller);
    }
}