クラス: PersistenceStoreInterface

クラス: PersistenceStoreInterface

QuickNav

メソッド

PersistenceStoreInterface

new PersistenceStoreInterface ()

ジョブ・ライフサイクル中のジョブの永続性を管理します。
このモジュールは、ジョブの状態を保存し、起動/停止およびフェイルオーバー中に状態を管理する責任があります。
  • 具体的には、次のことを行う必要があります:
    • すべてのジョブを追跡します。
    • 各ジョブについて:
      • ジョブに関するメタデータを格納し、言語サービス・プロバイダのプロジェクトにマッピングします。
      • OCE翻訳ジョブによって提供されるzipファイルを格納/解凍します。
      • 各ファイルに関するメタデータをzipに格納し、そのファイルを言語サービス・プロバイダのエントリにマップします。
      • 各ファイルのすべての翻訳が使用可能になったときに格納します。
      • すべての翻訳済ファイルの最終zipをOCE翻訳ジョブへの取込みに必要な形式で作成します。
      • ジョブの削除時に、ジョブに関連付けられているすべてのアーティファクトを削除します。
ソース:

メソッド

addBinaryTranslationFile(args) → {Promise}

翻訳済バイナリ・ファイルを翻訳リポジトリに追加
パラメータ:
名前 タイプ 説明
args object "addTranslationFile"パラメータを含むJavaScriptオブジェクト。
プロパティ
名前 タイプ 説明
jobId string ジョブの識別子。
locale string このファイルの翻訳のロケール。
fileType 'site' | 'assets' フェッチするファイルのタイプ - アセット・ファイルまたはサイト・リソースのいずれであるか。
filePath string 返すファイル・システム上のファイルの名前。
fileContent string ファイルの翻訳済コンテンツ。
fileName string ファイルの内容の書き込みに失敗した場合の記述名。
folderPath string バイナリ・ファイルへのフォルダ・パス。
ソース:
戻り値:
ファイルが翻訳リポジトリに保存されたときに解決される約束。
タイプ
予約

addTranslationFile(args) → {Promise}

翻訳リポジトリへの翻訳済ファイルの追加
パラメータ:
名前 タイプ 説明
args object "addTranslationFile"パラメータを含むJavaScriptオブジェクト。
プロパティ
名前 タイプ 説明
jobId string ジョブの識別子。
locale string このファイルの翻訳のロケール。
fileType 'site' | 'assets' フェッチするファイルのタイプ - アセット・ファイルまたはサイト・リソースのいずれであるか。
filePath string 返すファイル・システム上のファイルの名前。
fileContent string ファイルの翻訳済コンテンツ。
fileName string ファイルの内容の書き込みに失敗した場合の記述名。
ソース:
戻り値:
ファイルが翻訳リポジトリに保存されたときに解決される約束。
タイプ
予約

createFileMetadata(args) → {Promise.<PersistenceApi.fileMetadata>}

翻訳するファイルに保持されるメタデータを作成します。
パラメータ:
名前 タイプ 説明
args object "createFileMetadata"パラメータを含むJavaScriptオブジェクト。
プロパティ
名前 タイプ 説明
jobId string ジョブの識別子。
fileType 'site' | 'assets' フェッチするファイルのタイプ - アセット・ファイルまたはサイト・リソースのいずれであるか。
file SampleJobManager.file 永続ストア内のファイルに関する詳細。
ソース:
戻り値:
ファイルのメタデータに関する詳細で解決される約束
タイプ
Promise.<PersistenceApi.fileMetadata>

createJob(args) → {Promise.<SampleJobManager.JobConfig>}

翻訳ジョブの作成
この翻訳ジョブのエントリを永続性ストア内に作成します。
パラメータ:
名前 タイプ 説明
args object "createJob"パラメータを含むJavaScriptオブジェクト。
プロパティ
名前 タイプ 説明
jobName string OCE翻訳ジョブの名前。
workflowId string このジョブの翻訳に使用する言語サービス・プロバイダ・ワークフロー識別子。
authToken string LSPとの通信に使用する言語サービス・プロバイダ認可ヘッダー。
additionalData string LSPの各ドキュメントに適用する追加データ。
ソース:
戻り値:
このジョブに対して作成および格納されるメタデータ。
タイプ
Promise.<SampleJobManager.JobConfig>

createTranslationRepository(args) → {Promise}

すべての翻訳済ファイルを保持するリポジトリを作成します。
パラメータ:
名前 タイプ 説明
args object "createTranslationRepository"パラメータを含むJavaScriptオブジェクト。
プロパティ
名前 タイプ 説明
jobId string ジョブの識別子。
ソース:
戻り値:
リポジトリが翻訳を受け取るように設定されている場合に解決される約束。
タイプ
予約

