-
Notifications
You must be signed in to change notification settings - Fork 232
/
azure.ai.ml.data_transfer.DataTransferImportComponent.yml
127 lines (117 loc) · 4.17 KB
/
azure.ai.ml.data_transfer.DataTransferImportComponent.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
### YamlMime:PythonClass
uid: azure.ai.ml.data_transfer.DataTransferImportComponent
name: DataTransferImportComponent
fullName: azure.ai.ml.data_transfer.DataTransferImportComponent
module: azure.ai.ml.data_transfer
inheritances:
- azure.ai.ml.entities._component.datatransfer_component.DataTransferComponent
summary: '> [!NOTE]
> This is an experimental class, and may change at any time. Please see [https://aka.ms/azuremlexperimental](https://aka.ms/azuremlexperimental)
for more information.
>
DataTransfer import component version, used to define a data transfer import component.'
constructor:
syntax: 'DataTransferImportComponent(*, source: Dict | None = None, outputs: Dict
| None = None, **kwargs: Any)'
parameters:
- name: source
description: The data source of the file system or database.
isRequired: true
types:
- <xref:dict>
- name: outputs
description: 'Mapping of output data bindings used in the job.
Default value is an output port with the key "sink" and the type "mltable".'
isRequired: true
types:
- <xref:dict>
- name: kwargs
description: Additional parameters for the data transfer import component.
isRequired: true
methods:
- uid: azure.ai.ml.data_transfer.DataTransferImportComponent.dump
name: dump
summary: Dump the component content into a file in yaml format.
signature: 'dump(dest: str | PathLike | IO, **kwargs: Any) -> None'
parameters:
- name: dest
description: 'The destination to receive this component''s content.
Must be either a path to a local file, or an already-open file stream.
If dest is a file path, a new file will be created,
and an exception is raised if the file exists.
If dest is an open file, the file will be written to directly,
and an exception will be raised if the file is not writable.'
isRequired: true
types:
- <xref:typing.Union>[<xref:PathLike>, <xref:str>, <xref:typing.IO>[<xref:typing.AnyStr>]]
attributes:
- uid: azure.ai.ml.data_transfer.DataTransferImportComponent.base_path
name: base_path
summary: The base path of the resource.
return:
description: The base path of the resource.
types:
- <xref:str>
- uid: azure.ai.ml.data_transfer.DataTransferImportComponent.creation_context
name: creation_context
summary: The creation context of the resource.
return:
description: The creation metadata for the resource.
types:
- <xref:typing.Optional>[<xref:azure.ai.ml.entities.SystemData>]
- uid: azure.ai.ml.data_transfer.DataTransferImportComponent.display_name
name: display_name
summary: Display name of the component.
return:
description: Display name of the component.
types:
- <xref:str>
- uid: azure.ai.ml.data_transfer.DataTransferImportComponent.id
name: id
summary: The resource ID.
return:
description: The global ID of the resource, an Azure Resource Manager (ARM) ID.
types:
- <xref:typing.Optional>[<xref:str>]
- uid: azure.ai.ml.data_transfer.DataTransferImportComponent.inputs
name: inputs
summary: Inputs of the component.
return:
description: Inputs of the component.
types:
- <xref:dict>
- uid: azure.ai.ml.data_transfer.DataTransferImportComponent.is_deterministic
name: is_deterministic
summary: Whether the component is deterministic.
return:
description: Whether the component is deterministic
types:
- <xref:bool>
- uid: azure.ai.ml.data_transfer.DataTransferImportComponent.outputs
name: outputs
summary: Outputs of the component.
return:
description: Outputs of the component.
types:
- <xref:dict>
- uid: azure.ai.ml.data_transfer.DataTransferImportComponent.task
name: task
summary: Task type of the component.
return:
description: Task type of the component.
types:
- <xref:str>
- uid: azure.ai.ml.data_transfer.DataTransferImportComponent.type
name: type
summary: Type of the component, default is 'command'.
return:
description: Type of the component.
types:
- <xref:str>
- uid: azure.ai.ml.data_transfer.DataTransferImportComponent.version
name: version
summary: Version of the component.
return:
description: Version of the component.
types:
- <xref:str>