クラス: SampleConnector

クラス: SampleConnector

QuickNav

メソッド

SampleConnector

new SampleConnector ()

ソース:

メソッド

createJob(req, res) → {HttpResponse.<SampleConnector.JobStatus>}

POSTリクエストから翻訳ジョブを作成します。 ジョブはコネクタ永続性ストアに格納され、OCEから言語サービス・プロバイダに翻訳リクエストを関連付けるために使用されます。 ジョブ「status」は「CREATED」に設定されています。 対応するREST APIエンドポイントは次のとおりです: POST: /connector/rest/api/v1/job
パラメータ:
名前 タイプ 説明
req object HTTPSリクエスト・オブジェクト。
プロパティ
名前 タイプ 説明
body object 'req'パラメータから抽出された本文オブジェクト。
プロパティ
名前 タイプ 説明
name string 作成するジョブの名前。
header object ヘッダーを介して渡されるパラメータ。
プロパティ
名前 タイプ 説明
BearerToken string OAuth言語サービス・プロバイダに接続するためのBearerトークン
workflowId string このジョブでファイルを変換するときに使用するワークフローの識別子。
res object HTTPSレスポンス・オブジェクト。
ソース:
戻り値:
タイプ
HttpResponse.<SampleConnector.JobStatus>

deleteJob(req, res) → {HttpResponse.<string>}

ジョブとすべての関連データを翻訳コネクタから削除します。対応するREST APIエンドポイントは次のとおりです: DELETE : /connector/rest/api/v1/job/:id
パラメータ:
名前 タイプ 説明
req object HTTPSリクエスト・オブジェクト。
プロパティ
名前 タイプ 説明
params object URLに渡されたパラメータ。
プロパティ
名前 タイプ 説明
id string 取得するコネクタ・ジョブの識別子。
header object ヘッダーを介して渡されるパラメータ。
プロパティ
名前 タイプ 説明
BearerToken string OAuth言語サービス・プロバイダに接続するためのBearerトークン
res object HTTPSレスポンス・オブジェクト。
ソース:
戻り値:
削除が成功したことを確認
タイプ
HttpResponse.<string>

getApiVersions(req, res) → {HttpResponse.<array>}

このサーバーでサポートされているAPIバージョンの配列を返します。対応するREST APIエンドポイントは次のとおりです: GET: /connector/rest/api
パラメータ:
名前 タイプ 説明
req object HTTPSリクエスト・オブジェクト。
res object HTTPSレスポンス・オブジェクト。
ソース:
戻り値:
["v1"]
タイプ
HttpResponse.<array>

getJob(req, res) → {HttpResponse.<SampleConnector.JobStatus>}

GETリクエストから、特定のジョブIDに対応する翻訳コネクタ・ジョブの詳細、ステータスおよび翻訳の進行状況を取得します。 対応するREST APIエンドポイントは次のとおりです: GET : /connector/rest/api/v1/job/:id
パラメータ:
名前 タイプ 説明
req object HTTPSリクエスト・オブジェクト。
プロパティ
名前 タイプ 説明
params object URLに渡されたパラメータ。
プロパティ
名前 タイプ 説明
id string 取得するコネクタ・ジョブの識別子。
res.header object ヘッダーを介して渡されるパラメータ。
プロパティ
名前 タイプ 説明
BearerToken string OAuth言語サービス・プロバイダに接続するためのBearerトークン
res object HTTPSレスポンス・オブジェクト。
ソース:
戻り値:
タイプ
HttpResponse.<SampleConnector.JobStatus>

getServer(req, res) → {HttpResponse.<object>}

この翻訳コネクタ・サーバーのコネクタ構成を返します。対応するREST APIエンドポイントは次のとおりです: GET: /connector/rest/api/v1/server
パラメータ:
名前 タイプ 説明
req object HTTPSリクエスト・オブジェクト。
res object HTTPSレスポンス・オブジェクト。
ソース:
戻り値:
サーバー構成を説明するJSON
タイプ
HttpResponse.<object>

getTranslation(req, res) → {HttpResponse.<SampleConnector.ZipFileStream>}

指定されたコネクタ・ジョブ識別子の翻訳済zipファイルを取得します。 対応するREST APIエンドポイントは次のとおりです: GET : /connector/rest/api/v1/job/:id/translation
パラメータ:
名前 タイプ 説明
req object HTTPSリクエスト・オブジェクト。
プロパティ
名前 タイプ 説明
params object URLに渡されたパラメータ。
プロパティ
名前 タイプ 説明
id string 取得するコネクタ・ジョブの識別子。
header object ヘッダーを介して渡されるパラメータ。
プロパティ
名前 タイプ 説明
BearerToken string OAuth言語サービス・プロバイダに接続するためのBearerトークン
res object HTTPSレスポンス・オブジェクト。
ソース:
戻り値:
タイプ
HttpResponse.<SampleConnector.ZipFileStream>

