Class GatewayInfo
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<GatewayInfo.Builder,
GatewayInfo>
Describes a gateway object.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic GatewayInfo.Builder
builder()
final String
Date after which this gateway will not receive software updates for new features and bug fixes.final String
The ID of the Amazon EC2 instance that was used to launch the gateway.final String
The Amazon Web Services Region where the Amazon EC2 instance is located.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
The Amazon Resource Name (ARN) of the gateway.final String
The unique identifier assigned to your gateway during activation.final String
The name of the gateway.final String
The state of the gateway.final String
The type of the gateway.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final HostEnvironment
The type of hardware or software platform on which the gateway is running.final String
The type of hardware or software platform on which the gateway is running.final String
A unique identifier for the specific instance of the host platform running the gateway.static Class
<? extends GatewayInfo.Builder> final String
The version number of the software running on the gateway appliance.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 interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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
The type of the gateway.
- Returns:
- The type of the gateway.
-
gatewayOperationalState
The state of the gateway.
Valid Values:
DISABLED
|ACTIVE
- Returns:
- The state of the gateway.
Valid Values:
DISABLED
|ACTIVE
-
gatewayName
The name of the gateway.
- Returns:
- The name of the gateway.
-
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
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
The type of hardware or software platform on which the gateway is running.
If the service returns an enum value that is not available in the current SDK version,
hostEnvironment
will returnHostEnvironment.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromhostEnvironmentAsString()
.- Returns:
- The type of hardware or software platform on which the gateway is running.
- See Also:
-
hostEnvironmentAsString
The type of hardware or software platform on which the gateway is running.
If the service returns an enum value that is not available in the current SDK version,
hostEnvironment
will returnHostEnvironment.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromhostEnvironmentAsString()
.- Returns:
- The type of hardware or software platform on which the gateway is running.
- See Also:
-
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
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
The version number of the software running on the gateway appliance.
- Returns:
- The version number of the software running on the gateway appliance.
-
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<GatewayInfo.Builder,
GatewayInfo> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
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
-
sdkFields
-