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

Class CreateAdapterRequest

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

  • Method Details

    • adapterName

      public final String adapterName()

      The name to be assigned to the adapter being created.

      Returns:
      The name to be assigned to the adapter being created.

    • clientRequestToken

      public final String clientRequestToken()

      Idempotent token is used to recognize the request. If the same token is used with multiple CreateAdapter requests, the same session is returned. This token is employed to avoid unintentionally creating the same session multiple times.

      Returns:
      Idempotent token is used to recognize the request. If the same token is used with multiple CreateAdapter requests, the same session is returned. This token is employed to avoid unintentionally creating the same session multiple times.

    • description

      public final String description()

      The description to be assigned to the adapter being created.

      Returns:
      The description to be assigned to the adapter being created.

    • featureTypes

      public final List<FeatureType> featureTypes()

      The type of feature that the adapter is being trained on. Currrenly, supported feature types are: QUERIES

      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 type of feature that the adapter is being trained on. Currrenly, supported feature types are: QUERIES

    • 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 type of feature that the adapter is being trained on. Currrenly, supported feature types are: QUERIES

      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 type of feature that the adapter is being trained on. Currrenly, supported feature types are: QUERIES

    • autoUpdate

      public final AutoUpdate autoUpdate()

      Controls whether or not the adapter should automatically update.

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

      Returns:
      Controls whether or not the adapter should automatically update.
      See Also:

    • autoUpdateAsString

      public final String autoUpdateAsString()

      Controls whether or not the adapter should automatically update.

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

      Returns:
      Controls whether or not the adapter should automatically update.
      See Also:

    • 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 list of tags to be added to the adapter.

      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 list of tags to be added to the adapter.

    • toBuilder

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

    • builder

      public static CreateAdapterRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

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