DataTransferCopyComponent Class

Note

This is an experimental class, and may change at any time. Please see https://aka.ms/azuremlexperimental for more information.

DataTransfer copy component version, used to define a data transfer copy component.

Inheritance

azure.ai.ml.entities._component.datatransfer_component.DataTransferComponent

DataTransferCopyComponent

Constructor

DataTransferCopyComponent(*, data_copy_mode: str | None = None, inputs: Dict | None = None, outputs: Dict | None = None, **kwargs: Any)

Parameters

Name	Description
data_copy_mode Required	str Data copy mode in the copy task. Possible values are "merge_with_overwrite" and "fail_if_conflict".
inputs Required	dict Mapping of input data bindings used in the job.
outputs Required	dict Mapping of output data bindings used in the job.
kwargs Required	Additional parameters for the data transfer copy component.

Methods

dump	Dump the component content into a file in yaml format.

dump

Dump the component content into a file in yaml format.

dump(dest: str | PathLike | IO, **kwargs: Any) -> None

Parameters

Name	Description
dest Required	Union[<xref:PathLike>, str, IO[AnyStr]] 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.

Attributes

base_path

The base path of the resource.

Returns

Type	Description
str	The base path of the resource.

creation_context

The creation context of the resource.

Returns

Type	Description
Optional[SystemData]	The creation metadata for the resource.

data_copy_mode

Data copy mode of the component.

Returns

Type	Description
str	Data copy mode of the component.

display_name

Display name of the component.

Returns

Type	Description
str	Display name of the component.

id

The resource ID.

Returns

Type	Description
Optional[str]	The global ID of the resource, an Azure Resource Manager (ARM) ID.

inputs

Inputs of the component.

Returns

Type	Description
dict	Inputs of the component.

is_deterministic

Whether the component is deterministic.

Returns

Type	Description
bool	Whether the component is deterministic

outputs

Outputs of the component.

Returns

Type	Description
dict	Outputs of the component.

task

Task type of the component.

Returns

Type	Description
str	Task type of the component.

type

Type of the component, default is 'command'.

Returns

Type	Description
str	Type of the component.

version

Version of the component.

Returns

Type	Description
str	Version of the component.