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

Interface GetAdapterVersionResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<GetAdapterVersionResponse.Builder,GetAdapterVersionResponse>, SdkBuilder<GetAdapterVersionResponse.Builder,GetAdapterVersionResponse>, SdkPojo, SdkResponse.Builder, TextractResponse.Builder

Enclosing class:

GetAdapterVersionResponse

public static interface GetAdapterVersionResponse.Builder
extends TextractResponse.Builder, SdkPojo, CopyableBuilder<GetAdapterVersionResponse.Builder,GetAdapterVersionResponse>

Method Summary

Modifier and Type	Method	Description
GetAdapterVersionResponse.Builder	adapterId(String adapterId)	A string containing a unique ID for the adapter version being retrieved.
GetAdapterVersionResponse.Builder	adapterVersion(String adapterVersion)	A string containing the adapter version that has been retrieved.
GetAdapterVersionResponse.Builder	creationTime(Instant creationTime)	The time that the adapter version was created.
default GetAdapterVersionResponse.Builder	datasetConfig(Consumer<AdapterVersionDatasetConfig.Builder> datasetConfig)	Specifies a dataset used to train a new adapter version.
GetAdapterVersionResponse.Builder	datasetConfig(AdapterVersionDatasetConfig datasetConfig)	Specifies a dataset used to train a new adapter version.
GetAdapterVersionResponse.Builder	evaluationMetrics(Collection<AdapterVersionEvaluationMetric> evaluationMetrics)	The evaluation metrics (F1 score, Precision, and Recall) for the requested version, grouped by baseline metrics and adapter version.
GetAdapterVersionResponse.Builder	evaluationMetrics(Consumer<AdapterVersionEvaluationMetric.Builder>... evaluationMetrics)	The evaluation metrics (F1 score, Precision, and Recall) for the requested version, grouped by baseline metrics and adapter version.
GetAdapterVersionResponse.Builder	evaluationMetrics(AdapterVersionEvaluationMetric... evaluationMetrics)	The evaluation metrics (F1 score, Precision, and Recall) for the requested version, grouped by baseline metrics and adapter version.
GetAdapterVersionResponse.Builder	featureTypes(Collection<FeatureType> featureTypes)	List of the targeted feature types for the requested adapter version.
GetAdapterVersionResponse.Builder	featureTypes(FeatureType... featureTypes)	List of the targeted feature types for the requested adapter version.
GetAdapterVersionResponse.Builder	featureTypesWithStrings(String... featureTypes)	List of the targeted feature types for the requested adapter version.
GetAdapterVersionResponse.Builder	featureTypesWithStrings(Collection<String> featureTypes)	List of the targeted feature types for the requested adapter version.
GetAdapterVersionResponse.Builder	kmsKeyId(String kmsKeyId)	The identifier for your AWS Key Management Service key (AWS KMS key).
default GetAdapterVersionResponse.Builder	outputConfig(Consumer<OutputConfig.Builder> outputConfig)	Sets the value of the OutputConfig property for this object.
GetAdapterVersionResponse.Builder	outputConfig(OutputConfig outputConfig)	Sets the value of the OutputConfig property for this object.
GetAdapterVersionResponse.Builder	status(String status)	The status of the adapter version that has been requested.
GetAdapterVersionResponse.Builder	status(AdapterVersionStatus status)	The status of the adapter version that has been requested.
GetAdapterVersionResponse.Builder	statusMessage(String statusMessage)	A message that describes the status of the requested adapter version.
GetAdapterVersionResponse.Builder	tags(Map<String,String> tags)	A set of tags (key-value pairs) that are associated with the adapter version.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Methods inherited from interface software.amazon.awssdk.services.textract.model.TextractResponse.Builder

build, responseMetadata, responseMetadata

Method Details

adapterId

GetAdapterVersionResponse.Builder adapterId(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.

adapterVersion

GetAdapterVersionResponse.Builder adapterVersion(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.

creationTime

GetAdapterVersionResponse.Builder creationTime(Instant 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.

featureTypesWithStrings

GetAdapterVersionResponse.Builder featureTypesWithStrings(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.

featureTypesWithStrings

GetAdapterVersionResponse.Builder featureTypesWithStrings(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.

featureTypes

GetAdapterVersionResponse.Builder featureTypes(Collection<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.

featureTypes

GetAdapterVersionResponse.Builder featureTypes(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.

status

GetAdapterVersionResponse.Builder status(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
• AdapterVersionStatus

status

GetAdapterVersionResponse.Builder status(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
• AdapterVersionStatus

statusMessage

GetAdapterVersionResponse.Builder statusMessage(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.

datasetConfig

GetAdapterVersionResponse.Builder datasetConfig(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.

datasetConfig

default GetAdapterVersionResponse.Builder datasetConfig(Consumer<AdapterVersionDatasetConfig.Builder> datasetConfig)

Specifies a dataset used to train a new adapter version. Takes a ManifestS3Objec as the value.

This is a convenience method that creates an instance of the AdapterVersionDatasetConfig.Builder avoiding the need to create one manually via AdapterVersionDatasetConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to datasetConfig(AdapterVersionDatasetConfig).

Parameters:

datasetConfig - a consumer that will call methods on AdapterVersionDatasetConfig.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• datasetConfig(AdapterVersionDatasetConfig)

kmsKeyId

GetAdapterVersionResponse.Builder kmsKeyId(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.

outputConfig

GetAdapterVersionResponse.Builder outputConfig(OutputConfig outputConfig)

Sets the value of the OutputConfig property for this object.

Parameters:

outputConfig - The new value for the OutputConfig property for this object.

Returns:

Returns a reference to this object so that method calls can be chained together.

outputConfig

default GetAdapterVersionResponse.Builder outputConfig(Consumer<OutputConfig.Builder> outputConfig)

Sets the value of the OutputConfig property for this object. This is a convenience method that creates an instance of the OutputConfig.Builder avoiding the need to create one manually via OutputConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to outputConfig(OutputConfig).

Parameters:

outputConfig - a consumer that will call methods on OutputConfig.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• outputConfig(OutputConfig)

evaluationMetrics

GetAdapterVersionResponse.Builder evaluationMetrics(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.

evaluationMetrics

GetAdapterVersionResponse.Builder evaluationMetrics(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.

evaluationMetrics

GetAdapterVersionResponse.Builder evaluationMetrics(Consumer<AdapterVersionEvaluationMetric.Builder>... evaluationMetrics)

The evaluation metrics (F1 score, Precision, and Recall) for the requested version, grouped by baseline metrics and adapter version.

This is a convenience method that creates an instance of the AdapterVersionEvaluationMetric.Builder avoiding the need to create one manually via AdapterVersionEvaluationMetric.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to evaluationMetrics(List<AdapterVersionEvaluationMetric>).

Parameters:

evaluationMetrics - a consumer that will call methods on AdapterVersionEvaluationMetric.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• evaluationMetrics(java.util.Collection<AdapterVersionEvaluationMetric>)

tags

GetAdapterVersionResponse.Builder tags(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.