Package com.azure.analytics.synapse.artifacts.models

Class CustomActivity

java.lang.Object
com.azure.analytics.synapse.artifacts.models.Activity
com.azure.analytics.synapse.artifacts.models.ExecutionActivity
com.azure.analytics.synapse.artifacts.models.CustomActivity
public class CustomActivity extends ExecutionActivity
Custom activity type.

  • Constructor Details

    • CustomActivity

      public CustomActivity()

  • Method Details

    • getCommand

      public Object getCommand()
      Get the command property: Command for custom activity Type: string (or Expression with resultType string).
      Returns:
      the command value.

    • setCommand

      public CustomActivity setCommand(Object command)
      Set the command property: Command for custom activity Type: string (or Expression with resultType string).
      Parameters:
      command - the command value to set.
      Returns:
      the CustomActivity object itself.

    • getResourceLinkedService

      public LinkedServiceReference getResourceLinkedService()
      Get the resourceLinkedService property: Resource linked service reference.
      Returns:
      the resourceLinkedService value.

    • setResourceLinkedService

      public CustomActivity setResourceLinkedService(LinkedServiceReference resourceLinkedService)
      Set the resourceLinkedService property: Resource linked service reference.
      Parameters:
      resourceLinkedService - the resourceLinkedService value to set.
      Returns:
      the CustomActivity object itself.

    • getFolderPath

      public Object getFolderPath()
      Get the folderPath property: Folder path for resource files Type: string (or Expression with resultType string).
      Returns:
      the folderPath value.

    • setFolderPath

      public CustomActivity setFolderPath(Object folderPath)
      Set the folderPath property: Folder path for resource files Type: string (or Expression with resultType string).
      Parameters:
      folderPath - the folderPath value to set.
      Returns:
      the CustomActivity object itself.

    • getReferenceObjects

      public CustomActivityReferenceObject getReferenceObjects()
      Get the referenceObjects property: Reference objects.
      Returns:
      the referenceObjects value.

    • setReferenceObjects

      public CustomActivity setReferenceObjects(CustomActivityReferenceObject referenceObjects)
      Set the referenceObjects property: Reference objects.
      Parameters:
      referenceObjects - the referenceObjects value to set.
      Returns:
      the CustomActivity object itself.

    • getExtendedProperties

      public Map<String,Object> getExtendedProperties()
      Get the extendedProperties property: User defined property bag. There is no restriction on the keys or values that can be used. The user specified custom activity has the full responsibility to consume and interpret the content defined.
      Returns:
      the extendedProperties value.

    • setExtendedProperties

      public CustomActivity setExtendedProperties(Map<String,Object> extendedProperties)
      Set the extendedProperties property: User defined property bag. There is no restriction on the keys or values that can be used. The user specified custom activity has the full responsibility to consume and interpret the content defined.
      Parameters:
      extendedProperties - the extendedProperties value to set.
      Returns:
      the CustomActivity object itself.

    • getRetentionTimeInDays

      public Object getRetentionTimeInDays()
      Get the retentionTimeInDays property: The retention time for the files submitted for custom activity. Type: double (or Expression with resultType double).
      Returns:
      the retentionTimeInDays value.

    • setRetentionTimeInDays

      public CustomActivity setRetentionTimeInDays(Object retentionTimeInDays)
      Set the retentionTimeInDays property: The retention time for the files submitted for custom activity. Type: double (or Expression with resultType double).
      Parameters:
      retentionTimeInDays - the retentionTimeInDays value to set.
      Returns:
      the CustomActivity object itself.

    • getAutoUserSpecification

      public Object getAutoUserSpecification()
      Get the autoUserSpecification property: Elevation level and scope for the user, default is nonadmin task. Type: string (or Expression with resultType double).
      Returns:
      the autoUserSpecification value.

    • setAutoUserSpecification

      public CustomActivity setAutoUserSpecification(Object autoUserSpecification)
      Set the autoUserSpecification property: Elevation level and scope for the user, default is nonadmin task. Type: string (or Expression with resultType double).
      Parameters:
      autoUserSpecification - the autoUserSpecification value to set.
      Returns:
      the CustomActivity object itself.

    • setLinkedServiceName

      public CustomActivity setLinkedServiceName(LinkedServiceReference linkedServiceName)
      Set the linkedServiceName property: Linked service reference.
      Overrides:
      setLinkedServiceName in class ExecutionActivity
      Parameters:
      linkedServiceName - the linkedServiceName value to set.
      Returns:
      the ExecutionActivity object itself.

    • setPolicy

      public CustomActivity setPolicy(ActivityPolicy policy)
      Set the policy property: Activity policy.
      Overrides:
      setPolicy in class ExecutionActivity
      Parameters:
      policy - the policy value to set.
      Returns:
      the ExecutionActivity object itself.

    • setName

      public CustomActivity setName(String name)
      Set the name property: Activity name.
      Overrides:
      setName in class ExecutionActivity
      Parameters:
      name - the name value to set.
      Returns:
      the Activity object itself.

    • setDescription

      public CustomActivity setDescription(String description)
      Set the description property: Activity description.
      Overrides:
      setDescription in class ExecutionActivity
      Parameters:
      description - the description value to set.
      Returns:
      the Activity object itself.

    • setDependsOn

      public CustomActivity setDependsOn(List<ActivityDependency> dependsOn)
      Set the dependsOn property: Activity depends on condition.
      Overrides:
      setDependsOn in class ExecutionActivity
      Parameters:
      dependsOn - the dependsOn value to set.
      Returns:
      the Activity object itself.

    • setUserProperties

      public CustomActivity setUserProperties(List<UserProperty> userProperties)
      Set the userProperties property: Activity user properties.
      Overrides:
      setUserProperties in class ExecutionActivity
      Parameters:
      userProperties - the userProperties value to set.
      Returns:
      the Activity object itself.