Package software.amazon.awssdk.services.textract.model

Class GetAdapterVersionResponse

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

  • Method Details

    • adapterId

      public final String adapterId()

      A string containing a unique ID for the adapter version being retrieved.

      Returns:
      A string containing a unique ID for the adapter version being retrieved.

    • adapterVersion

      public final String adapterVersion()

      A string containing the adapter version that has been retrieved.

      Returns:
      A string containing the adapter version that has been retrieved.

    • creationTime

      public final Instant creationTime()

      The time that the adapter version was created.

      Returns:
      The time that the adapter version was created.

    • featureTypes

      public final List<FeatureType> featureTypes()

      List of the targeted feature types for the requested adapter version.

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

      Returns:
      List of the targeted feature types for the requested adapter version.

    • hasFeatureTypes

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

    • featureTypesAsStrings

      public final List<String> featureTypesAsStrings()

      List of the targeted feature types for the requested adapter version.

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

      Returns:
      List of the targeted feature types for the requested adapter version.

    • status

      public final AdapterVersionStatus status()

      The status of the adapter version that has been requested.

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

      Returns:
      The status of the adapter version that has been requested.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the adapter version that has been requested.

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

      Returns:
      The status of the adapter version that has been requested.
      See Also:

    • statusMessage

      public final String statusMessage()

      A message that describes the status of the requested adapter version.

      Returns:
      A message that describes the status of the requested adapter version.

    • datasetConfig

      public final AdapterVersionDatasetConfig datasetConfig()

      Specifies a dataset used to train a new adapter version. Takes a ManifestS3Objec as the value.

      Returns:
      Specifies a dataset used to train a new adapter version. Takes a ManifestS3Objec as the value.

    • kmsKeyId

      public final String kmsKeyId()

      The identifier for your AWS Key Management Service key (AWS KMS key). Used to encrypt your documents.

      Returns:
      The identifier for your AWS Key Management Service key (AWS KMS key). Used to encrypt your documents.

    • outputConfig

      public final OutputConfig outputConfig()
      Returns the value of the OutputConfig property for this object.
      Returns:
      The value of the OutputConfig property for this object.

    • hasEvaluationMetrics

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

    • evaluationMetrics

      public final List<AdapterVersionEvaluationMetric> evaluationMetrics()

      The evaluation metrics (F1 score, Precision, and Recall) for the requested version, grouped by baseline metrics and adapter version.

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

      Returns:
      The evaluation metrics (F1 score, Precision, and Recall) for the requested version, grouped by baseline metrics and adapter version.

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

      A set of tags (key-value pairs) that are associated with the adapter version.

      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:
      A set of tags (key-value pairs) that are associated with the adapter version.

    • toBuilder

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

    • builder

      public static GetAdapterVersionResponse.Builder builder()

    • serializableBuilderClass

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