Package com.azure.analytics.synapse.artifacts

Class LinkedServiceClient

java.lang.Object

com.azure.analytics.synapse.artifacts.LinkedServiceClient

public final class LinkedServiceClient
extends Object

Initializes a new instance of the synchronous ArtifactsClient type.

Method Summary

Modifier and Type	Method	Description
LinkedServiceResource	createOrUpdateLinkedService(String linkedServiceName, LinkedServiceResource linkedService)	Creates or updates a linked service.
LinkedServiceResource	createOrUpdateLinkedService(String linkedServiceName, LinkedServiceResource linkedService, String ifMatch)	Creates or updates a linked service.
com.azure.core.http.rest.Response<LinkedServiceResource>	createOrUpdateLinkedServiceWithResponse(String linkedServiceName, LinkedServiceResource linkedService, String ifMatch, com.azure.core.util.Context context)	Creates or updates a linked service.
void	deleteLinkedService(String linkedServiceName)	Deletes a linked service.
com.azure.core.http.rest.Response<Void>	deleteLinkedServiceWithResponse(String linkedServiceName, com.azure.core.util.Context context)	Deletes a linked service.
LinkedServiceResource	getLinkedService(String linkedServiceName)	Gets a linked service.
LinkedServiceResource	getLinkedService(String linkedServiceName, String ifNoneMatch)	Gets a linked service.
com.azure.core.http.rest.PagedIterable<LinkedServiceResource>	getLinkedServicesByWorkspace()	Lists linked services.
com.azure.core.http.rest.PagedIterable<LinkedServiceResource>	getLinkedServicesByWorkspace(com.azure.core.util.Context context)	Lists linked services.
com.azure.core.http.rest.Response<LinkedServiceResource>	getLinkedServiceWithResponse(String linkedServiceName, String ifNoneMatch, com.azure.core.util.Context context)	Gets a linked service.
void	renameLinkedService(String linkedServiceName, ArtifactRenameRequest request)	Renames a linked service.
com.azure.core.http.rest.Response<Void>	renameLinkedServiceWithResponse(String linkedServiceName, ArtifactRenameRequest request, com.azure.core.util.Context context)	Renames a linked service.

Methods inherited from class java.lang.Object

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

Method Detail

getLinkedServicesByWorkspace

public com.azure.core.http.rest.PagedIterable<LinkedServiceResource> getLinkedServicesByWorkspace()

Lists linked services.

Returns:

a list of linked service resources as paginated response with PagedIterable.

Throws:

CloudErrorException - thrown if the request is rejected by server.

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

getLinkedServicesByWorkspace

public com.azure.core.http.rest.PagedIterable<LinkedServiceResource> getLinkedServicesByWorkspace(com.azure.core.util.Context context)

Lists linked services.

Parameters:

context - The context to associate with this operation.

Returns:

a list of linked service resources as paginated response with PagedIterable.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

CloudErrorException - thrown if the request is rejected by server.

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

createOrUpdateLinkedService

public LinkedServiceResource createOrUpdateLinkedService(String linkedServiceName,
                                                         LinkedServiceResource linkedService,
                                                         String ifMatch)

Creates or updates a linked service.

Parameters:

linkedServiceName - The linked service name.

linkedService - Linked service resource definition.

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

Returns:

linked service resource type.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

CloudErrorException - thrown if the request is rejected by server.

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

createOrUpdateLinkedService

public LinkedServiceResource createOrUpdateLinkedService(String linkedServiceName,
                                                         LinkedServiceResource linkedService)

Creates or updates a linked service.

Parameters:

linkedServiceName - The linked service name.

linkedService - Linked service resource definition.

Returns:

linked service resource type.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

CloudErrorException - thrown if the request is rejected by server.

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

createOrUpdateLinkedServiceWithResponse

public com.azure.core.http.rest.Response<LinkedServiceResource> createOrUpdateLinkedServiceWithResponse(String linkedServiceName,
                                                                                                        LinkedServiceResource linkedService,
                                                                                                        String ifMatch,
                                                                                                        com.azure.core.util.Context context)

Creates or updates a linked service.

Parameters:

linkedServiceName - The linked service name.

linkedService - Linked service resource definition.

ifMatch - ETag of the linkedService 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:

linked service resource type along with Response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

CloudErrorException - thrown if the request is rejected by server.

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

getLinkedService

public LinkedServiceResource getLinkedService(String linkedServiceName,
                                              String ifNoneMatch)

Gets a linked service.

Parameters:

linkedServiceName - The linked service name.

ifNoneMatch - ETag of the linked service 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 linked service.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

CloudErrorException - thrown if the request is rejected by server.

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

getLinkedService

public LinkedServiceResource getLinkedService(String linkedServiceName)

Gets a linked service.

Parameters:

linkedServiceName - The linked service name.

Returns:

a linked service.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

CloudErrorException - thrown if the request is rejected by server.

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

getLinkedServiceWithResponse

public com.azure.core.http.rest.Response<LinkedServiceResource> getLinkedServiceWithResponse(String linkedServiceName,
                                                                                             String ifNoneMatch,
                                                                                             com.azure.core.util.Context context)

Gets a linked service.

Parameters:

linkedServiceName - The linked service name.

ifNoneMatch - ETag of the linked service 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 linked service along with Response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

CloudErrorException - thrown if the request is rejected by server.

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

deleteLinkedService

public void deleteLinkedService(String linkedServiceName)

Deletes a linked service.

Parameters:

linkedServiceName - The linked service name.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

CloudErrorException - thrown if the request is rejected by server.

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

deleteLinkedServiceWithResponse

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

Deletes a linked service.

Parameters:

linkedServiceName - The linked service name.

context - The context to associate with this operation.

Returns:

the Response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

CloudErrorException - thrown if the request is rejected by server.

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

renameLinkedService

public void renameLinkedService(String linkedServiceName,
                                ArtifactRenameRequest request)

Renames a linked service.

Parameters:

linkedServiceName - The linked service name.

request - proposed new name.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

CloudErrorException - thrown if the request is rejected by server.

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

renameLinkedServiceWithResponse

public com.azure.core.http.rest.Response<Void> renameLinkedServiceWithResponse(String linkedServiceName,
                                                                               ArtifactRenameRequest request,
                                                                               com.azure.core.util.Context context)

Renames a linked service.

Parameters:

linkedServiceName - The linked service name.

request - proposed new name.

context - The context to associate with this operation.

Returns:

the Response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

CloudErrorException - thrown if the request is rejected by server.

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