com.amazonaws.services.storagegateway.model

## クラス ActivateGatewayRequest

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

- すべての実装されたインタフェース:
    java.io.Serializable

      public class ActivateGatewayRequest
      extends AmazonWebServiceRequest
      implements java.io.Serializable

  Container for the parameters to the `ActivateGateway operation`.

  This operation activates the gateway you previously deployed on your VMware host. For more information, see Downloading and Deploying AWS Storage Gateway VM . 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 (see UpdateGatewayInformation).

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

  関連項目:
    `AWSStorageGateway.activateGateway(ActivateGatewayRequest)`, 直列化された形式

- - ### コンストラクタの概要

    コンストラクタ
    コンストラクタと説明
    `ActivateGatewayRequest()`

  - ### メソッドの概要

    メソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `boolean` | `equals(java.lang.Object obj)`
    `java.lang.String` | `getActivationKey()` Your gateway activation key.
    `java.lang.String` | `getGatewayName()` A unique identifier for your gateway.
    `java.lang.String` | `getGatewayRegion()` One of the values that indicates the region where you want to store the snapshot backups.
    `java.lang.String` | `getGatewayTimezone()` One of the values that indicates the time zone you want to set for the gateway.
    `java.lang.String` | `getGatewayType()` One of the values that defines the type of gateway to activate.
    `int` | `hashCode()`
    `void` | `setActivationKey(java.lang.String activationKey)` Your gateway activation key.
    `void` | `setGatewayName(java.lang.String gatewayName)` A unique identifier for your gateway.
    `void` | `setGatewayRegion(java.lang.String gatewayRegion)` One of the values that indicates the region where you want to store the snapshot backups.
    `void` | `setGatewayTimezone(GatewayTimezone gatewayTimezone)` One of the values that indicates the time zone you want to set for the gateway.
    `void` | `setGatewayTimezone(java.lang.String gatewayTimezone)` One of the values that indicates the time zone you want to set for the gateway.
    `void` | `setGatewayType(GatewayType gatewayType)` One of the values that defines the type of gateway to activate.
    `void` | `setGatewayType(java.lang.String gatewayType)` One of the values that defines the type of gateway to activate.
    `java.lang.String` | `toString()` Returns a string representation of this object; useful for testing and debugging.
    `ActivateGatewayRequest` | `withActivationKey(java.lang.String activationKey)` Your gateway activation key.
    `ActivateGatewayRequest` | `withGatewayName(java.lang.String gatewayName)` A unique identifier for your gateway.
    `ActivateGatewayRequest` | `withGatewayRegion(java.lang.String gatewayRegion)` One of the values that indicates the region where you want to store the snapshot backups.
    `ActivateGatewayRequest` | `withGatewayTimezone(GatewayTimezone gatewayTimezone)` One of the values that indicates the time zone you want to set for the gateway.
    `ActivateGatewayRequest` | `withGatewayTimezone(java.lang.String gatewayTimezone)` One of the values that indicates the time zone you want to set for the gateway.
    `ActivateGatewayRequest` | `withGatewayType(GatewayType gatewayType)` One of the values that defines the type of gateway to activate.
    `ActivateGatewayRequest` | `withGatewayType(java.lang.String gatewayType)` One of the values that defines the type of gateway to activate.

    - ### クラスから継承されたメソッド com.amazonaws.AmazonWebServiceRequest

      `copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentials`

    - ### クラスから継承されたメソッド java.lang.Object

      `clone, finalize, getClass, notify, notifyAll, wait, wait, wait`

