SparkJobDefinitionClient Class

Package:

com.azure.analytics.synapse.artifacts

Maven Artifact:

com.azure:azure-analytics-synapse-artifacts:1.0.0-beta.14

• java.lang.Object
• • com.azure.analytics.synapse.artifacts.SparkJobDefinitionClient

public final class SparkJobDefinitionClient

Initializes a new instance of the synchronous ArtifactsClient type.

Method Summary

Modifier and Type	Method and Description
SparkJobDefinitionResource	createOrUpdateSparkJobDefinition(String sparkJobDefinitionName, SparkJobDefinitionResource sparkJobDefinition) Creates or updates a Spark Job Definition.
SparkJobDefinitionResource	createOrUpdateSparkJobDefinition(String sparkJobDefinitionName, SparkJobDefinitionResource sparkJobDefinition, String ifMatch) Creates or updates a Spark Job Definition.
Response<SparkJobDefinitionResource>	createOrUpdateSparkJobDefinitionWithResponse(String sparkJobDefinitionName, SparkJobDefinitionResource sparkJobDefinition, String ifMatch, Context context) Creates or updates a Spark Job Definition.
SparkBatchJob	debugSparkJobDefinition(SparkJobDefinitionResource sparkJobDefinitionAzureResource) Debug the spark job definition.
Response<SparkBatchJob>	debugSparkJobDefinitionWithResponse(SparkJobDefinitionResource sparkJobDefinitionAzureResource, Context context) Debug the spark job definition.
void	deleteSparkJobDefinition(String sparkJobDefinitionName) Deletes a Spark Job Definition.
Response<Void>	deleteSparkJobDefinitionWithResponse(String sparkJobDefinitionName, Context context) Deletes a Spark Job Definition.
SparkBatchJob	executeSparkJobDefinition(String sparkJobDefinitionName) Executes the spark job definition.
Response<SparkBatchJob>	executeSparkJobDefinitionWithResponse(String sparkJobDefinitionName, Context context) Executes the spark job definition.
SparkJobDefinitionResource	getSparkJobDefinition(String sparkJobDefinitionName) Gets a Spark Job Definition.
SparkJobDefinitionResource	getSparkJobDefinition(String sparkJobDefinitionName, String ifNoneMatch) Gets a Spark Job Definition.
Response<SparkJobDefinitionResource>	getSparkJobDefinitionWithResponse(String sparkJobDefinitionName, String ifNoneMatch, Context context) Gets a Spark Job Definition.
PagedIterable<SparkJobDefinitionResource>	getSparkJobDefinitionsByWorkspace() Lists spark job definitions.
PagedIterable<SparkJobDefinitionResource>	getSparkJobDefinitionsByWorkspace(Context context) Lists spark job definitions.
void	renameSparkJobDefinition(String sparkJobDefinitionName, ArtifactRenameRequest request) Renames a sparkJobDefinition.
Response<Void>	renameSparkJobDefinitionWithResponse(String sparkJobDefinitionName, ArtifactRenameRequest request, Context context) Renames a sparkJobDefinition.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Method Details

createOrUpdateSparkJobDefinition

public SparkJobDefinitionResource createOrUpdateSparkJobDefinition(String sparkJobDefinitionName, SparkJobDefinitionResource sparkJobDefinition)

Creates or updates a Spark Job Definition.

Parameters:

sparkJobDefinitionName - The spark job definition name.

sparkJobDefinition - Spark Job Definition resource definition.

Returns:

spark job definition resource type.

createOrUpdateSparkJobDefinition

public SparkJobDefinitionResource createOrUpdateSparkJobDefinition(String sparkJobDefinitionName, SparkJobDefinitionResource sparkJobDefinition, String ifMatch)

Creates or updates a Spark Job Definition.

Parameters:

sparkJobDefinitionName - The spark job definition name.

sparkJobDefinition - Spark Job Definition resource definition.

ifMatch - ETag of the Spark Job Definition entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update.

Returns:

spark job definition resource type.

createOrUpdateSparkJobDefinitionWithResponse

public Response createOrUpdateSparkJobDefinitionWithResponse(String sparkJobDefinitionName, SparkJobDefinitionResource sparkJobDefinition, String ifMatch, Context context)

Creates or updates a Spark Job Definition.

