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

Class AdapterVersionOverview

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

Summary info for an adapter version. Contains information on the AdapterId, AdapterVersion, CreationTime, FeatureTypes, and Status.

See Also:

  • Method Details

    • adapterId

      public final String adapterId()

      A unique identifier for the adapter associated with a given adapter version.

      Returns:
      A unique identifier for the adapter associated with a given adapter version.

    • adapterVersion

      public final String adapterVersion()

      An identified for a given adapter version.

      Returns:
      An identified for a given adapter version.

    • creationTime

      public final Instant creationTime()

      The date and time that a given adapter version was created.

      Returns:
      The date and time that a given adapter version was created.

    • featureTypes

      public final List<FeatureType> featureTypes()

      The feature types that the adapter version is operating on.

      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:
      The feature types that the adapter version is operating on.

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

      The feature types that the adapter version is operating on.

      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:
      The feature types that the adapter version is operating on.

    • status

      public final AdapterVersionStatus status()

      Contains information on the status of a given adapter version.

      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:
      Contains information on the status of a given adapter version.
      See Also:

    • statusAsString

      public final String statusAsString()

      Contains information on the status of a given adapter version.

      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:
      Contains information on the status of a given adapter version.
      See Also:

    • statusMessage

      public final String statusMessage()

      A message explaining the status of a given adapter vesion.

      Returns:
      A message explaining the status of a given adapter vesion.

    • toBuilder

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

    • builder

      public static AdapterVersionOverview.Builder builder()

    • serializableBuilderClass

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