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

Class AttachThingPrincipalRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.iot.model.IotRequest

software.amazon.awssdk.services.iot.model.AttachThingPrincipalRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<AttachThingPrincipalRequest.Builder,AttachThingPrincipalRequest>

@Generated("software.amazon.awssdk:codegen")
public final class AttachThingPrincipalRequest
extends IotRequest
implements ToCopyableBuilder<AttachThingPrincipalRequest.Builder,AttachThingPrincipalRequest>

The input for the AttachThingPrincipal operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AttachThingPrincipalRequest.Builder

Method Summary

Modifier and Type	Method	Description
static AttachThingPrincipalRequest.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, which can be a certificate ARN (as returned from the CreateCertificate operation) or an Amazon Cognito ID.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends AttachThingPrincipalRequest.Builder>	serializableBuilderClass()
String	thingName()	The name of the thing.
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.
AttachThingPrincipalRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

thingName

public final String thingName()

The name of the thing.

Returns:

The name of the thing.

principal

public final String principal()

The principal, which can be a certificate ARN (as returned from the CreateCertificate operation) or an Amazon Cognito ID.

Returns:

The principal, which can be a certificate ARN (as returned from the CreateCertificate operation) or an Amazon Cognito ID.

thingPrincipalType

public final ThingPrincipalType thingPrincipalType()

The type of the relation you want to specify when you attach a principal to a 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.

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

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

• 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 AttachThingPrincipalRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AttachThingPrincipalRequest.Builder,AttachThingPrincipalRequest>

Specified by:

toBuilder in class IotRequest

builder

public static AttachThingPrincipalRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

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