Interface CreateManagedThingRequest.Builder

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

  • Method Details

    • role

      CreateManagedThingRequest.Builder role(String role)

      The type of device used. This will be the hub controller, cloud device, or AWS IoT device.

      Parameters:
      role - The type of device used. This will be the hub controller, cloud device, or AWS IoT device.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • role

      CreateManagedThingRequest.Builder role(Role role)

      The type of device used. This will be the hub controller, cloud device, or AWS IoT device.

      Parameters:
      role - The type of device used. This will be the hub controller, cloud device, or AWS IoT device.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • owner

      CreateManagedThingRequest.Builder owner(String owner)

      Owner of the device, usually an indication of whom the device belongs to. This value should not contain personal identifiable information.

      Parameters:
      owner - Owner of the device, usually an indication of whom the device belongs to. This value should not contain personal identifiable information.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • credentialLockerId

      CreateManagedThingRequest.Builder credentialLockerId(String credentialLockerId)

      The identifier of the credential for the managed thing.

      Parameters:
      credentialLockerId - The identifier of the credential for the managed thing.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • authenticationMaterial

      CreateManagedThingRequest.Builder authenticationMaterial(String authenticationMaterial)

      The authentication material defining the device connectivity setup requests. The authentication materials used are the device bar code.

      Parameters:
      authenticationMaterial - The authentication material defining the device connectivity setup requests. The authentication materials used are the device bar code.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • authenticationMaterialType

      CreateManagedThingRequest.Builder authenticationMaterialType(String authenticationMaterialType)

      The type of authentication material used for device connectivity setup requests.

      Parameters:
      authenticationMaterialType - The type of authentication material used for device connectivity setup requests.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • authenticationMaterialType

      CreateManagedThingRequest.Builder authenticationMaterialType(AuthMaterialType authenticationMaterialType)

      The type of authentication material used for device connectivity setup requests.

      Parameters:
      authenticationMaterialType - The type of authentication material used for device connectivity setup requests.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • serialNumber

      CreateManagedThingRequest.Builder serialNumber(String serialNumber)

      The serial number of the device.

      Parameters:
      serialNumber - The serial number of the device.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • brand

      CreateManagedThingRequest.Builder brand(String brand)

      The brand of the device.

      Parameters:
      brand - The brand of the device.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • model

      CreateManagedThingRequest.Builder model(String model)

      The model of the device.

      Parameters:
      model - The model of the device.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • name

      CreateManagedThingRequest.Builder name(String name)

      The name of the managed thing representing the physical device.

      Parameters:
      name - The name of the managed thing representing the physical device.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • capabilityReport

      CreateManagedThingRequest.Builder capabilityReport(CapabilityReport capabilityReport)

      A report of the capabilities for the managed thing.

      Parameters:
      capabilityReport - A report of the capabilities for the managed thing.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • capabilityReport

      default CreateManagedThingRequest.Builder capabilityReport(Consumer<CapabilityReport.Builder> capabilityReport)

      A report of the capabilities for the managed thing.

      This is a convenience method that creates an instance of the CapabilityReport.Builder avoiding the need to create one manually via CapabilityReport.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to capabilityReport(CapabilityReport).

      Parameters:
      capabilityReport - a consumer that will call methods on CapabilityReport.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • capabilitySchemas

      CreateManagedThingRequest.Builder capabilitySchemas(Collection<CapabilitySchemaItem> capabilitySchemas)

      The capability schemas that define the functionality and features supported by the managed thing, including device capabilities and their associated properties.

      Parameters:
      capabilitySchemas - The capability schemas that define the functionality and features supported by the managed thing, including device capabilities and their associated properties.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • capabilitySchemas

      CreateManagedThingRequest.Builder capabilitySchemas(CapabilitySchemaItem... capabilitySchemas)

      The capability schemas that define the functionality and features supported by the managed thing, including device capabilities and their associated properties.

      Parameters:
      capabilitySchemas - The capability schemas that define the functionality and features supported by the managed thing, including device capabilities and their associated properties.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • capabilitySchemas

      CreateManagedThingRequest.Builder capabilitySchemas(Consumer<CapabilitySchemaItem.Builder>... capabilitySchemas)

      The capability schemas that define the functionality and features supported by the managed thing, including device capabilities and their associated properties.

      This is a convenience method that creates an instance of the CapabilitySchemaItem.Builder avoiding the need to create one manually via CapabilitySchemaItem.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to capabilitySchemas(List<CapabilitySchemaItem>).

      Parameters:
      capabilitySchemas - a consumer that will call methods on CapabilitySchemaItem.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • capabilities

      CreateManagedThingRequest.Builder capabilities(String capabilities)

      The capabilities of the device such as light bulb.

      Parameters:
      capabilities - The capabilities of the device such as light bulb.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clientToken

      CreateManagedThingRequest.Builder clientToken(String clientToken)

      An idempotency token. If you retry a request that completed successfully initially using the same client token and parameters, then the retry attempt will succeed without performing any further actions.

      Parameters:
      clientToken - An idempotency token. If you retry a request that completed successfully initially using the same client token and parameters, then the retry attempt will succeed without performing any further actions.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • classification

      CreateManagedThingRequest.Builder classification(String classification)

      The classification of the managed thing such as light bulb or thermostat.

      Parameters:
      classification - The classification of the managed thing such as light bulb or thermostat.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateManagedThingRequest.Builder tags(Map<String,String> tags)

      A set of key/value pairs that are used to manage the managed thing.

      Parameters:
      tags - A set of key/value pairs that are used to manage the managed thing.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • metaData

      CreateManagedThingRequest.Builder metaData(Map<String,String> metaData)

      The metadata for the managed thing.

      The managedThing metadata parameter is used for associating attributes with a managedThing that can be used for grouping over-the-air (OTA) tasks. Name value pairs in metadata can be used in the OtaTargetQueryString parameter for the CreateOtaTask API operation.

      Parameters:
      metaData - The metadata for the managed thing.

      The managedThing metadata parameter is used for associating attributes with a managedThing that can be used for grouping over-the-air (OTA) tasks. Name value pairs in metadata can be used in the OtaTargetQueryString parameter for the CreateOtaTask API operation.

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

    • overrideConfiguration

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

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