Parameters:

sparkJobDefinitionName - The spark job definition name.

sparkJobDefinition - Spark Job Definition resource definition.

ifMatch - ETag of the Spark Job Definition entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update.

context - The context to associate with this operation.

Returns:

spark job definition resource type along with Response<T>.

debugSparkJobDefinition

public SparkBatchJob debugSparkJobDefinition(SparkJobDefinitionResource sparkJobDefinitionAzureResource)

Debug the spark job definition.

Parameters:

sparkJobDefinitionAzureResource - Spark Job Definition resource definition.

Returns:

the response.

debugSparkJobDefinitionWithResponse

public Response debugSparkJobDefinitionWithResponse(SparkJobDefinitionResource sparkJobDefinitionAzureResource, Context context)

Debug the spark job definition.

Parameters:

sparkJobDefinitionAzureResource - Spark Job Definition resource definition.

context - The context to associate with this operation.

Returns:

the response body along with Response<T>.

deleteSparkJobDefinition

public void deleteSparkJobDefinition(String sparkJobDefinitionName)

Deletes a Spark Job Definition.

Parameters:

sparkJobDefinitionName - The spark job definition name.

deleteSparkJobDefinitionWithResponse

public Response deleteSparkJobDefinitionWithResponse(String sparkJobDefinitionName, Context context)

Deletes a Spark Job Definition.

Parameters:

sparkJobDefinitionName - The spark job definition name.

context - The context to associate with this operation.

Returns:

the Response<T>.

executeSparkJobDefinition

public SparkBatchJob executeSparkJobDefinition(String sparkJobDefinitionName)

Executes the spark job definition.

Parameters:

sparkJobDefinitionName - The spark job definition name.

Returns:

the response.

executeSparkJobDefinitionWithResponse

public Response executeSparkJobDefinitionWithResponse(String sparkJobDefinitionName, Context context)

Executes the spark job definition.

Parameters:

sparkJobDefinitionName - The spark job definition name.

context - The context to associate with this operation.

Returns:

the response body along with Response<T>.

getSparkJobDefinition

public SparkJobDefinitionResource getSparkJobDefinition(String sparkJobDefinitionName)

Gets a Spark Job Definition.

Parameters:

sparkJobDefinitionName - The spark job definition name.

Returns:

a Spark Job Definition.

getSparkJobDefinition

public SparkJobDefinitionResource getSparkJobDefinition(String sparkJobDefinitionName, String ifNoneMatch)

Gets a Spark Job Definition.

Parameters:

sparkJobDefinitionName - The spark job definition name.

ifNoneMatch - ETag of the Spark Job Definition entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned.

Returns:

a Spark Job Definition.

getSparkJobDefinitionWithResponse

public Response getSparkJobDefinitionWithResponse(String sparkJobDefinitionName, String ifNoneMatch, Context context)

Gets a Spark Job Definition.

Parameters:

sparkJobDefinitionName - The spark job definition name.

ifNoneMatch - ETag of the Spark Job Definition entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned.

context - The context to associate with this operation.

Returns:

a Spark Job Definition along with Response<T>.

getSparkJobDefinitionsByWorkspace

public PagedIterable getSparkJobDefinitionsByWorkspace()

Lists spark job definitions.

Returns:

a list of spark job definitions resources as paginated response with PagedIterable<T>.

getSparkJobDefinitionsByWorkspace

public PagedIterable getSparkJobDefinitionsByWorkspace(Context context)

Lists spark job definitions.

Parameters:

context - The context to associate with this operation.

Returns:

a list of spark job definitions resources as paginated response with PagedIterable<T>.

renameSparkJobDefinition

public void renameSparkJobDefinition(String sparkJobDefinitionName, ArtifactRenameRequest request)

Renames a sparkJobDefinition.

Parameters:

sparkJobDefinitionName - The spark job definition name.

request - proposed new name.

renameSparkJobDefinitionWithResponse

public Response renameSparkJobDefinitionWithResponse(String sparkJobDefinitionName, ArtifactRenameRequest request, Context context)

Renames a sparkJobDefinition.

Parameters:

sparkJobDefinitionName - The spark job definition name.

request - proposed new name.

context - The context to associate with this operation.

Returns:

the Response<T>.