Interface UpdateThingRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<UpdateThingRequest.Builder,UpdateThingRequest>, IotRequest.Builder, SdkBuilder<UpdateThingRequest.Builder,UpdateThingRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
UpdateThingRequest
@Mutable @NotThreadSafe public static interface UpdateThingRequest.Builder extends IotRequest.Builder, SdkPojo, CopyableBuilder<UpdateThingRequest.Builder,UpdateThingRequest>

  • Method Details

    • thingName

      UpdateThingRequest.Builder thingName(String thingName)

      The name of the thing to update.

      You can't change a thing's name. To change a thing's name, you must create a new thing, give it the new name, and then delete the old thing.

      Parameters:
      thingName - The name of the thing to update.

      You can't change a thing's name. To change a thing's name, you must create a new thing, give it the new name, and then delete the old thing.

      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 method 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:

    • 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 association is removed.

      Parameters:
      removeThingType - Remove a thing type association. If true, the association is removed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      UpdateThingRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      UpdateThingRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.