Package software.amazon.awssdk.services.connect.model

Class Evaluation

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

Information about a contact evaluation.

See Also:

  • Method Details

    • evaluationId

      public final String evaluationId()

      A unique identifier for the contact evaluation.

      Returns:
      A unique identifier for the contact evaluation.

    • evaluationArn

      public final String evaluationArn()

      The Amazon Resource Name (ARN) for the contact evaluation resource.

      Returns:
      The Amazon Resource Name (ARN) for the contact evaluation resource.

    • metadata

      public final EvaluationMetadata metadata()

      Metadata about the contact evaluation.

      Returns:
      Metadata about the contact evaluation.

    • hasAnswers

      public final boolean hasAnswers()
      For responses, this returns true if the service returned a value for the Answers 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.

    • answers

      public final Map<String,EvaluationAnswerOutput> answers()

      A map of question identifiers to answer value.

      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 hasAnswers() method.

      Returns:
      A map of question identifiers to answer value.

    • hasNotes

      public final boolean hasNotes()
      For responses, this returns true if the service returned a value for the Notes 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.

    • notes

      public final Map<String,EvaluationNote> notes()

      A map of question identifiers to note value.

      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 hasNotes() method.

      Returns:
      A map of question identifiers to note value.

    • status

      public final EvaluationStatus status()

      The status of the contact evaluation.

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

      Returns:
      The status of the contact evaluation.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the contact evaluation.

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

      Returns:
      The status of the contact evaluation.
      See Also:

    • hasScores

      public final boolean hasScores()
      For responses, this returns true if the service returned a value for the Scores 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.

    • scores

      public final Map<String,EvaluationScore> scores()

      A map of item (section or question) identifiers to score value.

      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 hasScores() method.

      Returns:
      A map of item (section or question) identifiers to score value.

    • createdTime

      public final Instant createdTime()

      The timestamp for when the evaluation was created.

      Returns:
      The timestamp for when the evaluation was created.

    • lastModifiedTime

      public final Instant lastModifiedTime()

      The timestamp for when the evaluation was last updated.

      Returns:
      The timestamp for when the evaluation was last updated.

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags 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.

    • tags

      public final Map<String,String> tags()

      The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.

      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 hasTags() method.

      Returns:
      The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.

    • toBuilder

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

    • builder

      public static Evaluation.Builder builder()

    • serializableBuilderClass

      public static Class<? extends Evaluation.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.