Class KqlScriptClient
java.lang.Object
com.azure.analytics.synapse.artifacts.KqlScriptClient
Initializes a new instance of the synchronous ArtifactsClient type.
-
Method Summary
Modifier and TypeMethodDescriptioncreateOrUpdate
(String kqlScriptName, KqlScriptResource kqlScript) Creates or updates a KQL Script.createOrUpdateWithResponse
(String kqlScriptName, KqlScriptResource kqlScript, Context context) Creates or updates a KQL Script.void
deleteByName
(String kqlScriptName) Delete KQL script by name.deleteByNameWithResponse
(String kqlScriptName, Context context) Delete KQL script by name.Get KQL script by name.getByNameWithResponse
(String kqlScriptName, Context context) Get KQL script by name.void
rename
(String kqlScriptName, ArtifactRenameRequest renameRequest) Rename KQL script.renameWithResponse
(String kqlScriptName, ArtifactRenameRequest renameRequest, Context context) Rename KQL script.
-
Method Details
-
createOrUpdate
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 Response<KqlScriptResource> createOrUpdateWithResponse(String kqlScriptName, KqlScriptResource kqlScript, 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
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
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
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
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
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 Response<Void> renameWithResponse(String kqlScriptName, ArtifactRenameRequest renameRequest, 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.
-