com.amazonaws.services.storagegateway.model.CreateTapesRequest 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.storagegateway.model;
import java.io.Serializable;
import com.amazonaws.AmazonWebServiceRequest;
/**
 * 
 * CreateTapesInput
 * 
 */
public class CreateTapesRequest extends AmazonWebServiceRequest implements
        Serializable, Cloneable {
    /**
     * 
     * The unique Amazon Resource Name (ARN) that represents the gateway to
     * associate the virtual tapes with. Use the ListGateways operation
     * to return a list of gateways for your account and region.
     * 
     */
    private String gatewayARN;
    /**
     * 
     * The size, in bytes, of the virtual tapes that you want to create.
     * 
     * 
     * 
     * The size must be aligned by gigabyte (1024*1024*1024 byte).
     * 
     *  
     */
    private Long tapeSizeInBytes;
    /**
     * 
     * A unique identifier that you use to retry a request. If you retry a
     * request, use the same ClientToken you specified in the
     * initial request.
     * 
     * 
     * 
     * Using the same ClientToken prevents creating the tape
     * multiple times.
     * 
     *  
     */
    private String clientToken;
    /**
     * 
     * The number of virtual tapes that you want to create.
     * 
     */
    private Integer numTapesToCreate;
    /**
     * 
     * A prefix that you append to the barcode of the virtual tape you are
     * creating. This prefix makes the barcode unique.
     * 
     * 
     * 
     * The prefix must be 1 to 4 characters in length and must be one of the
     * uppercase letters from A to Z.
     * 
     *  
     */
    private String tapeBarcodePrefix;
    /**
     * 
     * The unique Amazon Resource Name (ARN) that represents the gateway to
     * associate the virtual tapes with. Use the ListGateways operation
     * to return a list of gateways for your account and region.
     * 
     * 
     * @param gatewayARN
     *        The unique Amazon Resource Name (ARN) that represents the gateway
     *        to associate the virtual tapes with. Use the ListGateways
     *        operation to return a list of gateways for your account and
     *        region.
     */
    public void setGatewayARN(String gatewayARN) {
        this.gatewayARN = gatewayARN;
    }
    /**
     * 
     * The unique Amazon Resource Name (ARN) that represents the gateway to
     * associate the virtual tapes with. Use the ListGateways operation
     * to return a list of gateways for your account and region.
     * 
     * 
     * @return The unique Amazon Resource Name (ARN) that represents the gateway
     *         to associate the virtual tapes with. Use the ListGateways
     *         operation to return a list of gateways for your account and
     *         region.
     */
    public String getGatewayARN() {
        return this.gatewayARN;
    }
    /**
     * 
     * The unique Amazon Resource Name (ARN) that represents the gateway to
     * associate the virtual tapes with. Use the ListGateways operation
     * to return a list of gateways for your account and region.
     * 
     * 
     * @param gatewayARN
     *        The unique Amazon Resource Name (ARN) that represents the gateway
     *        to associate the virtual tapes with. Use the ListGateways
     *        operation to return a list of gateways for your account and
     *        region.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public CreateTapesRequest withGatewayARN(String gatewayARN) {
        setGatewayARN(gatewayARN);
        return this;
    }
    /**
     * 
     * The size, in bytes, of the virtual tapes that you want to create.
     * 
     * 
     * 
     * The size must be aligned by gigabyte (1024*1024*1024 byte).
     * 
     *  
     * 
     * @param tapeSizeInBytes
     *        The size, in bytes, of the virtual tapes that you want to
     *        create. 
     *        
     *        The size must be aligned by gigabyte (1024*1024*1024 byte).
     *        
     */
    public void setTapeSizeInBytes(Long tapeSizeInBytes) {
        this.tapeSizeInBytes = tapeSizeInBytes;
    }
    /**
     * 
     * The size, in bytes, of the virtual tapes that you want to create.
     * 
     * 
     * 
     * The size must be aligned by gigabyte (1024*1024*1024 byte).
     * 
     *  
     * 
     * @return The size, in bytes, of the virtual tapes that you want to
     *         create. 
     *         
     *         The size must be aligned by gigabyte (1024*1024*1024 byte).
     *         
     */
    public Long getTapeSizeInBytes() {
        return this.tapeSizeInBytes;
    }
    /**
     * 
     * The size, in bytes, of the virtual tapes that you want to create.
     * 
     * 
     * 
     * The size must be aligned by gigabyte (1024*1024*1024 byte).
     * 
     *  
     * 
     * @param tapeSizeInBytes
     *        The size, in bytes, of the virtual tapes that you want to
     *        create. 
     *        
     *        The size must be aligned by gigabyte (1024*1024*1024 byte).
     *        
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public CreateTapesRequest withTapeSizeInBytes(Long tapeSizeInBytes) {
        setTapeSizeInBytes(tapeSizeInBytes);
        return this;
    }
    /**
     * 
     * A unique identifier that you use to retry a request. If you retry a
     * request, use the same ClientToken you specified in the
     * initial request.
     * 
     * 
     * 
     * Using the same ClientToken prevents creating the tape
     * multiple times.
     * 
     *  
     * 
     * @param clientToken
     *        A unique identifier that you use to retry a request. If you retry
     *        a request, use the same ClientToken you specified in
     *        the initial request. 
     *        
     *        Using the same ClientToken prevents creating the tape
     *        multiple times.
     *        
     */
    public void setClientToken(String clientToken) {
        this.clientToken = clientToken;
    }
    /**
     * 
     * A unique identifier that you use to retry a request. If you retry a
     * request, use the same ClientToken you specified in the
     * initial request.
     * 
     * 
     * 
     * Using the same ClientToken prevents creating the tape
     * multiple times.
     * 
     *  
     * 
     * @return A unique identifier that you use to retry a request. If you retry
     *         a request, use the same ClientToken you specified in
     *         the initial request. 
     *         
     *         Using the same ClientToken prevents creating the
     *         tape multiple times.
     *         
     */
    public String getClientToken() {
        return this.clientToken;
    }
    /**
     * 
     * A unique identifier that you use to retry a request. If you retry a
     * request, use the same ClientToken you specified in the
     * initial request.
     * 
     * 
     * 
     * Using the same ClientToken prevents creating the tape
     * multiple times.
     * 
     *  
     * 
     * @param clientToken
     *        A unique identifier that you use to retry a request. If you retry
     *        a request, use the same ClientToken you specified in
     *        the initial request. 
     *        
     *        Using the same ClientToken prevents creating the tape
     *        multiple times.
     *        
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public CreateTapesRequest withClientToken(String clientToken) {
        setClientToken(clientToken);
        return this;
    }
    /**
     * 
     * The number of virtual tapes that you want to create.
     * 
     * 
     * @param numTapesToCreate
     *        The number of virtual tapes that you want to create.
     */
    public void setNumTapesToCreate(Integer numTapesToCreate) {
        this.numTapesToCreate = numTapesToCreate;
    }
    /**
     * 
     * The number of virtual tapes that you want to create.
     * 
     * 
     * @return The number of virtual tapes that you want to create.
     */
    public Integer getNumTapesToCreate() {
        return this.numTapesToCreate;
    }
    /**
     * 
     * The number of virtual tapes that you want to create.
     * 
     * 
     * @param numTapesToCreate
     *        The number of virtual tapes that you want to create.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public CreateTapesRequest withNumTapesToCreate(Integer numTapesToCreate) {
        setNumTapesToCreate(numTapesToCreate);
        return this;
    }
    /**
     * 
     * A prefix that you append to the barcode of the virtual tape you are
     * creating. This prefix makes the barcode unique.
     * 
     * 
     * 
     * The prefix must be 1 to 4 characters in length and must be one of the
     * uppercase letters from A to Z.
     * 
     *  
     * 
     * @param tapeBarcodePrefix
     *        A prefix that you append to the barcode of the virtual tape you
     *        are creating. This prefix makes the barcode unique. 
     *        
     *        The prefix must be 1 to 4 characters in length and must be one of
     *        the uppercase letters from A to Z.
     *        
     */
    public void setTapeBarcodePrefix(String tapeBarcodePrefix) {
        this.tapeBarcodePrefix = tapeBarcodePrefix;
    }
    /**
     * 
     * A prefix that you append to the barcode of the virtual tape you are
     * creating. This prefix makes the barcode unique.
     * 
     * 
     * 
     * The prefix must be 1 to 4 characters in length and must be one of the
     * uppercase letters from A to Z.
     * 
     *  
     * 
     * @return A prefix that you append to the barcode of the virtual tape you
     *         are creating. This prefix makes the barcode unique. 
     *         
     *         The prefix must be 1 to 4 characters in length and must be one of
     *         the uppercase letters from A to Z.
     *         
     */
    public String getTapeBarcodePrefix() {
        return this.tapeBarcodePrefix;
    }
    /**
     * 
     * A prefix that you append to the barcode of the virtual tape you are
     * creating. This prefix makes the barcode unique.
     * 
     * 
     * 
     * The prefix must be 1 to 4 characters in length and must be one of the
     * uppercase letters from A to Z.
     * 
     *  
     * 
     * @param tapeBarcodePrefix
     *        A prefix that you append to the barcode of the virtual tape you
     *        are creating. This prefix makes the barcode unique. 
     *        
     *        The prefix must be 1 to 4 characters in length and must be one of
     *        the uppercase letters from A to Z.
     *        
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public CreateTapesRequest withTapeBarcodePrefix(String tapeBarcodePrefix) {
        setTapeBarcodePrefix(tapeBarcodePrefix);
        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 (getGatewayARN() != null)
            sb.append("GatewayARN: " + getGatewayARN() + ",");
        if (getTapeSizeInBytes() != null)
            sb.append("TapeSizeInBytes: " + getTapeSizeInBytes() + ",");
        if (getClientToken() != null)
            sb.append("ClientToken: " + getClientToken() + ",");
        if (getNumTapesToCreate() != null)
            sb.append("NumTapesToCreate: " + getNumTapesToCreate() + ",");
        if (getTapeBarcodePrefix() != null)
            sb.append("TapeBarcodePrefix: " + getTapeBarcodePrefix());
        sb.append("}");
        return sb.toString();
    }
    @Override
    public boolean equals(Object obj) {
        if (this == obj)
            return true;
        if (obj == null)
            return false;
        if (obj instanceof CreateTapesRequest == false)
            return false;
        CreateTapesRequest other = (CreateTapesRequest) obj;
        if (other.getGatewayARN() == null ^ this.getGatewayARN() == null)
            return false;
        if (other.getGatewayARN() != null
                && other.getGatewayARN().equals(this.getGatewayARN()) == false)
            return false;
        if (other.getTapeSizeInBytes() == null
                ^ this.getTapeSizeInBytes() == null)
            return false;
        if (other.getTapeSizeInBytes() != null
                && other.getTapeSizeInBytes().equals(this.getTapeSizeInBytes()) == false)
            return false;
        if (other.getClientToken() == null ^ this.getClientToken() == null)
            return false;
        if (other.getClientToken() != null
                && other.getClientToken().equals(this.getClientToken()) == false)
            return false;
        if (other.getNumTapesToCreate() == null
                ^ this.getNumTapesToCreate() == null)
            return false;
        if (other.getNumTapesToCreate() != null
                && other.getNumTapesToCreate().equals(
                        this.getNumTapesToCreate()) == false)
            return false;
        if (other.getTapeBarcodePrefix() == null
                ^ this.getTapeBarcodePrefix() == null)
            return false;
        if (other.getTapeBarcodePrefix() != null
                && other.getTapeBarcodePrefix().equals(
                        this.getTapeBarcodePrefix()) == false)
            return false;
        return true;
    }
    @Override
    public int hashCode() {
        final int prime = 31;
        int hashCode = 1;
        hashCode = prime * hashCode
                + ((getGatewayARN() == null) ? 0 : getGatewayARN().hashCode());
        hashCode = prime
                * hashCode
                + ((getTapeSizeInBytes() == null) ? 0 : getTapeSizeInBytes()
                        .hashCode());
        hashCode = prime
                * hashCode
                + ((getClientToken() == null) ? 0 : getClientToken().hashCode());
        hashCode = prime
                * hashCode
                + ((getNumTapesToCreate() == null) ? 0 : getNumTapesToCreate()
                        .hashCode());
        hashCode = prime
                * hashCode
                + ((getTapeBarcodePrefix() == null) ? 0
                        : getTapeBarcodePrefix().hashCode());
        return hashCode;
    }
    @Override
    public CreateTapesRequest clone() {
        return (CreateTapesRequest) super.clone();
    }
}