DatasetOperationsImpl | @azure/synapse-artifacts

Class containing DatasetOperations operations.

Hierarchy

DatasetOperationsImpl

Implements

DatasetOperations

Index

Constructors

constructor

Methods

Constructors

constructor

new DatasetOperationsImpl(client: ArtifactsClient): DatasetOperationsImpl

- Defined in operations/datasetOperations.ts:37
Initialize a new instance of the class DatasetOperations class.

Parameters
- client: ArtifactsClient
  
  Reference to the service client
Returns DatasetOperationsImpl

Methods

beginCreateOrUpdateDataset

beginCreateOrUpdateDataset(datasetName: string, dataset: DatasetResource, options?: DatasetCreateOrUpdateDatasetOptionalParams): Promise<PollerLike<PollOperationState<DatasetCreateOrUpdateDatasetResponse>, DatasetCreateOrUpdateDatasetResponse>>

Implementation of DatasetOperations.beginCreateOrUpdateDataset
- Defined in operations/datasetOperations.ts:126
Creates or updates a dataset.

Parameters
- datasetName: string
  
  The dataset name.
- dataset: DatasetResource
  
  Dataset resource definition.
- Optional options: DatasetCreateOrUpdateDatasetOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<DatasetCreateOrUpdateDatasetResponse>, DatasetCreateOrUpdateDatasetResponse>>

beginCreateOrUpdateDatasetAndWait

beginCreateOrUpdateDatasetAndWait(datasetName: string, dataset: DatasetResource, options?: DatasetCreateOrUpdateDatasetOptionalParams): Promise<DatasetCreateOrUpdateDatasetResponse>

Implementation of DatasetOperations.beginCreateOrUpdateDatasetAndWait
- Defined in operations/datasetOperations.ts:209
Creates or updates a dataset.

Parameters
- datasetName: string
  
  The dataset name.
- dataset: DatasetResource
  
  Dataset resource definition.
- Optional options: DatasetCreateOrUpdateDatasetOptionalParams
  
  The options parameters.
Returns Promise<DatasetCreateOrUpdateDatasetResponse>

beginDeleteDataset

beginDeleteDataset(datasetName: string, options?: DatasetDeleteDatasetOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Implementation of DatasetOperations.beginDeleteDataset
- Defined in operations/datasetOperations.ts:254
Deletes a dataset.

Parameters
- datasetName: string
  
  The dataset name.
- Optional options: DatasetDeleteDatasetOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteDatasetAndWait

beginDeleteDatasetAndWait(datasetName: string, options?: DatasetDeleteDatasetOptionalParams): Promise<void>

Implementation of DatasetOperations.beginDeleteDatasetAndWait
- Defined in operations/datasetOperations.ts:330
Deletes a dataset.

Parameters
- datasetName: string
  
  The dataset name.
- Optional options: DatasetDeleteDatasetOptionalParams
  
  The options parameters.
Returns Promise<void>

beginRenameDataset

beginRenameDataset(datasetName: string, request: ArtifactRenameRequest, options?: DatasetRenameDatasetOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Implementation of DatasetOperations.beginRenameDataset
- Defined in operations/datasetOperations.ts:344
Renames a dataset.

Parameters
- datasetName: string
  
  The dataset name.
- request: ArtifactRenameRequest
  
  proposed new name.
- Optional options: DatasetRenameDatasetOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginRenameDatasetAndWait

beginRenameDatasetAndWait(datasetName: string, request: ArtifactRenameRequest, options?: DatasetRenameDatasetOptionalParams): Promise<void>

Implementation of DatasetOperations.beginRenameDatasetAndWait
- Defined in operations/datasetOperations.ts:422
Renames a dataset.

Parameters
- datasetName: string
  
  The dataset name.
- request: ArtifactRenameRequest
  
  proposed new name.
- Optional options: DatasetRenameDatasetOptionalParams
  
  The options parameters.
Returns Promise<void>

getDataset

getDataset(datasetName: string, options?: DatasetGetDatasetOptionalParams): Promise<DatasetGetDatasetResponse>

Implementation of DatasetOperations.getDataset
- Defined in operations/datasetOperations.ts:227
Gets a dataset.

Parameters
- datasetName: string
  
  The dataset name.
- Optional options: DatasetGetDatasetOptionalParams
  
  The options parameters.
Returns Promise<DatasetGetDatasetResponse>

listDatasetsByWorkspace

listDatasetsByWorkspace(options?: DatasetGetDatasetsByWorkspaceOptionalParams): PagedAsyncIterableIterator<DatasetResource>

Implementation of DatasetOperations.listDatasetsByWorkspace
- Defined in operations/datasetOperations.ts:51
Lists datasets.

Parameters
- Optional options: DatasetGetDatasetsByWorkspaceOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<DatasetResource>

Hierarchy

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

client: ArtifactsClient

Returns DatasetOperationsImpl

Methods

beginCreateOrUpdateDataset

Parameters

datasetName: string

dataset: DatasetResource

Optional options: DatasetCreateOrUpdateDatasetOptionalParams

Returns Promise<PollerLike<PollOperationState<DatasetCreateOrUpdateDatasetResponse>, DatasetCreateOrUpdateDatasetResponse>>

beginCreateOrUpdateDatasetAndWait

Parameters

datasetName: string

dataset: DatasetResource

Optional options: DatasetCreateOrUpdateDatasetOptionalParams

Returns Promise<DatasetCreateOrUpdateDatasetResponse>

beginDeleteDataset

Parameters

datasetName: string

Optional options: DatasetDeleteDatasetOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteDatasetAndWait

Parameters

datasetName: string

Optional options: DatasetDeleteDatasetOptionalParams

Returns Promise<void>

beginRenameDataset

Parameters

datasetName: string

request: ArtifactRenameRequest

Optional options: DatasetRenameDatasetOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginRenameDatasetAndWait

Parameters

datasetName: string

request: ArtifactRenameRequest

Optional options: DatasetRenameDatasetOptionalParams

Returns Promise<void>

getDataset

Parameters

datasetName: string

Optional options: DatasetGetDatasetOptionalParams

Returns Promise<DatasetGetDatasetResponse>

listDatasetsByWorkspace

Parameters

Optional options: DatasetGetDatasetsByWorkspaceOptionalParams

Returns PagedAsyncIterableIterator<DatasetResource>