Interface BatchUpdateCaseRequest.Builder

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

  • Method Details

    • domainId

      BatchUpdateCaseRequest.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.

    • cases

      BatchUpdateCaseRequest.Builder cases(Collection<BatchUpdateCaseIdentifier> cases)

      The list of cases to update. All cases must belong to the same domain.

      Parameters:
      cases - The list of cases to update. All cases must belong to the same domain.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • cases

      BatchUpdateCaseRequest.Builder cases(BatchUpdateCaseIdentifier... cases)

      The list of cases to update. All cases must belong to the same domain.

      Parameters:
      cases - The list of cases to update. All cases must belong to the same domain.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • cases

      BatchUpdateCaseRequest.Builder cases(Consumer<BatchUpdateCaseIdentifier.Builder>... cases)

      The list of cases to update. All cases must belong to the same domain.

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

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

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

    • fields

      BatchUpdateCaseRequest.Builder fields(Collection<FieldValueInput> fields)

      An array of objects, each with a fieldIdentifier and a value. You can identify each field by its ID or by its name; identifying a field by name is supported only in BatchUpdateCase . The same field values are applied to every case in the request. This field must be present, but can be an empty list when you provide the top-level title, status, or customerId parameters. Do not include title, status, or customerId in this list; set those values only through their top-level parameters. Duplicating them in fields results in a validation error.

      Parameters:
      fields - An array of objects, each with a fieldIdentifier and a value. You can identify each field by its ID or by its name; identifying a field by name is supported only in BatchUpdateCase. The same field values are applied to every case in the request. This field must be present, but can be an empty list when you provide the top-level title, status, or customerId parameters. Do not include title, status, or customerId in this list; set those values only through their top-level parameters. Duplicating them in fields results in a validation error.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • fields

      BatchUpdateCaseRequest.Builder fields(FieldValueInput... fields)

      An array of objects, each with a fieldIdentifier and a value. You can identify each field by its ID or by its name; identifying a field by name is supported only in BatchUpdateCase . The same field values are applied to every case in the request. This field must be present, but can be an empty list when you provide the top-level title, status, or customerId parameters. Do not include title, status, or customerId in this list; set those values only through their top-level parameters. Duplicating them in fields results in a validation error.

      Parameters:
      fields - An array of objects, each with a fieldIdentifier and a value. You can identify each field by its ID or by its name; identifying a field by name is supported only in BatchUpdateCase. The same field values are applied to every case in the request. This field must be present, but can be an empty list when you provide the top-level title, status, or customerId parameters. Do not include title, status, or customerId in this list; set those values only through their top-level parameters. Duplicating them in fields results in a validation error.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • fields

      BatchUpdateCaseRequest.Builder fields(Consumer<FieldValueInput.Builder>... fields)

      An array of objects, each with a fieldIdentifier and a value. You can identify each field by its ID or by its name; identifying a field by name is supported only in BatchUpdateCase . The same field values are applied to every case in the request. This field must be present, but can be an empty list when you provide the top-level title, status, or customerId parameters. Do not include title, status, or customerId in this list; set those values only through their top-level parameters. Duplicating them in fields results in a validation error.

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

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

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

    • performedBy

      BatchUpdateCaseRequest.Builder performedBy(UserUnion performedBy)

      The entity that performed the action.

      Parameters:
      performedBy - The entity that performed the action.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • performedBy

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

      The entity that performed the action.

      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:

    • title

      BatchUpdateCaseRequest.Builder title(String title)

      The title to apply to all cases in the request.

      Parameters:
      title - The title to apply to all cases in the request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • status

      BatchUpdateCaseRequest.Builder status(String status)

      The status to apply to all cases in the request.

      Parameters:
      status - The status to apply to all cases in the request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • customerId

      BatchUpdateCaseRequest.Builder customerId(String customerId)

      The ARN of the customer profile to associate with all cases in the request.

      Parameters:
      customerId - The ARN of the customer profile to associate with all cases in the request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clientToken

      BatchUpdateCaseRequest.Builder clientToken(String clientToken)

      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

      If you retry a request with the same client token, the service returns the original response instead of processing the request again. If you reuse a client token with different request parameters, the request fails with a ConflictException.

      Parameters:
      clientToken - A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

      If you retry a request with the same client token, the service returns the original response instead of processing the request again. If you reuse a client token with different request parameters, the request fails with a ConflictException.

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

    • overrideConfiguration

      BatchUpdateCaseRequest.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

      BatchUpdateCaseRequest.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.