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>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
CreateAdapterRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description String
adapterName()
The name to be assigned to the adapter being created.AutoUpdate
autoUpdate()
Controls whether or not the adapter should automatically update.String
autoUpdateAsString()
Controls whether or not the adapter should automatically update.static CreateAdapterRequest.Builder
builder()
String
clientRequestToken()
Idempotent token is used to recognize the request.String
description()
The description to be assigned to the adapter being created.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
List<FeatureType>
featureTypes()
The type of feature that the adapter is being trained on.List<String>
featureTypesAsStrings()
The type of feature that the adapter is being trained on.<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
boolean
hasFeatureTypes()
For responses, this returns true if the service returned a value for the FeatureTypes property.int
hashCode()
boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.List<SdkField<?>>
sdkFields()
static Class<? extends CreateAdapterRequest.Builder>
serializableBuilderClass()
Map<String,String>
tags()
A list of tags to be added to the adapter.CreateAdapterRequest.Builder
toBuilder()
String
toString()
Returns a string representation of this object.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
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 theisEmpty()
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 returnAutoUpdate.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromautoUpdateAsString()
.- Returns:
- Controls whether or not the adapter should automatically update.
- See Also:
AutoUpdate
-
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 returnAutoUpdate.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromautoUpdateAsString()
.- Returns:
- Controls whether or not the adapter should automatically update.
- See Also:
AutoUpdate
-
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 theisEmpty()
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()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<CreateAdapterRequest.Builder,CreateAdapterRequest>
- Specified by:
toBuilder
in classTextractRequest
-
builder
public static CreateAdapterRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends CreateAdapterRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCode
in classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForField
in classSdkRequest
-
-