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:
  • Method Details

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

      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.
      See Also:
    • hostEnvironmentAsString

      public final String 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 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.
      See Also:
    • 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()
      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<GatewayInfo.Builder,GatewayInfo>
      Returns:
      a builder for type T
    • 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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.
    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.