com.amazonaws.services.kms.model.EnableKeyRequest 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.kms.model;
import java.io.Serializable;
import com.amazonaws.AmazonWebServiceRequest;
/**
 * 
 */
public class EnableKeyRequest extends AmazonWebServiceRequest implements
        Serializable, Cloneable {
    /**
     * 
     * A unique identifier for the customer master key. This value can be a
     * globally unique identifier or the fully specified ARN to a key.
     * 
     * 
     * - 
     * 
     * Key ARN Example -
     * arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234
     * -1234-123456789012
     * 
     *  
     * - 
     * 
     * Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
     * 
     *  
     * 
     */
    private String keyId;
    /**
     * 
     * A unique identifier for the customer master key. This value can be a
     * globally unique identifier or the fully specified ARN to a key.
     * 
     * 
     * - 
     * 
     * Key ARN Example -
     * arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234
     * -1234-123456789012
     * 
     *  
     * - 
     * 
     * Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
     * 
     *  
     * 
     * 
     * @param keyId
     *        A unique identifier for the customer master key. This value can be
     *        a globally unique identifier or the fully specified ARN to a
     *        key.
     *        
     *        - 
     *        
     *        Key ARN Example -
     *        arn:aws:kms:us-east-1:123456789012:key/12345678-1234
     *        -1234-1234-123456789012
     *        
     *         
     *        - 
     *        
     *        Globally Unique Key ID Example -
     *        12345678-1234-1234-1234-123456789012
     *        
     *         
     */
    public void setKeyId(String keyId) {
        this.keyId = keyId;
    }
    /**
     * 
     * A unique identifier for the customer master key. This value can be a
     * globally unique identifier or the fully specified ARN to a key.
     * 
     * 
     * - 
     * 
     * Key ARN Example -
     * arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234
     * -1234-123456789012
     * 
     *  
     * - 
     * 
     * Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
     * 
     *  
     * 
     * 
     * @return A unique identifier for the customer master key. This value can
     *         be a globally unique identifier or the fully specified ARN to a
     *         key.
     *         
     *         - 
     *         
     *         Key ARN Example -
     *         arn:aws:kms:us-east-1:123456789012:key/12345678-
     *         1234-1234-1234-123456789012
     *         
     *          
     *         - 
     *         
     *         Globally Unique Key ID Example -
     *         12345678-1234-1234-1234-123456789012
     *         
     *          
     */
    public String getKeyId() {
        return this.keyId;
    }
    /**
     * 
     * A unique identifier for the customer master key. This value can be a
     * globally unique identifier or the fully specified ARN to a key.
     * 
     * 
     * - 
     * 
     * Key ARN Example -
     * arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234
     * -1234-123456789012
     * 
     *  
     * - 
     * 
     * Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
     * 
     *  
     * 
     * 
     * @param keyId
     *        A unique identifier for the customer master key. This value can be
     *        a globally unique identifier or the fully specified ARN to a
     *        key.
     *        
     *        - 
     *        
     *        Key ARN Example -
     *        arn:aws:kms:us-east-1:123456789012:key/12345678-1234
     *        -1234-1234-123456789012
     *        
     *         
     *        - 
     *        
     *        Globally Unique Key ID Example -
     *        12345678-1234-1234-1234-123456789012
     *        
     *         
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public EnableKeyRequest withKeyId(String keyId) {
        setKeyId(keyId);
        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 (getKeyId() != null)
            sb.append("KeyId: " + getKeyId());
        sb.append("}");
        return sb.toString();
    }
    @Override
    public boolean equals(Object obj) {
        if (this == obj)
            return true;
        if (obj == null)
            return false;
        if (obj instanceof EnableKeyRequest == false)
            return false;
        EnableKeyRequest other = (EnableKeyRequest) obj;
        if (other.getKeyId() == null ^ this.getKeyId() == null)
            return false;
        if (other.getKeyId() != null
                && other.getKeyId().equals(this.getKeyId()) == false)
            return false;
        return true;
    }
    @Override
    public int hashCode() {
        final int prime = 31;
        int hashCode = 1;
        hashCode = prime * hashCode
                + ((getKeyId() == null) ? 0 : getKeyId().hashCode());
        return hashCode;
    }
    @Override
    public EnableKeyRequest clone() {
        return (EnableKeyRequest) super.clone();
    }
}