AWS SDK for C++  1.8.95
AWS SDK for C++
Public Member Functions | List of all members
Aws::Glue::Model::FindMatchesParameters Class Reference

#include <FindMatchesParameters.h>

Public Member Functions

 FindMatchesParameters ()
 
 FindMatchesParameters (Aws::Utils::Json::JsonView jsonValue)
 
FindMatchesParametersoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetPrimaryKeyColumnName () const
 
bool PrimaryKeyColumnNameHasBeenSet () const
 
void SetPrimaryKeyColumnName (const Aws::String &value)
 
void SetPrimaryKeyColumnName (Aws::String &&value)
 
void SetPrimaryKeyColumnName (const char *value)
 
FindMatchesParametersWithPrimaryKeyColumnName (const Aws::String &value)
 
FindMatchesParametersWithPrimaryKeyColumnName (Aws::String &&value)
 
FindMatchesParametersWithPrimaryKeyColumnName (const char *value)
 
double GetPrecisionRecallTradeoff () const
 
bool PrecisionRecallTradeoffHasBeenSet () const
 
void SetPrecisionRecallTradeoff (double value)
 
FindMatchesParametersWithPrecisionRecallTradeoff (double value)
 
double GetAccuracyCostTradeoff () const
 
bool AccuracyCostTradeoffHasBeenSet () const
 
void SetAccuracyCostTradeoff (double value)
 
FindMatchesParametersWithAccuracyCostTradeoff (double value)
 
bool GetEnforceProvidedLabels () const
 
bool EnforceProvidedLabelsHasBeenSet () const
 
void SetEnforceProvidedLabels (bool value)
 
FindMatchesParametersWithEnforceProvidedLabels (bool value)
 

Detailed Description

The parameters to configure the find matches transform.

See Also:

AWS API Reference

Definition at line 32 of file FindMatchesParameters.h.

Constructor & Destructor Documentation

◆ FindMatchesParameters() [1/2]

Aws::Glue::Model::FindMatchesParameters::FindMatchesParameters ( )

◆ FindMatchesParameters() [2/2]

Aws::Glue::Model::FindMatchesParameters::FindMatchesParameters ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AccuracyCostTradeoffHasBeenSet()

bool Aws::Glue::Model::FindMatchesParameters::AccuracyCostTradeoffHasBeenSet ( ) const
inline

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 FindMatches transform, 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.

Definition at line 165 of file FindMatchesParameters.h.

◆ EnforceProvidedLabelsHasBeenSet()

bool Aws::Glue::Model::FindMatchesParameters::EnforceProvidedLabelsHasBeenSet ( ) const
inline

The value to switch on or off to force the output to match the provided labels from users. If the value is True, the find matches transform forces the output to match the provided labels. The results override the normal conflation results. If the value is False, the find matches transform 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.

Definition at line 218 of file FindMatchesParameters.h.

◆ GetAccuracyCostTradeoff()

double Aws::Glue::Model::FindMatchesParameters::GetAccuracyCostTradeoff ( ) const
inline

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 FindMatches transform, 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.

Definition at line 151 of file FindMatchesParameters.h.

◆ GetEnforceProvidedLabels()

bool Aws::Glue::Model::FindMatchesParameters::GetEnforceProvidedLabels ( ) const
inline

The value to switch on or off to force the output to match the provided labels from users. If the value is True, the find matches transform forces the output to match the provided labels. The results override the normal conflation results. If the value is False, the find matches transform 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.

Definition at line 206 of file FindMatchesParameters.h.

◆ GetPrecisionRecallTradeoff()

double Aws::Glue::Model::FindMatchesParameters::GetPrecisionRecallTradeoff ( ) const
inline

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.

Definition at line 100 of file FindMatchesParameters.h.

◆ GetPrimaryKeyColumnName()

const Aws::String& Aws::Glue::Model::FindMatchesParameters::GetPrimaryKeyColumnName ( ) const
inline

The name of a column that uniquely identifies rows in the source table. Used to help identify matching records.

Definition at line 45 of file FindMatchesParameters.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::Glue::Model::FindMatchesParameters::Jsonize ( ) const

◆ operator=()

FindMatchesParameters& Aws::Glue::Model::FindMatchesParameters::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ PrecisionRecallTradeoffHasBeenSet()

bool Aws::Glue::Model::FindMatchesParameters::PrecisionRecallTradeoffHasBeenSet ( ) const
inline

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.

