DatabricksNotebookActivity Class

Package:
com.azure.resourcemanager.datafactory.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-datafactory:1.2.0

public final class DatabricksNotebookActivity
extends ExecutionActivity

DatabricksNotebook activity.

Constructor Summary

Constructor Description
DatabricksNotebookActivity()

Creates an instance of DatabricksNotebookActivity class.

Method Summary

Modifier and Type Method and Description
Map<String,Object> baseParameters()

Get the baseParameters property: Base parameters to be used for each run of this job.If the notebook takes a parameter that is not specified, the default value from the notebook will be used.
static DatabricksNotebookActivity fromJson(JsonReader jsonReader)

Reads an instance of DatabricksNotebookActivity from the JsonReader.
List<Map<String,Object>> libraries()

Get the libraries property: A list of libraries to be installed on the cluster that will execute the job.
Object notebookPath()

Get the notebookPath property: The absolute path of the notebook to be run in the Databricks Workspace.
JsonWriter toJson(JsonWriter jsonWriter)
String type()

Get the type property: Type of activity.
void validate()

Validates the instance.
DatabricksNotebookActivity withBaseParameters(Map<String,Object> baseParameters)

Set the baseParameters property: Base parameters to be used for each run of this job.If the notebook takes a parameter that is not specified, the default value from the notebook will be used.
DatabricksNotebookActivity withDependsOn(List<ActivityDependency> dependsOn)

Set the dependsOn property: Activity depends on condition.
DatabricksNotebookActivity withDescription(String description)

Set the description property: Activity description.
DatabricksNotebookActivity withLibraries(List<Map<String,Object>> libraries)

Set the libraries property: A list of libraries to be installed on the cluster that will execute the job.
DatabricksNotebookActivity withLinkedServiceName(LinkedServiceReference linkedServiceName)

Set the linkedServiceName property: Linked service reference.
DatabricksNotebookActivity withName(String name)

Set the name property: Activity name.
DatabricksNotebookActivity withNotebookPath(Object notebookPath)

Set the notebookPath property: The absolute path of the notebook to be run in the Databricks Workspace.
DatabricksNotebookActivity withOnInactiveMarkAs(ActivityOnInactiveMarkAs onInactiveMarkAs)

Set the onInactiveMarkAs property: Status result of the activity when the state is set to Inactive.
DatabricksNotebookActivity withPolicy(ActivityPolicy policy)

Set the policy property: Activity policy.
DatabricksNotebookActivity withState(ActivityState state)

Set the state property: Activity state.
DatabricksNotebookActivity 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

fromJson linkedServiceName policy toJson 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

DatabricksNotebookActivity

public DatabricksNotebookActivity()

Creates an instance of DatabricksNotebookActivity class.

Method Details

baseParameters

public Map<String,Object> baseParameters()

Get the baseParameters property: Base parameters to be used for each run of this job.If the notebook takes a parameter that is not specified, the default value from the notebook will be used.

Returns:

the baseParameters value.

fromJson

public static DatabricksNotebookActivity fromJson(JsonReader jsonReader)

Reads an instance of DatabricksNotebookActivity from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of DatabricksNotebookActivity if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

 - If the deserialized JSON object was missing any required properties.

libraries

public List<Map<String,Object>> libraries()

Get the libraries property: A list of libraries to be installed on the cluster that will execute the job.

Returns:

the libraries value.

notebookPath

public Object notebookPath()

Get the notebookPath property: The absolute path of the notebook to be run in the Databricks Workspace. This path must begin with a slash. Type: string (or Expression with resultType string).

Returns:

the notebookPath value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

DatabricksNotebookActivity.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

type

public String type()

Get the type property: Type of activity.

Overrides:

DatabricksNotebookActivity.type()

Returns:

the type value.

validate

public void validate()

Validates the instance.

Overrides:

DatabricksNotebookActivity.validate()

withBaseParameters

public DatabricksNotebookActivity withBaseParameters(Map<String,Object> baseParameters)

Set the baseParameters property: Base parameters to be used for each run of this job.If the notebook takes a parameter that is not specified, the default value from the notebook will be used.

Parameters:

baseParameters - the baseParameters value to set.

Returns:

the DatabricksNotebookActivity object itself.

withDependsOn

public DatabricksNotebookActivity withDependsOn(List<ActivityDependency> dependsOn)

Set the dependsOn property: Activity depends on condition.

Overrides:

DatabricksNotebookActivity.withDependsOn(List<ActivityDependency> dependsOn)

Parameters:

dependsOn

withDescription

public DatabricksNotebookActivity withDescription(String description)

Set the description property: Activity description.

Overrides:

DatabricksNotebookActivity.withDescription(String description)

Parameters:

description

withLibraries

public DatabricksNotebookActivity withLibraries(List<Map<String,Object>> libraries)

Set the libraries property: A list of libraries to be installed on the cluster that will execute the job.

Parameters:

libraries - the libraries value to set.

Returns:

the DatabricksNotebookActivity object itself.

withLinkedServiceName

public DatabricksNotebookActivity withLinkedServiceName(LinkedServiceReference linkedServiceName)

Set the linkedServiceName property: Linked service reference.

Overrides:

DatabricksNotebookActivity.withLinkedServiceName(LinkedServiceReference linkedServiceName)

Parameters:

linkedServiceName

withName

public DatabricksNotebookActivity withName(String name)

Set the name property: Activity name.

Overrides:

DatabricksNotebookActivity.withName(String name)

Parameters:

name

withNotebookPath

public DatabricksNotebookActivity withNotebookPath(Object notebookPath)

Set the notebookPath property: The absolute path of the notebook to be run in the Databricks Workspace. This path must begin with a slash. Type: string (or Expression with resultType string).

Parameters:

notebookPath - the notebookPath value to set.

Returns:

the DatabricksNotebookActivity object itself.

withOnInactiveMarkAs

public DatabricksNotebookActivity 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:

DatabricksNotebookActivity.withOnInactiveMarkAs(ActivityOnInactiveMarkAs onInactiveMarkAs)

Parameters:

onInactiveMarkAs

withPolicy

public DatabricksNotebookActivity withPolicy(ActivityPolicy policy)

Set the policy property: Activity policy.

Overrides:

DatabricksNotebookActivity.withPolicy(ActivityPolicy policy)

Parameters:

policy

withState

public DatabricksNotebookActivity 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:

DatabricksNotebookActivity.withState(ActivityState state)

Parameters:

state

withUserProperties

public DatabricksNotebookActivity withUserProperties(List<UserProperty> userProperties)

Set the userProperties property: Activity user properties.

Overrides:

DatabricksNotebookActivity.withUserProperties(List<UserProperty> userProperties)

Parameters:

userProperties

Applies to