Interface StartEngagementFromOpportunityTaskResponse.Builder

  • Method Details

    • engagementId

      The identifier of the newly created Engagement. Only populated if TaskStatus is COMPLETE.

      Parameters:
      engagementId - The identifier of the newly created Engagement. Only populated if TaskStatus is COMPLETE.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • engagementInvitationId

      StartEngagementFromOpportunityTaskResponse.Builder engagementInvitationId(String engagementInvitationId)

      The identifier of the new Engagement invitation. Only populated if TaskStatus is COMPLETE.

      Parameters:
      engagementInvitationId - The identifier of the new Engagement invitation. Only populated if TaskStatus is COMPLETE.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • message

      If the task fails, this field contains a detailed message describing the failure and possible recovery steps.

      Parameters:
      message - If the task fails, this field contains a detailed message describing the failure and possible recovery steps.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • opportunityId

      Returns the original opportunity identifier passed in the request, which is the unique identifier for the opportunity created in the partner’s system.

      Parameters:
      opportunityId - Returns the original opportunity identifier passed in the request, which is the unique identifier for the opportunity created in the partner’s system.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • reasonCode

      Indicates the reason for task failure using an enumerated code.

      Parameters:
      reasonCode - Indicates the reason for task failure using an enumerated code.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • reasonCode

      Indicates the reason for task failure using an enumerated code.

      Parameters:
      reasonCode - Indicates the reason for task failure using an enumerated code.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • resourceSnapshotJobId

      StartEngagementFromOpportunityTaskResponse.Builder resourceSnapshotJobId(String resourceSnapshotJobId)

      The identifier of the resource snapshot job created to add the opportunity resource snapshot to the Engagement. Only populated if TaskStatus is COMPLETE

      Parameters:
      resourceSnapshotJobId - The identifier of the resource snapshot job created to add the opportunity resource snapshot to the Engagement. Only populated if TaskStatus is COMPLETE
      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 RFC 3339 section 5.6.

      Parameters:
      startTime - The timestamp indicating when the task was initiated. The format follows RFC 3339 section 5.6.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • taskArn

      The Amazon Resource Name (ARN) of the task, used for tracking and managing the task within AWS.

      Parameters:
      taskArn - The Amazon Resource Name (ARN) of the task, used for tracking and managing the task within AWS.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • taskId

      The unique identifier of the task, used to track the task’s progress. This value follows a specific pattern: ^oit-[0-9a-z]{13}$.

      Parameters:
      taskId - The unique identifier of the task, used to track the task’s progress. This value follows a specific pattern: ^oit-[0-9a-z]{13}$.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • taskStatus

      Indicates the current status of the task. Valid values include IN_PROGRESS, COMPLETE, and FAILED.

      Parameters:
      taskStatus - Indicates the current status of the task. Valid values include IN_PROGRESS, COMPLETE, and FAILED.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • taskStatus

      Indicates the current status of the task. Valid values include IN_PROGRESS, COMPLETE, and FAILED.

      Parameters:
      taskStatus - Indicates the current status of the task. Valid values include IN_PROGRESS, COMPLETE, and FAILED.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: