Interface IDataSourceManagementClient

Namespace

FoundationaLLM.Client.Management.Interfaces

Assembly

FoundationaLLM.Client.Management.dll

Provides methods to manage data source resources.

public interface IDataSourceManagementClient

Extension Methods

ObjectExtensions.GetPropertyValues(object, List<string>)

Methods

CheckDataSourceNameAsync(ResourceName)

Checks the availability of a resource name for a data source. If the name is available, the Status value will be "Allowed". If the name is not available, the Status value will be "Denied" and the Message will explain the reason why. Typically, a denied name is due to a name conflict with an existing data source or a data source that was deleted but not purged.

Task<ResourceNameCheckResult> CheckDataSourceNameAsync(ResourceName resourceName)

Parameters

resourceName ResourceName

Contains the name of the resource to check.

Returns

Task<ResourceNameCheckResult>

Exceptions

ArgumentException

Thrown when the required properties within the argument are empty or missing.

DeleteDataSourceAsync(string)

Upserts a data source resource. If a data source does not exist, it will be created. If a data source does exist, it will be updated.

Task DeleteDataSourceAsync(string dataSourceName)

Parameters

dataSourceName string

The data source resource to create or update.

Returns

Task

Returns a ResourceProviderUpsertResult, which contains the Object ID of the resource.

FilterDataSourceAsync(ResourceFilter)

Returns data sources that match the filter criteria.

Task<List<DataSourceBase>> FilterDataSourceAsync(ResourceFilter resourceFilter)

Parameters

resourceFilter ResourceFilter

The filter criteria to apply to the request.

Returns

Task<List<DataSourceBase>>

GetDataSourceAsync(string)

Retrieves a specific data source by name.

Task<ResourceProviderGetResult<DataSourceBase>> GetDataSourceAsync(string dataSourceName)

Parameters

dataSourceName string

The name of the data source resource to retrieve.

Returns

Task<ResourceProviderGetResult<DataSourceBase>>

GetDataSourcesAsync()

Retrieves all data source resources.

Task<List<ResourceProviderGetResult<DataSourceBase>>> GetDataSourcesAsync()

Returns

Task<List<ResourceProviderGetResult<DataSourceBase>>>

All data source resources to which the caller has access and which have not been marked as deleted.

PurgeDataSourceAsync(string)

Purges a deleted data source by its name. This action is irreversible.

Task<ResourceProviderActionResult> PurgeDataSourceAsync(string dataSourceName)

Parameters

dataSourceName string

The name of the data source to purge.

Returns

Task<ResourceProviderActionResult>

UpsertDataSourceAsync(DataSourceBase)

Upserts a data source resource. If a data source does not exist, it will be created. If a data source does exist, it will be updated.

Task<ResourceProviderUpsertResult> UpsertDataSourceAsync(DataSourceBase dataSource)

Parameters

dataSource DataSourceBase

The data source resource to create or update.

Returns

Task<ResourceProviderUpsertResult>

Returns a ResourceProviderUpsertResult, which contains the Object ID of the resource.