Class StartMergeCasesRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.connectcases.model.ConnectCasesRequest
software.amazon.awssdk.services.connectcases.model.StartMergeCasesRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<StartMergeCasesRequest.Builder,StartMergeCasesRequest>
@Generated("software.amazon.awssdk:codegen") public final class StartMergeCasesRequest extends ConnectCasesRequest implements ToCopyableBuilder<StartMergeCasesRequest.Builder,StartMergeCasesRequest>

  • Method Details

    • domainId

      public final String domainId()

      The unique identifier of the Cases domain.

      Returns:
      The unique identifier of the Cases domain.

    • caseId

      public final 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.

      Returns:
      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.

    • hasSecondaryCaseIds

      public final boolean hasSecondaryCaseIds()
      For responses, this returns true if the service returned a value for the SecondaryCaseIds property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • secondaryCaseIds

      public final List<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.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSecondaryCaseIds() method.

      Returns:
      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.

    • hasFieldsConfiguration

      public final boolean hasFieldsConfiguration()
      For responses, this returns true if the service returned a value for the FieldsConfiguration property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • fieldsConfiguration

      public final List<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.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasFieldsConfiguration() method.

      Returns:
      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.

    • relatedItemsConfiguration

      public final 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.

      Returns:
      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.

    • performedBy

      public final UserUnion performedBy()

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

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

    • toBuilder

      public StartMergeCasesRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<StartMergeCasesRequest.Builder,StartMergeCasesRequest>
      Specified by:
      toBuilder in class ConnectCasesRequest
      Returns:
      a builder for type T

    • builder

      public static StartMergeCasesRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends StartMergeCasesRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.