Package software.amazon.awssdk.services.iotsitewise.model

Class GatewaySummary

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

Contains a summary of a gateway.

See Also:

  • Method Details

    • gatewayId

      public final String gatewayId()

      The ID of the gateway device.

      Returns:
      The ID of the gateway device.

    • gatewayName

      public final String gatewayName()

      The name of the asset.

      Returns:
      The name of the asset.

    • gatewayPlatform

      public final GatewayPlatform gatewayPlatform()
      Returns the value of the GatewayPlatform property for this object.
      Returns:
      The value of the GatewayPlatform property for this object.

    • hasGatewayCapabilitySummaries

      public final boolean hasGatewayCapabilitySummaries()
      For responses, this returns true if the service returned a value for the GatewayCapabilitySummaries property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • gatewayCapabilitySummaries

      public final List<GatewayCapabilitySummary> gatewayCapabilitySummaries()

      A list of gateway capability summaries that each contain a namespace and status. Each gateway capability defines data sources for the gateway. To retrieve a capability configuration's definition, use DescribeGatewayCapabilityConfiguration.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasGatewayCapabilitySummaries() method.

      Returns:
      A list of gateway capability summaries that each contain a namespace and status. Each gateway capability defines data sources for the gateway. To retrieve a capability configuration's definition, use DescribeGatewayCapabilityConfiguration.

    • creationDate

      public final Instant creationDate()

      The date the gateway was created, in Unix epoch time.

      Returns:
      The date the gateway was created, in Unix epoch time.

    • lastUpdateDate

      public final Instant lastUpdateDate()

      The date the gateway was last updated, in Unix epoch time.

      Returns:
      The date the gateway was last updated, in Unix epoch time.

    • toBuilder

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

    • builder

      public static GatewaySummary.Builder builder()

    • serializableBuilderClass

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