ActivateGatewayRequest (AWS Java SDK :: Services :: AWS Storage Gateway 2.20.56 API)

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.storagegateway.model.StorageGatewayRequest
    - - software.amazon.awssdk.services.storagegateway.model.ActivateGatewayRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ActivateGatewayRequest.Builder,ActivateGatewayRequest>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class ActivateGatewayRequest
extends StorageGatewayRequest
implements ToCopyableBuilder<ActivateGatewayRequest.Builder,ActivateGatewayRequest>
```
A JSON object containing one or more of the following fields:

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ActivateGatewayRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ActivateGatewayRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`activationKey()` Your gateway activation key.
`static ActivateGatewayRequest.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`gatewayName()` The name you configured for your gateway.
`String`	`gatewayRegion()` A value that indicates the Amazon Web Services Region where you want to store your data.
`String`	`gatewayTimezone()` A value that indicates the time zone you want to set for the gateway.
`String`	`gatewayType()` A value that defines the type of gateway to activate.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasTags()` For responses, this returns true if the service returned a value for the Tags property.
`String`	`mediumChangerType()` The value that indicates the type of medium changer to use for tape gateway.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ActivateGatewayRequest.Builder>`	`serializableBuilderClass()`
`List<Tag>`	`tags()` A list of up to 50 tags that you can assign to the gateway.
`String`	`tapeDriveType()` The value that indicates the type of tape drive to use for tape gateway.
`ActivateGatewayRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - activationKey
```
public final 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.
    
    For more information, see Getting activation key in the Storage Gateway User Guide.
    
    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.
    
    For more information, see Getting activation key in the Storage Gateway User Guide.
  - gatewayName
```
public final String gatewayName()
```
    The name you configured for your gateway.
    
    Returns:
    
    The name you configured for your gateway.
  - gatewayTimezone
```
public final String 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.
    
    Returns:
    
    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.
  - gatewayRegion
```
public final String gatewayRegion()
```
    A value that indicates the Amazon Web Services Region where you want to store your data. The gateway Amazon Web Services Region specified must be the same Amazon Web Services Region as the Amazon Web Services Region in your Host header in the request. For more information about available Amazon Web Services Regions and endpoints for Storage Gateway, see Storage Gateway endpoints and quotas in the Amazon Web Services General Reference.
    
    Valid Values: See Storage Gateway endpoints and quotas in the Amazon Web Services General Reference.
    
    Returns:
    
    A value that indicates the Amazon Web Services Region where you want to store your data. The gateway Amazon Web Services Region specified must be the same Amazon Web Services Region as the Amazon Web Services Region in your Host header in the request. For more information about available Amazon Web Services Regions and endpoints for Storage Gateway, see Storage Gateway endpoints and quotas in the Amazon Web Services General Reference.
    
    Valid Values: See Storage Gateway endpoints and quotas in the Amazon Web Services General Reference.
  - gatewayType
```
public final 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 CACHED.
    
    Valid Values: STORED | CACHED | VTL | VTL_SNOW | FILE_S3 | FILE_FSX_SMB
    
    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 CACHED .
    
    Valid Values: STORED | CACHED | VTL | VTL_SNOW | FILE_S3 | FILE_FSX_SMB
  - tapeDriveType
```
public final String tapeDriveType()
```
    The value that indicates the type of tape drive to use for tape gateway. This field is optional.
    
    Valid Values: IBM-ULT3580-TD5
    
    Returns:
    
    The value that indicates the type of tape drive to use for tape gateway. This field is optional.
    
    Valid Values: IBM-ULT3580-TD5
  - mediumChangerType
```
public final String 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 | IBM-03584L32-0402
    
    Returns:
    
    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 | IBM-03584L32-0402
  - hasTags
```
public final boolean hasTags()
```
    For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - tags
```
public final List<Tag> tags()
```
    A list of up to 50 tags that you can assign to the gateway. Each tag is a key-value pair.
    
    Valid characters for key and value are letters, spaces, and numbers that can be represented in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256 characters.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.
    
    Returns:
    
    A list of up to 50 tags that you can assign to the gateway. Each tag is a key-value pair.
    
    Valid characters for key and value are letters, spaces, and numbers that can be represented in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256 characters.
  - toBuilder
```
public ActivateGatewayRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ActivateGatewayRequest.Builder,ActivateGatewayRequest>
    
    Specified by:
    
    toBuilder in class StorageGatewayRequest
  - builder
```
public static ActivateGatewayRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ActivateGatewayRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class ActivateGatewayRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

activationKey

gatewayName

gatewayTimezone

gatewayRegion

gatewayType

tapeDriveType

mediumChangerType

hasTags

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields