com.amazonaws.services.storagegateway.model.DescribeBandwidthRateLimitRequest Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of aws-java-sdk Show documentation

The Amazon Web Services SDK for Java provides Java APIs for building software on AWS' cost-effective, scalable, and reliable infrastructure products. The AWS Java SDK allows developers to code against APIs for all of Amazon's infrastructure web services (Amazon S3, Amazon EC2, Amazon SQS, Amazon Relational Database Service, Amazon AutoScaling, etc).

The newest version!

/*
 * Copyright 2010-2014 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;

/**
 * Container for the parameters to the {@link com.amazonaws.services.storagegateway.AWSStorageGateway#describeBandwidthRateLimit(DescribeBandwidthRateLimitRequest) DescribeBandwidthRateLimit operation}.
 * 
 * This operation returns the bandwidth rate limits of a gateway. By
 * default, these limits are not set, which means no bandwidth rate
 * limiting is in effect.
 * 
 * 
 * This operation only returns a value for a bandwidth rate limit only if
 * the limit is set. If no limits are set for the gateway, then this
 * operation returns only the gateway ARN in the response body. To
 * specify which gateway to describe, use the Amazon Resource Name (ARN)
 * of the gateway in your request.
 * 
 *
 * @see com.amazonaws.services.storagegateway.AWSStorageGateway#describeBandwidthRateLimit(DescribeBandwidthRateLimitRequest)
 */
public class DescribeBandwidthRateLimitRequest extends AmazonWebServiceRequest implements Serializable {

    /**
     * The Amazon Resource Name (ARN) of the gateway. Use the
     * ListGateways operation to return a list of gateways for your
     * account and region.
     * 
     * Constraints:

     * Length: 50 - 500

     */
    private String gatewayARN;

    /**
     * The Amazon Resource Name (ARN) of the gateway. Use the
     * ListGateways operation to return a list of gateways for your
     * account and region.
     * 

     * Constraints:

     * Length: 50 - 500

     *
     * @return The Amazon Resource Name (ARN) of the gateway. Use the
     *         ListGateways operation to return a list of gateways for your
     *         account and region.
     */
    public String getGatewayARN() {
        return gatewayARN;
    }
    
    /**
     * The Amazon Resource Name (ARN) of the gateway. Use the
     * ListGateways operation to return a list of gateways for your
     * account and region.
     * 

     * Constraints:

     * Length: 50 - 500

     *
     * @param gatewayARN The Amazon Resource Name (ARN) of the gateway. Use the
     *         ListGateways operation to return a list of gateways for your
     *         account and region.
     */
    public void setGatewayARN(String gatewayARN) {
        this.gatewayARN = gatewayARN;
    }
    
    /**
     * The Amazon Resource Name (ARN) of the gateway. Use the
     * ListGateways operation to return a list of gateways for your
     * account and region.
     * 

     * Returns a reference to this object so that method calls can be chained together.
     * 
     * Constraints:

     * Length: 50 - 500

     *
     * @param gatewayARN The Amazon Resource Name (ARN) of the gateway. Use the
     *         ListGateways operation to return a list of gateways for your
     *         account and region.
     *
     * @return A reference to this updated object so that method calls can be chained 
     *         together.
     */
    public DescribeBandwidthRateLimitRequest withGatewayARN(String gatewayARN) {
        this.gatewayARN = gatewayARN;
        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() );
        sb.append("}");
        return sb.toString();
    }
    
    @Override
    public int hashCode() {
        final int prime = 31;
        int hashCode = 1;
        
        hashCode = prime * hashCode + ((getGatewayARN() == null) ? 0 : getGatewayARN().hashCode()); 
        return hashCode;
    }
    
    @Override
    public boolean equals(Object obj) {
        if (this == obj) return true;
        if (obj == null) return false;

        if (obj instanceof DescribeBandwidthRateLimitRequest == false) return false;
        DescribeBandwidthRateLimitRequest other = (DescribeBandwidthRateLimitRequest)obj;
        
        if (other.getGatewayARN() == null ^ this.getGatewayARN() == null) return false;
        if (other.getGatewayARN() != null && other.getGatewayARN().equals(this.getGatewayARN()) == false) return false; 
        return true;
    }
    
}