Package com.azure.analytics.synapse.artifacts

Class KqlScriptClient

java.lang.Object

com.azure.analytics.synapse.artifacts.KqlScriptClient

public final class KqlScriptClient
extends Object

Initializes a new instance of the synchronous ArtifactsClient type.

Method Summary

Modifier and Type	Method	Description
KqlScriptResource	createOrUpdate(String kqlScriptName, KqlScriptResource kqlScript)	Creates or updates a KQL Script.
com.azure.core.http.rest.Response<KqlScriptResource>	createOrUpdateWithResponse(String kqlScriptName, KqlScriptResource kqlScript, com.azure.core.util.Context context)	Creates or updates a KQL Script.
void	deleteByName(String kqlScriptName)	Delete KQL script by name.
com.azure.core.http.rest.Response<Void>	deleteByNameWithResponse(String kqlScriptName, com.azure.core.util.Context context)	Delete KQL script by name.
KqlScriptResource	getByName(String kqlScriptName)	Get KQL script by name.
com.azure.core.http.rest.Response<KqlScriptResource>	getByNameWithResponse(String kqlScriptName, com.azure.core.util.Context context)	Get KQL script by name.
void	rename(String kqlScriptName, ArtifactRenameRequest renameRequest)	Rename KQL script.
com.azure.core.http.rest.Response<Void>	renameWithResponse(String kqlScriptName, ArtifactRenameRequest renameRequest, com.azure.core.util.Context context)	Rename KQL script.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

createOrUpdate

public KqlScriptResource createOrUpdate(String kqlScriptName,
                                        KqlScriptResource kqlScript)

Creates or updates a KQL Script.

Parameters:

kqlScriptName - KQL script name.

kqlScript - KQL script.

Returns:

the response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

ErrorContractException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

createOrUpdateWithResponse

public com.azure.core.http.rest.Response<KqlScriptResource> createOrUpdateWithResponse(String kqlScriptName,
                                                                                       KqlScriptResource kqlScript,
                                                                                       com.azure.core.util.Context context)

Creates or updates a KQL Script.

Parameters:

kqlScriptName - KQL script name.

kqlScript - KQL script.

context - The context to associate with this operation.

Returns:

the response body along with Response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

ErrorContractException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getByName

public KqlScriptResource getByName(String kqlScriptName)

Get KQL script by name.

Parameters:

kqlScriptName - KQL script name.

Returns:

kQL script by name.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

ErrorContractException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getByNameWithResponse

public com.azure.core.http.rest.Response<KqlScriptResource> getByNameWithResponse(String kqlScriptName,
                                                                                  com.azure.core.util.Context context)

Get KQL script by name.

Parameters:

kqlScriptName - KQL script name.

context - The context to associate with this operation.

Returns:

kQL script by name along with Response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

ErrorContractException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

deleteByName

public void deleteByName(String kqlScriptName)

Delete KQL script by name.

Parameters:

kqlScriptName - KQL script name.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

ErrorContractException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

deleteByNameWithResponse

public com.azure.core.http.rest.Response<Void> deleteByNameWithResponse(String kqlScriptName,
                                                                        com.azure.core.util.Context context)

Delete KQL script by name.

Parameters:

kqlScriptName - KQL script name.

context - The context to associate with this operation.

Returns:

the Response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

ErrorContractException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

rename

public void rename(String kqlScriptName,
                   ArtifactRenameRequest renameRequest)

Rename KQL script.

Parameters:

kqlScriptName - KQL script name.

renameRequest - Rename request.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

ErrorContractException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

renameWithResponse

public com.azure.core.http.rest.Response<Void> renameWithResponse(String kqlScriptName,
                                                                  ArtifactRenameRequest renameRequest,
                                                                  com.azure.core.util.Context context)

Rename KQL script.

Parameters:

kqlScriptName - KQL script name.

renameRequest - Rename request.

context - The context to associate with this operation.

Returns:

the Response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

ErrorContractException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.