Class Gateway

java.lang.Object
software.amazon.awssdk.services.backupgateway.model.Gateway
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Gateway.Builder,Gateway>
@Generated("software.amazon.awssdk:codegen") public final class Gateway extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Gateway.Builder,Gateway>

A gateway is an Backup Gateway appliance that runs on the customer's network to provide seamless connectivity to backup storage in the Amazon Web Services Cloud.

See Also:

  • Method Details

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

    • gatewayDisplayName

      public final String gatewayDisplayName()

      The display name of the gateway.

      Returns:
      The display name of the gateway.

    • gatewayType

      public final GatewayType gatewayType()

      The type of the gateway.

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

      Returns:
      The type of the gateway.
      See Also:

    • gatewayTypeAsString

      public final String gatewayTypeAsString()

      The type of the gateway.

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

      Returns:
      The type of the gateway.
      See Also:

    • hypervisorId

      public final String hypervisorId()

      The hypervisor ID of the gateway.

      Returns:
      The hypervisor ID of the gateway.

    • lastSeenTime

      public final Instant lastSeenTime()

      The last time Backup gateway communicated with the gateway, in Unix format and UTC time.

      Returns:
      The last time Backup gateway communicated with the gateway, in Unix format and UTC time.

    • toBuilder

      public Gateway.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<Gateway.Builder,Gateway>
      Returns:
      a builder for type T

    • builder

      public static Gateway.Builder builder()

    • serializableBuilderClass

      public static Class<? extends Gateway.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.