Class ThingPrincipalObject

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

An object that represents the principal and the type of relation it has with the thing.

See Also:

  • Method Details

    • principal

      public final String principal()

      The principal of the thing principal object.

      Returns:
      The principal of the thing principal object.

    • thingPrincipalType

      public final ThingPrincipalType thingPrincipalType()

      The type of the relation you want to specify when you attach a principal to a thing. The value defaults to NON_EXCLUSIVE_THING.

      • EXCLUSIVE_THING - Attaches the specified principal to the specified thing, exclusively. The thing will be the only thing that’s attached to the principal.

      • NON_EXCLUSIVE_THING - Attaches the specified principal to the specified thing. Multiple things can be attached to the principal.

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

      Returns:
      The type of the relation you want to specify when you attach a principal to a thing. The value defaults to NON_EXCLUSIVE_THING.

      • EXCLUSIVE_THING - Attaches the specified principal to the specified thing, exclusively. The thing will be the only thing that’s attached to the principal.

      • NON_EXCLUSIVE_THING - Attaches the specified principal to the specified thing. Multiple things can be attached to the principal.

      See Also:

    • thingPrincipalTypeAsString

      public final String thingPrincipalTypeAsString()

      The type of the relation you want to specify when you attach a principal to a thing. The value defaults to NON_EXCLUSIVE_THING.

      • EXCLUSIVE_THING - Attaches the specified principal to the specified thing, exclusively. The thing will be the only thing that’s attached to the principal.

      • NON_EXCLUSIVE_THING - Attaches the specified principal to the specified thing. Multiple things can be attached to the principal.

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

      Returns:
      The type of the relation you want to specify when you attach a principal to a thing. The value defaults to NON_EXCLUSIVE_THING.

      • EXCLUSIVE_THING - Attaches the specified principal to the specified thing, exclusively. The thing will be the only thing that’s attached to the principal.

      • NON_EXCLUSIVE_THING - Attaches the specified principal to the specified thing. Multiple things can be attached to the principal.

      See Also:

    • toBuilder

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

    • builder

      public static ThingPrincipalObject.Builder builder()

    • serializableBuilderClass

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