Class DescribeGatewayCapabilityConfigurationResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.iotsitewise.model.IoTSiteWiseResponse
software.amazon.awssdk.services.iotsitewise.model.DescribeGatewayCapabilityConfigurationResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeGatewayCapabilityConfigurationResponse.Builder,DescribeGatewayCapabilityConfigurationResponse>
@Generated("software.amazon.awssdk:codegen") public final class DescribeGatewayCapabilityConfigurationResponse extends IoTSiteWiseResponse implements ToCopyableBuilder<DescribeGatewayCapabilityConfigurationResponse.Builder,DescribeGatewayCapabilityConfigurationResponse>

  • Method Details

    • gatewayId

      public final String gatewayId()

      The ID of the gateway that defines the capability configuration.

      Returns:
      The ID of the gateway that defines the capability configuration.

    • capabilityNamespace

      public final String capabilityNamespace()

      The namespace of the gateway capability.

      Returns:
      The namespace of the gateway capability.

    • capabilityConfiguration

      public final String capabilityConfiguration()

      The JSON document that defines the gateway capability's configuration. For more information, see Configuring data sources (CLI) in the IoT SiteWise User Guide.

      Returns:
      The JSON document that defines the gateway capability's configuration. For more information, see Configuring data sources (CLI) in the IoT SiteWise User Guide.

    • 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 DescribeGatewayCapabilityConfigurationResponse.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<DescribeGatewayCapabilityConfigurationResponse.Builder,DescribeGatewayCapabilityConfigurationResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static DescribeGatewayCapabilityConfigurationResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DescribeGatewayCapabilityConfigurationResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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