Class CustomActivity


public final class CustomActivity extends ExecutionActivity
Custom activity type.
  • Constructor Details

    • CustomActivity

      public CustomActivity()
      Creates an instance of CustomActivity class.
  • Method Details

    • withLinkedServiceName

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

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

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

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

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

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

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

      public CustomActivity withCommand(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.
    • resourceLinkedService

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

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

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

      public CustomActivity withFolderPath(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.
    • referenceObjects

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

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

      public Map<String,Object> extendedProperties()
      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.
    • withExtendedProperties

      public CustomActivity withExtendedProperties(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.
    • retentionTimeInDays

      public Object retentionTimeInDays()
      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.
    • withRetentionTimeInDays

      public CustomActivity withRetentionTimeInDays(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.
    • autoUserSpecification

      public Object autoUserSpecification()
      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.
    • withAutoUserSpecification

      public CustomActivity withAutoUserSpecification(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.
    • validate

      public void validate()
      Validates the instance.
      Overrides:
      validate in class ExecutionActivity
      Throws:
      IllegalArgumentException - thrown if the instance is not valid.