Class ActivateGatewayRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<ActivateGatewayRequest.Builder,
ActivateGatewayRequest>
A JSON object containing one or more of the following fields:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
Your gateway activation key.builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
The name you configured for your gateway.final String
A value that indicates the Amazon Web Services Region where you want to store your data.final String
A value that indicates the time zone you want to set for the gateway.final String
A value that defines the type of gateway to activate.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final String
The value that indicates the type of medium changer to use for tape gateway.static Class
<? extends ActivateGatewayRequest.Builder> tags()
A list of up to 50 tags that you can assign to the gateway.final String
The value that indicates the type of tape drive to use for tape gateway.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 theActivateGateway
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 theActivateGateway
API call determine the actual configuration of your gateway.For more information, see Getting activation key in the Storage Gateway User Guide.
-
gatewayName
The name you configured for your gateway.
- Returns:
- The name you configured for your gateway.
-
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
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
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
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
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 theisEmpty()
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
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
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<ActivateGatewayRequest.Builder,
ActivateGatewayRequest> - Specified by:
toBuilder
in classStorageGatewayRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-