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

Class GatewayInfo

java.lang.Object

software.amazon.awssdk.services.storagegateway.model.GatewayInfo

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<GatewayInfo.Builder,GatewayInfo>

@Generated("software.amazon.awssdk:codegen")
public final class GatewayInfo
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<GatewayInfo.Builder,GatewayInfo>

Describes a gateway object.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GatewayInfo.Builder

Method Summary

Modifier and Type	Method	Description
static GatewayInfo.Builder	builder()
String	deprecationDate()	Date after which this gateway will not receive software updates for new features and bug fixes.
String	ec2InstanceId()	The ID of the Amazon EC2 instance that was used to launch the gateway.
String	ec2InstanceRegion()	The Amazon Web Services Region where the Amazon EC2 instance is located.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	gatewayARN()	The Amazon Resource Name (ARN) of the gateway.
String	gatewayId()	The unique identifier assigned to your gateway during activation.
String	gatewayName()	The name of the gateway.
String	gatewayOperationalState()	The state of the gateway.
String	gatewayType()	The type of the gateway.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
HostEnvironment	hostEnvironment()	The type of hardware or software platform on which the gateway is running.
String	hostEnvironmentAsString()	The type of hardware or software platform on which the gateway is running.
String	hostEnvironmentId()	A unique identifier for the specific instance of the host platform running the gateway.
List<SdkField<?>>	sdkFields()
static Class<? extends GatewayInfo.Builder>	serializableBuilderClass()
String	softwareVersion()	The version number of the software running on the gateway appliance.
GatewayInfo.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

gatewayId

public final String gatewayId()

The unique identifier assigned to your gateway during activation. This ID becomes part of the gateway Amazon Resource Name (ARN), which you use as input for other operations.

Returns:

The unique identifier assigned to your gateway during activation. This ID becomes part of the gateway Amazon Resource Name (ARN), which you use as input for other operations.

gatewayARN

public final String gatewayARN()

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

Returns:

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

gatewayType

public final String gatewayType()

The type of the gateway.

Returns:

The type of the gateway.

gatewayOperationalState

public final String gatewayOperationalState()

The state of the gateway.

Valid Values: DISABLED | ACTIVE

Returns:

The state of the gateway.

Valid Values: DISABLED | ACTIVE

gatewayName

public final String gatewayName()

The name of the gateway.

Returns:

The name of the gateway.

ec2InstanceId

public final String ec2InstanceId()

The ID of the Amazon EC2 instance that was used to launch the gateway.

Returns:

The ID of the Amazon EC2 instance that was used to launch the gateway.

ec2InstanceRegion

public final String ec2InstanceRegion()

The Amazon Web Services Region where the Amazon EC2 instance is located.

Returns:

The Amazon Web Services Region where the Amazon EC2 instance is located.

hostEnvironment

public final HostEnvironment hostEnvironment()

The type of hardware or software platform on which the gateway is running.

Tape Gateway is no longer available on Snow Family devices.

If the service returns an enum value that is not available in the current SDK version, hostEnvironment will return HostEnvironment.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from hostEnvironmentAsString().

Returns:

The type of hardware or software platform on which the gateway is running.

Tape Gateway is no longer available on Snow Family devices.

See Also:

HostEnvironment

hostEnvironmentAsString

public final String hostEnvironmentAsString()

The type of hardware or software platform on which the gateway is running.

Tape Gateway is no longer available on Snow Family devices.

If the service returns an enum value that is not available in the current SDK version, hostEnvironment will return HostEnvironment.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from hostEnvironmentAsString().

Returns:

The type of hardware or software platform on which the gateway is running.

Tape Gateway is no longer available on Snow Family devices.

See Also:

HostEnvironment

hostEnvironmentId

public final String hostEnvironmentId()

A unique identifier for the specific instance of the host platform running the gateway. This value is only available for certain host environments, and its format depends on the host environment type.

Returns:

A unique identifier for the specific instance of the host platform running the gateway. This value is only available for certain host environments, and its format depends on the host environment type.

deprecationDate

public final String deprecationDate()

Date after which this gateway will not receive software updates for new features and bug fixes.

Returns:

Date after which this gateway will not receive software updates for new features and bug fixes.

softwareVersion

public final String softwareVersion()

The version number of the software running on the gateway appliance.

Returns:

The version number of the software running on the gateway appliance.

toBuilder

public GatewayInfo.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GatewayInfo.Builder,GatewayInfo>

builder

public static GatewayInfo.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo