1. IDataSourcesClient

インターフェイス IDataSourcesClient

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

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

データソースのクエリ、作成、操作を行う機能を提供します。

名前空間: Stylelabs.M.Sdk.Clients
アセンブリ: Stylelabs.M.Sdk.dll
構文
public interface IDataSourcesClient

メソッド

CreateAsync(IDataSource)

新しいデータソースを作成します。

宣言
Task CreateAsync(IDataSource dataSource)
パラメーター
名前説明
IDataSourcedataSource

作成するデータソース。

戻り値
説明
Task

非同期操作を 表すタスク。

例外
条件
ValidationException

データソースが有効でないために作成できなかった場合にスローされます。 一般的なケースは次のとおりです。

  • データソースの名前が無効である。
  • データソースには階層値が含まれているが、型が "Flat" である。
  • 指定した名前のデータソースが既に存在する。
  • 識別子がない値がある。
  • 値の識別子が一意でない。
ForbiddenException

ユーザーがデータソースを作成することを許可されていない場合にスローされます。

DeleteAsync(String)

指定された name を持つデータソースを削除します。

宣言
Task DeleteAsync(string name)
パラメーター
名前説明
System.Stringname

削除するデータソースの名前 (大文字と小文字は区別されません)。

戻り値
説明
Task

A 表すタスク。

例外
条件
ForbiddenException

ユーザーがデータソースを削除することを許可されていない場合にスローされます。

ValidationException

検証エラーが発生したためにデータソースを削除できなかった場合にスローされます。 一般的なケース: データソースが 1 つ以上の EntityDefinitions で使用されています。

GetAllAsync()

M に存在するすべてのデータソースの名前を取得します。

宣言
Task<IList<string>> GetAllAsync()
戻り値
説明
Task<IList<System.String>>

M に存在するすべてのデータソースの名前。

GetAsync(String)

指定された name を持つデータソースを取得します。

宣言
Task<IDataSource> GetAsync(string name)
パラメーター
名前説明
System.Stringname

取得するデータソースの名前 (大文字と小文字は区別されません)。

戻り値
説明
Task<IDataSource>

指定された name を持つデータソース、または、データソースが見つからなかった場合は null

UpdateAsync(IDataSource)

データソースを更新します。

宣言
Task UpdateAsync(IDataSource dataSource)
パラメーター
名前説明
IDataSourcedataSource

更新するデータソース。

戻り値
説明
Task

A 表すタスク。

例外
条件
ValidationException

データソースが有効でないために作成できなかった場合にスローされます。 一般的なケースは次のとおりです。

  • データソースには階層値が含まれているが、型が "Flat" である。
  • 識別子がない値がある。
  • 値の識別子が一意でない。
ForbiddenException

ユーザーがデータソースを更新することを許可されていない場合にスローされます。

NotFoundException

指定された名前のデータソースが見つからなかった場合にスローされます。

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