DataFlow Class

Package:
com.azure.analytics.synapse.artifacts.models
Maven Artifact:
com.azure:azure-analytics-synapse-artifacts:1.0.0-beta.17
  • java.lang.Object
    • com.azure.analytics.synapse.artifacts.models.DataFlow

Implements

JsonSerializable<DataFlow>

public class DataFlow
implements JsonSerializable<DataFlow>

Azure Synapse nested object which contains a flow with data movements and transformations.

Constructor Summary

Constructor Description
DataFlow()

Creates an instance of DataFlow class.

Method Summary

Modifier and Type Method and Description
static DataFlow fromJson(JsonReader jsonReader)

Reads an instance of DataFlow from the JsonReader.
List<Object> getAnnotations()

Get the annotations property: List of tags that can be used for describing the data flow.
String getDescription()

Get the description property: The description of the data flow.
DataFlowFolder getFolder()

Get the folder property: The folder that this data flow is in.
String getType()

Get the type property: Type of data flow.
DataFlow setAnnotations(List<Object> annotations)

Set the annotations property: List of tags that can be used for describing the data flow.
DataFlow setDescription(String description)

Set the description property: The description of the data flow.
DataFlow setFolder(DataFlowFolder folder)

Set the folder property: The folder that this data flow is in.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

DataFlow

public DataFlow()

Creates an instance of DataFlow class.

Method Details

fromJson

public static DataFlow fromJson(JsonReader jsonReader)

Reads an instance of DataFlow from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of DataFlow if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

 - If an error occurs while reading the DataFlow.

getAnnotations

public List<Object> getAnnotations()

Get the annotations property: List of tags that can be used for describing the data flow.

Returns:

the annotations value.

getDescription

public String getDescription()

Get the description property: The description of the data flow.

Returns:

the description value.

getFolder

public DataFlowFolder getFolder()

Get the folder property: The folder that this data flow is in. If not specified, Data flow will appear at the root level.

Returns:

the folder value.

getType

public String getType()

Get the type property: Type of data flow.

Returns:

the type value.

setAnnotations

public DataFlow setAnnotations(List<Object> annotations)

Set the annotations property: List of tags that can be used for describing the data flow.

Parameters:

annotations - the annotations value to set.

Returns:

the DataFlow object itself.

setDescription

public DataFlow setDescription(String description)

Set the description property: The description of the data flow.

Parameters:

description - the description value to set.

Returns:

the DataFlow object itself.

setFolder

public DataFlow setFolder(DataFlowFolder folder)

Set the folder property: The folder that this data flow is in. If not specified, Data flow will appear at the root level.

Parameters:

folder - the folder value to set.

Returns:

the DataFlow object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to