Class FindMatchesParameters
- java.lang.Object
-
- software.amazon.awssdk.services.glue.model.FindMatchesParameters
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<FindMatchesParameters.Builder,FindMatchesParameters>
@Generated("software.amazon.awssdk:codegen") public final class FindMatchesParameters extends Object implements SdkPojo, Serializable, ToCopyableBuilder<FindMatchesParameters.Builder,FindMatchesParameters>
The parameters to configure the find matches transform.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceFindMatchesParameters.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description DoubleaccuracyCostTradeoff()The value that is selected when tuning your transform for a balance between accuracy and cost.static FindMatchesParameters.Builderbuilder()BooleanenforceProvidedLabels()The value to switch on or off to force the output to match the provided labels from users.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()DoubleprecisionRecallTradeoff()The value selected when tuning your transform for a balance between precision and recall.StringprimaryKeyColumnName()The name of a column that uniquely identifies rows in the source table.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends FindMatchesParameters.Builder>serializableBuilderClass()FindMatchesParameters.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
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
-
primaryKeyColumnName
public final String primaryKeyColumnName()
The name of a column that uniquely identifies rows in the source table. Used to help identify matching records.
- Returns:
- The name of a column that uniquely identifies rows in the source table. Used to help identify matching records.
-
precisionRecallTradeoff
public final Double precisionRecallTradeoff()
The value selected when tuning your transform for a balance between precision and recall. A value of 0.5 means no preference; a value of 1.0 means a bias purely for precision, and a value of 0.0 means a bias for recall. Because this is a tradeoff, choosing values close to 1.0 means very low recall, and choosing values close to 0.0 results in very low precision.
The precision metric indicates how often your model is correct when it predicts a match.
The recall metric indicates that for an actual match, how often your model predicts the match.
- Returns:
- The value selected when tuning your transform for a balance between precision and recall. A value of 0.5
means no preference; a value of 1.0 means a bias purely for precision, and a value of 0.0 means a bias
for recall. Because this is a tradeoff, choosing values close to 1.0 means very low recall, and choosing
values close to 0.0 results in very low precision.
The precision metric indicates how often your model is correct when it predicts a match.
The recall metric indicates that for an actual match, how often your model predicts the match.
-
accuracyCostTradeoff
public final Double accuracyCostTradeoff()
The value that is selected when tuning your transform for a balance between accuracy and cost. A value of 0.5 means that the system balances accuracy and cost concerns. A value of 1.0 means a bias purely for accuracy, which typically results in a higher cost, sometimes substantially higher. A value of 0.0 means a bias purely for cost, which results in a less accurate
FindMatchestransform, sometimes with unacceptable accuracy.Accuracy measures how well the transform finds true positives and true negatives. Increasing accuracy requires more machine resources and cost. But it also results in increased recall.
Cost measures how many compute resources, and thus money, are consumed to run the transform.
- Returns:
- The value that is selected when tuning your transform for a balance between accuracy and cost. A value of
0.5 means that the system balances accuracy and cost concerns. A value of 1.0 means a bias purely for
accuracy, which typically results in a higher cost, sometimes substantially higher. A value of 0.0 means
a bias purely for cost, which results in a less accurate
FindMatchestransform, sometimes with unacceptable accuracy.Accuracy measures how well the transform finds true positives and true negatives. Increasing accuracy requires more machine resources and cost. But it also results in increased recall.
Cost measures how many compute resources, and thus money, are consumed to run the transform.
-
enforceProvidedLabels
public final Boolean enforceProvidedLabels()
The value to switch on or off to force the output to match the provided labels from users. If the value is
True, thefind matchestransform forces the output to match the provided labels. The results override the normal conflation results. If the value isFalse, thefind matchestransform does not ensure all the labels provided are respected, and the results rely on the trained model.Note that setting this value to true may increase the conflation execution time.
- Returns:
- The value to switch on or off to force the output to match the provided labels from users. If the value
is
True, thefind matchestransform forces the output to match the provided labels. The results override the normal conflation results. If the value isFalse, thefind matchestransform does not ensure all the labels provided are respected, and the results rely on the trained model.Note that setting this value to true may increase the conflation execution time.
-
toBuilder
public FindMatchesParameters.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<FindMatchesParameters.Builder,FindMatchesParameters>
-
builder
public static FindMatchesParameters.Builder builder()
-
serializableBuilderClass
public static Class<? extends FindMatchesParameters.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin 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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-