GetMetadataActivity Class

Activity to get metadata of dataset.

All required parameters must be populated in order to send to server.

Inheritance

azure.mgmt.datafactory.models._models_py3.ExecutionActivity

GetMetadataActivity

Constructor

GetMetadataActivity(*, name: str, dataset: _models.DatasetReference, additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, description: str | None = None, state: str | _models.ActivityState | None = None, on_inactive_mark_as: str | _models.ActivityOnInactiveMarkAs | None = None, depends_on: List[_models.ActivityDependency] | None = None, user_properties: List[_models.UserProperty] | None = None, linked_service_name: _models.LinkedServiceReference | None = None, policy: _models.ActivityPolicy | None = None, field_list: List[MutableMapping[str, Any]] | None = None, store_settings: _models.StoreReadSettings | None = None, format_settings: _models.FormatReadSettings | None = None, **kwargs: Any)

Keyword-Only Parameters

Name	Description
additional_properties	dict[str, <xref:JSON>] Unmatched properties from the message are deserialized to this collection.
name	str Activity name. Required.
description	str Activity description.
state	str or ActivityState Activity state. This is an optional property and if not provided, the state will be Active by default. Known values are: "Active" and "Inactive".
on_inactive_mark_as	str or ActivityOnInactiveMarkAs Status result of the activity when the state is set to Inactive. This is an optional property and if not provided when the activity is inactive, the status will be Succeeded by default. Known values are: "Succeeded", "Failed", and "Skipped".
depends_on	list[ActivityDependency] Activity depends on condition.
user_properties	list[UserProperty] Activity user properties.
linked_service_name	LinkedServiceReference Linked service reference.
policy	ActivityPolicy Activity policy.
dataset	DatasetReference GetMetadata activity dataset reference. Required.
field_list	list[<xref:JSON>] Fields of metadata to get from dataset.
store_settings	StoreReadSettings GetMetadata activity store settings.
format_settings	FormatReadSettings GetMetadata activity format settings.

Variables

Name	Description
additional_properties	dict[str, <xref:JSON>] Unmatched properties from the message are deserialized to this collection.
name	str Activity name. Required.
type	str Type of activity. Required.
description	str Activity description.
state	str or ActivityState Activity state. This is an optional property and if not provided, the state will be Active by default. Known values are: "Active" and "Inactive".
on_inactive_mark_as	str or ActivityOnInactiveMarkAs Status result of the activity when the state is set to Inactive. This is an optional property and if not provided when the activity is inactive, the status will be Succeeded by default. Known values are: "Succeeded", "Failed", and "Skipped".
depends_on	list[ActivityDependency] Activity depends on condition.
user_properties	list[UserProperty] Activity user properties.
linked_service_name	LinkedServiceReference Linked service reference.
policy	ActivityPolicy Activity policy.
dataset	DatasetReference GetMetadata activity dataset reference. Required.
field_list	list[<xref:JSON>] Fields of metadata to get from dataset.
store_settings	StoreReadSettings GetMetadata activity store settings.
format_settings	FormatReadSettings GetMetadata activity format settings.