createTranslationZip(args) → {Promise.<SampleJobManager.JobConfig>}

翻訳済ファイルのエクスポートzipファイルを作成します。
パラメータ:
名前 タイプ 説明
args object "createTranslationZip"パラメータを含むJavaScriptオブジェクト。
プロパティ
名前 タイプ 説明
jobId string ジョブの識別子。
ソース:
戻り値:
作成されたzipファイルのtranslatedZipFileプロパティを含む更新されたジョブ・メタデータで解決される約束。
タイプ
Promise.<SampleJobManager.JobConfig>

deleteJob(args) → {Promise}

指定されたジョブ識別子に関連するすべての永続性データを削除します。
パラメータ:
名前 タイプ 説明
args object "deleteJob"パラメータを含むJavaScriptオブジェクト。
プロパティ
名前 タイプ 説明
jobId string 削除するジョブの識別子。
ソース:
戻り値:
ジョブが削除されたときに解決される約束。
タイプ
予約

exportTranslationZip(args) → {Promise.<PersistenceApi.ZipFileStream>}

翻訳済zipファイルをエクスポート
パラメータ:
名前 タイプ 説明
args object "exportTranslationZip"パラメータを含むJavaScriptオブジェクト。
プロパティ
名前 タイプ 説明
jobId string ジョブの識別子。
ソース:
戻り値:
HTTPSレスポンスで返すことができるzipファイル・ストリームで解決される約束。
タイプ
Promise.<PersistenceApi.ZipFileStream>

getAllJobs() → {Promise.<Array.<SampleJobManager.JobConfig>>}

PersistenceApiによって現在追跡されているすべてのジョブを取得
ソース:
戻り値:
各翻訳ジョブのメタデータの配列を返す約束。
タイプ
Promise.<Array.<SampleJobManager.JobConfig>>

getBinaryFile(args) → {Promise.<string>}

バイナリ・ファイルを取得します。
パラメータ:
名前 タイプ 説明
args object "getSourceFile"パラメータを含むJavaScriptオブジェクト。
プロパティ
名前 タイプ 説明
jobId string ジョブの識別子。
fileType 'site' | 'assets' フェッチするファイルのタイプ - アセット・ファイルまたはサイト・リソースのいずれであるか。
folderPath string バイナリ・ファイル・ディレクトリのフォルダ・パス。
file SampleJobManager.file 永続ストアから戻すファイルに関する詳細。
ソース:
戻り値:
バイナリ ファイル;バイナリー ファイル
タイプ
Promise.<string>

getBinaryFilePath() → {string}

デジタル・アセットのバイナリ・ファイル・フォルダへのパスを取得します。
パラメータ:
名前 タイプ 説明
args.contentItemId string デジタル・アセットID
ソース:
戻り値:
デジタル・アセットのバイナリ・ファイル・フォルダへのパス。
タイプ
string

getBinaryFileSpec(args) → {string}

バイナリ・ファイルのバイナリ・ファイル仕様を取得します。
パラメータ:
名前 タイプ 説明
args object "getSourceFile"パラメータを含むJavaScriptオブジェクト。
プロパティ
名前 タイプ 説明
jobId string ジョブの識別子。
fileType 'site' | 'assets' フェッチするファイルのタイプ - アセット・ファイルまたはサイト・リソースのいずれであるか。
folderPath string バイナリ・ファイル・ディレクトリのフォルダ・パス。
file SampleJobManager.file 永続ストアから戻すファイルに関する詳細。
ソース:
戻り値:
デジタル・アセットのバイナリ・ファイル仕様。
タイプ
string

getFileMetadata(args) → {Promise.<PersistenceApi.fileMetadata>}

変換するファイルのメタデータを取得します。
パラメータ:
名前 タイプ 説明
args object "getFileMetadata"パラメータを含むJavaScriptオブジェクト。
プロパティ
名前 タイプ 説明
jobId string ジョブの識別子。
fileType 'site' | 'assets' フェッチするファイルのタイプ - アセット・ファイルまたはサイト・リソースのいずれであるか。
file SampleJobManager.file 永続ストア内のファイルに関する詳細。
ソース:
戻り値:
ファイルのメタデータに関する詳細で解決される約束
タイプ
Promise.<PersistenceApi.fileMetadata>

getFolderFiles(args) → {Array.<string>}