refreshTranslation(req, res) → {HttpResponse.<SampleConnector.JobStatus>}

URLに渡されたジョブIDのLSPサーバーから翻訳ファイルをリフレッシュ(再フェッチ)します。 対応するREST APIエンドポイントは次のとおりです: POST : /connector/rest/api/v1/job/:id/translateジョブ"status"は、すべてのファイルがzipから抽出され、言語サービス・プロバイダで作成された対応するドキュメントが抽出されるまで「IMPORTING」に更新されます。
パラメータ:
名前 タイプ 説明
req object HTTPSリクエスト・オブジェクト。
プロパティ
名前 タイプ 説明
params object URLに渡されたパラメータ。
プロパティ
名前 タイプ 説明
id string 取得するコネクタ・ジョブの識別子。
body stream ストリームとして渡されたzipファイルの内容
header object ヘッダーを介して渡されるパラメータ。
プロパティ
名前 タイプ 説明
BearerToken string OAuth言語サービス・プロバイダに接続するためのBearerトークン
res object HTTPSレスポンス・オブジェクト。
ソース:
戻り値:
タイプ
HttpResponse.<SampleConnector.JobStatus>

translateJob(req, res) → {HttpResponse.<SampleConnector.JobStatus>}

URLに渡されたコネクタ・ジョブ識別子を使用して、リクエスト本文からPOSTed zipを翻訳します。 対応するREST APIエンドポイントは次のとおりです: POST : /connector/rest/api/v1/job/:id/translateジョブ"status"は、すべてのファイルがzipから抽出され、言語サービス・プロバイダで作成された対応するドキュメントが抽出されるまで「IMPORTING」に更新されます。
パラメータ:
名前 タイプ 説明
req object HTTPSリクエスト・オブジェクト。
プロパティ
名前 タイプ 説明
params object URLに渡されたパラメータ。
プロパティ
名前 タイプ 説明
id string 取得するコネクタ・ジョブの識別子。
body stream ストリームとして渡されたzipファイルの内容
header object ヘッダーを介して渡されるパラメータ。
プロパティ
名前 タイプ 説明
BearerToken string OAuth言語サービス・プロバイダに接続するためのBearerトークン
res object HTTPSレスポンス・オブジェクト。
ソース:
戻り値:
タイプ
HttpResponse.<SampleConnector.JobStatus>

validateBasicAuthorization(req, res) → {HttpResponse.<true>}

Basic認証セキュリティが有効であり、動作していることを確認します。対応するREST APIエンドポイント: GET: /connector/rest/api/v1/authorization/basicAuthorization
パラメータ:
名前 タイプ 説明
req object HTTPSリクエスト・オブジェクト。
プロパティ
名前 タイプ 説明
header object ヘッダーを介して渡されるパラメータ。
プロパティ
名前 タイプ 説明
X-CEC-UserName string 基本認証検証のユーザー名。
X-CEC-Pwd string 基本認証検証に使用するパスワード。
res object HTTPSレスポンス・オブジェクト。
ソース:
戻り値:
基本認証を使用して接続できる確認
タイプ
HttpResponse.<true>

タイプ定義

JobStatus

タイプ:
  • オブジェクト
プロパティ:
名前 タイプ 説明
properties object ジョブのプロパティ
プロパティ
名前 タイプ 説明
id string リクエストされたジョブのコネクタ・ジョブ識別子。
title string このジョブ識別子に対して作成されたコネクタ・ジョブ・ラベル。
workflowId string このジョブでファイルを変換するときに使用するワークフローの識別子。
status 'CREATED' | 'IMPORTING' | 'TRANSLATING' | 'DOWNLOADING' | 'TRANSLATED' ジョブのステータス。
progress number ジョブの翻訳の進捗率。
ソース:

ZipFileStream

タイプ:
  • オブジェクト
プロパティ:
名前 タイプ 属性 デフォルト 説明
Content-Type string <optional>
 		'application/zip' コンテンツ・タイプ・レスポンス・ヘッダー - アプリケーション・タイプ
Content-Length string <optional>
 		{ファイルのサイズ} コンテンツ長レスポンス・ヘッダー - zipファイルのサイズ
zipfile stream zipファイルの内容
ソース:
Copyright © 2017, 2022 Oracle and/or its affiliates.