Interface GetEngagementResponse.Builder

  • Method Details

    • arn

      The Amazon Resource Name (ARN) of the engagement retrieved.

      Parameters:
      arn - The Amazon Resource Name (ARN) of the engagement retrieved.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • contexts

      A list of context objects associated with the engagement. Each context provides additional information related to the Engagement, such as customer projects or documents.

      Parameters:
      contexts - A list of context objects associated with the engagement. Each context provides additional information related to the Engagement, such as customer projects or documents.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • contexts

      A list of context objects associated with the engagement. Each context provides additional information related to the Engagement, such as customer projects or documents.

      Parameters:
      contexts - A list of context objects associated with the engagement. Each context provides additional information related to the Engagement, such as customer projects or documents.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • contexts

      A list of context objects associated with the engagement. Each context provides additional information related to the Engagement, such as customer projects or documents.

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

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

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

      GetEngagementResponse.Builder createdAt(Instant createdAt)

      The date and time when the Engagement was created, presented in ISO 8601 format (UTC). For example: "2023-05-01T20:37:46Z". This timestamp helps track the lifecycle of the Engagement.

      Parameters:
      createdAt - The date and time when the Engagement was created, presented in ISO 8601 format (UTC). For example: "2023-05-01T20:37:46Z". This timestamp helps track the lifecycle of the Engagement.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • createdBy

      GetEngagementResponse.Builder createdBy(String createdBy)

      The AWS account ID of the user who originally created the engagement. This field helps in tracking the origin of the engagement.

      Parameters:
      createdBy - The AWS account ID of the user who originally created the engagement. This field helps in tracking the origin of the engagement.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • description

      GetEngagementResponse.Builder description(String description)

      A more detailed description of the engagement. This provides additional context or information about the engagement's purpose or scope.

      Parameters:
      description - A more detailed description of the engagement. This provides additional context or information about the engagement's purpose or scope.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • id

      The unique resource identifier of the engagement retrieved.

      Parameters:
      id - The unique resource identifier of the engagement retrieved.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • memberCount

      GetEngagementResponse.Builder memberCount(Integer memberCount)

      Specifies the current count of members participating in the Engagement. This count includes all active members regardless of their roles or permissions within the Engagement.

      Parameters:
      memberCount - Specifies the current count of members participating in the Engagement. This count includes all active members regardless of their roles or permissions within the Engagement.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • title

      The title of the engagement. It provides a brief, descriptive name for the engagement that is meaningful and easily recognizable.

      Parameters:
      title - The title of the engagement. It provides a brief, descriptive name for the engagement that is meaningful and easily recognizable.
      Returns:
      Returns a reference to this object so that method calls can be chained together.