com.amazonaws.services.storagegateway.model.ActivateGatewayRequest Maven / Gradle / Ivy
/*
* Copyright 2013-2018 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 javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* A JSON object containing one or more of the following fields:
*
*
* -
*
*
* -
*
*
* -
*
*
* -
*
*
* -
*
*
* -
*
*
* -
*
*
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class ActivateGatewayRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* Your gateway activation key. You can obtain the activation key by sending an HTTP GET request with redirects
* enabled to the gateway IP address (port 80). The redirect URL returned in the response provides you the
* activation key for your gateway in the query string parameter activationKey. It may also include
* other activation-related parameters, however, these are merely defaults -- the arguments you pass to the
* ActivateGateway API call determine the actual configuration of your gateway.
*
*
* For more information, see https://docs.aws.amazon.com/storagegateway/latest/userguide/get-activation-key.html in
* the Storage Gateway User Guide.
*
*/
private String activationKey;
/**
*
* The name you configured for your gateway.
*
*/
private String gatewayName;
/**
*
* A value that indicates the time zone you want to set for the gateway. The time zone is of the format "GMT-hr:mm"
* or "GMT+hr:mm". For example, GMT-4:00 indicates the time is 4 hours behind GMT. GMT+2:00 indicates the time is 2
* hours ahead of GMT. The time zone is used, for example, for scheduling snapshots and your gateway's maintenance
* schedule.
*
*/
private String gatewayTimezone;
/**
*
* A value that indicates the region where you want to store your data. The gateway region specified must be the
* same region as the region in your Host header in the request. For more information about available
* regions and endpoints for AWS Storage Gateway, see Regions and Endpoints in the
* Amazon Web Services Glossary.
*
*
* Valid Values: "us-east-1", "us-east-2", "us-west-1", "us-west-2", "ca-central-1", "eu-west-1", "eu-central-1",
* "eu-west-2", "eu-west-3", "ap-northeast-1", "ap-northeast-2", "ap-southeast-1", "ap-southeast-2", "ap-south-1",
* "sa-east-1"
*
*/
private String gatewayRegion;
/**
*
* A value that defines the type of gateway to activate. The type specified is critical to all later functions of
* the gateway and cannot be changed after activation. The default value is CACHED.
*
*
* Valid Values: "STORED", "CACHED", "VTL", "FILE_S3"
*
*/
private String gatewayType;
/**
*
* The value that indicates the type of tape drive to use for tape gateway. This field is optional.
*
*
* Valid Values: "IBM-ULT3580-TD5"
*
*/
private String tapeDriveType;
/**
*
* The value that indicates the type of medium changer to use for tape gateway. This field is optional.
*
*
* Valid Values: "STK-L700", "AWS-Gateway-VTL"
*
*/
private String mediumChangerType;
/**
*
* Your gateway activation key. You can obtain the activation key by sending an HTTP GET request with redirects
* enabled to the gateway IP address (port 80). The redirect URL returned in the response provides you the
* activation key for your gateway in the query string parameter activationKey. It may also include
* other activation-related parameters, however, these are merely defaults -- the arguments you pass to the
* ActivateGateway API call determine the actual configuration of your gateway.
*
*
* For more information, see https://docs.aws.amazon.com/storagegateway/latest/userguide/get-activation-key.html in
* the Storage Gateway User Guide.
*
*
* @param activationKey
* Your gateway activation key. You can obtain the activation key by sending an HTTP GET request with
* redirects enabled to the gateway IP address (port 80). The redirect URL returned in the response provides
* you the activation key for your gateway in the query string parameter activationKey. It may
* also include other activation-related parameters, however, these are merely defaults -- the arguments you
* pass to the ActivateGateway API call determine the actual configuration of your gateway.
*
* For more information, see
* https://docs.aws.amazon.com/storagegateway/latest/userguide/get-activation-key.html in the Storage Gateway
* User Guide.
*/
public void setActivationKey(String activationKey) {
this.activationKey = activationKey;
}
/**
*
* Your gateway activation key. You can obtain the activation key by sending an HTTP GET request with redirects
* enabled to the gateway IP address (port 80). The redirect URL returned in the response provides you the
* activation key for your gateway in the query string parameter activationKey. It may also include
* other activation-related parameters, however, these are merely defaults -- the arguments you pass to the
* ActivateGateway API call determine the actual configuration of your gateway.
*
*
* For more information, see https://docs.aws.amazon.com/storagegateway/latest/userguide/get-activation-key.html in
* the Storage Gateway User Guide.
*
*
* @return Your gateway activation key. You can obtain the activation key by sending an HTTP GET request with
* redirects enabled to the gateway IP address (port 80). The redirect URL returned in the response provides
* you the activation key for your gateway in the query string parameter activationKey. It may
* also include other activation-related parameters, however, these are merely defaults -- the arguments you
* pass to the ActivateGateway API call determine the actual configuration of your gateway.
*
*
* For more information, see
* https://docs.aws.amazon.com/storagegateway/latest/userguide/get-activation-key.html in the Storage
* Gateway User Guide.
*/
public String getActivationKey() {
return this.activationKey;
}
/**
*
* Your gateway activation key. You can obtain the activation key by sending an HTTP GET request with redirects
* enabled to the gateway IP address (port 80). The redirect URL returned in the response provides you the
* activation key for your gateway in the query string parameter activationKey. It may also include
* other activation-related parameters, however, these are merely defaults -- the arguments you pass to the
* ActivateGateway API call determine the actual configuration of your gateway.
*
*
* For more information, see https://docs.aws.amazon.com/storagegateway/latest/userguide/get-activation-key.html in
* the Storage Gateway User Guide.
*
*
* @param activationKey
* Your gateway activation key. You can obtain the activation key by sending an HTTP GET request with
* redirects enabled to the gateway IP address (port 80). The redirect URL returned in the response provides
* you the activation key for your gateway in the query string parameter activationKey. It may
* also include other activation-related parameters, however, these are merely defaults -- the arguments you
* pass to the ActivateGateway API call determine the actual configuration of your gateway.
*
* For more information, see
* https://docs.aws.amazon.com/storagegateway/latest/userguide/get-activation-key.html in the Storage Gateway
* User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ActivateGatewayRequest withActivationKey(String activationKey) {
setActivationKey(activationKey);
return this;
}
/**
*
* The name you configured for your gateway.
*
*
* @param gatewayName
* The name you configured for your gateway.
*/
public void setGatewayName(String gatewayName) {
this.gatewayName = gatewayName;
}
/**
*
* The name you configured for your gateway.
*
*
* @return The name you configured for your gateway.
*/
public String getGatewayName() {
return this.gatewayName;
}
/**
*
* The name you configured for your gateway.
*
*
* @param gatewayName
* The name you configured for your gateway.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ActivateGatewayRequest withGatewayName(String gatewayName) {
setGatewayName(gatewayName);
return this;
}
/**
*
* A value that indicates the time zone you want to set for the gateway. The time zone is of the format "GMT-hr:mm"
* or "GMT+hr:mm". For example, GMT-4:00 indicates the time is 4 hours behind GMT. GMT+2:00 indicates the time is 2
* hours ahead of GMT. The time zone is used, for example, for scheduling snapshots and your gateway's maintenance
* schedule.
*
*
* @param gatewayTimezone
* A value that indicates the time zone you want to set for the gateway. The time zone is of the format
* "GMT-hr:mm" or "GMT+hr:mm". For example, GMT-4:00 indicates the time is 4 hours behind GMT. GMT+2:00
* indicates the time is 2 hours ahead of GMT. The time zone is used, for example, for scheduling snapshots
* and your gateway's maintenance schedule.
*/
public void setGatewayTimezone(String gatewayTimezone) {
this.gatewayTimezone = gatewayTimezone;
}
/**
*
* A value that indicates the time zone you want to set for the gateway. The time zone is of the format "GMT-hr:mm"
* or "GMT+hr:mm". For example, GMT-4:00 indicates the time is 4 hours behind GMT. GMT+2:00 indicates the time is 2
* hours ahead of GMT. The time zone is used, for example, for scheduling snapshots and your gateway's maintenance
* schedule.
*
*
* @return A value that indicates the time zone you want to set for the gateway. The time zone is of the format
* "GMT-hr:mm" or "GMT+hr:mm". For example, GMT-4:00 indicates the time is 4 hours behind GMT. GMT+2:00
* indicates the time is 2 hours ahead of GMT. The time zone is used, for example, for scheduling snapshots
* and your gateway's maintenance schedule.
*/
public String getGatewayTimezone() {
return this.gatewayTimezone;
}
/**
*
* A value that indicates the time zone you want to set for the gateway. The time zone is of the format "GMT-hr:mm"
* or "GMT+hr:mm". For example, GMT-4:00 indicates the time is 4 hours behind GMT. GMT+2:00 indicates the time is 2
* hours ahead of GMT. The time zone is used, for example, for scheduling snapshots and your gateway's maintenance
* schedule.
*
*
* @param gatewayTimezone
* A value that indicates the time zone you want to set for the gateway. The time zone is of the format
* "GMT-hr:mm" or "GMT+hr:mm". For example, GMT-4:00 indicates the time is 4 hours behind GMT. GMT+2:00
* indicates the time is 2 hours ahead of GMT. The time zone is used, for example, for scheduling snapshots
* and your gateway's maintenance schedule.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ActivateGatewayRequest withGatewayTimezone(String gatewayTimezone) {
setGatewayTimezone(gatewayTimezone);
return this;
}
/**
*
* A value that indicates the region where you want to store your data. The gateway region specified must be the
* same region as the region in your Host header in the request. For more information about available
* regions and endpoints for AWS Storage Gateway, see Regions and Endpoints in the
* Amazon Web Services Glossary.
*
*
* Valid Values: "us-east-1", "us-east-2", "us-west-1", "us-west-2", "ca-central-1", "eu-west-1", "eu-central-1",
* "eu-west-2", "eu-west-3", "ap-northeast-1", "ap-northeast-2", "ap-southeast-1", "ap-southeast-2", "ap-south-1",
* "sa-east-1"
*
*
* @param gatewayRegion
* A value that indicates the region where you want to store your data. The gateway region specified must be
* the same region as the region in your Host header in the request. For more information about
* available regions and endpoints for AWS Storage Gateway, see Regions and Endpoints in the
* Amazon Web Services Glossary.
*
* Valid Values: "us-east-1", "us-east-2", "us-west-1", "us-west-2", "ca-central-1", "eu-west-1",
* "eu-central-1", "eu-west-2", "eu-west-3", "ap-northeast-1", "ap-northeast-2", "ap-southeast-1",
* "ap-southeast-2", "ap-south-1", "sa-east-1"
*/
public void setGatewayRegion(String gatewayRegion) {
this.gatewayRegion = gatewayRegion;
}
/**
*
* A value that indicates the region where you want to store your data. The gateway region specified must be the
* same region as the region in your Host header in the request. For more information about available
* regions and endpoints for AWS Storage Gateway, see Regions and Endpoints in the
* Amazon Web Services Glossary.
*
*
* Valid Values: "us-east-1", "us-east-2", "us-west-1", "us-west-2", "ca-central-1", "eu-west-1", "eu-central-1",
* "eu-west-2", "eu-west-3", "ap-northeast-1", "ap-northeast-2", "ap-southeast-1", "ap-southeast-2", "ap-south-1",
* "sa-east-1"
*
*
* @return A value that indicates the region where you want to store your data. The gateway region specified must be
* the same region as the region in your Host header in the request. For more information about
* available regions and endpoints for AWS Storage Gateway, see Regions and Endpoints in the
* Amazon Web Services Glossary.
*
* Valid Values: "us-east-1", "us-east-2", "us-west-1", "us-west-2", "ca-central-1", "eu-west-1",
* "eu-central-1", "eu-west-2", "eu-west-3", "ap-northeast-1", "ap-northeast-2", "ap-southeast-1",
* "ap-southeast-2", "ap-south-1", "sa-east-1"
*/
public String getGatewayRegion() {
return this.gatewayRegion;
}
/**
*
* A value that indicates the region where you want to store your data. The gateway region specified must be the
* same region as the region in your Host header in the request. For more information about available
* regions and endpoints for AWS Storage Gateway, see Regions and Endpoints in the
* Amazon Web Services Glossary.
*
*
* Valid Values: "us-east-1", "us-east-2", "us-west-1", "us-west-2", "ca-central-1", "eu-west-1", "eu-central-1",
* "eu-west-2", "eu-west-3", "ap-northeast-1", "ap-northeast-2", "ap-southeast-1", "ap-southeast-2", "ap-south-1",
* "sa-east-1"
*
*
* @param gatewayRegion
* A value that indicates the region where you want to store your data. The gateway region specified must be
* the same region as the region in your Host header in the request. For more information about
* available regions and endpoints for AWS Storage Gateway, see Regions and Endpoints in the
* Amazon Web Services Glossary.
*
* Valid Values: "us-east-1", "us-east-2", "us-west-1", "us-west-2", "ca-central-1", "eu-west-1",
* "eu-central-1", "eu-west-2", "eu-west-3", "ap-northeast-1", "ap-northeast-2", "ap-southeast-1",
* "ap-southeast-2", "ap-south-1", "sa-east-1"
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ActivateGatewayRequest withGatewayRegion(String gatewayRegion) {
setGatewayRegion(gatewayRegion);
return this;
}
/**
*
* A value that defines the type of gateway to activate. The type specified is critical to all later functions of
* the gateway and cannot be changed after activation. The default value is CACHED.
*
*
* Valid Values: "STORED", "CACHED", "VTL", "FILE_S3"
*
*
* @param gatewayType
* A value that defines the type of gateway to activate. The type specified is critical to all later
* functions of the gateway and cannot be changed after activation. The default value is CACHED.
*
*
* Valid Values: "STORED", "CACHED", "VTL", "FILE_S3"
*/
public void setGatewayType(String gatewayType) {
this.gatewayType = gatewayType;
}
/**
*
* A value that defines the type of gateway to activate. The type specified is critical to all later functions of
* the gateway and cannot be changed after activation. The default value is CACHED.
*
*
* Valid Values: "STORED", "CACHED", "VTL", "FILE_S3"
*
*
* @return A value that defines the type of gateway to activate. The type specified is critical to all later
* functions of the gateway and cannot be changed after activation. The default value is CACHED
* .
*
* Valid Values: "STORED", "CACHED", "VTL", "FILE_S3"
*/
public String getGatewayType() {
return this.gatewayType;
}
/**
*
* A value that defines the type of gateway to activate. The type specified is critical to all later functions of
* the gateway and cannot be changed after activation. The default value is CACHED.
*
*
* Valid Values: "STORED", "CACHED", "VTL", "FILE_S3"
*
*
* @param gatewayType
* A value that defines the type of gateway to activate. The type specified is critical to all later
* functions of the gateway and cannot be changed after activation. The default value is CACHED.
*
*
* Valid Values: "STORED", "CACHED", "VTL", "FILE_S3"
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ActivateGatewayRequest withGatewayType(String gatewayType) {
setGatewayType(gatewayType);
return this;
}
/**
*
* The value that indicates the type of tape drive to use for tape gateway. This field is optional.
*
*
* Valid Values: "IBM-ULT3580-TD5"
*
*
* @param tapeDriveType
* The value that indicates the type of tape drive to use for tape gateway. This field is optional.
*
* Valid Values: "IBM-ULT3580-TD5"
*/
public void setTapeDriveType(String tapeDriveType) {
this.tapeDriveType = tapeDriveType;
}
/**
*
* The value that indicates the type of tape drive to use for tape gateway. This field is optional.
*
*
* Valid Values: "IBM-ULT3580-TD5"
*
*
* @return The value that indicates the type of tape drive to use for tape gateway. This field is optional.
*
* Valid Values: "IBM-ULT3580-TD5"
*/
public String getTapeDriveType() {
return this.tapeDriveType;
}
/**
*
* The value that indicates the type of tape drive to use for tape gateway. This field is optional.
*
*
* Valid Values: "IBM-ULT3580-TD5"
*
*
* @param tapeDriveType
* The value that indicates the type of tape drive to use for tape gateway. This field is optional.
*
* Valid Values: "IBM-ULT3580-TD5"
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ActivateGatewayRequest withTapeDriveType(String tapeDriveType) {
setTapeDriveType(tapeDriveType);
return this;
}
/**
*
* The value that indicates the type of medium changer to use for tape gateway. This field is optional.
*
*
* Valid Values: "STK-L700", "AWS-Gateway-VTL"
*
*
* @param mediumChangerType
* The value that indicates the type of medium changer to use for tape gateway. This field is optional.
*
* Valid Values: "STK-L700", "AWS-Gateway-VTL"
*/
public void setMediumChangerType(String mediumChangerType) {
this.mediumChangerType = mediumChangerType;
}
/**
*
* The value that indicates the type of medium changer to use for tape gateway. This field is optional.
*
*
* Valid Values: "STK-L700", "AWS-Gateway-VTL"
*
*
* @return The value that indicates the type of medium changer to use for tape gateway. This field is optional.
*
* Valid Values: "STK-L700", "AWS-Gateway-VTL"
*/
public String getMediumChangerType() {
return this.mediumChangerType;
}
/**
*
* The value that indicates the type of medium changer to use for tape gateway. This field is optional.
*
*
* Valid Values: "STK-L700", "AWS-Gateway-VTL"
*
*
* @param mediumChangerType
* The value that indicates the type of medium changer to use for tape gateway. This field is optional.
*
* Valid Values: "STK-L700", "AWS-Gateway-VTL"
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ActivateGatewayRequest withMediumChangerType(String mediumChangerType) {
setMediumChangerType(mediumChangerType);
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 (getActivationKey() != null)
sb.append("ActivationKey: ").append(getActivationKey()).append(",");
if (getGatewayName() != null)
sb.append("GatewayName: ").append(getGatewayName()).append(",");
if (getGatewayTimezone() != null)
sb.append("GatewayTimezone: ").append(getGatewayTimezone()).append(",");
if (getGatewayRegion() != null)
sb.append("GatewayRegion: ").append(getGatewayRegion()).append(",");
if (getGatewayType() != null)
sb.append("GatewayType: ").append(getGatewayType()).append(",");
if (getTapeDriveType() != null)
sb.append("TapeDriveType: ").append(getTapeDriveType()).append(",");
if (getMediumChangerType() != null)
sb.append("MediumChangerType: ").append(getMediumChangerType());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof ActivateGatewayRequest == false)
return false;
ActivateGatewayRequest other = (ActivateGatewayRequest) obj;
if (other.getActivationKey() == null ^ this.getActivationKey() == null)
return false;
if (other.getActivationKey() != null && other.getActivationKey().equals(this.getActivationKey()) == false)
return false;
if (other.getGatewayName() == null ^ this.getGatewayName() == null)
return false;
if (other.getGatewayName() != null && other.getGatewayName().equals(this.getGatewayName()) == false)
return false;
if (other.getGatewayTimezone() == null ^ this.getGatewayTimezone() == null)
return false;
if (other.getGatewayTimezone() != null && other.getGatewayTimezone().equals(this.getGatewayTimezone()) == false)
return false;
if (other.getGatewayRegion() == null ^ this.getGatewayRegion() == null)
return false;
if (other.getGatewayRegion() != null && other.getGatewayRegion().equals(this.getGatewayRegion()) == false)
return false;
if (other.getGatewayType() == null ^ this.getGatewayType() == null)
return false;
if (other.getGatewayType() != null && other.getGatewayType().equals(this.getGatewayType()) == false)
return false;
if (other.getTapeDriveType() == null ^ this.getTapeDriveType() == null)
return false;
if (other.getTapeDriveType() != null && other.getTapeDriveType().equals(this.getTapeDriveType()) == false)
return false;
if (other.getMediumChangerType() == null ^ this.getMediumChangerType() == null)
return false;
if (other.getMediumChangerType() != null && other.getMediumChangerType().equals(this.getMediumChangerType()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getActivationKey() == null) ? 0 : getActivationKey().hashCode());
hashCode = prime * hashCode + ((getGatewayName() == null) ? 0 : getGatewayName().hashCode());
hashCode = prime * hashCode + ((getGatewayTimezone() == null) ? 0 : getGatewayTimezone().hashCode());
hashCode = prime * hashCode + ((getGatewayRegion() == null) ? 0 : getGatewayRegion().hashCode());
hashCode = prime * hashCode + ((getGatewayType() == null) ? 0 : getGatewayType().hashCode());
hashCode = prime * hashCode + ((getTapeDriveType() == null) ? 0 : getTapeDriveType().hashCode());
hashCode = prime * hashCode + ((getMediumChangerType() == null) ? 0 : getMediumChangerType().hashCode());
return hashCode;
}
@Override
public ActivateGatewayRequest clone() {
return (ActivateGatewayRequest) super.clone();
}
}