Package software.amazon.awssdk.services.iot.model

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ThingPrincipalObject.Builder

Method Summary

Modifier and Type	Method	Description
static ThingPrincipalObject.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	principal()	The principal of the thing principal object.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ThingPrincipalObject.Builder>	serializableBuilderClass()
ThingPrincipalType	thingPrincipalType()	The type of the relation you want to specify when you attach a principal to a thing.
String	thingPrincipalTypeAsString()	The type of the relation you want to specify when you attach a principal to a thing.
ThingPrincipalObject.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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:

ThingPrincipalType

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:

ThingPrincipalType

toBuilder

public ThingPrincipalObject.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ThingPrincipalObject.Builder,ThingPrincipalObject>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo