C# Class Microsoft.PowerBI.Api.V1.DatasetsExtensions

Extension methods for Datasets.

Show file Open project: Microsoft/PowerBI-CSharp

Public Methods

Method	Description
DeleteDatasetById ( this operations, string collectionName, string workspaceId, string datasetKey ) : object	Deletes the dataset with the specified id
DeleteDatasetByIdAsync ( this operations, string collectionName, string workspaceId, string datasetKey, CancellationToken cancellationToken = default(CancellationToken) ) : Task	Deletes the dataset with the specified id
DeleteRows ( this operations, string collectionName, string workspaceId, string datasetKey, string tableName ) : object	Deletes all rows from the specified table
DeleteRowsAsync ( this operations, string collectionName, string workspaceId, string datasetKey, string tableName, CancellationToken cancellationToken = default(CancellationToken) ) : Task	Deletes all rows from the specified table
GetDatasetById ( this operations, string collectionName, string workspaceId, string datasetKey ) : Dataset	Gets the dataset metadata for the specifeid dataset id
GetDatasetByIdAsync ( this operations, string collectionName, string workspaceId, string datasetKey, CancellationToken cancellationToken = default(CancellationToken) ) : Task	Gets the dataset metadata for the specifeid dataset id
GetDatasets ( this operations, string collectionName, string workspaceId ) : ODataResponseListDataset	Returns the datasets
GetDatasetsAsync ( this operations, string collectionName, string workspaceId, CancellationToken cancellationToken = default(CancellationToken) ) : Task	Returns the datasets
GetDatasources ( this operations, string collectionName, string workspaceId, string datasetKey ) : ODataResponseListDatasource	Gets a list of datasource for the specified dataset
GetDatasourcesAsync ( this operations, string collectionName, string workspaceId, string datasetKey, CancellationToken cancellationToken = default(CancellationToken) ) : Task	Gets a list of datasource for the specified dataset
GetGatewayDatasources ( this operations, string collectionName, string workspaceId, string datasetKey ) : ODataResponseListGatewayDatasource	Gets a list of bound gateway datasources for the specified dataset
GetGatewayDatasourcesAsync ( this operations, string collectionName, string workspaceId, string datasetKey, CancellationToken cancellationToken = default(CancellationToken) ) : Task	Gets a list of bound gateway datasources for the specified dataset
GetTables ( this operations, string collectionName, string workspaceId, string datasetKey ) : ODataResponseListTable	Gets all tables within the specified dataset
GetTablesAsync ( this operations, string collectionName, string workspaceId, string datasetKey, CancellationToken cancellationToken = default(CancellationToken) ) : Task	Gets all tables within the specified dataset
PostDataset ( this operations, string collectionName, string workspaceId, Dataset dataset ) : object	Post a new entity to datasets
PostDatasetAsync ( this operations, string collectionName, string workspaceId, Dataset dataset, CancellationToken cancellationToken = default(CancellationToken) ) : Task	Post a new entity to datasets
PostRows ( this operations, string collectionName, string workspaceId, string datasetKey, string tableName, object requestMessage ) : object	Posts new data rows into the specified table
PostRowsAsync ( this operations, string collectionName, string workspaceId, string datasetKey, string tableName, object requestMessage, CancellationToken cancellationToken = default(CancellationToken) ) : Task	Posts new data rows into the specified table
PutTable ( this operations, string collectionName, string workspaceId, string datasetKey, string tableName, object requestMessage ) : object	Updates a schema and metadata for the specified table
PutTableAsync ( this operations, string collectionName, string workspaceId, string datasetKey, string tableName, object requestMessage, CancellationToken cancellationToken = default(CancellationToken) ) : Task	Updates a schema and metadata for the specified table
SetAllConnections ( this operations, string collectionName, string workspaceId, string datasetKey, object>.IDictionary parameters ) : object	Sets all connections for the specified dataset
SetAllConnectionsAsync ( this operations, string collectionName, string workspaceId, string datasetKey, object>.IDictionary parameters, CancellationToken cancellationToken = default(CancellationToken) ) : Task	Sets all connections for the specified dataset

Method Details

DeleteDatasetById() public static method

Deletes the dataset with the specified id

public static DeleteDatasetById ( this operations, string collectionName, string workspaceId, string datasetKey ) : object
operations	this	/// The operations group for this extension method. ///
collectionName	string	/// The workspace collection name ///
workspaceId	string	/// The workspace id ///
datasetKey	string	/// The dataset id ///
return	object

DeleteDatasetByIdAsync() public static method

Deletes the dataset with the specified id

public static DeleteDatasetByIdAsync ( this operations, string collectionName, string workspaceId, string datasetKey, CancellationToken cancellationToken = default(CancellationToken) ) : Task
operations	this	/// The operations group for this extension method. ///
collectionName	string	/// The workspace collection name ///
workspaceId	string	/// The workspace id ///
datasetKey	string	/// The dataset id ///
cancellationToken	System.Threading.CancellationToken	/// The cancellation token. ///
return	Task

