Class TabularTranslator
- java.lang.Object
-
- com.azure.resourcemanager.datafactory.models.CopyTranslator
-
- com.azure.resourcemanager.datafactory.models.TabularTranslator
-
public final class TabularTranslator extends CopyTranslator
A copy activity tabular translator.
-
-
Constructor Summary
Constructors Constructor Description TabularTranslator()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Object
collectionReference()
Get the collectionReference property: The JSON Path of the Nested Array that is going to do cross-apply.Object
columnMappings()
Get the columnMappings property: Column mappings.Object
mapComplexValuesToString()
Get the mapComplexValuesToString property: Whether to map complex (array and object) values to simple strings in json format.Object
mappings()
Get the mappings property: Column mappings with logical types.Object
schemaMapping()
Get the schemaMapping property: The schema mapping to map between tabular data and hierarchical data.Object
typeConversion()
Get the typeConversion property: Whether to enable the advanced type conversion feature in the Copy activity.TypeConversionSettings
typeConversionSettings()
Get the typeConversionSettings property: Type conversion settings.void
validate()
Validates the instance.TabularTranslator
withCollectionReference(Object collectionReference)
Set the collectionReference property: The JSON Path of the Nested Array that is going to do cross-apply.TabularTranslator
withColumnMappings(Object columnMappings)
Set the columnMappings property: Column mappings.TabularTranslator
withMapComplexValuesToString(Object mapComplexValuesToString)
Set the mapComplexValuesToString property: Whether to map complex (array and object) values to simple strings in json format.TabularTranslator
withMappings(Object mappings)
Set the mappings property: Column mappings with logical types.TabularTranslator
withSchemaMapping(Object schemaMapping)
Set the schemaMapping property: The schema mapping to map between tabular data and hierarchical data.TabularTranslator
withTypeConversion(Object typeConversion)
Set the typeConversion property: Whether to enable the advanced type conversion feature in the Copy activity.TabularTranslator
withTypeConversionSettings(TypeConversionSettings typeConversionSettings)
Set the typeConversionSettings property: Type conversion settings.-
Methods inherited from class com.azure.resourcemanager.datafactory.models.CopyTranslator
additionalProperties, withAdditionalProperties
-
-
-
-
Method Detail
-
columnMappings
public Object columnMappings()
Get the columnMappings property: Column mappings. Example: "UserId: MyUserId, Group: MyGroup, Name: MyName" Type: string (or Expression with resultType string). This property will be retired. Please use mappings property.- Returns:
- the columnMappings value.
-
withColumnMappings
public TabularTranslator withColumnMappings(Object columnMappings)
Set the columnMappings property: Column mappings. Example: "UserId: MyUserId, Group: MyGroup, Name: MyName" Type: string (or Expression with resultType string). This property will be retired. Please use mappings property.- Parameters:
columnMappings
- the columnMappings value to set.- Returns:
- the TabularTranslator object itself.
-
schemaMapping
public Object schemaMapping()
Get the schemaMapping property: The schema mapping to map between tabular data and hierarchical data. Example: {"Column1": "$.Column1", "Column2": "$.Column2.Property1", "Column3": "$.Column2.Property2"}. Type: object (or Expression with resultType object). This property will be retired. Please use mappings property.- Returns:
- the schemaMapping value.
-
withSchemaMapping
public TabularTranslator withSchemaMapping(Object schemaMapping)
Set the schemaMapping property: The schema mapping to map between tabular data and hierarchical data. Example: {"Column1": "$.Column1", "Column2": "$.Column2.Property1", "Column3": "$.Column2.Property2"}. Type: object (or Expression with resultType object). This property will be retired. Please use mappings property.- Parameters:
schemaMapping
- the schemaMapping value to set.- Returns:
- the TabularTranslator object itself.
-
collectionReference
public Object collectionReference()
Get the collectionReference property: The JSON Path of the Nested Array that is going to do cross-apply. Type: object (or Expression with resultType object).- Returns:
- the collectionReference value.
-
withCollectionReference
public TabularTranslator withCollectionReference(Object collectionReference)
Set the collectionReference property: The JSON Path of the Nested Array that is going to do cross-apply. Type: object (or Expression with resultType object).- Parameters:
collectionReference
- the collectionReference value to set.- Returns:
- the TabularTranslator object itself.
-
mapComplexValuesToString
public Object mapComplexValuesToString()
Get the mapComplexValuesToString property: Whether to map complex (array and object) values to simple strings in json format. Type: boolean (or Expression with resultType boolean).- Returns:
- the mapComplexValuesToString value.
-
withMapComplexValuesToString
public TabularTranslator withMapComplexValuesToString(Object mapComplexValuesToString)
Set the mapComplexValuesToString property: Whether to map complex (array and object) values to simple strings in json format. Type: boolean (or Expression with resultType boolean).- Parameters:
mapComplexValuesToString
- the mapComplexValuesToString value to set.- Returns:
- the TabularTranslator object itself.
-
mappings
public Object mappings()
Get the mappings property: Column mappings with logical types. Tabular->tabular example: [{"source":{"name":"CustomerName","type":"String"},"sink":{"name":"ClientName","type":"String"}}" + ",{"source":{"name":"CustomerAddress","type":"String"},"sink":{"name":"ClientAddress","type":"String"}}]. Hierarchical->tabular example: [{"source":{"path":"$" + ".CustomerName","type":"String"},"sink":{"name":"ClientName","type":"String"}},{"source":{"path":"$" + ".CustomerAddress","type":"String"},"sink":{"name":"ClientAddress","type":"String"}}]. Type: object (or Expression with resultType object).- Returns:
- the mappings value.
-
withMappings
public TabularTranslator withMappings(Object mappings)
Set the mappings property: Column mappings with logical types. Tabular->tabular example: [{"source":{"name":"CustomerName","type":"String"},"sink":{"name":"ClientName","type":"String"}}" + ",{"source":{"name":"CustomerAddress","type":"String"},"sink":{"name":"ClientAddress","type":"String"}}]. Hierarchical->tabular example: [{"source":{"path":"$" + ".CustomerName","type":"String"},"sink":{"name":"ClientName","type":"String"}},{"source":{"path":"$" + ".CustomerAddress","type":"String"},"sink":{"name":"ClientAddress","type":"String"}}]. Type: object (or Expression with resultType object).- Parameters:
mappings
- the mappings value to set.- Returns:
- the TabularTranslator object itself.
-
typeConversion
public Object typeConversion()
Get the typeConversion property: Whether to enable the advanced type conversion feature in the Copy activity. Type: boolean (or Expression with resultType boolean).- Returns:
- the typeConversion value.
-
withTypeConversion
public TabularTranslator withTypeConversion(Object typeConversion)
Set the typeConversion property: Whether to enable the advanced type conversion feature in the Copy activity. Type: boolean (or Expression with resultType boolean).- Parameters:
typeConversion
- the typeConversion value to set.- Returns:
- the TabularTranslator object itself.
-
typeConversionSettings
public TypeConversionSettings typeConversionSettings()
Get the typeConversionSettings property: Type conversion settings.- Returns:
- the typeConversionSettings value.
-
withTypeConversionSettings
public TabularTranslator withTypeConversionSettings(TypeConversionSettings typeConversionSettings)
Set the typeConversionSettings property: Type conversion settings.- Parameters:
typeConversionSettings
- the typeConversionSettings value to set.- Returns:
- the TabularTranslator object itself.
-
validate
public void validate()
Validates the instance.- Overrides:
validate
in classCopyTranslator
- Throws:
IllegalArgumentException
- thrown if the instance is not valid.
-
-