GetMetadataActivity Class

  • Reference

Definition

Namespace:
Azure.Analytics.Synapse.Artifacts.Models
Assembly:
Azure.Analytics.Synapse.Artifacts.dll
Package:
Azure.Analytics.Synapse.Artifacts v1.0.0-preview.20
Source:
GetMetadataActivity.cs

Activity to get metadata of dataset.

[System.Text.Json.Serialization.JsonConverter(typeof(Azure.Analytics.Synapse.Artifacts.Models.GetMetadataActivity+GetMetadataActivityConverter))]
public class GetMetadataActivity : Azure.Analytics.Synapse.Artifacts.Models.ExecutionActivity
[<System.Text.Json.Serialization.JsonConverter(typeof(Azure.Analytics.Synapse.Artifacts.Models.GetMetadataActivity+GetMetadataActivityConverter))>]
type GetMetadataActivity = class
    inherit ExecutionActivity
Public Class GetMetadataActivity
Inherits ExecutionActivity
Inheritance
Object
Activity
ExecutionActivity
GetMetadataActivity
Attributes
JsonConverterAttribute

Constructors

GetMetadataActivity(String, DatasetReference)

Initializes a new instance of GetMetadataActivity.

Properties

AdditionalProperties

Additional Properties.

(Inherited from Activity)
Dataset

GetMetadata activity dataset reference.
DependsOn

Activity depends on condition.

(Inherited from Activity)
Description

Activity description.

(Inherited from Activity)
FieldList

Fields of metadata to get from dataset.
FormatSettings

GetMetadata activity format settings. Please note FormatReadSettings is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include BinaryReadSettings, DelimitedTextReadSettings, JsonReadSettings, ParquetReadSettings and XmlReadSettings.
LinkedServiceName

Linked service reference.

(Inherited from ExecutionActivity)
Name

Activity name.

(Inherited from Activity)
OnInactiveMarkAs

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.

(Inherited from Activity)
Policy

Activity policy.

(Inherited from ExecutionActivity)
State

Activity state. This is an optional property and if not provided, the state will be Active by default.

(Inherited from Activity)
StoreSettings

GetMetadata activity store settings. Please note StoreReadSettings is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include AmazonS3ReadSettings, AzureBlobFSReadSettings, AzureBlobStorageReadSettings, AzureDataLakeStoreReadSettings, AzureFileStorageReadSettings, FileServerReadSettings, FtpReadSettings, GoogleCloudStorageReadSettings, HdfsReadSettings, HttpReadSettings, LakeHouseReadSettings and SftpReadSettings.
UserProperties

Activity user properties.

(Inherited from Activity)

Applies to