DeleteRows() public static method

Deletes all rows from the specified table

public static DeleteRows ( this operations, string collectionName, string workspaceId, string datasetKey, string tableName ) : object
operations	this	/// The operations group for this extension method. ///
collectionName	string	/// The workspace collection name ///
workspaceId	string	/// The workspace id ///
datasetKey	string	/// The dataset id ///
tableName	string	/// The table name ///
return	object

DeleteRowsAsync() public static method

Deletes all rows from the specified table

public static DeleteRowsAsync ( this operations, string collectionName, string workspaceId, string datasetKey, string tableName, CancellationToken cancellationToken = default(CancellationToken) ) : Task
operations	this	/// The operations group for this extension method. ///
collectionName	string	/// The workspace collection name ///
workspaceId	string	/// The workspace id ///
datasetKey	string	/// The dataset id ///
tableName	string	/// The table name ///
cancellationToken	System.Threading.CancellationToken	/// The cancellation token. ///
return	Task

GetDatasetById() public static method

Gets the dataset metadata for the specifeid dataset id

public static GetDatasetById ( this operations, string collectionName, string workspaceId, string datasetKey ) : Dataset
operations	this	/// The operations group for this extension method. ///
collectionName	string	/// The workspace collection name ///
workspaceId	string	/// The workspace id ///
datasetKey	string	/// The dataset id ///
return	Dataset

GetDatasetByIdAsync() public static method

Gets the dataset metadata for the specifeid dataset id

public static GetDatasetByIdAsync ( this operations, string collectionName, string workspaceId, string datasetKey, CancellationToken cancellationToken = default(CancellationToken) ) : Task
operations	this	/// The operations group for this extension method. ///
collectionName	string	/// The workspace collection name ///
workspaceId	string	/// The workspace id ///
datasetKey	string	/// The dataset id ///
cancellationToken	System.Threading.CancellationToken	/// The cancellation token. ///
return	Task

GetDatasets() public static method

Returns the datasets

public static GetDatasets ( this operations, string collectionName, string workspaceId ) : ODataResponseListDataset
operations	this	/// The operations group for this extension method. ///
collectionName	string	/// The workspace collection name ///
workspaceId	string	/// The workspace id ///
return	ODataResponseListDataset

GetDatasetsAsync() public static method

Returns the datasets

public static GetDatasetsAsync ( this operations, string collectionName, string workspaceId, CancellationToken cancellationToken = default(CancellationToken) ) : Task
operations	this	/// The operations group for this extension method. ///
collectionName	string	/// The workspace collection name ///
workspaceId	string	/// The workspace id ///
cancellationToken	System.Threading.CancellationToken	/// The cancellation token. ///
return	Task

GetDatasources() public static method

Gets a list of datasource for the specified dataset

public static GetDatasources ( this operations, string collectionName, string workspaceId, string datasetKey ) : ODataResponseListDatasource
operations	this	/// The operations group for this extension method. ///
collectionName	string	/// The workspace collection name ///
workspaceId	string	/// The workspace id ///
datasetKey	string	///
return	ODataResponseListDatasource

GetDatasourcesAsync() public static method

Gets a list of datasource for the specified dataset

public static GetDatasourcesAsync ( this operations, string collectionName, string workspaceId, string datasetKey, CancellationToken cancellationToken = default(CancellationToken) ) : Task
operations	this	/// The operations group for this extension method. ///
collectionName	string	/// The workspace collection name ///
workspaceId	string	/// The workspace id ///
datasetKey	string	///
cancellationToken	System.Threading.CancellationToken	/// The cancellation token. ///
return	Task

GetGatewayDatasources() public static method

Gets a list of bound gateway datasources for the specified dataset

public static GetGatewayDatasources ( this operations, string collectionName, string workspaceId, string datasetKey ) : ODataResponseListGatewayDatasource
operations	this	/// The operations group for this extension method. ///
collectionName	string	/// The workspace collection name ///
workspaceId	string	/// The workspace id ///
datasetKey	string	/// The dataset id ///
return	ODataResponseListGatewayDatasource

GetGatewayDatasourcesAsync() public static method

Gets a list of bound gateway datasources for the specified dataset

public static GetGatewayDatasourcesAsync ( this operations, string collectionName, string workspaceId, string datasetKey, CancellationToken cancellationToken = default(CancellationToken) ) : Task
operations	this	/// The operations group for this extension method. ///
collectionName	string	/// The workspace collection name ///
workspaceId	string	/// The workspace id ///
datasetKey	string	/// The dataset id ///
cancellationToken	System.Threading.CancellationToken	/// The cancellation token. ///
return	Task

GetTables() public static method

Gets all tables within the specified dataset

