Interface ListEngagementFromOpportunityTaskSummary.Builder

    • Method Detail

      • engagementId

        ListEngagementFromOpportunityTaskSummary.Builder engagementId​(String engagementId)

        The unique identifier of the engagement created as a result of the task. This field is populated when the task is completed successfully.

        Parameters:
        engagementId - The unique identifier of the engagement created as a result of the task. This field is populated when the task is completed successfully.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • engagementInvitationId

        ListEngagementFromOpportunityTaskSummary.Builder engagementInvitationId​(String engagementInvitationId)

        The unique identifier of the Engagement Invitation.

        Parameters:
        engagementInvitationId - The unique identifier of the Engagement Invitation.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • message

        ListEngagementFromOpportunityTaskSummary.Builder message​(String message)

        A detailed message providing additional information about the task, especially useful in case of failures. This field may contain error details or other relevant information about the task's execution

        Parameters:
        message - A detailed message providing additional information about the task, especially useful in case of failures. This field may contain error details or other relevant information about the task's execution
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • opportunityId

        ListEngagementFromOpportunityTaskSummary.Builder opportunityId​(String opportunityId)

        The unique identifier of the original Opportunity from which the Engagement is being created. This field helps track the source of the Engagement creation task.

        Parameters:
        opportunityId - The unique identifier of the original Opportunity from which the Engagement is being created. This field helps track the source of the Engagement creation task.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • reasonCode

        ListEngagementFromOpportunityTaskSummary.Builder reasonCode​(String reasonCode)

        A code indicating the specific reason for a task failure. This field is populated when the task status is FAILED and provides a categorized reason for the failure.

        Parameters:
        reasonCode - A code indicating the specific reason for a task failure. This field is populated when the task status is FAILED and provides a categorized reason for the failure.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ReasonCode, ReasonCode
      • reasonCode

        ListEngagementFromOpportunityTaskSummary.Builder reasonCode​(ReasonCode reasonCode)

        A code indicating the specific reason for a task failure. This field is populated when the task status is FAILED and provides a categorized reason for the failure.

        Parameters:
        reasonCode - A code indicating the specific reason for a task failure. This field is populated when the task status is FAILED and provides a categorized reason for the failure.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ReasonCode, ReasonCode
      • resourceSnapshotJobId

        ListEngagementFromOpportunityTaskSummary.Builder resourceSnapshotJobId​(String resourceSnapshotJobId)

        The identifier of the resource snapshot job associated with this task, if a snapshot was created as part of the Engagement creation process.

        Parameters:
        resourceSnapshotJobId - The identifier of the resource snapshot job associated with this task, if a snapshot was created as part of the Engagement creation process.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • startTime

        ListEngagementFromOpportunityTaskSummary.Builder startTime​(Instant startTime)

        The timestamp indicating when the task was initiated, in RFC 3339 5.6 date-time format.

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

        ListEngagementFromOpportunityTaskSummary.Builder taskArn​(String taskArn)

        The Amazon Resource Name (ARN) uniquely identifying this task within AWS. This ARN can be used for referencing the task in other AWS services or APIs.

        Parameters:
        taskArn - The Amazon Resource Name (ARN) uniquely identifying this task within AWS. This ARN can be used for referencing the task in other AWS services or APIs.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • taskId

        ListEngagementFromOpportunityTaskSummary.Builder taskId​(String taskId)

        A unique identifier for a specific task.

        Parameters:
        taskId - A unique identifier for a specific task.
        Returns:
        Returns a reference to this object so that method calls can be chained together.