CustomActivity Class

Package:

com.azure.resourcemanager.datafactory.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-datafactory:1.0.0-beta.28

• java.lang.Object
• • com.azure.resourcemanager.datafactory.models.Activity
  • • com.azure.resourcemanager.datafactory.models.ExecutionActivity
    • • com.azure.resourcemanager.datafactory.models.CustomActivity

public final class CustomActivity
extends ExecutionActivity

Custom activity type.

Constructor Summary

Constructor	Description
CustomActivity()	Creates an instance of CustomActivity class.

Method Summary

Modifier and Type	Method and Description
Object	autoUserSpecification() Get the autoUserSpecification property: Elevation level and scope for the user, default is nonadmin task.
Object	command() Get the command property: Command for custom activity Type: string (or Expression with resultType string).
Map<String,Object>	extendedProperties() Get the extendedProperties property: User defined property bag.
Object	folderPath() Get the folderPath property: Folder path for resource files Type: string (or Expression with resultType string).
CustomActivityReferenceObject	referenceObjects() Get the referenceObjects property: Reference objects.
LinkedServiceReference	resourceLinkedService() Get the resourceLinkedService property: Resource linked service reference.
Object	retentionTimeInDays() Get the retentionTimeInDays property: The retention time for the files submitted for custom activity.
String	type() Get the type property: Type of activity.
void	validate() Validates the instance.
CustomActivity	withAutoUserSpecification(Object autoUserSpecification) Set the autoUserSpecification property: Elevation level and scope for the user, default is nonadmin task.
CustomActivity	withCommand(Object command) Set the command property: Command for custom activity Type: string (or Expression with resultType string).
CustomActivity	withDependsOn(List<ActivityDependency> dependsOn) Set the dependsOn property: Activity depends on condition.
CustomActivity	withDescription(String description) Set the description property: Activity description.
CustomActivity	withExtendedProperties(Map<String,Object> extendedProperties) Set the extendedProperties property: User defined property bag.
CustomActivity	withFolderPath(Object folderPath) Set the folderPath property: Folder path for resource files Type: string (or Expression with resultType string).
CustomActivity	withLinkedServiceName(LinkedServiceReference linkedServiceName) Set the linkedServiceName property: Linked service reference.
CustomActivity	withName(String name) Set the name property: Activity name.
CustomActivity	withOnInactiveMarkAs(ActivityOnInactiveMarkAs onInactiveMarkAs) Set the onInactiveMarkAs property: Status result of the activity when the state is set to Inactive.
CustomActivity	withPolicy(ActivityPolicy policy) Set the policy property: Activity policy.
CustomActivity	withReferenceObjects(CustomActivityReferenceObject referenceObjects) Set the referenceObjects property: Reference objects.
CustomActivity	withResourceLinkedService(LinkedServiceReference resourceLinkedService) Set the resourceLinkedService property: Resource linked service reference.
CustomActivity	withRetentionTimeInDays(Object retentionTimeInDays) Set the retentionTimeInDays property: The retention time for the files submitted for custom activity.
CustomActivity	withState(ActivityState state) Set the state property: Activity state.
CustomActivity	withUserProperties(List<UserProperty> userProperties) Set the userProperties property: Activity user properties.

Methods inherited from Activity

additionalProperties dependsOn description name onInactiveMarkAs state userProperties withAdditionalProperties

Methods inherited from ExecutionActivity

linkedServiceName policy type validate withDependsOn withDescription withLinkedServiceName withName withOnInactiveMarkAs withPolicy withState withUserProperties

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

CustomActivity

public CustomActivity()

Creates an instance of CustomActivity class.

Method Details

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.

command

public Object command()

Get the command property: Command for custom activity Type: string (or Expression with resultType string).

Returns:

the command value.

extendedProperties

public Map 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.

folderPath

public Object folderPath()

Get the folderPath property: Folder path for resource files Type: string (or Expression with resultType string).

Returns:

the folderPath value.

referenceObjects

public CustomActivityReferenceObject referenceObjects()

Get the referenceObjects property: Reference objects.

Returns:

the referenceObjects value.

resourceLinkedService

public LinkedServiceReference resourceLinkedService()

Get the resourceLinkedService property: Resource linked service reference.

Returns:

the resourceLinkedService value.

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.

type

public String type()

Get the type property: Type of activity.

Overrides:

CustomActivity.type()

Returns:

the type value.

validate

public void validate()

Validates the instance.

Overrides:

CustomActivity.validate()

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.

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.

withDependsOn

public CustomActivity withDependsOn(List dependsOn)

Set the dependsOn property: Activity depends on condition.

Overrides:

CustomActivity.withDependsOn(List<ActivityDependency> dependsOn)

Parameters:

dependsOn

withDescription

public CustomActivity withDescription(String description)

Set the description property: Activity description.

Overrides:

CustomActivity.withDescription(String description)

Parameters:

description

withExtendedProperties

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

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.

withLinkedServiceName

public CustomActivity withLinkedServiceName(LinkedServiceReference linkedServiceName)

Set the linkedServiceName property: Linked service reference.

Overrides:

CustomActivity.withLinkedServiceName(LinkedServiceReference linkedServiceName)

Parameters:

linkedServiceName

withName

public CustomActivity withName(String name)

Set the name property: Activity name.

Overrides:

CustomActivity.withName(String name)

Parameters:

name

withOnInactiveMarkAs

public CustomActivity withOnInactiveMarkAs(ActivityOnInactiveMarkAs onInactiveMarkAs)

Set the onInactiveMarkAs property: 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.

Overrides:

CustomActivity.withOnInactiveMarkAs(ActivityOnInactiveMarkAs onInactiveMarkAs)

Parameters:

onInactiveMarkAs

withPolicy

public CustomActivity withPolicy(ActivityPolicy policy)

Set the policy property: Activity policy.

Overrides:

CustomActivity.withPolicy(ActivityPolicy policy)

Parameters:

policy

withReferenceObjects

public CustomActivity withReferenceObjects(CustomActivityReferenceObject referenceObjects)

Set the referenceObjects property: Reference objects.

Parameters:

referenceObjects - the referenceObjects value to set.

Returns:

the CustomActivity object itself.

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.

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.

withState

public CustomActivity withState(ActivityState state)

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

Overrides:

CustomActivity.withState(ActivityState state)

Parameters:

state

withUserProperties

public CustomActivity withUserProperties(List userProperties)

Set the userProperties property: Activity user properties.

Overrides:

CustomActivity.withUserProperties(List<UserProperty> userProperties)

Parameters:

userProperties