GetAdapterVersionResult (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceResult<ResponseMetadata>
- - com.amazonaws.services.textract.model.GetAdapterVersionResult

All Implemented Interfaces:: Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class GetAdapterVersionResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

GetAdapterVersionResult()

Constructors
Constructor and Description
`GetAdapterVersionResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GetAdapterVersionResult`	`addTagsEntry(String key, String value)` Add a single Tags entry
`GetAdapterVersionResult`	`clearTagsEntries()` Removes all the entries added into Tags.
`GetAdapterVersionResult`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAdapterId()` A string containing a unique ID for the adapter version being retrieved.
`String`	`getAdapterVersion()` A string containing the adapter version that has been retrieved.
`Date`	`getCreationTime()` The time that the adapter version was created.
`AdapterVersionDatasetConfig`	`getDatasetConfig()` Specifies a dataset used to train a new adapter version.
`List<AdapterVersionEvaluationMetric>`	`getEvaluationMetrics()` The evaluation metrics (F1 score, Precision, and Recall) for the requested version, grouped by baseline metrics and adapter version.
`List<String>`	`getFeatureTypes()` List of the targeted feature types for the requested adapter version.
`String`	`getKMSKeyId()` The identifier for your AWS Key Management Service key (AWS KMS key).
`OutputConfig`	`getOutputConfig()`
`String`	`getStatus()` The status of the adapter version that has been requested.
`String`	`getStatusMessage()` A message that describes the status of the requested adapter version.
`Map<String,String>`	`getTags()` A set of tags (key-value pairs) that are associated with the adapter version.
`int`	`hashCode()`
`void`	`setAdapterId(String adapterId)` A string containing a unique ID for the adapter version being retrieved.
`void`	`setAdapterVersion(String adapterVersion)` A string containing the adapter version that has been retrieved.
`void`	`setCreationTime(Date creationTime)` The time that the adapter version was created.
`void`	`setDatasetConfig(AdapterVersionDatasetConfig datasetConfig)` Specifies a dataset used to train a new adapter version.
`void`	`setEvaluationMetrics(Collection<AdapterVersionEvaluationMetric> evaluationMetrics)` The evaluation metrics (F1 score, Precision, and Recall) for the requested version, grouped by baseline metrics and adapter version.
`void`	`setFeatureTypes(Collection<String> featureTypes)` List of the targeted feature types for the requested adapter version.
`void`	`setKMSKeyId(String kMSKeyId)` The identifier for your AWS Key Management Service key (AWS KMS key).
`void`	`setOutputConfig(OutputConfig outputConfig)`
`void`	`setStatus(String status)` The status of the adapter version that has been requested.
`void`	`setStatusMessage(String statusMessage)` A message that describes the status of the requested adapter version.
`void`	`setTags(Map<String,String> tags)` A set of tags (key-value pairs) that are associated with the adapter version.
`String`	`toString()` Returns a string representation of this object.
`GetAdapterVersionResult`	`withAdapterId(String adapterId)` A string containing a unique ID for the adapter version being retrieved.
`GetAdapterVersionResult`	`withAdapterVersion(String adapterVersion)` A string containing the adapter version that has been retrieved.
`GetAdapterVersionResult`	`withCreationTime(Date creationTime)` The time that the adapter version was created.
`GetAdapterVersionResult`	`withDatasetConfig(AdapterVersionDatasetConfig datasetConfig)` Specifies a dataset used to train a new adapter version.
`GetAdapterVersionResult`	`withEvaluationMetrics(AdapterVersionEvaluationMetric... evaluationMetrics)` The evaluation metrics (F1 score, Precision, and Recall) for the requested version, grouped by baseline metrics and adapter version.
`GetAdapterVersionResult`	`withEvaluationMetrics(Collection<AdapterVersionEvaluationMetric> evaluationMetrics)` The evaluation metrics (F1 score, Precision, and Recall) for the requested version, grouped by baseline metrics and adapter version.
`GetAdapterVersionResult`	`withFeatureTypes(Collection<String> featureTypes)` List of the targeted feature types for the requested adapter version.
`GetAdapterVersionResult`	`withFeatureTypes(FeatureType... featureTypes)` List of the targeted feature types for the requested adapter version.
`GetAdapterVersionResult`	`withFeatureTypes(String... featureTypes)` List of the targeted feature types for the requested adapter version.
`GetAdapterVersionResult`	`withKMSKeyId(String kMSKeyId)` The identifier for your AWS Key Management Service key (AWS KMS key).
`GetAdapterVersionResult`	`withOutputConfig(OutputConfig outputConfig)`
`GetAdapterVersionResult`	`withStatus(AdapterVersionStatus status)` The status of the adapter version that has been requested.
`GetAdapterVersionResult`	`withStatus(String status)` The status of the adapter version that has been requested.
`GetAdapterVersionResult`	`withStatusMessage(String statusMessage)` A message that describes the status of the requested adapter version.
`GetAdapterVersionResult`	`withTags(Map<String,String> tags)` A set of tags (key-value pairs) that are associated with the adapter version.

Methods inherited from class com.amazonaws.AmazonWebServiceResult
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - GetAdapterVersionResult
```
public GetAdapterVersionResult()
```
- Method Detail
  - setAdapterId
```
public void setAdapterId(String adapterId)
```
    A string containing a unique ID for the adapter version being retrieved.
    
    Parameters:
    
    adapterId - A string containing a unique ID for the adapter version being retrieved.
  - getAdapterId
```
public String getAdapterId()
```
    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.
  - withAdapterId
```
public GetAdapterVersionResult withAdapterId(String adapterId)
```
    A string containing a unique ID for the adapter version being retrieved.
    
    Parameters:
    
    adapterId - A string containing a unique ID for the adapter version being retrieved.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAdapterVersion
```
public void setAdapterVersion(String adapterVersion)
```
    A string containing the adapter version that has been retrieved.
    
    Parameters:
    
    adapterVersion - A string containing the adapter version that has been retrieved.
  - getAdapterVersion
```
public String getAdapterVersion()
```
    A string containing the adapter version that has been retrieved.
    
    Returns:
    
    A string containing the adapter version that has been retrieved.
  - withAdapterVersion
```
public GetAdapterVersionResult withAdapterVersion(String adapterVersion)
```
    A string containing the adapter version that has been retrieved.
    
    Parameters:
    
    adapterVersion - A string containing the adapter version that has been retrieved.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreationTime
```
public void setCreationTime(Date creationTime)
```
    The time that the adapter version was created.
    
    Parameters:
    
    creationTime - The time that the adapter version was created.
  - getCreationTime
```
public Date getCreationTime()
```
    The time that the adapter version was created.
    
    Returns:
    
    The time that the adapter version was created.
  - withCreationTime
```
public GetAdapterVersionResult withCreationTime(Date creationTime)
```
    The time that the adapter version was created.
    
    Parameters:
    
    creationTime - The time that the adapter version was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getFeatureTypes
```
public List<String> getFeatureTypes()
```
    List of the targeted feature types for the requested adapter version.
    
    Returns:
    
    List of the targeted feature types for the requested adapter version.
    
    See Also:
    
    FeatureType
  - setFeatureTypes
```
public void setFeatureTypes(Collection<String> featureTypes)
```
    List of the targeted feature types for the requested adapter version.
    
    Parameters:
    
    featureTypes - List of the targeted feature types for the requested adapter version.
    
    See Also:
    
    FeatureType
  - withFeatureTypes
```
public GetAdapterVersionResult withFeatureTypes(String... featureTypes)
```
    List of the targeted feature types for the requested adapter version.
    
    NOTE: This method appends the values to the existing list (if any). Use setFeatureTypes(java.util.Collection) or withFeatureTypes(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    featureTypes - List of the targeted feature types for the requested adapter version.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    FeatureType
  - withFeatureTypes
```
public GetAdapterVersionResult withFeatureTypes(Collection<String> featureTypes)
```
    List of the targeted feature types for the requested adapter version.
    
    Parameters:
    
    featureTypes - List of the targeted feature types for the requested adapter version.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    FeatureType
  - withFeatureTypes
```
public GetAdapterVersionResult withFeatureTypes(FeatureType... featureTypes)
```
    List of the targeted feature types for the requested adapter version.
    
    Parameters:
    
    featureTypes - List of the targeted feature types for the requested adapter version.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    FeatureType
  - setStatus
```
public void setStatus(String status)
```
    The status of the adapter version that has been requested.
    
    Parameters:
    
    status - The status of the adapter version that has been requested.
    
    See Also:
    
    AdapterVersionStatus
  - getStatus
```
public String getStatus()
```
    The status of the adapter version that has been requested.
    
    Returns:
    
    The status of the adapter version that has been requested.
    
    See Also:
    
    AdapterVersionStatus
  - withStatus
```
public GetAdapterVersionResult withStatus(String status)
```
    The status of the adapter version that has been requested.
    
    Parameters:
    
    status - The status of the adapter version that has been requested.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AdapterVersionStatus
  - withStatus
```
public GetAdapterVersionResult withStatus(AdapterVersionStatus status)
```
    The status of the adapter version that has been requested.
    
    Parameters:
    
    status - The status of the adapter version that has been requested.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AdapterVersionStatus
  - setStatusMessage
```
public void setStatusMessage(String statusMessage)
```
    A message that describes the status of the requested adapter version.
    
    Parameters:
    
    statusMessage - A message that describes the status of the requested adapter version.
  - getStatusMessage
```
public String getStatusMessage()
```
    A message that describes the status of the requested adapter version.
    
    Returns:
    
    A message that describes the status of the requested adapter version.
  - withStatusMessage
```
public GetAdapterVersionResult withStatusMessage(String statusMessage)
```
    A message that describes the status of the requested adapter version.
    
    Parameters:
    
    statusMessage - A message that describes the status of the requested adapter version.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDatasetConfig
```
public void setDatasetConfig(AdapterVersionDatasetConfig datasetConfig)
```
    Specifies a dataset used to train a new adapter version. Takes a ManifestS3Objec as the value.
    
    Parameters:
    
    datasetConfig - Specifies a dataset used to train a new adapter version. Takes a ManifestS3Objec as the value.
  - getDatasetConfig
```
public AdapterVersionDatasetConfig getDatasetConfig()
```
    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.
  - withDatasetConfig
```
public GetAdapterVersionResult withDatasetConfig(AdapterVersionDatasetConfig datasetConfig)
```
    Specifies a dataset used to train a new adapter version. Takes a ManifestS3Objec as the value.
    
    Parameters:
    
    datasetConfig - Specifies a dataset used to train a new adapter version. Takes a ManifestS3Objec as the value.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setKMSKeyId
```
public void setKMSKeyId(String kMSKeyId)
```
    The identifier for your AWS Key Management Service key (AWS KMS key). Used to encrypt your documents.
    
    Parameters:
    
    kMSKeyId - The identifier for your AWS Key Management Service key (AWS KMS key). Used to encrypt your documents.
  - getKMSKeyId
```
public String getKMSKeyId()
```
    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.
  - withKMSKeyId
```
public GetAdapterVersionResult withKMSKeyId(String kMSKeyId)
```
    The identifier for your AWS Key Management Service key (AWS KMS key). Used to encrypt your documents.
    
    Parameters:
    
    kMSKeyId - The identifier for your AWS Key Management Service key (AWS KMS key). Used to encrypt your documents.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOutputConfig
```
public void setOutputConfig(OutputConfig outputConfig)
```
    Parameters:
    
    outputConfig -
  - getOutputConfig
```
public OutputConfig getOutputConfig()
```
    Returns:
  - withOutputConfig
```
public GetAdapterVersionResult withOutputConfig(OutputConfig outputConfig)
```
    Parameters:
    
    outputConfig -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getEvaluationMetrics
```
public List<AdapterVersionEvaluationMetric> getEvaluationMetrics()
```
    The evaluation metrics (F1 score, Precision, and Recall) for the requested version, grouped by baseline metrics and adapter version.
    
    Returns:
    
    The evaluation metrics (F1 score, Precision, and Recall) for the requested version, grouped by baseline metrics and adapter version.
  - setEvaluationMetrics
```
public void setEvaluationMetrics(Collection<AdapterVersionEvaluationMetric> evaluationMetrics)
```
    The evaluation metrics (F1 score, Precision, and Recall) for the requested version, grouped by baseline metrics and adapter version.
    
    Parameters:
    
    evaluationMetrics - The evaluation metrics (F1 score, Precision, and Recall) for the requested version, grouped by baseline metrics and adapter version.
  - withEvaluationMetrics
```
public GetAdapterVersionResult withEvaluationMetrics(AdapterVersionEvaluationMetric... evaluationMetrics)
```
    The evaluation metrics (F1 score, Precision, and Recall) for the requested version, grouped by baseline metrics and adapter version.
    
    NOTE: This method appends the values to the existing list (if any). Use setEvaluationMetrics(java.util.Collection) or withEvaluationMetrics(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    evaluationMetrics - The evaluation metrics (F1 score, Precision, and Recall) for the requested version, grouped by baseline metrics and adapter version.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withEvaluationMetrics
```
public GetAdapterVersionResult withEvaluationMetrics(Collection<AdapterVersionEvaluationMetric> evaluationMetrics)
```
    The evaluation metrics (F1 score, Precision, and Recall) for the requested version, grouped by baseline metrics and adapter version.
    
    Parameters:
    
    evaluationMetrics - The evaluation metrics (F1 score, Precision, and Recall) for the requested version, grouped by baseline metrics and adapter version.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTags
```
public Map<String,String> getTags()
```
    A set of tags (key-value pairs) that are associated with the adapter version.
    
    Returns:
    
    A set of tags (key-value pairs) that are associated with the adapter version.
  - setTags
```
public void setTags(Map<String,String> tags)
```
    A set of tags (key-value pairs) that are associated with the adapter version.
    
    Parameters:
    
    tags - A set of tags (key-value pairs) that are associated with the adapter version.
  - withTags
```
public GetAdapterVersionResult withTags(Map<String,String> tags)
```
    A set of tags (key-value pairs) that are associated with the adapter version.
    
    Parameters:
    
    tags - A set of tags (key-value pairs) that are associated with the adapter version.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addTagsEntry
```
public GetAdapterVersionResult addTagsEntry(String key,
                                            String value)
```
    Add a single Tags entry
    
    See Also:
    
    withTags(java.util.Map<java.lang.String, java.lang.String>)
  - clearTagsEntries
```
public GetAdapterVersionResult clearTagsEntries()
```
    Removes all the entries added into Tags.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public GetAdapterVersionResult clone()
```
    Overrides:
    
    clone in class Object

AWS SDK for Java 1.x API Reference - 1.12.780

Class GetAdapterVersionResult

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceResult

Methods inherited from class java.lang.Object

Constructor Detail

GetAdapterVersionResult

Method Detail

setAdapterId

getAdapterId

withAdapterId

setAdapterVersion

getAdapterVersion

withAdapterVersion

setCreationTime

getCreationTime

withCreationTime

getFeatureTypes

setFeatureTypes

withFeatureTypes

withFeatureTypes

withFeatureTypes

setStatus

getStatus

withStatus

withStatus

setStatusMessage

getStatusMessage

withStatusMessage

setDatasetConfig

getDatasetConfig

withDatasetConfig

setKMSKeyId

getKMSKeyId

withKMSKeyId

setOutputConfig

getOutputConfig

withOutputConfig

getEvaluationMetrics

setEvaluationMetrics

withEvaluationMetrics

withEvaluationMetrics

getTags

setTags

withTags

addTagsEntry

clearTagsEntries

toString

equals

hashCode

clone