1. IDataSourcesClient

Interface IDataSourcesClient

Version:
日本語翻訳に関する免責事項

このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。

Provides functionality to query, create and manipulate datasources.

Namespace: Stylelabs.M.Sdk.Clients
Assembly: Stylelabs.M.Sdk.dll
Syntax
public interface IDataSourcesClient

Methods

CreateAsync(IDataSource)

Creates a new datasource.

Declaration
Task CreateAsync(IDataSource dataSource)
Parameters
TypeNameDescription
IDataSourcedataSource

The datasource to create.

Returns
TypeDescription
Task

A representing the asynchronous operation.

Exceptions
TypeCondition
ValidationException

Thrown when the datasource could not be created because it is not valid. Common cases:

  • The name of the datasource is invalid.
  • The datasource contains hierarchical values but has type "Flat".
  • A datasource with the specified name already exists.
  • Not all values have an identifier.
  • The identifiers of the values are not unique.
ForbiddenException

Thrown when the user is not allowed to create datasources.

DeleteAsync(String)

Deletes the datasource with the specified name.

Declaration
Task DeleteAsync(string name)
Parameters
TypeNameDescription
System.Stringname

The name of the datasource to delete (case insensitive).

Returns
TypeDescription
Task

A representing the asynchronous operation.

Exceptions
TypeCondition
ForbiddenException

Thrown when the user is not allowed to delete the datasource.

ValidationException

Thrown when the datasource could not be deleted because a validation error occurred. Common case: the datasource is being used in one or more EntityDefinitions.

GetAllAsync()

Gets the names of all datasources that exist in the M.

Declaration
Task<IList<string>> GetAllAsync()
Returns
TypeDescription
Task<IList<System.String>>

The names of all datasources that exist in M.

GetAsync(String)

Gets the datasource with the specified name.

Declaration
Task<IDataSource> GetAsync(string name)
Parameters
TypeNameDescription
System.Stringname

The name of the datasource to get (case insensitive).

Returns
TypeDescription
Task<IDataSource>

The datasource with the specified name or null if the datasource could not be found.

UpdateAsync(IDataSource)

Updates a datasource.

Declaration
Task UpdateAsync(IDataSource dataSource)
Parameters
TypeNameDescription
IDataSourcedataSource

The datasource to update.

Returns
TypeDescription
Task

A representing the asynchronous operation.

Exceptions
TypeCondition
ValidationException

Thrown when the datasource could not be created because it is not valid. Common cases:

  • The datasource contains hierarchical values but has type "Flat".
  • Not all values have an identifier.
  • The identifiers of the values are not unique.
ForbiddenException

Thrown when the user is not allowed to update datasources.

NotFoundException

Thrown when the datasource with the specified name could not be found.

この記事を改善するための提案がある場合は、 お知らせください!