- - ### コンストラクタの詳細

    - #### ActivateGatewayRequest

          public ActivateGatewayRequest()

  - ### メソッドの詳細

    - #### getActivationKey

          public java.lang.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.

      Constraints:
      Length: 1 - 50

      戻り値:
        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.

    - #### setActivationKey

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

      Constraints:
      Length: 1 - 50

      パラメータ:
        `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.

    - #### withActivationKey

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

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

      Constraints:
      Length: 1 - 50

      パラメータ:
        `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.

    - #### getGatewayName

          public java.lang.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.

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

      戻り値:
        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.

    - #### setGatewayName

          public void setGatewayName(java.lang.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.

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

      パラメータ:
        `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.

    - #### withGatewayName

          public ActivateGatewayRequest withGatewayName(java.lang.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.

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

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

      パラメータ:
        `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.

    - #### getGatewayTimezone

          public java.lang.String getGatewayTimezone()

      One of the values 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.

      Constraints:
      Allowed Values: GMT-12:00, GMT-11:00, GMT-10:00, GMT-9:00, GMT-8:00, GMT-7:00, GMT-6:00, GMT-5:00, GMT-4:00, GMT-3:30, GMT-3:00, GMT-2:00, GMT-1:00, GMT, GMT+1:00, GMT+2:00, GMT+3:00, GMT+3:30, GMT+4:00, GMT+4:30, GMT+5:00, GMT+5:30, GMT+5:45, GMT+6:00, GMT+7:00, GMT+8:00, GMT+9:00, GMT+9:30, GMT+10:00, GMT+11:00, GMT+12:00

      戻り値:
        One of the values 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.
      関連項目:
        `GatewayTimezone`

    - #### setGatewayTimezone

          public void setGatewayTimezone(java.lang.String gatewayTimezone)

      One of the values 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.

      Constraints:
      Allowed Values: GMT-12:00, GMT-11:00, GMT-10:00, GMT-9:00, GMT-8:00, GMT-7:00, GMT-6:00, GMT-5:00, GMT-4:00, GMT-3:30, GMT-3:00, GMT-2:00, GMT-1:00, GMT, GMT+1:00, GMT+2:00, GMT+3:00, GMT+3:30, GMT+4:00, GMT+4:30, GMT+5:00, GMT+5:30, GMT+5:45, GMT+6:00, GMT+7:00, GMT+8:00, GMT+9:00, GMT+9:30, GMT+10:00, GMT+11:00, GMT+12:00

      パラメータ:
        `gatewayTimezone` - One of the values 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.
      関連項目:
        `GatewayTimezone`

    - #### withGatewayTimezone

          public ActivateGatewayRequest withGatewayTimezone(java.lang.String gatewayTimezone)

      One of the values 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 reference to this object so that method calls can be chained together.

      Constraints:
      Allowed Values: GMT-12:00, GMT-11:00, GMT-10:00, GMT-9:00, GMT-8:00, GMT-7:00, GMT-6:00, GMT-5:00, GMT-4:00, GMT-3:30, GMT-3:00, GMT-2:00, GMT-1:00, GMT, GMT+1:00, GMT+2:00, GMT+3:00, GMT+3:30, GMT+4:00, GMT+4:30, GMT+5:00, GMT+5:30, GMT+5:45, GMT+6:00, GMT+7:00, GMT+8:00, GMT+9:00, GMT+9:30, GMT+10:00, GMT+11:00, GMT+12:00

      パラメータ:
        `gatewayTimezone` - One of the values 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.
      関連項目:
        `GatewayTimezone`

    - #### setGatewayTimezone

          public void setGatewayTimezone(GatewayTimezone gatewayTimezone)

      One of the values 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.

      Constraints:
      Allowed Values: GMT-12:00, GMT-11:00, GMT-10:00, GMT-9:00, GMT-8:00, GMT-7:00, GMT-6:00, GMT-5:00, GMT-4:00, GMT-3:30, GMT-3:00, GMT-2:00, GMT-1:00, GMT, GMT+1:00, GMT+2:00, GMT+3:00, GMT+3:30, GMT+4:00, GMT+4:30, GMT+5:00, GMT+5:30, GMT+5:45, GMT+6:00, GMT+7:00, GMT+8:00, GMT+9:00, GMT+9:30, GMT+10:00, GMT+11:00, GMT+12:00

      パラメータ:
        `gatewayTimezone` - One of the values 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.
      関連項目:
        `GatewayTimezone`

    - #### withGatewayTimezone

          public ActivateGatewayRequest withGatewayTimezone(GatewayTimezone gatewayTimezone)

      One of the values 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 reference to this object so that method calls can be chained together.

      Constraints:
      Allowed Values: GMT-12:00, GMT-11:00, GMT-10:00, GMT-9:00, GMT-8:00, GMT-7:00, GMT-6:00, GMT-5:00, GMT-4:00, GMT-3:30, GMT-3:00, GMT-2:00, GMT-1:00, GMT, GMT+1:00, GMT+2:00, GMT+3:00, GMT+3:30, GMT+4:00, GMT+4:30, GMT+5:00, GMT+5:30, GMT+5:45, GMT+6:00, GMT+7:00, GMT+8:00, GMT+9:00, GMT+9:30, GMT+10:00, GMT+11:00, GMT+12:00

      パラメータ:
        `gatewayTimezone` - One of the values 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.
      関連項目:
        `GatewayTimezone`

    - #### getGatewayRegion

          public java.lang.String getGatewayRegion()

      One of the values 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", "ap-northeast-1", "ap-southest-1", "sa-east-1"

      Constraints:
      Length: 1 - 25

      戻り値:
        One of the values 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", "ap-northeast-1", "ap-southest-1", "sa-east-1"

    - #### setGatewayRegion

          public void setGatewayRegion(java.lang.String gatewayRegion)

      One of the values 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", "ap-northeast-1", "ap-southest-1", "sa-east-1"

      Constraints:
      Length: 1 - 25

      パラメータ:
        `gatewayRegion` - One of the values 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", "ap-northeast-1", "ap-southest-1", "sa-east-1"

    - #### withGatewayRegion

          public ActivateGatewayRequest withGatewayRegion(java.lang.String gatewayRegion)

      One of the values 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", "ap-northeast-1", "ap-southest-1", "sa-east-1"

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

      Constraints:
      Length: 1 - 25

      パラメータ:
        `gatewayRegion` - One of the values 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", "ap-northeast-1", "ap-southest-1", "sa-east-1"

    - #### getGatewayType

          public java.lang.String getGatewayType()

      One of the values 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`.

      Constraints:
      Allowed Values: STORED, CACHED

      戻り値:
        One of the values 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`.
      関連項目:
        `GatewayType`

    - #### setGatewayType

          public void setGatewayType(java.lang.String gatewayType)

      One of the values 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`.

      Constraints:
      Allowed Values: STORED, CACHED

      パラメータ:
        `gatewayType` - One of the values 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`.
      関連項目:
        `GatewayType`

    - #### withGatewayType

          public ActivateGatewayRequest withGatewayType(java.lang.String gatewayType)

      One of the values 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 reference to this object so that method calls can be chained together.

      Constraints:
      Allowed Values: STORED, CACHED

      パラメータ:
        `gatewayType` - One of the values 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`.
      関連項目:
        `GatewayType`

    - #### setGatewayType

          public void setGatewayType(GatewayType gatewayType)

      One of the values 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`.

      Constraints:
      Allowed Values: STORED, CACHED

      パラメータ:
        `gatewayType` - One of the values 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`.
      関連項目:
        `GatewayType`

    - #### withGatewayType

          public ActivateGatewayRequest withGatewayType(GatewayType gatewayType)

      One of the values 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 reference to this object so that method calls can be chained together.

      Constraints:
      Allowed Values: STORED, CACHED

      パラメータ:
        `gatewayType` - One of the values 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`.
      関連項目:
        `GatewayType`

    - #### toString

          public java.lang.String toString()

      Returns a string representation of this object; useful for testing and debugging.
      オーバーライド:
        `toString` クラス内 `java.lang.Object`
      戻り値:
        A string representation of this object.
      関連項目:
        `Object.toString()`

    - #### hashCode

          public int hashCode()

      オーバーライド:
        `hashCode` クラス内 `java.lang.Object`

    - #### equals

          public boolean equals(java.lang.Object obj)

      オーバーライド:
        `equals` クラス内 `java.lang.Object`