software.amazon.awssdk.services.iot.model

Interface UpdateThingRequest.Builder

All Superinterfaces:

AwsRequest.Builder, CopyableBuilder<UpdateThingRequest.Builder,UpdateThingRequest>, IoTRequest.Builder, SdkBuilder<UpdateThingRequest.Builder,UpdateThingRequest>, SdkRequest.Builder

Enclosing class:

UpdateThingRequest

public static interface UpdateThingRequest.Builder
extends IoTRequest.Builder, CopyableBuilder<UpdateThingRequest.Builder,UpdateThingRequest>

Method Summary

Modifier and Type	Method and Description
UpdateThingRequest.Builder	attributePayload(AttributePayload attributePayload) A list of thing attributes, a JSON string containing name-value pairs.
default UpdateThingRequest.Builder	attributePayload(Consumer<AttributePayload.Builder> attributePayload) A list of thing attributes, a JSON string containing name-value pairs.
UpdateThingRequest.Builder	expectedVersion(Long expectedVersion) The expected version of the thing record in the registry.
UpdateThingRequest.Builder	removeThingType(Boolean removeThingType) Remove a thing type association.
UpdateThingRequest.Builder	requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig) Add an optional request override configuration.
UpdateThingRequest.Builder	requestOverrideConfig(Consumer<AwsRequestOverrideConfig.Builder> builderConsumer) Add an optional request override configuration.
UpdateThingRequest.Builder	thingName(String thingName) The name of the thing to update.
UpdateThingRequest.Builder	thingTypeName(String thingTypeName) The name of the thing type.

Methods inherited from interface software.amazon.awssdk.services.iot.model.IoTRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

requestOverrideConfig

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

copy

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

apply, build

Method Detail

thingName

UpdateThingRequest.Builder thingName(String thingName)

The name of the thing to update.

Parameters:

thingName - The name of the thing to update.

Returns:

Returns a reference to this object so that method calls can be chained together.

thingTypeName

UpdateThingRequest.Builder thingTypeName(String thingTypeName)

The name of the thing type.

Parameters:

thingTypeName - The name of the thing type.

Returns:

Returns a reference to this object so that method calls can be chained together.

attributePayload

UpdateThingRequest.Builder attributePayload(AttributePayload attributePayload)

A list of thing attributes, a JSON string containing name-value pairs. For example:

{\"attributes\":{\"name1\":\"value2\"}}

This data is used to add new attributes or update existing attributes.

Parameters:

attributePayload - A list of thing attributes, a JSON string containing name-value pairs. For example:

{\"attributes\":{\"name1\":\"value2\"}}

This data is used to add new attributes or update existing attributes.

Returns:

Returns a reference to this object so that method calls can be chained together.

attributePayload

default UpdateThingRequest.Builder attributePayload(Consumer<AttributePayload.Builder> attributePayload)

A list of thing attributes, a JSON string containing name-value pairs. For example:

{\"attributes\":{\"name1\":\"value2\"}}

This data is used to add new attributes or update existing attributes.

This is a convenience that creates an instance of the AttributePayload.Builder avoiding the need to create one manually via AttributePayload.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to attributePayload(AttributePayload).

Parameters:

attributePayload - a consumer that will call methods on AttributePayload.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

attributePayload(AttributePayload)

expectedVersion

UpdateThingRequest.Builder expectedVersion(Long expectedVersion)

The expected version of the thing record in the registry. If the version of the record in the registry does not match the expected version specified in the request, the UpdateThing request is rejected with a VersionConflictException.

Parameters:

expectedVersion - The expected version of the thing record in the registry. If the version of the record in the registry does not match the expected version specified in the request, the UpdateThing request is rejected with a VersionConflictException.

Returns:

Returns a reference to this object so that method calls can be chained together.

removeThingType

UpdateThingRequest.Builder removeThingType(Boolean removeThingType)

Remove a thing type association. If true, the assocation is removed.

Parameters:

removeThingType - Remove a thing type association. If true, the assocation is removed.

Returns:

Returns a reference to this object so that method calls can be chained together.

requestOverrideConfig

UpdateThingRequest.Builder requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

requestOverrideConfig in interface AwsRequest.Builder

Parameters:

awsRequestOverrideConfig - The override configuration.

Returns:

This object for method chaining.

requestOverrideConfig

UpdateThingRequest.Builder requestOverrideConfig(Consumer<AwsRequestOverrideConfig.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

requestOverrideConfig in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfig.Builder will be given.

Returns:

This object for method chaining.