ActivateGatewayRequest (AWS SDK for Java

Overview

Package

Class

Index

Help

Did this page help you?
Yes No Tell us about it...

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.amazonaws.services.storagegateway.model
Class ActivateGatewayRequest

java.lang.Object
  com.amazonaws.AmazonWebServiceRequest
      com.amazonaws.services.storagegateway.model.ActivateGatewayRequest

public class ActivateGatewayRequest
extends AmazonWebServiceRequest
extends AmazonWebServiceRequest

Container for the parameters to the ActivateGateway operation.

This operation activates the gateway you previously deployed on your VMware host. For more information, see DownloadAndDeploy. In the activation process you specify information such as the region you want to use for storing snapshots, the time zone for scheduled snapshots and the gateway schedule window, an activation key, and a name for your gateway. The activation process also associates your gateway with your account.

NOTE:You must power on the gateway VM before you can activate your gateway.

See Also:: AWSStorageGateway.activateGateway(ActivateGatewayRequest)

Constructor Summary
`ActivateGatewayRequest()`

Method Summary
`boolean`	`equals(Object obj)`
`String`	`getActivationKey()` Your gateway activation key.
`String`	`getGatewayName()` A unique identifier for your gateway.
`String`	`getGatewayRegion()` A value that indicates the region your gateway is activated in, and where your snapshots are stored.
`String`	`getGatewayTimezone()` One of the GatewayTimezone values that indicates the time zone you want to set for the gateway.
`int`	`hashCode()`
`void`	`setActivationKey(String activationKey)` Your gateway activation key.
`void`	`setGatewayName(String gatewayName)` A unique identifier for your gateway.
`void`	`setGatewayRegion(String gatewayRegion)` A value that indicates the region your gateway is activated in, and where your snapshots are stored.
`void`	`setGatewayTimezone(GatewayTimezone gatewayTimezone)` One of the GatewayTimezone values that indicates the time zone you want to set for the gateway.
`void`	`setGatewayTimezone(String gatewayTimezone)` One of the GatewayTimezone values that indicates the time zone you want to set for the gateway.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`ActivateGatewayRequest`	`withActivationKey(String activationKey)` Your gateway activation key.
`ActivateGatewayRequest`	`withGatewayName(String gatewayName)` A unique identifier for your gateway.
`ActivateGatewayRequest`	`withGatewayRegion(String gatewayRegion)` A value that indicates the region your gateway is activated in, and where your snapshots are stored.
`ActivateGatewayRequest`	`withGatewayTimezone(GatewayTimezone gatewayTimezone)` One of the GatewayTimezone values that indicates the time zone you want to set for the gateway.
`ActivateGatewayRequest`	`withGatewayTimezone(String gatewayTimezone)` One of the GatewayTimezone values that indicates the time zone you want to set for the gateway.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
`copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentials`

Methods inherited from class java.lang.Object
`getClass, notify, notifyAll, wait, wait, wait`

Constructor Detail

ActivateGatewayRequest

public ActivateGatewayRequest()

Method Detail

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. The redirect URL returned in the response provides you the activation key for your gateway in the query string parameter activationKey.

Length: Minimum length of 1. Maximum length of 50.

Constraints:
Length: 1 - 50

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. The redirect URL returned in the response provides you the activation key for your gateway in the query string parameter activationKey.
Length: Minimum length of 1. Maximum length of 50.

setActivationKey

public void setActivationKey(String activationKey)

Length: Minimum length of 1. Maximum length of 50.

Constraints:
Length: 1 - 50

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. The redirect URL returned in the response provides you the activation key for your gateway in the query string parameter activationKey.
Length: Minimum length of 1. Maximum length of 50.

withActivationKey

public ActivateGatewayRequest withActivationKey(String activationKey)

Length: Minimum length of 1. Maximum length of 50.

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

Constraints:
Length: 1 - 50

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. The redirect URL returned in the response provides you the activation key for your gateway in the query string parameter activationKey.
Length: Minimum length of 1. Maximum length of 50.
Returns:: A reference to this updated object so that method calls can be chained together.

getGatewayName

public String getGatewayName()

A unique identifier for your gateway. This name becomes part of the gateway Amazon Resources Name (ARN) which is what you use as an input to other operations.

Length: Minimum length of 2. Maximum length of 255.

Constraints:
Length: 2 - 255
Pattern: ^[ -\.0-\[\]-~]*[!-\.0-\[\]-~][ -\.0-\[\]-~]*$

Returns:: A unique identifier for your gateway. This name becomes part of the gateway Amazon Resources Name (ARN) which is what you use as an input to other operations.
Length: Minimum length of 2. Maximum length of 255.

setGatewayName

public void setGatewayName(String gatewayName)

A unique identifier for your gateway. This name becomes part of the gateway Amazon Resources Name (ARN) which is what you use as an input to other operations.

Length: Minimum length of 2. Maximum length of 255.

Constraints:
Length: 2 - 255
Pattern: ^[ -\.0-\[\]-~]*[!-\.0-\[\]-~][ -\.0-\[\]-~]*$

Parameters:: gatewayName - A unique identifier for your gateway. This name becomes part of the gateway Amazon Resources Name (ARN) which is what you use as an input to other operations.
Length: Minimum length of 2. Maximum length of 255.

withGatewayName

public ActivateGatewayRequest withGatewayName(String gatewayName)

A unique identifier for your gateway. This name becomes part of the gateway Amazon Resources Name (ARN) which is what you use as an input to other operations.

Length: Minimum length of 2. Maximum length of 255.

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

Constraints:
Length: 2 - 255
Pattern: ^[ -\.0-\[\]-~]*[!-\.0-\[\]-~][ -\.0-\[\]-~]*$

Parameters:: gatewayName - A unique identifier for your gateway. This name becomes part of the gateway Amazon Resources Name (ARN) which is what you use as an input to other operations.
Length: Minimum length of 2. Maximum length of 255.
Returns:: A reference to this updated object so that method calls can be chained together.