public static GetTables ( this operations, string collectionName, string workspaceId, string datasetKey ) : ODataResponseListTable
operations	this	/// The operations group for this extension method. ///
collectionName	string	/// The workspace collection name ///
workspaceId	string	/// The workspace id ///
datasetKey	string	/// The dataset id ///
return	ODataResponseListTable

GetTablesAsync() public static method

Gets all tables within the specified dataset

public static GetTablesAsync ( this operations, string collectionName, string workspaceId, string datasetKey, CancellationToken cancellationToken = default(CancellationToken) ) : Task
operations	this	/// The operations group for this extension method. ///
collectionName	string	/// The workspace collection name ///
workspaceId	string	/// The workspace id ///
datasetKey	string	/// The dataset id ///
cancellationToken	System.Threading.CancellationToken	/// The cancellation token. ///
return	Task

PostDataset() public static method

Post a new entity to datasets

public static PostDataset ( this operations, string collectionName, string workspaceId, Dataset dataset ) : object
operations	this	/// The operations group for this extension method. ///
collectionName	string	/// The workspace collection name ///
workspaceId	string	/// The workspace id ///
dataset	Dataset	/// The entity to post ///
return	object

PostDatasetAsync() public static method

Post a new entity to datasets

public static PostDatasetAsync ( this operations, string collectionName, string workspaceId, Dataset dataset, CancellationToken cancellationToken = default(CancellationToken) ) : Task
operations	this	/// The operations group for this extension method. ///
collectionName	string	/// The workspace collection name ///
workspaceId	string	/// The workspace id ///
dataset	Dataset	/// The entity to post ///
cancellationToken	System.Threading.CancellationToken	/// The cancellation token. ///
return	Task

PostRows() public static method

Posts new data rows into the specified table

public static PostRows ( this operations, string collectionName, string workspaceId, string datasetKey, string tableName, object requestMessage ) : object
operations	this	/// The operations group for this extension method. ///
collectionName	string	/// The workspace collection name ///
workspaceId	string	/// The workspace id ///
datasetKey	string	/// The dataset id ///
tableName	string	/// The table name ///
requestMessage	object	/// The request message ///
return	object

PostRowsAsync() public static method

Posts new data rows into the specified table

public static PostRowsAsync ( this operations, string collectionName, string workspaceId, string datasetKey, string tableName, object requestMessage, CancellationToken cancellationToken = default(CancellationToken) ) : Task
operations	this	/// The operations group for this extension method. ///
collectionName	string	/// The workspace collection name ///
workspaceId	string	/// The workspace id ///
datasetKey	string	/// The dataset id ///
tableName	string	/// The table name ///
requestMessage	object	/// The request message ///
cancellationToken	System.Threading.CancellationToken	/// The cancellation token. ///
return	Task

PutTable() public static method

Updates a schema and metadata for the specified table

public static PutTable ( this operations, string collectionName, string workspaceId, string datasetKey, string tableName, object requestMessage ) : object
operations	this	/// The operations group for this extension method. ///
collectionName	string	/// The workspace collection name ///
workspaceId	string	/// The workspace id ///
datasetKey	string	/// The dataset id ///
tableName	string	/// The table name ///
requestMessage	object	/// The request message ///
return	object

PutTableAsync() public static method

Updates a schema and metadata for the specified table

public static PutTableAsync ( this operations, string collectionName, string workspaceId, string datasetKey, string tableName, object requestMessage, CancellationToken cancellationToken = default(CancellationToken) ) : Task
operations	this	/// The operations group for this extension method. ///
collectionName	string	/// The workspace collection name ///
workspaceId	string	/// The workspace id ///
datasetKey	string	/// The dataset id ///
tableName	string	/// The table name ///
requestMessage	object	/// The request message ///
cancellationToken	System.Threading.CancellationToken	/// The cancellation token. ///
return	Task

SetAllConnections() public static method

Sets all connections for the specified dataset

public static SetAllConnections ( this operations, string collectionName, string workspaceId, string datasetKey, object>.IDictionary parameters ) : object
operations	this	/// The operations group for this extension method. ///
collectionName	string	/// The workspace collection name ///
workspaceId	string	/// The workspace id ///
datasetKey	string	/// The dataset id ///
parameters	object>.IDictionary	/// The body ///
return	object

SetAllConnectionsAsync() public static method

Sets all connections for the specified dataset

public static SetAllConnectionsAsync ( this operations, string collectionName, string workspaceId, string datasetKey, object>.IDictionary parameters, CancellationToken cancellationToken = default(CancellationToken) ) : Task
operations	this	/// The operations group for this extension method. ///
collectionName	string	/// The workspace collection name ///
workspaceId	string	/// The workspace id ///
datasetKey	string	/// The dataset id ///
parameters	object>.IDictionary	/// The body ///
cancellationToken	System.Threading.CancellationToken	/// The cancellation token. ///
return	Task