Class ComponentSummary

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

An object that returns information about a component summary.

See Also:

  • Method Details

    • componentName

      public final String componentName()

      The name of the component.

      Returns:
      The name of the component.

    • componentTypeId

      public final String componentTypeId()

      The ID of the component type.

      Returns:
      The ID of the component type.

    • definedIn

      public final String definedIn()

      The name of the property definition set in the request.

      Returns:
      The name of the property definition set in the request.

    • description

      public final String description()

      The description of the component request.

      Returns:
      The description of the component request.

    • hasPropertyGroups

      public final boolean hasPropertyGroups()
      For responses, this returns true if the service returned a value for the PropertyGroups 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.

    • propertyGroups

      public final Map<String,ComponentPropertyGroupResponse> propertyGroups()

      The property groups.

      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 hasPropertyGroups() method.

      Returns:
      The property groups.

    • status

      public final Status status()

      The status of the component type.

      Returns:
      The status of the component type.

    • syncSource

      public final String syncSource()

      The syncSource of the sync job, if this entity was created by a sync job.

      Returns:
      The syncSource of the sync job, if this entity was created by a sync job.

    • componentPath

      public final String componentPath()

      This string specifies the path to the composite component, starting from the top-level component.

      Returns:
      This string specifies the path to the composite component, starting from the top-level component.

    • toBuilder

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

    • builder

      public static ComponentSummary.Builder builder()

    • serializableBuilderClass

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