Package software.amazon.awssdk.services.storagegateway.model

Class ActivateGatewayRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.storagegateway.model.ActivateGatewayRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<ActivateGatewayRequest.Builder,ActivateGatewayRequest>

@Generated("software.amazon.awssdk:codegen")
public class ActivateGatewayRequest
extends AmazonWebServiceRequest
implements ToCopyableBuilder<ActivateGatewayRequest.Builder,ActivateGatewayRequest>

A JSON object containing one or more of the following fields:

• ActivateGatewayInput$ActivationKey

• ActivateGatewayInput$GatewayName

• ActivateGatewayInput$GatewayRegion

• ActivateGatewayInput$GatewayTimezone

• ActivateGatewayInput$GatewayType

• ActivateGatewayInput$TapeDriveType

• ActivateGatewayInput$MediumChangerType

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ActivateGatewayRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
String	activationKey()	Your gateway activation key.
static ActivateGatewayRequest.Builder	builder()
boolean	equals(Object obj)
String	gatewayName()	The name you configured for your gateway.
String	gatewayRegion()	A value that indicates the 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.
int	hashCode()
String	mediumChangerType()	The value that indicates the type of medium changer to use for tape gateway.
static Class<? extends ActivateGatewayRequest.Builder>	serializableBuilderClass()
String	tapeDriveType()	The value that indicates the type of tape drive to use for tape gateway.
ActivateGatewayRequest.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

activationKey

public 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:

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.

gatewayName

public String gatewayName()

The name you configured for your gateway.

Returns:

The name you configured for your gateway.

gatewayTimezone

public 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 String gatewayRegion()

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

Returns:

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

gatewayType

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

Valid Values: "STORED", "CACHED", "VTL", "FILE_S3"

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 .

Valid Values: "STORED", "CACHED", "VTL", "FILE_S3"

tapeDriveType

public 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 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"

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"

toBuilder

public ActivateGatewayRequest.Builder 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 interface ToCopyableBuilder<ActivateGatewayRequest.Builder,ActivateGatewayRequest>

Returns:

a builder for type T

builder

public static ActivateGatewayRequest.Builder builder()

serializableBuilderClass

public static Class<? extends ActivateGatewayRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object