Class GatewayCapabilitySummary

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

Contains a summary of a gateway capability configuration.

See Also:

  • Method Details

    • capabilityNamespace

      public final String capabilityNamespace()

      The namespace of the capability configuration. For example, if you configure OPC-UA sources from the IoT SiteWise console, your OPC-UA capability configuration has the namespace iotsitewise:opcuacollector:version, where version is a number such as 1.

      Returns:
      The namespace of the capability configuration. For example, if you configure OPC-UA sources from the IoT SiteWise console, your OPC-UA capability configuration has the namespace iotsitewise:opcuacollector:version, where version is a number such as 1.

    • capabilitySyncStatus

      public final CapabilitySyncStatus capabilitySyncStatus()

      The synchronization status of the capability configuration. The sync status can be one of the following:

      • IN_SYNC – The gateway is running the capability configuration.

      • NOT_APPLICABLE – Synchronization is not required for this capability configuration. This is most common when integrating partner data sources, because the data integration is handled externally by the partner.

      • OUT_OF_SYNC – The gateway hasn't received the capability configuration.

      • SYNC_FAILED – The gateway rejected the capability configuration.

      • UNKNOWN – The synchronization status is currently unknown due to an undetermined or temporary error.

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

      Returns:
      The synchronization status of the capability configuration. The sync status can be one of the following:

      • IN_SYNC – The gateway is running the capability configuration.

      • NOT_APPLICABLE – Synchronization is not required for this capability configuration. This is most common when integrating partner data sources, because the data integration is handled externally by the partner.

      • OUT_OF_SYNC – The gateway hasn't received the capability configuration.

      • SYNC_FAILED – The gateway rejected the capability configuration.

      • UNKNOWN – The synchronization status is currently unknown due to an undetermined or temporary error.

      See Also:

    • capabilitySyncStatusAsString

      public final String capabilitySyncStatusAsString()

      The synchronization status of the capability configuration. The sync status can be one of the following:

      • IN_SYNC – The gateway is running the capability configuration.

      • NOT_APPLICABLE – Synchronization is not required for this capability configuration. This is most common when integrating partner data sources, because the data integration is handled externally by the partner.

      • OUT_OF_SYNC – The gateway hasn't received the capability configuration.

      • SYNC_FAILED – The gateway rejected the capability configuration.

      • UNKNOWN – The synchronization status is currently unknown due to an undetermined or temporary error.

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

      Returns:
      The synchronization status of the capability configuration. The sync status can be one of the following:

      • IN_SYNC – The gateway is running the capability configuration.

      • NOT_APPLICABLE – Synchronization is not required for this capability configuration. This is most common when integrating partner data sources, because the data integration is handled externally by the partner.

      • OUT_OF_SYNC – The gateway hasn't received the capability configuration.

      • SYNC_FAILED – The gateway rejected the capability configuration.

      • UNKNOWN – The synchronization status is currently unknown due to an undetermined or temporary error.

      See Also:

    • toBuilder

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

    • builder

      public static GatewayCapabilitySummary.Builder builder()

    • serializableBuilderClass

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