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

Class EvaluationForm

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

Information about the evaluation form.

See Also:

  • Method Details

    • evaluationFormId

      public final String evaluationFormId()

      The unique identifier for the evaluation form.

      Returns:
      The unique identifier for the evaluation form.

    • evaluationFormVersion

      public final Integer evaluationFormVersion()

      A version of the evaluation form.

      Returns:
      A version of the evaluation form.

    • locked

      public final Boolean locked()

      The flag indicating whether the evaluation form is locked for changes.

      Returns:
      The flag indicating whether the evaluation form is locked for changes.

    • evaluationFormArn

      public final String evaluationFormArn()

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

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

    • title

      public final String title()

      A title of the evaluation form.

      Returns:
      A title of the evaluation form.

    • description

      public final String description()

      The description of the evaluation form.

      Returns:
      The description of the evaluation form.

    • status

      public final EvaluationFormVersionStatus status()

      The status of the evaluation form.

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

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

    • statusAsString

      public final String statusAsString()

      The status of the evaluation form.

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

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

    • hasItems

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

    • items

      public final List<EvaluationFormItem> items()

      Items that are part of the evaluation form. The total number of sections and questions must not exceed 100 each. Questions must be contained in a section.

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

      Returns:
      Items that are part of the evaluation form. The total number of sections and questions must not exceed 100 each. Questions must be contained in a section.

    • scoringStrategy

      public final EvaluationFormScoringStrategy scoringStrategy()

      A scoring strategy of the evaluation form.

      Returns:
      A scoring strategy of the evaluation form.

    • createdTime

      public final Instant createdTime()

      The timestamp for when the evaluation form was created.

      Returns:
      The timestamp for when the evaluation form was created.

    • createdBy

      public final String createdBy()

      The Amazon Resource Name (ARN) of the user who created the evaluation form.

      Returns:
      The Amazon Resource Name (ARN) of the user who created the evaluation form.

    • lastModifiedTime

      public final Instant lastModifiedTime()

      The timestamp for when the evaluation form was last updated.

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

    • lastModifiedBy

      public final String lastModifiedBy()

      The Amazon Resource Name (ARN) of the user who last updated the evaluation form.

      Returns:
      The Amazon Resource Name (ARN) of the user who last updated the evaluation form.

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

    • builder

      public static EvaluationForm.Builder builder()

    • serializableBuilderClass

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