Interface StartMergeCasesRequest.Builder

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

  • Method Details

    • domainId

      StartMergeCasesRequest.Builder domainId(String domainId)

      The unique identifier of the Cases domain.

      Parameters:
      domainId - The unique identifier of the Cases domain.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • caseId

      StartMergeCasesRequest.Builder caseId(String caseId)

      The unique identifier of the primary case. The primary case remains active and receives the merged field values and related items. The cases can use different templates, and the primary case keeps its template.

      Parameters:
      caseId - The unique identifier of the primary case. The primary case remains active and receives the merged field values and related items. The cases can use different templates, and the primary case keeps its template.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • secondaryCaseIds

      StartMergeCasesRequest.Builder secondaryCaseIds(Collection<String> secondaryCaseIds)

      The unique identifier of the secondary case to merge into the primary case. The secondary case is closed when the merge finishes. Specify exactly one case ID.

      Parameters:
      secondaryCaseIds - The unique identifier of the secondary case to merge into the primary case. The secondary case is closed when the merge finishes. Specify exactly one case ID.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • secondaryCaseIds

      StartMergeCasesRequest.Builder secondaryCaseIds(String... secondaryCaseIds)

      The unique identifier of the secondary case to merge into the primary case. The secondary case is closed when the merge finishes. Specify exactly one case ID.

      Parameters:
      secondaryCaseIds - The unique identifier of the secondary case to merge into the primary case. The secondary case is closed when the merge finishes. Specify exactly one case ID.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • fieldsConfiguration

      StartMergeCasesRequest.Builder fieldsConfiguration(Collection<FieldsConfiguration> fieldsConfiguration)

      The fields whose values to take from the secondary case. You can only merge custom fields and the following system fields: assigned_queue, assigned_user, summary, and case_reason. If you select any other system field, the request fails with a ValidationException.

      For each field that can be merged, the merge works as follows:

      • If you select the field, the primary case gets the secondary case's value. If the secondary case's value is empty, the primary case's value is cleared.

      • If you don't select the field and the primary case has a value for it, the primary case keeps its value.

      • If you don't select the field and the primary case doesn't have the field, or its value is empty, the primary case gets the secondary case's value. This applies even when the field isn't on the primary case's template.

      Field values are read from both cases when the merge runs, so changes that you make to the primary case after you start the merge are taken into account.

      Specify at most one entry, and set its sourceCaseId to the secondary case ID.

      Parameters:
      fieldsConfiguration - The fields whose values to take from the secondary case. You can only merge custom fields and the following system fields: assigned_queue, assigned_user, summary , and case_reason. If you select any other system field, the request fails with a ValidationException.

      For each field that can be merged, the merge works as follows:

      • If you select the field, the primary case gets the secondary case's value. If the secondary case's value is empty, the primary case's value is cleared.

      • If you don't select the field and the primary case has a value for it, the primary case keeps its value.

      • If you don't select the field and the primary case doesn't have the field, or its value is empty, the primary case gets the secondary case's value. This applies even when the field isn't on the primary case's template.

      Field values are read from both cases when the merge runs, so changes that you make to the primary case after you start the merge are taken into account.

      Specify at most one entry, and set its sourceCaseId to the secondary case ID.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • fieldsConfiguration

      StartMergeCasesRequest.Builder fieldsConfiguration(FieldsConfiguration... fieldsConfiguration)

      The fields whose values to take from the secondary case. You can only merge custom fields and the following system fields: assigned_queue, assigned_user, summary, and case_reason. If you select any other system field, the request fails with a ValidationException.

      For each field that can be merged, the merge works as follows:

      • If you select the field, the primary case gets the secondary case's value. If the secondary case's value is empty, the primary case's value is cleared.

      • If you don't select the field and the primary case has a value for it, the primary case keeps its value.

      • If you don't select the field and the primary case doesn't have the field, or its value is empty, the primary case gets the secondary case's value. This applies even when the field isn't on the primary case's template.

      Field values are read from both cases when the merge runs, so changes that you make to the primary case after you start the merge are taken into account.

      Specify at most one entry, and set its sourceCaseId to the secondary case ID.

      Parameters:
      fieldsConfiguration - The fields whose values to take from the secondary case. You can only merge custom fields and the following system fields: assigned_queue, assigned_user, summary , and case_reason. If you select any other system field, the request fails with a ValidationException.

      For each field that can be merged, the merge works as follows:

      • If you select the field, the primary case gets the secondary case's value. If the secondary case's value is empty, the primary case's value is cleared.

      • If you don't select the field and the primary case has a value for it, the primary case keeps its value.

      • If you don't select the field and the primary case doesn't have the field, or its value is empty, the primary case gets the secondary case's value. This applies even when the field isn't on the primary case's template.

      Field values are read from both cases when the merge runs, so changes that you make to the primary case after you start the merge are taken into account.

      Specify at most one entry, and set its sourceCaseId to the secondary case ID.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • fieldsConfiguration

      StartMergeCasesRequest.Builder fieldsConfiguration(Consumer<FieldsConfiguration.Builder>... fieldsConfiguration)

      The fields whose values to take from the secondary case. You can only merge custom fields and the following system fields: assigned_queue, assigned_user, summary, and case_reason. If you select any other system field, the request fails with a ValidationException.

      For each field that can be merged, the merge works as follows:

      • If you select the field, the primary case gets the secondary case's value. If the secondary case's value is empty, the primary case's value is cleared.

      • If you don't select the field and the primary case has a value for it, the primary case keeps its value.

      • If you don't select the field and the primary case doesn't have the field, or its value is empty, the primary case gets the secondary case's value. This applies even when the field isn't on the primary case's template.

      Field values are read from both cases when the merge runs, so changes that you make to the primary case after you start the merge are taken into account.

      Specify at most one entry, and set its sourceCaseId to the secondary case ID.

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

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

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

    • relatedItemsConfiguration

      StartMergeCasesRequest.Builder relatedItemsConfiguration(RelatedItemsConfiguration relatedItemsConfiguration)

      The types of related items to move from the secondary case to the primary case. Related items of a type that you don't select, or set to false, stay on the closed secondary case. If you omit this parameter, no related items are moved.

      File, SLA, and work plan related items are never moved. They stay on the secondary case.

      Parameters:
      relatedItemsConfiguration - The types of related items to move from the secondary case to the primary case. Related items of a type that you don't select, or set to false, stay on the closed secondary case. If you omit this parameter, no related items are moved.

      File, SLA, and work plan related items are never moved. They stay on the secondary case.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • relatedItemsConfiguration

      default StartMergeCasesRequest.Builder relatedItemsConfiguration(Consumer<RelatedItemsConfiguration.Builder> relatedItemsConfiguration)

      The types of related items to move from the secondary case to the primary case. Related items of a type that you don't select, or set to false, stay on the closed secondary case. If you omit this parameter, no related items are moved.

      File, SLA, and work plan related items are never moved. They stay on the secondary case.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to relatedItemsConfiguration(RelatedItemsConfiguration).

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

    • performedBy

      StartMergeCasesRequest.Builder performedBy(UserUnion performedBy)

      The user who performed the merge. If you provide userArn, you must also have DescribeUser permission on the ARN of that user.

      Parameters:
      performedBy - The user who performed the merge. If you provide userArn, you must also have DescribeUser permission on the ARN of that user.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • performedBy

      default StartMergeCasesRequest.Builder performedBy(Consumer<UserUnion.Builder> performedBy)

      The user who performed the merge. If you provide userArn, you must also have DescribeUser permission on the ARN of that user.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to performedBy(UserUnion).

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

    • overrideConfiguration

      StartMergeCasesRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      StartMergeCasesRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.