Package com.azure.resourcemanager.datafactory.models

Interface Datasets

public interface Datasets

Resource collection API of Datasets.

Method Summary

Modifier and Type	Method	Description
DatasetResource.DefinitionStages.Blank	define(String name)	Begins definition for a new DatasetResource resource.
void	delete(String resourceGroupName, String factoryName, String datasetName)	Deletes a dataset.
void	deleteById(String id)	Deletes a dataset.
com.azure.core.http.rest.Response<Void>	deleteByIdWithResponse(String id, com.azure.core.util.Context context)	Deletes a dataset.
com.azure.core.http.rest.Response<Void>	deleteWithResponse(String resourceGroupName, String factoryName, String datasetName, com.azure.core.util.Context context)	Deletes a dataset.
DatasetResource	get(String resourceGroupName, String factoryName, String datasetName)	Gets a dataset.
DatasetResource	getById(String id)	Gets a dataset.
com.azure.core.http.rest.Response<DatasetResource>	getByIdWithResponse(String id, String ifNoneMatch, com.azure.core.util.Context context)	Gets a dataset.
com.azure.core.http.rest.Response<DatasetResource>	getWithResponse(String resourceGroupName, String factoryName, String datasetName, String ifNoneMatch, com.azure.core.util.Context context)	Gets a dataset.
com.azure.core.http.rest.PagedIterable<DatasetResource>	listByFactory(String resourceGroupName, String factoryName)	Lists datasets.
com.azure.core.http.rest.PagedIterable<DatasetResource>	listByFactory(String resourceGroupName, String factoryName, com.azure.core.util.Context context)	Lists datasets.

Method Detail

listByFactory

com.azure.core.http.rest.PagedIterable<DatasetResource> listByFactory(String resourceGroupName,
                                                                      String factoryName)

Lists datasets.

Parameters:

resourceGroupName - The resource group name.

factoryName - The factory name.

Returns:

a list of dataset resources as paginated response with PagedIterable.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

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

listByFactory

com.azure.core.http.rest.PagedIterable<DatasetResource> listByFactory(String resourceGroupName,
                                                                      String factoryName,
                                                                      com.azure.core.util.Context context)

Lists datasets.

Parameters:

resourceGroupName - The resource group name.

factoryName - The factory name.

context - The context to associate with this operation.

Returns:

a list of dataset resources as paginated response with PagedIterable.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

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

get

DatasetResource get(String resourceGroupName,
                    String factoryName,
                    String datasetName)

Gets a dataset.

Parameters:

resourceGroupName - The resource group name.

factoryName - The factory name.

datasetName - The dataset name.

Returns:

a dataset.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

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

getWithResponse

com.azure.core.http.rest.Response<DatasetResource> getWithResponse(String resourceGroupName,
                                                                   String factoryName,
                                                                   String datasetName,
                                                                   String ifNoneMatch,
                                                                   com.azure.core.util.Context context)

Gets a dataset.

Parameters:

resourceGroupName - The resource group name.

factoryName - The factory name.

datasetName - The dataset name.

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

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

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

delete

void delete(String resourceGroupName,
            String factoryName,
            String datasetName)

Deletes a dataset.

Parameters:

resourceGroupName - The resource group name.

factoryName - The factory name.

datasetName - The dataset name.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

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

deleteWithResponse

com.azure.core.http.rest.Response<Void> deleteWithResponse(String resourceGroupName,
                                                           String factoryName,
                                                           String datasetName,
                                                           com.azure.core.util.Context context)

Deletes a dataset.

Parameters:

resourceGroupName - The resource group name.

factoryName - The factory name.

datasetName - The dataset name.

context - The context to associate with this operation.

Returns:

the Response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

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

getById

DatasetResource getById(String id)

Gets a dataset.

Parameters:

id - the resource ID.

Returns:

a dataset along with Response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

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

getByIdWithResponse

com.azure.core.http.rest.Response<DatasetResource> getByIdWithResponse(String id,
                                                                       String ifNoneMatch,
                                                                       com.azure.core.util.Context context)

Gets a dataset.

Parameters:

id - the resource ID.

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

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

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

deleteById

void deleteById(String id)

Deletes a dataset.

Parameters:

id - the resource ID.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

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

deleteByIdWithResponse

com.azure.core.http.rest.Response<Void> deleteByIdWithResponse(String id,
                                                               com.azure.core.util.Context context)

Deletes a dataset.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

Returns:

the Response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

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

define

DatasetResource.DefinitionStages.Blank define(String name)

Begins definition for a new DatasetResource resource.

Parameters:

name - resource name.

Returns:

the first stage of the new DatasetResource definition.