Class Reference

java.lang.Object
software.amazon.awssdk.services.connect.model.Reference
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Reference.Builder,Reference>
@Generated("software.amazon.awssdk:codegen") public final class Reference extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Reference.Builder,Reference>

Well-formed data on a contact, used by agents to complete a contact request. You can have up to 4,096 UTF-8 bytes across all references for a contact.

See Also:

  • Method Details

    • value

      public final String value()

      A valid value for the reference. For example, for a URL reference, a formatted URL that is displayed to an agent in the Contact Control Panel (CCP).

      Returns:
      A valid value for the reference. For example, for a URL reference, a formatted URL that is displayed to an agent in the Contact Control Panel (CCP).

    • type

      public final ReferenceType type()

      The type of the reference. DATE must be of type Epoch timestamp.

      If the service returns an enum value that is not available in the current SDK version, type will return ReferenceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      Returns:
      The type of the reference. DATE must be of type Epoch timestamp.
      See Also:

    • typeAsString

      public final String typeAsString()

      The type of the reference. DATE must be of type Epoch timestamp.

      If the service returns an enum value that is not available in the current SDK version, type will return ReferenceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      Returns:
      The type of the reference. DATE must be of type Epoch timestamp.
      See Also:

    • status

      public final ReferenceStatus status()

      Status of the attachment reference type.

      If the service returns an enum value that is not available in the current SDK version, status will return ReferenceStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      Status of the attachment reference type.
      See Also:

    • statusAsString

      public final String statusAsString()

      Status of the attachment reference type.

      If the service returns an enum value that is not available in the current SDK version, status will return ReferenceStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      Status of the attachment reference type.
      See Also:

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) of the reference

      Returns:
      The Amazon Resource Name (ARN) of the reference

    • statusReason

      public final String statusReason()

      Relevant details why the reference was not successfully created.

      Returns:
      Relevant details why the reference was not successfully created.

    • toBuilder

      public Reference.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<Reference.Builder,Reference>
      Returns:
      a builder for type T

    • builder

      public static Reference.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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)

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