デジタル・アセットのバイナリ・ファイル・フォルダ内のファイルのリストを取得します。
パラメータ:
名前 タイプ 説明
args object "getSourceFile"パラメータを含むJavaScriptオブジェクト。
プロパティ
名前 タイプ 説明
jobId string ジョブの識別子。
fileType 'site' | 'assets' フェッチするファイルのタイプ - アセット・ファイルまたはサイト・リソースのいずれであるか。
folderPath string バイナリ・ファイル・ディレクトリのフォルダ・パス。
file SampleJobManager.file 永続ストアから戻すファイルに関する詳細。
ソース:
戻り値:
デジタル・アセットのバイナリ・ファイル・フォルダ内のファイルのリスト。
タイプ
Array.<string>

getJob(args) → {Promise.<SampleJobManager.JobConfig>}

翻訳ジョブを取得します。
このジョブの永続性ストアからジョブ・メタデータを取得します。
パラメータ:
名前 タイプ 説明
args object "getJob"パラメータを含むJavaScriptオブジェクト。
プロパティ
名前 タイプ 説明
jobId string 永続ストア内のジョブの識別子。
ソース:
戻り値:
このジョブに対して作成および格納されるメタデータ。
タイプ
Promise.<SampleJobManager.JobConfig>

getSourceFile(args) → {Promise.<string>}

リクエストされたソース・ファイルをジョブから取得します。
パラメータ:
名前 タイプ 説明
args object "getSourceFile"パラメータを含むJavaScriptオブジェクト。
プロパティ
名前 タイプ 説明
jobId string ジョブの識別子。
fileType 'site' | 'assets' フェッチするファイルのタイプ - アセット・ファイルまたはサイト・リソースのいずれであるか。
filePath string 返すファイル・システム上のファイルの名前。
file SampleJobManager.file 永続ストアから戻すファイルに関する詳細。
ソース:
戻り値:
ファイル内容で解決される約束。
タイプ
Promise.<string>

getSourceJobJSON(args) → {Promise.<SampleJobManager.JobDetails>}

zipファイルのソースjob.jsonファイルを取得します。
ジョブは、次のいずれかになります:
  • 次の構造を持つ"assets"ジョブ・タイプ:
    • job.json
    • root
  • 次の構造を持つ"site"ジョブ・タイプ:
    • assets
      • job.json
      • root
    • site
      • job.json
      • root
パラメータ:
名前 タイプ 説明
args object "getSourceJobJSON"パラメータを含むJavaScriptオブジェクト。
プロパティ
名前 タイプ 説明
jobId string job.json情報を取得するためのジョブの識別子。
ソース:
戻り値:
結合されたjob.jsonファイルで解決される約束。
タイプ
Promise.<SampleJobManager.JobDetails>

importSourceZip(args) → {Promise}

ソースzipファイルをインポートし、永続性ストアの「translation-source」フォルダに展開します。
パラメータ:
名前 タイプ 説明
args object "importSourceZip"パラメータを含むJavaScriptオブジェクト。
プロパティ
名前 タイプ 説明
jobId string 削除するジョブの識別子。
zipFile stream ファイルシステムに書き込むzipファイルの内容
ソース:
戻り値:
zipファイルがファイルシステムに書き込まれ、展開されたときに解決される約束。
タイプ
予約

updateFileMetadata(args) → {Promise.<PersistenceApi.fileMetadata>}

翻訳するファイルのメタデータを更新します。
パラメータ:
名前 タイプ 説明
args object "updateFileMetadata"パラメータを含むJavaScriptオブジェクト。
プロパティ
名前 タイプ 説明
jobId string ジョブの識別子。
fileType 'site' | 'assets' フェッチするファイルのタイプ - アセット・ファイルまたはサイト・リソースのいずれであるか。
file SampleJobManager.file 永続ストア内のファイルに関する詳細。
ソース:
戻り値:
ファイルのメタデータに関する詳細で解決される約束
タイプ
Promise.<PersistenceApi.fileMetadata>

updateJob(args) → {Promise.<SampleJobManager.JobConfig>}

翻訳ジョブを更新します。
ジョブの状態に関する新しいメタデータで翻訳ジョブを更新します。
ノート : 現在、メタデータ内の次のプロパティの更新のみがサポートされています:
  • status
  • statusMessage
  • translatedZipFile
  • progress
パラメータ:
名前 タイプ 説明
args SampleJobManager.JobConfig このジョブで更新するメタデータを含むJavaScriptオブジェクト。
ソース:
戻り値:
このジョブに保存されている更新されたメタデータ。
タイプ
Promise.<SampleJobManager.JobConfig>
Copyright © 2017, 2022 Oracle and/or its affiliates.