Share via

ImportDataSchedule Class

  • Reference

Note

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

ImportDataSchedule object.

Inheritance
azure.ai.ml.entities._schedule.schedule.Schedule
ImportDataSchedule

Constructor

ImportDataSchedule(*, name: str, trigger: CronTrigger | RecurrenceTrigger | None, import_data: DataImport, display_name: str | None = None, description: str | None = None, tags: Dict | None = None, properties: Dict | None = None, **kwargs: Any)

Parameters

Name Description
name
Required
str

Name of the schedule.
trigger
Required
Union[CronTrigger, RecurrenceTrigger]

Trigger of the schedule.
import_data
Required
DataImport

The schedule action data import definition.
display_name
Required
str

Display name of the schedule.
description
Required
str

Description of the schedule, defaults to None
tags
Required
dict[str, str]

Tag dictionary. Tags can be added, removed, and updated.
properties
Required
dict[str, str]

The data import property dictionary.

Methods

dump

Dump the schedule content into a file in YAML format.

dump

Dump the schedule 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 local path or file stream to write the YAML content to. If dest is a file path, a new file will be created. If dest is an open file, the file will be written to directly.

Exceptions

Type Description
FileExistsError

Raised if dest is a file path and the file already exists.
IOError

Raised if dest is an open file and the file is not writable.

Attributes

base_path

The base path of the resource.

Returns

Type Description
str

The base path of the resource.

create_job

The create_job entity associated with the schedule if exists.

creation_context

The creation context of the resource.

Returns

Type Description
Optional[SystemData]

The creation metadata for the resource.

id

The resource ID.

Returns

Type Description
Optional[str]

The global ID of the resource, an Azure Resource Manager (ARM) ID.

is_enabled

Specifies if the schedule is enabled or not.

Returns

Type Description
bool

True if the schedule is enabled, False otherwise.

provisioning_state

Returns the schedule's provisioning state. The possible values include "Creating", "Updating", "Deleting", "Succeeded", "Failed", "Canceled".

Returns

Type Description
str

The schedule's provisioning state.

type

The schedule type. Accepted values are 'job' and 'monitor'.

Returns

Type Description
str

The schedule type.