Interface CreateCommandRequest.Builder

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

  • Method Details

    • commandId

      CreateCommandRequest.Builder commandId(String commandId)

      A unique identifier for the command. We recommend using UUID. Alpha-numeric characters, hyphens, and underscores are valid for use here.

      Parameters:
      commandId - A unique identifier for the command. We recommend using UUID. Alpha-numeric characters, hyphens, and underscores are valid for use here.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • namespace

      CreateCommandRequest.Builder namespace(String namespace)

      The namespace of the command. The MQTT reserved topics and validations will be used for command executions according to the namespace setting.

      Parameters:
      namespace - The namespace of the command. The MQTT reserved topics and validations will be used for command executions according to the namespace setting.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • namespace

      CreateCommandRequest.Builder namespace(CommandNamespace namespace)

      The namespace of the command. The MQTT reserved topics and validations will be used for command executions according to the namespace setting.

      Parameters:
      namespace - The namespace of the command. The MQTT reserved topics and validations will be used for command executions according to the namespace setting.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • displayName

      CreateCommandRequest.Builder displayName(String displayName)

      The user-friendly name in the console for the command. This name doesn't have to be unique. You can update the user-friendly name after you define it.

      Parameters:
      displayName - The user-friendly name in the console for the command. This name doesn't have to be unique. You can update the user-friendly name after you define it.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      CreateCommandRequest.Builder description(String description)

      A short text decription of the command.

      Parameters:
      description - A short text decription of the command.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • payload

      CreateCommandRequest.Builder payload(CommandPayload payload)

      The payload object for the command. You must specify this information when using the AWS-IoT namespace.

      You can upload a static payload file from your local storage that contains the instructions for the device to process. The payload file can use any format. To make sure that the device correctly interprets the payload, we recommend you to specify the payload content type.

      Parameters:
      payload - The payload object for the command. You must specify this information when using the AWS-IoT namespace.

      You can upload a static payload file from your local storage that contains the instructions for the device to process. The payload file can use any format. To make sure that the device correctly interprets the payload, we recommend you to specify the payload content type.

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

    • payload

      default CreateCommandRequest.Builder payload(Consumer<CommandPayload.Builder> payload)

      The payload object for the command. You must specify this information when using the AWS-IoT namespace.

      You can upload a static payload file from your local storage that contains the instructions for the device to process. The payload file can use any format. To make sure that the device correctly interprets the payload, we recommend you to specify the payload content type.

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

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

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

    • mandatoryParameters

      CreateCommandRequest.Builder mandatoryParameters(Collection<CommandParameter> mandatoryParameters)

      A list of parameters that are required by the StartCommandExecution API. These parameters need to be specified only when using the AWS-IoT-FleetWise namespace. You can either specify them here or when running the command using the StartCommandExecution API.

      Parameters:
      mandatoryParameters - A list of parameters that are required by the StartCommandExecution API. These parameters need to be specified only when using the AWS-IoT-FleetWise namespace. You can either specify them here or when running the command using the StartCommandExecution API.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • mandatoryParameters

      CreateCommandRequest.Builder mandatoryParameters(CommandParameter... mandatoryParameters)

      A list of parameters that are required by the StartCommandExecution API. These parameters need to be specified only when using the AWS-IoT-FleetWise namespace. You can either specify them here or when running the command using the StartCommandExecution API.

      Parameters:
      mandatoryParameters - A list of parameters that are required by the StartCommandExecution API. These parameters need to be specified only when using the AWS-IoT-FleetWise namespace. You can either specify them here or when running the command using the StartCommandExecution API.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • mandatoryParameters

      CreateCommandRequest.Builder mandatoryParameters(Consumer<CommandParameter.Builder>... mandatoryParameters)

      A list of parameters that are required by the StartCommandExecution API. These parameters need to be specified only when using the AWS-IoT-FleetWise namespace. You can either specify them here or when running the command using the StartCommandExecution API.

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

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

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

    • roleArn

      CreateCommandRequest.Builder roleArn(String roleArn)

      The IAM role that you must provide when using the AWS-IoT-FleetWise namespace. The role grants IoT Device Management the permission to access IoT FleetWise resources for generating the payload for the command. This field is not required when you use the AWS-IoT namespace.

      Parameters:
      roleArn - The IAM role that you must provide when using the AWS-IoT-FleetWise namespace. The role grants IoT Device Management the permission to access IoT FleetWise resources for generating the payload for the command. This field is not required when you use the AWS-IoT namespace.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateCommandRequest.Builder tags(Collection<Tag> tags)

      Name-value pairs that are used as metadata to manage a command.

      Parameters:
      tags - Name-value pairs that are used as metadata to manage a command.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateCommandRequest.Builder tags(Tag... tags)

      Name-value pairs that are used as metadata to manage a command.

      Parameters:
      tags - Name-value pairs that are used as metadata to manage a command.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateCommandRequest.Builder tags(Consumer<Tag.Builder>... tags)

      Name-value pairs that are used as metadata to manage a command.

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

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

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

    • overrideConfiguration

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

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