Share via


ControlActivity Class

Definition

Base class for all control activities like IfCondition, ForEach , Until. Please note ControlActivity 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 AppendVariableActivity, ExecutePipelineActivity, FailActivity, FilterActivity, ForEachActivity, IfConditionActivity, SetVariableActivity, SwitchActivity, UntilActivity, ValidationActivity, WaitActivity and WebHookActivity.

public class ControlActivity : Azure.ResourceManager.DataFactory.Models.PipelineActivity, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.DataFactory.Models.ControlActivity>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.DataFactory.Models.ControlActivity>
public class ControlActivity : Azure.ResourceManager.DataFactory.Models.PipelineActivity
type ControlActivity = class
    inherit PipelineActivity
    interface IJsonModel<ControlActivity>
    interface IPersistableModel<ControlActivity>
type ControlActivity = class
    inherit PipelineActivity
Public Class ControlActivity
Inherits PipelineActivity
Implements IJsonModel(Of ControlActivity), IPersistableModel(Of ControlActivity)
Public Class ControlActivity
Inherits PipelineActivity
Inheritance
ControlActivity
Derived
Implements

Constructors

ControlActivity(String)

Initializes a new instance of ControlActivity.

Properties

AdditionalProperties

Additional Properties

To assign an object to the value of this property use FromObjectAsJson<T>(T, JsonSerializerOptions).

To assign an already formatted json string to this property use FromString(String).

Examples:

  • BinaryData.FromObjectAsJson("foo"): Creates a payload of "foo".
  • BinaryData.FromString("\"foo\""): Creates a payload of "foo".
  • BinaryData.FromObjectAsJson(new { key = "value" }): Creates a payload of { "key": "value" }.
  • BinaryData.FromString("{\"key\": \"value\"}"): Creates a payload of { "key": "value" }.

(Inherited from PipelineActivity)
DependsOn

Activity depends on condition.

(Inherited from PipelineActivity)
Description

Activity description.

(Inherited from PipelineActivity)
Name

Activity name.

(Inherited from PipelineActivity)
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 PipelineActivity)
State

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

(Inherited from PipelineActivity)
UserProperties

Activity user properties.

(Inherited from PipelineActivity)

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions) (Inherited from PipelineActivity)

Explicit Interface Implementations

IJsonModel<ControlActivity>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<ControlActivity>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IJsonModel<PipelineActivity>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

(Inherited from PipelineActivity)
IJsonModel<PipelineActivity>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

(Inherited from PipelineActivity)
IPersistableModel<ControlActivity>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<ControlActivity>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<ControlActivity>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

IPersistableModel<PipelineActivity>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

(Inherited from PipelineActivity)
IPersistableModel<PipelineActivity>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

(Inherited from PipelineActivity)
IPersistableModel<PipelineActivity>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

(Inherited from PipelineActivity)

Applies to