Interface StartProspectingFromEngagementTaskResponse.Builder

  • Method Details

    • identifiers

      The list of engagement identifiers that were accepted into the task queue for processing. This list matches the identifiers provided in the request.

      Parameters:
      identifiers - The list of engagement identifiers that were accepted into the task queue for processing. This list matches the identifiers provided in the request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • identifiers

      The list of engagement identifiers that were accepted into the task queue for processing. This list matches the identifiers provided in the request.

      Parameters:
      identifiers - The list of engagement identifiers that were accepted into the task queue for processing. This list matches the identifiers provided in the request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • taskName

      The task name from the request.

      Parameters:
      taskName - The task name from the request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • message

      A message providing additional context about the task's current state. When the task fails, this field contains a detailed description of the failure and suggested recovery steps. This field is only populated for tasks in a failed state.

      Parameters:
      message - A message providing additional context about the task's current state. When the task fails, this field contains a detailed description of the failure and suggested recovery steps. This field is only populated for tasks in a failed state.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • reasonCode

      An enumerated code identifying the reason for task failure. This field is only populated when the task has failed. Use the corresponding Message field for a human-readable description of the failure.

      Parameters:
      reasonCode - An enumerated code identifying the reason for task failure. This field is only populated when the task has failed. Use the corresponding Message field for a human-readable description of the failure.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • startTime

      The timestamp indicating when the task was initiated. The format follows ISO 8601 date-time notation.

      Parameters:
      startTime - The timestamp indicating when the task was initiated. The format follows ISO 8601 date-time notation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • taskId

      The unique identifier assigned to this task. Use this identifier with GetProspectingFromEngagementTask to retrieve task details and check status.

      Parameters:
      taskId - The unique identifier assigned to this task. Use this identifier with GetProspectingFromEngagementTask to retrieve task details and check status.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • taskArn

      The Amazon Resource Name (ARN) of the task. The ARN uniquely identifies the task across AWS and can be used for resource-level IAM policies.

      Parameters:
      taskArn - The Amazon Resource Name (ARN) of the task. The ARN uniquely identifies the task across AWS and can be used for resource-level IAM policies.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • taskStatus

      The current status of the task. Possible values: PENDING (waiting to run), IN_PROGRESS (actively processing), COMPLETED (successfully processed), and FAILED (unrecoverable error).

      Parameters:
      taskStatus - The current status of the task. Possible values: PENDING (waiting to run), IN_PROGRESS (actively processing), COMPLETED (successfully processed), and FAILED (unrecoverable error).
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • taskStatus

      The current status of the task. Possible values: PENDING (waiting to run), IN_PROGRESS (actively processing), COMPLETED (successfully processed), and FAILED (unrecoverable error).

      Parameters:
      taskStatus - The current status of the task. Possible values: PENDING (waiting to run), IN_PROGRESS (actively processing), COMPLETED (successfully processed), and FAILED (unrecoverable error).
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: