Class ActivateGatewayRequest

java.lang.Object
com.amazonaws.AmazonWebServiceRequest
com.amazonaws.services.storagegateway.model.ActivateGatewayRequest
All Implemented Interfaces:
ReadLimitInfo, Serializable, Cloneable

public class ActivateGatewayRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
See Also:
  • Constructor Details

    • ActivateGatewayRequest

      public ActivateGatewayRequest()
  • Method Details

    • setActivationKey

      public void setActivationKey(String 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.

      Parameters:
      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.
    • getActivationKey

      public String getActivationKey()

      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.

      Returns:
      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.
    • withActivationKey

      public ActivateGatewayRequest withActivationKey(String 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setGatewayName

      public void setGatewayName(String gatewayName)

      The name you configured for your gateway.

      Parameters:
      gatewayName - The name you configured for your gateway.
    • getGatewayName

      public String getGatewayName()

      The name you configured for your gateway.

      Returns:
      The name you configured for your gateway.
    • withGatewayName

      public ActivateGatewayRequest withGatewayName(String gatewayName)

      The name you configured for your gateway.

      Parameters:
      gatewayName - The name you configured for your gateway.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setGatewayTimezone

      public void setGatewayTimezone(String gatewayTimezone)

      A value that indicates the time zone you want to set for the gateway. The time zone is used, for example, for scheduling snapshots and your gateway's maintenance schedule.

      Parameters:
      gatewayTimezone - A value that indicates the time zone you want to set for the gateway. The time zone is used, for example, for scheduling snapshots and your gateway's maintenance schedule.
    • getGatewayTimezone

      public String getGatewayTimezone()

      A value that indicates the time zone you want to set for the gateway. The time zone is used, for example, for scheduling snapshots and your gateway's maintenance schedule.

      Returns:
      A value that indicates the time zone you want to set for the gateway. The time zone is used, for example, for scheduling snapshots and your gateway's maintenance schedule.
    • withGatewayTimezone

      public ActivateGatewayRequest withGatewayTimezone(String gatewayTimezone)

      A value that indicates the time zone you want to set for the gateway. The time zone is used, for example, for scheduling snapshots and your gateway's maintenance schedule.

      Parameters:
      gatewayTimezone - A value that indicates the time zone you want to set for the gateway. The time zone is used, for example, for scheduling snapshots and your gateway's maintenance schedule.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setGatewayRegion

      public void setGatewayRegion(String gatewayRegion)

      A value that indicates the region where you want to store the snapshot backups. 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-west-1", "us-west-2", "eu-west-1", "eu-central-1", "ap-northeast-1", "ap-northeast-2", "ap-southeast-1", "ap-southeast-2", "sa-east-1"

      Parameters:
      gatewayRegion - A value that indicates the region where you want to store the snapshot backups. 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-west-1", "us-west-2", "eu-west-1", "eu-central-1", "ap-northeast-1", "ap-northeast-2", "ap-southeast-1", "ap-southeast-2", "sa-east-1"

    • getGatewayRegion

      public String getGatewayRegion()

      A value that indicates the region where you want to store the snapshot backups. 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-west-1", "us-west-2", "eu-west-1", "eu-central-1", "ap-northeast-1", "ap-northeast-2", "ap-southeast-1", "ap-southeast-2", "sa-east-1"

      Returns:
      A value that indicates the region where you want to store the snapshot backups. 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-west-1", "us-west-2", "eu-west-1", "eu-central-1", "ap-northeast-1", "ap-northeast-2", "ap-southeast-1", "ap-southeast-2", "sa-east-1"

    • withGatewayRegion

      public ActivateGatewayRequest withGatewayRegion(String gatewayRegion)

      A value that indicates the region where you want to store the snapshot backups. 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-west-1", "us-west-2", "eu-west-1", "eu-central-1", "ap-northeast-1", "ap-northeast-2", "ap-southeast-1", "ap-southeast-2", "sa-east-1"

      Parameters:
      gatewayRegion - A value that indicates the region where you want to store the snapshot backups. 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-west-1", "us-west-2", "eu-west-1", "eu-central-1", "ap-northeast-1", "ap-northeast-2", "ap-southeast-1", "ap-southeast-2", "sa-east-1"

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

      public void setGatewayType(String 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 STORED.

      Parameters:
      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 STORED.
    • getGatewayType

      public String getGatewayType()

      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 STORED.

      Returns:
      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 STORED.
    • withGatewayType

      public ActivateGatewayRequest withGatewayType(String 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 STORED.

      Parameters:
      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 STORED.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setTapeDriveType

      public void setTapeDriveType(String tapeDriveType)

      The value that indicates the type of tape drive to use for gateway-VTL. This field is optional.

      Valid Values: "IBM-ULT3580-TD5"

      Parameters:
      tapeDriveType - The value that indicates the type of tape drive to use for gateway-VTL. This field is optional.

      Valid Values: "IBM-ULT3580-TD5"

    • getTapeDriveType

      public String getTapeDriveType()

      The value that indicates the type of tape drive to use for gateway-VTL. This field is optional.

      Valid Values: "IBM-ULT3580-TD5"

      Returns:
      The value that indicates the type of tape drive to use for gateway-VTL. This field is optional.

      Valid Values: "IBM-ULT3580-TD5"

    • withTapeDriveType

      public ActivateGatewayRequest withTapeDriveType(String tapeDriveType)

      The value that indicates the type of tape drive to use for gateway-VTL. This field is optional.

      Valid Values: "IBM-ULT3580-TD5"

      Parameters:
      tapeDriveType - The value that indicates the type of tape drive to use for gateway-VTL. This field is optional.

      Valid Values: "IBM-ULT3580-TD5"

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

      public void setMediumChangerType(String mediumChangerType)

      The value that indicates the type of medium changer to use for gateway-VTL. This field is optional.

      Valid Values: "STK-L700", "AWS-Gateway-VTL"

      Parameters:
      mediumChangerType - The value that indicates the type of medium changer to use for gateway-VTL. This field is optional.

      Valid Values: "STK-L700", "AWS-Gateway-VTL"

    • getMediumChangerType

      public String getMediumChangerType()

      The value that indicates the type of medium changer to use for gateway-VTL. This field is optional.

      Valid Values: "STK-L700", "AWS-Gateway-VTL"

      Returns:
      The value that indicates the type of medium changer to use for gateway-VTL. This field is optional.

      Valid Values: "STK-L700", "AWS-Gateway-VTL"

    • withMediumChangerType

      public ActivateGatewayRequest withMediumChangerType(String mediumChangerType)

      The value that indicates the type of medium changer to use for gateway-VTL. This field is optional.

      Valid Values: "STK-L700", "AWS-Gateway-VTL"

      Parameters:
      mediumChangerType - The value that indicates the type of medium changer to use for gateway-VTL. This field is optional.

      Valid Values: "STK-L700", "AWS-Gateway-VTL"

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

      public String toString()
      Returns a string representation of this object; useful for testing and debugging.
      Overrides:
      toString in class Object
      Returns:
      A string representation of this object.
      See Also:
    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • clone

      public ActivateGatewayRequest clone()
      Description copied from class: AmazonWebServiceRequest
      Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.
      Overrides:
      clone in class AmazonWebServiceRequest
      See Also: