Package software.amazon.awssdk.services.iotthingsgraph.model

Class SystemInstanceDescription

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

An object that contains a system instance definition and summary information.

See Also:

  • Method Details

    • summary

      public final SystemInstanceSummary summary()

      An object that contains summary information about a system instance.

      Returns:
      An object that contains summary information about a system instance.

    • definition

      public final DefinitionDocument definition()
      Returns the value of the Definition property for this object.
      Returns:
      The value of the Definition property for this object.

    • s3BucketName

      public final String s3BucketName()

      The Amazon Simple Storage Service bucket where information about a system instance is stored.

      Returns:
      The Amazon Simple Storage Service bucket where information about a system instance is stored.

    • metricsConfiguration

      public final MetricsConfiguration metricsConfiguration()
      Returns the value of the MetricsConfiguration property for this object.
      Returns:
      The value of the MetricsConfiguration property for this object.

    • validatedNamespaceVersion

      public final Long validatedNamespaceVersion()

      The version of the user's namespace against which the system instance was validated.

      Returns:
      The version of the user's namespace against which the system instance was validated.

    • hasValidatedDependencyRevisions

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

    • validatedDependencyRevisions

      public final List<DependencyRevision> validatedDependencyRevisions()

      A list of objects that contain all of the IDs and revision numbers of workflows and systems that are used in a system instance.

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

      Returns:
      A list of objects that contain all of the IDs and revision numbers of workflows and systems that are used in a system instance.

    • flowActionsRoleArn

      public final String flowActionsRoleArn()

      The AWS Identity and Access Management (IAM) role that AWS IoT Things Graph assumes during flow execution in a cloud deployment. This role must have read and write permissionss to AWS Lambda and AWS IoT and to any other AWS services that the flow uses.

      Returns:
      The AWS Identity and Access Management (IAM) role that AWS IoT Things Graph assumes during flow execution in a cloud deployment. This role must have read and write permissionss to AWS Lambda and AWS IoT and to any other AWS services that the flow uses.

    • toBuilder

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

    • builder

      public static SystemInstanceDescription.Builder builder()

    • serializableBuilderClass

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