Interface StartDeviceDiscoveryRequest.Builder

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

  • Method Details

    • discoveryType

      StartDeviceDiscoveryRequest.Builder discoveryType(String discoveryType)

      The discovery type supporting the type of device to be discovered in the device discovery task request.

      Parameters:
      discoveryType - The discovery type supporting the type of device to be discovered in the device discovery task request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • discoveryType

      StartDeviceDiscoveryRequest.Builder discoveryType(DiscoveryType discoveryType)

      The discovery type supporting the type of device to be discovered in the device discovery task request.

      Parameters:
      discoveryType - The discovery type supporting the type of device to be discovered in the device discovery task request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • customProtocolDetail

      StartDeviceDiscoveryRequest.Builder customProtocolDetail(Map<String,String> customProtocolDetail)

      Additional protocol-specific details required for device discovery, which vary based on the discovery type.

      For a DiscoveryType of CUSTOM, the string-to-string map must have a key value of Name set to a non-empty-string.

      Parameters:
      customProtocolDetail - Additional protocol-specific details required for device discovery, which vary based on the discovery type.

      For a DiscoveryType of CUSTOM, the string-to-string map must have a key value of Name set to a non-empty-string.

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

    • controllerIdentifier

      StartDeviceDiscoveryRequest.Builder controllerIdentifier(String controllerIdentifier)

      The id of the end-user's IoT hub.

      Parameters:
      controllerIdentifier - The id of the end-user's IoT hub.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • connectorAssociationIdentifier

      @Deprecated StartDeviceDiscoveryRequest.Builder connectorAssociationIdentifier(String connectorAssociationIdentifier)
      Deprecated.
      ConnectorAssociationIdentifier is deprecated

      The id of the connector association.

      Parameters:
      connectorAssociationIdentifier - The id of the connector association.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • accountAssociationId

      StartDeviceDiscoveryRequest.Builder accountAssociationId(String accountAssociationId)

      The identifier of the cloud-to-cloud account association to use for discovery of third-party devices.

      Parameters:
      accountAssociationId - The identifier of the cloud-to-cloud account association to use for discovery of third-party devices.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • authenticationMaterial

      StartDeviceDiscoveryRequest.Builder authenticationMaterial(String authenticationMaterial)

      The authentication material required to start the local device discovery job request.

      Parameters:
      authenticationMaterial - The authentication material required to start the local device discovery job request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • authenticationMaterialType

      StartDeviceDiscoveryRequest.Builder authenticationMaterialType(String authenticationMaterialType)

      The type of authentication material used for device discovery jobs.

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

    • authenticationMaterialType

      StartDeviceDiscoveryRequest.Builder authenticationMaterialType(DiscoveryAuthMaterialType authenticationMaterialType)

      The type of authentication material used for device discovery jobs.

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

    • clientToken

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

    • tags

      @Deprecated StartDeviceDiscoveryRequest.Builder tags(Map<String,String> tags)
      Deprecated.
      Tags have been deprecated from this api

      A set of key/value pairs that are used to manage the device discovery request.

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

    • overrideConfiguration

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

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