スクリプティングSDKクライアント

ジョブ・クライアント

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

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

スクリプティングSDKは、エンティティに対してCRUD操作を実行するためのJobs clientを提供します。

メモ

EntitiesクライアントからJobsクライアントへのコード更新を支援するために、いくつかの例が用意されています。

GetTargetsAsync (英語)

このメソッドは、ジョブのターゲットを取得し、JobTargetQueryリクエストパラメータをサポートします。このパラメーターは、ジョブ・ターゲット照会要求であり、さまざまなフィルター・オプションを持つジョブ・ターゲットの要求を表します。これにより、関心のあるジョブ目標を絞り込むための基準を指定できます。

このメソッドでサポートされるプロパティを次の表に示します。

財産	種類	形容
JobId	長い	ジョブの一意のID。
State	糸	ジョブ・ターゲットの状態 (オプション)。これを使用して、現在の状態に基づいてターゲットをフィルタリングできます。
Condition	糸	ジョブ・ターゲットの条件 (オプション)。これを使用して、特定の条件に基づいてターゲットをフィルタリングできます。
Type	糸	ジョブ・ターゲットのタイプ (オプション)。これを使用して、タイプに基づいてターゲットをフィルタリングできます。
Location	糸	ジョブ・ターゲットの位置 (オプション)。これを使用して、地理的な場所に基づいてターゲットをフィルタリングできます。
Skip	整数	スキップするレコードの数。これは、ページネーションに役立ちます。
Take	整数	取得するレコードの数。これは、ページネーションに役立ちます。デフォルト値は25です。
Cultures	文化情報	エンティティを読み込むためのカルチャ情報 (省略可能)。カルチャが指定されていない場合、複数言語のプロパティは含まれません。デフォルト値は、CultureInfo.InvariantCultureを含む配列です。

次の例では、JobTargetQueryを使用して、状態、条件、タイプ、場所などのさまざまなフィルターが適用された特定のジョブ (JobId = 123) のジョブターゲットを要求します。このクエリは0レコードをスキップし、50レコードを受け取り、英語 (米国) とフランス語 (FR) カルチャの多言語プロパティが含まれます。

var jobTargetQuery = new JobTargetQuery(123)
{
    State = "Waiting",
    Condition = "Pending",
    Type = "System",
    Location = "67890",
    Skip = 0,
    Take = 50,
    Cultures = new[] { new CultureInfo("en-US"), new CultureInfo("fr-FR") }
};

この例では、クライアントメソッドを呼び出します。

using Stylelabs.M.Sdk.Contracts.Jobs;

var jobTargetQuery = new JobTargetQuery(123)
{
    State = "Waiting",
    Skip = 0,
    Take = 10
};

IEntityCollectionResult targets = await MClient.Jobs.GetTargetsAsync(jobTargetQuery);

このメソッドは、ジョブ・ターゲットのコレクションをTask<IEntityCollectionResult>. .次の例外が発生する可能性があります。

ArgumentNullException - リクエストがnullの場合。
ArgumentOutOfRangeException - request.Takeまたはrequest.Skipの値が負の数値であるか、または要求。JobIdは有効なIDではありません。
ArgumentException - request.culturesがnullの場合、またはジョブエンティティが見つからない場合。

GetTargetAsync

このメソッドは、ジョブの特定のターゲットを取得します。

このメソッドでサポートされるプロパティを次の表に示します。

財産	種類	形容
JobId	長い	ジョブの一意のID。
TargetId	長い	ターゲットID。
Cultures	文化情報	エンティティを読み込むためのカルチャ情報 (省略可能)。カルチャが指定されていない場合、複数言語のプロパティは含まれません。デフォルト値は、CultureInfo.InvariantCultureを含む配列です。

次の例では、

IEntity description = await MClient.Jobs.GetTargetAsync(jobId, targetId);

このメソッドは、特定のターゲットエンティティTask<IEntity>を返します。次の例外が発生する可能性があります。

ArgumentException - JobIdまたはTargetIdが有効でない場合。
WebApiException - HTTP要求が失敗した場合。

SaveTargetAsync

このメソッドは、ジョブのターゲットを作成または更新します。次のパラメータをサポートしています。

パラメーター	種類	形容
jobId	長い	ジョブID。
target	イエンティ	ターゲットエンティティ。

このメソッドは、保存されたターゲットTask<long>のIDを返します。次の例外が発生する可能性があります。

ArgumentNullException - ターゲットがnullの場合。
ArgumentException - ジョブエンティティが見つからない場合。
ArgumentOutOfRangeException - ジョブIDが有効なIDでない場合。

このメソッドでは、次の構文を使用します。

long targetId = await MClient.Jobs.SaveTargetAsync(123, targetEntity);

DeleteTargetAsync

このメソッドは、ジョブのターゲットを削除します。次のパラメータをサポートしています。

パラメーター	種類	形容
jobId	長い	ジョブID。
targetId	長い	ターゲットID。

このメソッドは、非同期操作を表すタスクを返します。次の例外が発生する可能性があります。

ArgumentException - ジョブIDまたは対象IDが無効な場合
ArgumentOutOfRangeException - ジョブIDまたは対象IDが有効なIDでない場合。

このメソッドでは、次の構文を使用します。

await MClient.Jobs.DeleteTargetAsync(123, 456);

GetDescriptionAsync

このメソッドは、ジョブの説明を取得します。次のパラメータをサポートしています。

パラメーター	種類	形容
jobId	長い	ジョブID。
cultures	文化情報	説明のオプションのカルチャ。

このメソッドは、ジョブ記述エンティティTask<IEntity>を返します。次の例外が発生する可能性があります。

ArgumentException - ジョブIDが無効な場合
ArgumentOutOfRangeException - ジョブIDが有効なIDでない場合。

このメソッドでは、次の構文を使用します。

IEntity jobDescription = await MClient.Jobs.GetDescriptionAsync(123);

SaveDescriptionAsync

このメソッドは、ジョブの説明を作成または更新します。次のパラメータをサポートしています。

パラメーター	種類	形容
jobId	長い	ジョブID。
jobDescription	イエンティ	ジョブ記述エンティティ。

このメソッドは、保存されたジョブの説明のIDを返しますTask<long>.次の例外が発生する可能性があります。

ArgumentNullException - ジョブの説明がnullの場合。
ArgumentException - ジョブIDまたはジョブ記述IDが無効な場合
ArgumentOutOfRangeException - ジョブIDが有効なIDでない場合。

このメソッドでは、次の構文を使用します。

long descriptionId = await MClient.Jobs.SaveDescriptionAsync(123, jobDescriptionEntity);

DeleteDescriptionAsync

このメソッドは、ジョブの説明を削除します。次のパラメータをサポートしています。

パラメーター	種類	形容
jobId	長い	ジョブID。

このメソッドは、非同期操作を表すタスクを返します。次の例外が発生する可能性があります。

ArgumentException - ジョブまたは説明エンティティが見つからない場合。
ArgumentOutOfRangeException - ジョブIDが有効なIDでない場合。

このメソッドでは、次の構文を使用します。

await MClient.Jobs.DeleteDescriptionAsync(123);

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