Valid Address (ValidAddressGenerator)
The Valid Address generator replaces the source value with a real address value from the United States, Brazil, or Mexico.
Link object structure
The Valid Address generator can be self-consistent or consistent with another column. You cannot configure differential privacy. It can be linked to other columns.
The metadata object is populated from ValidAddressMetadata.
For the Valid Address generator, you select the country to use. You can either identify a specific country, or identify a column that contains the country. If the column does not contain a valid country value, then Structural uses the fallback generator.
For linked columns, Structural uses the same country for all of the columns.
After you configure the country, you specify the type of address value that is in the source column.
Here is the basic structure of a link object for the Valid Address generator.
{
"schema": "string",
"table": "string",
"column": "street",
"metadata": {
"presetId": "string",
"generatorId": "ValidAddressGenerator",
"country": "string", // Do not set if countryColumn is set.
"countryColumn": "string", // Do not set if country is set.
"addressComponent": "StreetAddress",
"isConsistent": boolean,
"consistencyColumn": "string",
"caseSensitiveConsistency": boolean
}
}Example replacement
The following example shows linked columns that are assigned the built-in generator preset for the Valid Address generator.
The request specifically sets the country to be the United States.
One column contains city names, and the other postal codes. Self-consistency is enabled and consistency is case-sensitive.
Last updated
Was this helpful?