Interface EngagementProspectingResult.Builder

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

  • Method Details

    • engagementIdentifier

      EngagementProspectingResult.Builder engagementIdentifier(String engagementIdentifier)

      The unique identifier of the engagement that was processed.

      Parameters:
      engagementIdentifier - The unique identifier of the engagement that was processed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • engagementContextId

      EngagementProspectingResult.Builder engagementContextId(String engagementContextId)

      The identifier of the prospecting context created for this engagement. This field is only populated when the engagement was processed successfully (status is COMPLETED). Use this identifier to reference the prospecting context in subsequent operations.

      Parameters:
      engagementContextId - The identifier of the prospecting context created for this engagement. This field is only populated when the engagement was processed successfully (status is COMPLETED). Use this identifier to reference the prospecting context in subsequent operations.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • status

      EngagementProspectingResult.Builder status(String status)

      The processing status of this specific engagement. Possible values are PENDING, IN_PROGRESS, COMPLETED, and FAILED.

      Parameters:
      status - The processing status of this specific engagement. Possible values are PENDING, IN_PROGRESS, COMPLETED, and FAILED.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      EngagementProspectingResult.Builder status(ProspectingTaskStatus status)

      The processing status of this specific engagement. Possible values are PENDING, IN_PROGRESS, COMPLETED, and FAILED.

      Parameters:
      status - The processing status of this specific engagement. Possible values are PENDING, IN_PROGRESS, COMPLETED, and FAILED.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • reasonCode

      EngagementProspectingResult.Builder reasonCode(String reasonCode)

      An enumerated code indicating the reason this engagement failed to process. This field is only populated when Status is FAILED.

      Parameters:
      reasonCode - An enumerated code indicating the reason this engagement failed to process. This field is only populated when Status is FAILED.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • message

      EngagementProspectingResult.Builder message(String message)

      A human-readable description of the failure for this engagement, including suggested recovery steps. This field is only populated when Status is FAILED.

      Parameters:
      message - A human-readable description of the failure for this engagement, including suggested recovery steps. This field is only populated when Status is FAILED.
      Returns:
      Returns a reference to this object so that method calls can be chained together.