com.azure.analytics.synapse.artifacts.models.DataFlow.yml

### YamlMime:JavaType
uid: "com.azure.analytics.synapse.artifacts.models.DataFlow"
fullName: "com.azure.analytics.synapse.artifacts.models.DataFlow"
name: "DataFlow"
nameWithType: "DataFlow"
summary: "Azure Synapse nested object which contains a flow with data movements and transformations."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
  methodsRef:
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
syntax: "public class **DataFlow**"
constructors:
- uid: "com.azure.analytics.synapse.artifacts.models.DataFlow.DataFlow()"
  fullName: "com.azure.analytics.synapse.artifacts.models.DataFlow.DataFlow()"
  name: "DataFlow()"
  nameWithType: "DataFlow.DataFlow()"
  summary: "Creates an instance of Data<wbr>Flow class."
  syntax: "public DataFlow()"
  desc: "Creates an instance of DataFlow class."
methods:
- uid: "com.azure.analytics.synapse.artifacts.models.DataFlow.getAnnotations()"
  fullName: "com.azure.analytics.synapse.artifacts.models.DataFlow.getAnnotations()"
  name: "getAnnotations()"
  nameWithType: "DataFlow.getAnnotations()"
  summary: "Get the annotations property: List of tags that can be used for describing the data flow."
  syntax: "public List<Object> getAnnotations()"
  desc: "Get the annotations property: List of tags that can be used for describing the data flow."
  returns:
    description: "the annotations value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>&gt;"
- uid: "com.azure.analytics.synapse.artifacts.models.DataFlow.getDescription()"
  fullName: "com.azure.analytics.synapse.artifacts.models.DataFlow.getDescription()"
  name: "getDescription()"
  nameWithType: "DataFlow.getDescription()"
  summary: "Get the description property: The description of the data flow."
  syntax: "public String getDescription()"
  desc: "Get the description property: The description of the data flow."
  returns:
    description: "the description value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.analytics.synapse.artifacts.models.DataFlow.getFolder()"
  fullName: "com.azure.analytics.synapse.artifacts.models.DataFlow.getFolder()"
  name: "getFolder()"
  nameWithType: "DataFlow.getFolder()"
  summary: "Get the folder property: The folder that this data flow is in."
  syntax: "public DataFlowFolder getFolder()"
  desc: "Get the folder property: The folder that this data flow is in. If not specified, Data flow will appear at the root level."
  returns:
    description: "the folder value."
    type: "<xref href=\"com.azure.analytics.synapse.artifacts.models.DataFlowFolder?alt=com.azure.analytics.synapse.artifacts.models.DataFlowFolder&text=DataFlowFolder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.analytics.synapse.artifacts.models.DataFlow.setAnnotations(java.util.List<java.lang.Object>)"
  fullName: "com.azure.analytics.synapse.artifacts.models.DataFlow.setAnnotations(List<Object> annotations)"
  name: "setAnnotations(List<Object> annotations)"
  nameWithType: "DataFlow.setAnnotations(List<Object> annotations)"
  summary: "Set the annotations property: List of tags that can be used for describing the data flow."
  parameters:
  - description: "the annotations value to set."
    name: "annotations"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>&gt;"
  syntax: "public DataFlow setAnnotations(List<Object> annotations)"
  desc: "Set the annotations property: List of tags that can be used for describing the data flow."
  returns:
    description: "the DataFlow object itself."
    type: "<xref href=\"com.azure.analytics.synapse.artifacts.models.DataFlow?alt=com.azure.analytics.synapse.artifacts.models.DataFlow&text=DataFlow\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.analytics.synapse.artifacts.models.DataFlow.setDescription(java.lang.String)"
  fullName: "com.azure.analytics.synapse.artifacts.models.DataFlow.setDescription(String description)"
  name: "setDescription(String description)"
  nameWithType: "DataFlow.setDescription(String description)"
  summary: "Set the description property: The description of the data flow."
  parameters:
  - description: "the description value to set."
    name: "description"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  syntax: "public DataFlow setDescription(String description)"
  desc: "Set the description property: The description of the data flow."
  returns:
    description: "the DataFlow object itself."
    type: "<xref href=\"com.azure.analytics.synapse.artifacts.models.DataFlow?alt=com.azure.analytics.synapse.artifacts.models.DataFlow&text=DataFlow\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.analytics.synapse.artifacts.models.DataFlow.setFolder(com.azure.analytics.synapse.artifacts.models.DataFlowFolder)"
  fullName: "com.azure.analytics.synapse.artifacts.models.DataFlow.setFolder(DataFlowFolder folder)"
  name: "setFolder(DataFlowFolder folder)"
  nameWithType: "DataFlow.setFolder(DataFlowFolder folder)"
  summary: "Set the folder property: The folder that this data flow is in."
  parameters:
  - description: "the folder value to set."
    name: "folder"
    type: "<xref href=\"com.azure.analytics.synapse.artifacts.models.DataFlowFolder?alt=com.azure.analytics.synapse.artifacts.models.DataFlowFolder&text=DataFlowFolder\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public DataFlow setFolder(DataFlowFolder folder)"
  desc: "Set the folder property: The folder that this data flow is in. If not specified, Data flow will appear at the root level."
  returns:
    description: "the DataFlow object itself."
    type: "<xref href=\"com.azure.analytics.synapse.artifacts.models.DataFlow?alt=com.azure.analytics.synapse.artifacts.models.DataFlow&text=DataFlow\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Azure Synapse nested object which contains a flow with data movements and transformations."
metadata: {}
package: "com.azure.analytics.synapse.artifacts.models"
artifact: com.azure:azure-analytics-synapse-artifacts:1.0.0-beta.15