Definition at line 112 of file FindMatchesParameters.h.

◆ PrimaryKeyColumnNameHasBeenSet()

bool Aws::Glue::Model::FindMatchesParameters::PrimaryKeyColumnNameHasBeenSet ( ) const
inline

The name of a column that uniquely identifies rows in the source table. Used to help identify matching records.

Definition at line 51 of file FindMatchesParameters.h.

◆ SetAccuracyCostTradeoff()

void Aws::Glue::Model::FindMatchesParameters::SetAccuracyCostTradeoff ( double  value)
inline

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 FindMatches transform, 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.

Definition at line 179 of file FindMatchesParameters.h.

◆ SetEnforceProvidedLabels()

void Aws::Glue::Model::FindMatchesParameters::SetEnforceProvidedLabels ( bool  value)
inline

The value to switch on or off to force the output to match the provided labels from users. If the value is True, the find matches transform forces the output to match the provided labels. The results override the normal conflation results. If the value is False, the find matches transform 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.

Definition at line 230 of file FindMatchesParameters.h.

◆ SetPrecisionRecallTradeoff()

void Aws::Glue::Model::FindMatchesParameters::SetPrecisionRecallTradeoff ( double  value)
inline

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.

Definition at line 124 of file FindMatchesParameters.h.

◆ SetPrimaryKeyColumnName() [1/3]

void Aws::Glue::Model::FindMatchesParameters::SetPrimaryKeyColumnName ( const Aws::String value)
inline

The name of a column that uniquely identifies rows in the source table. Used to help identify matching records.

Definition at line 57 of file FindMatchesParameters.h.

◆ SetPrimaryKeyColumnName() [2/3]

void Aws::Glue::Model::FindMatchesParameters::SetPrimaryKeyColumnName ( Aws::String &&  value)
inline

The name of a column that uniquely identifies rows in the source table. Used to help identify matching records.

Definition at line 63 of file FindMatchesParameters.h.

◆ SetPrimaryKeyColumnName() [3/3]

void Aws::Glue::Model::FindMatchesParameters::SetPrimaryKeyColumnName ( const char *  value)
inline

The name of a column that uniquely identifies rows in the source table. Used to help identify matching records.

Definition at line 69 of file FindMatchesParameters.h.

◆ WithAccuracyCostTradeoff()

FindMatchesParameters& Aws::Glue::Model::FindMatchesParameters::WithAccuracyCostTradeoff ( double  value)
inline

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 FindMatches transform, 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.

Definition at line 193 of file FindMatchesParameters.h.

◆ WithEnforceProvidedLabels()

FindMatchesParameters& Aws::Glue::Model::FindMatchesParameters::WithEnforceProvidedLabels ( bool  value)
inline

The value to switch on or off to force the output to match the provided labels from users. If the value is True, the find matches transform forces the output to match the provided labels. The results override the normal conflation results. If the value is False, the find matches transform 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.

Definition at line 242 of file FindMatchesParameters.h.

◆ WithPrecisionRecallTradeoff()

FindMatchesParameters& Aws::Glue::Model::FindMatchesParameters::WithPrecisionRecallTradeoff ( double  value)
inline

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.

Definition at line 136 of file FindMatchesParameters.h.

◆ WithPrimaryKeyColumnName() [1/3]

FindMatchesParameters& Aws::Glue::Model::FindMatchesParameters::WithPrimaryKeyColumnName ( const Aws::String value)
inline

The name of a column that uniquely identifies rows in the source table. Used to help identify matching records.

Definition at line 75 of file FindMatchesParameters.h.

◆ WithPrimaryKeyColumnName() [2/3]

FindMatchesParameters& Aws::Glue::Model::FindMatchesParameters::WithPrimaryKeyColumnName ( Aws::String &&  value)
inline

The name of a column that uniquely identifies rows in the source table. Used to help identify matching records.

Definition at line 81 of file FindMatchesParameters.h.

◆ WithPrimaryKeyColumnName() [3/3]

FindMatchesParameters& Aws::Glue::Model::FindMatchesParameters::WithPrimaryKeyColumnName ( const char *  value)
inline

The name of a column that uniquely identifies rows in the source table. Used to help identify matching records.

Definition at line 87 of file FindMatchesParameters.h.


The documentation for this class was generated from the following file: