ScriptAction Class

  • java.lang.Object
    • com.azure.analytics.synapse.artifacts.models.ScriptAction

Implements

public final class ScriptAction
implements JsonSerializable<ScriptAction>

Custom script action to run on HDI ondemand cluster once it's up.

Constructor Summary

Constructor Description
ScriptAction()

Creates an instance of ScriptAction class.

Method Summary

Modifier and Type Method and Description
static ScriptAction fromJson(JsonReader jsonReader)

Reads an instance of ScriptAction from the JsonReader.

String getName()

Get the name property: The user provided name of the script action.

String getParameters()

Get the parameters property: The parameters for the script action.

Object getRoles()

Get the roles property: The node types on which the script action should be executed.

String getUri()

Get the uri property: The URI for the script action.

ScriptAction setName(String name)

Set the name property: The user provided name of the script action.

ScriptAction setParameters(String parameters)

Set the parameters property: The parameters for the script action.

ScriptAction setRoles(Object roles)

Set the roles property: The node types on which the script action should be executed.

ScriptAction setUri(String uri)

Set the uri property: The URI for the script action.

JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

Constructor Details

ScriptAction

public ScriptAction()

Creates an instance of ScriptAction class.

Method Details

fromJson

public static ScriptAction fromJson(JsonReader jsonReader)

Reads an instance of ScriptAction from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of ScriptAction 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.

getName

public String getName()

Get the name property: The user provided name of the script action.

Returns:

the name value.

getParameters

public String getParameters()

Get the parameters property: The parameters for the script action.

Returns:

the parameters value.

getRoles

public Object getRoles()

Get the roles property: The node types on which the script action should be executed.

Returns:

the roles value.

getUri

public String getUri()

Get the uri property: The URI for the script action.

Returns:

the uri value.

setName

public ScriptAction setName(String name)

Set the name property: The user provided name of the script action.

Parameters:

name - the name value to set.

Returns:

the ScriptAction object itself.

setParameters

public ScriptAction setParameters(String parameters)

Set the parameters property: The parameters for the script action.

Parameters:

parameters - the parameters value to set.

Returns:

the ScriptAction object itself.

setRoles

public ScriptAction setRoles(Object roles)

Set the roles property: The node types on which the script action should be executed.

Parameters:

roles - the roles value to set.

Returns:

the ScriptAction object itself.

setUri

public ScriptAction setUri(String uri)

Set the uri property: The URI for the script action.

Parameters:

uri - the uri value to set.

Returns:

the ScriptAction object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to