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>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
GetAdapterVersionResponse.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description String
adapterId()
A string containing a unique ID for the adapter version being retrieved.String
adapterVersion()
A string containing the adapter version that has been retrieved.static GetAdapterVersionResponse.Builder
builder()
Instant
creationTime()
The time that the adapter version was created.AdapterVersionDatasetConfig
datasetConfig()
Specifies a dataset used to train a new adapter version.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
List<AdapterVersionEvaluationMetric>
evaluationMetrics()
The evaluation metrics (F1 score, Precision, and Recall) for the requested version, grouped by baseline metrics and adapter version.List<FeatureType>
featureTypes()
List of the targeted feature types for the requested adapter version.List<String>
featureTypesAsStrings()
List of the targeted feature types for the requested adapter version.<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
boolean
hasEvaluationMetrics()
For responses, this returns true if the service returned a value for the EvaluationMetrics property.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.String
kmsKeyId()
The identifier for your AWS Key Management Service key (AWS KMS key).OutputConfig
outputConfig()
Returns the value of the OutputConfig property for this object.List<SdkField<?>>
sdkFields()
static Class<? extends GetAdapterVersionResponse.Builder>
serializableBuilderClass()
AdapterVersionStatus
status()
The status of the adapter version that has been requested.String
statusAsString()
The status of the adapter version that has been requested.String
statusMessage()
A message that describes the status of the requested adapter version.Map<String,String>
tags()
A set of tags (key-value pairs) that are associated with the adapter version.GetAdapterVersionResponse.Builder
toBuilder()
String
toString()
Returns a string representation of this object.-
Methods inherited from class software.amazon.awssdk.services.textract.model.TextractResponse
responseMetadata
-
Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse
-
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
-
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 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()
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 returnAdapterVersionStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of the adapter version that has been requested.
- See Also:
AdapterVersionStatus
-
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 returnAdapterVersionStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of the adapter version that has been requested.
- See Also:
AdapterVersionStatus
-
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 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.
-
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 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 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()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<GetAdapterVersionResponse.Builder,GetAdapterVersionResponse>
- Specified by:
toBuilder
in classAwsResponse
-
builder
public static GetAdapterVersionResponse.Builder builder()
-
serializableBuilderClass
public static Class<? extends GetAdapterVersionResponse.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCode
in classAwsResponse
-
equals
public final boolean equals(Object obj)
- Overrides:
equals
in classAwsResponse
-
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 classSdkResponse
-
-