Class GetEvaluationFormValidationResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.connect.model.ConnectResponse
software.amazon.awssdk.services.connect.model.GetEvaluationFormValidationResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetEvaluationFormValidationResponse.Builder,GetEvaluationFormValidationResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetEvaluationFormValidationResponse extends ConnectResponse implements ToCopyableBuilder<GetEvaluationFormValidationResponse.Builder,GetEvaluationFormValidationResponse>

  • Method Details

    • status

      public final EvaluationFormValidationStatus status()

      The current status of the validation process. Valid values: IN_PROGRESS, COMPLETED, FAILED.

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

      Returns:
      The current status of the validation process. Valid values: IN_PROGRESS, COMPLETED, FAILED.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the validation process. Valid values: IN_PROGRESS, COMPLETED, FAILED.

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

      Returns:
      The current status of the validation process. Valid values: IN_PROGRESS, COMPLETED, FAILED.
      See Also:

    • failureReason

      public final String failureReason()

      The reason the validation failed. This field is populated only when the status is FAILED.

      Returns:
      The reason the validation failed. This field is populated only when the status is FAILED.

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

    • startedTime

      public final Instant startedTime()

      The timestamp when the validation process was started.

      Returns:
      The timestamp when the validation process was started.

    • hasFindings

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

    • findings

      public final List<EvaluationFormValidationFinding> findings()

      A list of findings from the validation process. Each finding identifies a structural issue or quality improvement for the evaluation form, and may include a suggested fix. This field is populated when the status is COMPLETED.

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

      Returns:
      A list of findings from the validation process. Each finding identifies a structural issue or quality improvement for the evaluation form, and may include a suggested fix. This field is populated when the status is COMPLETED.

    • toBuilder

      public GetEvaluationFormValidationResponse.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<GetEvaluationFormValidationResponse.Builder,GetEvaluationFormValidationResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static GetEvaluationFormValidationResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. 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 SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      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.