Salesforce CDP Connector 1.0 リファレンス

Salesforce CDP 用 Anypoint Connector (Salesforce CDP Connector) では、データを Salesforce 以外のプロパティと Salesforce プロパティの両方から Salesforce CDP に同様に送信するためのパイプラインがユーザーに提供されます。

設定

SDC Config (SDC 設定)

パラメーター

名前 説明 デフォルト値 必須

Name (名前)

String (文字列)

この設定の名前。コネクタはこの名前の設定を参照します。

x

Connection (接続)

この設定の接続種別。

x

Response Timeout (応答タイムアウト)

Number (数値)

応答がタイムアウトするまで Mule が応答の完了を待機する時間。

1

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

[Response Timeout (応答タイムアウト)]​ 項目の時間単位。

MINUTES

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

コネクタが要求のコンテンツをリモートサービスにストリーミングする方法。

  • AUTO​ (デフォルト)

    コネクタは、要求コンテンツに基づいて自動的に最適なストリーミング戦略を使用します。

  • ALWAYS

    コネクタは、常に要求コンテンツをストリーミングします。

  • NEVER

    コネクタは、要求コンテンツをストリーミングしません。

AUTO

Name (名前)

String (文字列)

この設定の参照に使用される ID。

x

Expiration Policy (有効期限ポリシー)

設定の有効期限ポリシーを設定します。

接続種別

OAuth JWT

OAuth JWT フローのカスタム接続プロバイダー。

パラメーター
名前 説明 デフォルト値 必須

Default Headers (デフォルトヘッダー)

すべてのアウトバウンド要求に自動的に追加されるヘッダー。

クエリパラメーター

すべてのアウトバウンド要求に自動的に追加されるクエリパラメーター。

Connection Timeout (接続タイムアウト)

Number (数値)

コネクタがタイムアウトする前に、リモートサービスへの接続を最初に確立するのを待機する時間。

30

Connection Timeout Unit (接続タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

[Connection Timeout (接続タイムアウト)]​ 項目の時間単位。

SECONDS

Use Persistent Connections (永続接続を使用)

Boolean (ブール)

永続接続を使用するかどうかを示します。

  • true

    Mule は永続接続を使用します。

  • false

    Mule は最初の要求が完了すると接続を閉じます。

true

Max Connections (最大接続数)

Number (数値)

バックエンドに対して開く接続の最大数。HTTP 要求は、複数の接続を介して並行して送信されます。この値の設定が高すぎると、レイテンシーに影響し、スループットを高めることなく追加リソースがコンシュームされる可能性があります。

-1

Connection Idle Timeout (接続アイドルタイムアウト)

Number (数値)

永続接続が有効になっている場合、接続が Mule によって閉じられるまでアイドル状態を維持できる時間。

30

Connection Idle Timeout Unit (接続アイドルタイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

[Connection Timeout (接続タイムアウト)]​ 項目の時間単位。

SECONDS

Proxy Config (プロキシ設定)

アウトバウンド接続のプロキシを設定します。

Stream Response (応答のストリーミング)

Boolean (ブール)

この値が ​true​ の場合、Mule は受信した応答をストリーミングします。

false

Response Buffer Size (応答バッファサイズ)

Number (数値)

HTTP 応答が保存されるバッファのサイズ (バイト)。

-1

Consumer key (コンシューマーキー)

String (文字列)

Salesforce 接続アプリケーションのコンシューマーキー。

x

Key store (キーストア)

String (文字列)

認証時にデータへの署名に使用するキーストアへのパス。

x

Store password (ストアのパスワード)

String (文字列)

キーストアのパスワード。

x

Certificate alias (証明書の別名)

String (文字列)

証明書の別名。

x

Subject (件名)

String (文字列)

Salesforce ユーザーの代理でアクションを実行する場合、そのユーザーのユーザー名。

x

Audience url (オーディエンス URL)

String (文字列)

対象オーディエンスとして認証サーバーを識別します。

x

Protocol (プロトコル)

Enumeration (列挙)。次のいずれかになります。

  • HTTP

  • HTTPS

通信に使用するプロトコル。有効な値は ​HTTP​ と ​HTTPS​ です。

HTTP

TLS Configuration (TLS 設定)

TLS

TLS を設定します。HTTPS プロトコルを使用する場合、TLS を設定する必要があります。

Reconnection (再接続)

アプリケーションがデプロイされると、すべてのコネクタで接続テストが実行されます。​true​ に設定されている場合、関連する再接続戦略をすべて実行した後にテストに合格しないと、デプロイメントが失敗します。

OAuth Username Password

ユーザー名/パスワードフローのカスタム接続プロバイダー。

パラメーター
名前 説明 デフォルト値 必須

Default Headers (デフォルトヘッダー)

すべてのアウトバウンド要求に自動的に追加されるヘッダー。

クエリパラメーター

すべてのアウトバウンド要求に自動的に追加されるクエリパラメーター。

Connection Timeout (接続タイムアウト)

Number (数値)

コネクタがタイムアウトする前に、リモートサービスへの接続を最初に確立するのを待機する時間。

30

Connection Timeout Unit (接続タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

[Connection Timeout (接続タイムアウト)]​ 項目の時間単位。

SECONDS

Use Persistent Connections (永続接続を使用)

Boolean (ブール)

永続接続を使用するかどうかを示します。

  • true

    Mule は永続接続を使用します。

  • false

    Mule は最初の要求が完了すると接続を閉じます。

true

Max Connections (最大接続数)

Number (数値)

バックエンドに対して開く接続の最大数。HTTP 要求は、複数の接続を介して並行して送信されます。この値の設定が高すぎると、レイテンシーに影響し、スループットを高めることなく追加リソースがコンシュームされる可能性があります。

-1

Connection Idle Timeout (接続アイドルタイムアウト)

Number (数値)

永続接続が有効になっている場合、接続が Mule によって閉じられるまでアイドル状態を維持できる時間。

30

Connection Idle Timeout Unit (接続アイドルタイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

[Connection Timeout (接続タイムアウト)]​ 項目の時間単位。

SECONDS

Proxy Config (プロキシ設定)

アウトバウンド接続のプロキシを設定します。

Stream Response (応答のストリーミング)

Boolean (ブール)

この値が ​true​ の場合、Mule は受信した応答をストリーミングします。

false

Response Buffer Size (応答バッファサイズ)

Number (数値)

HTTP 応答が保存されるバッファのサイズ (バイト)。

-1

Consumer key (コンシューマーキー)

String (文字列)

Salesforce 接続アプリケーションのコンシューマーキー。

x

Consumer secret (コンシューマーシークレット)

String (文字列)

アプリケーションのコンシューマーシークレット (リモートアクセスの詳細のコンシューマーシークレット)。

x

Username (ユーザー名)

String (文字列)

セッションの初期化に使用するユーザー名。

x

Password (パスワード)

String (文字列)

ユーザーの認証に使用するパスワード。

x

Audience url (オーディエンス URL)

String (文字列)

対象オーディエンスとして認証サーバーを識別します。

x

Protocol (プロトコル)

Enumeration (列挙)。次のいずれかになります。

  • HTTP

  • HTTPS

通信に使用するプロトコル。有効な値は ​HTTP​ と ​HTTPS​ です。

HTTP

TLS Configuration (TLS 設定)

TLS

TLS を設定します。HTTPS プロトコルを使用する場合、TLS を設定する必要があります。

Reconnection (再接続)

アプリケーションがデプロイされると、すべてのコネクタで接続テストが実行されます。​true​ に設定されている場合、関連する再接続戦略をすべて実行した後にテストに合格しないと、デプロイメントが失敗します。

Bulk - Create Job

<sdc:create-bulk-job>

データを管理するための一括操作を表すジョブを作成します。この操作では、/ingest/jobs エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Source API name (ソース API 参照名)

String (文字列)

操作する取り込みソース API の名前。

x

Object name (オブジェクト名)

String (文字列)

操作するオブジェクトの名前。

x

Operation (操作)

Enumeration (列挙)。次のいずれかになります。

  • delete

  • upsert

実行する操作。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

x

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

Response Timeout (応答タイムアウト)

Number (数値)

応答がタイムアウトするまで Mule が応答の完了を待機する時間。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

[Response Timeout (応答タイムアウト)]​ 項目の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

コネクタが要求のコンテンツをリモートサービスにストリーミングする方法。

  • AUTO​ (デフォルト)

    コネクタは、要求コンテンツに基づいて自動的に最適なストリーミング戦略を使用します。

  • ALWAYS

    コネクタは、常に要求コンテンツをストリーミングします。

  • NEVER

    コネクタは、要求コンテンツをストリーミングしません。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は ​[Target Variable (対象変数)]​ 項目に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

Any (任意)

Attributes Type (属性型)

次の設定の場合

スロー

  • SDC:BAD_REQUEST

  • SDC:CLIENT_ERROR

  • SDC:CONNECTIVITY

  • SDC:INTERNAL_SERVER_ERROR

  • SDC:NOT_ACCEPTABLE

  • SDC:NOT_FOUND

  • SDC:RETRY_EXHAUSTED

  • SDC:SERVER_ERROR

  • SDC:SERVICE_UNAVAILABLE

  • SDC:TIMEOUT

  • SDC:TOO_MANY_REQUESTS

  • SDC:UNAUTHORIZED

  • SDC:UNSUPPORTED_MEDIA_TYPE

Bulk - Upload Job Data

<sdc:upload-data-bulk-job>

外部データセットを CDP に取り込みます。この操作では、/ingest/jobs/{id}/batches エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

ID

String (文字列)

Create Job​ 要求からレスポンスボディに返されたジョブ ID。

x

Body (本文)

String (文字列)

使用するコンテンツ。

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

x

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

Response Timeout (応答タイムアウト)

Number (数値)

応答がタイムアウトするまで Mule が応答の完了を待機する時間。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

[Response Timeout (応答タイムアウト)]​ 項目の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

コネクタが要求のコンテンツをリモートサービスにストリーミングする方法。

  • AUTO​ (デフォルト)

    コネクタは、要求コンテンツに基づいて自動的に最適なストリーミング戦略を使用します。

  • ALWAYS

    コネクタは、常に要求コンテンツをストリーミングします。

  • NEVER

    コネクタは、要求コンテンツをストリーミングしません。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は ​[Target Variable (対象変数)]​ 項目に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

String (文字列)

Attributes Type (属性型)

次の設定の場合

スロー

  • SDC:BAD_REQUEST

  • SDC:CLIENT_ERROR

  • SDC:CONNECTIVITY

  • SDC:INTERNAL_SERVER_ERROR

  • SDC:NOT_ACCEPTABLE

  • SDC:NOT_FOUND

  • SDC:RETRY_EXHAUSTED

  • SDC:SERVER_ERROR

  • SDC:SERVICE_UNAVAILABLE

  • SDC:TIMEOUT

  • SDC:TOO_MANY_REQUESTS

  • SDC:UNAUTHORIZED

  • SDC:UNSUPPORTED_MEDIA_TYPE

Bulk - Close / Abort Job

<sdc:update-bulk-operation-job>

指定したジョブ ID のジョブを更新します。この操作では、/api/v1/ingest/jobs/{id} エンドポイントに対する HTTP PATCH 要求を行います。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Job ID (ジョブ ID)

String (文字列)

ジョブの識別子。

x

State (状態)

Enumeration (列挙)。次のいずれかになります。

  • Aborted (中止)

  • UploadComplete

ジョブの新しい状態。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

x

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

Response Timeout (応答タイムアウト)

Number (数値)

応答がタイムアウトするまで Mule が応答の完了を待機する時間。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

[Response Timeout (応答タイムアウト)]​ 項目の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

コネクタが要求のコンテンツをリモートサービスにストリーミングする方法。

  • AUTO​ (デフォルト)

    コネクタは、要求コンテンツに基づいて自動的に最適なストリーミング戦略を使用します。

  • ALWAYS

    コネクタは、常に要求コンテンツをストリーミングします。

  • NEVER

    コネクタは、要求コンテンツをストリーミングしません。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は ​[Target Variable (対象変数)]​ 項目に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

Any (任意)

Attributes Type (属性型)

次の設定の場合

スロー

  • SDC:BAD_REQUEST

  • SDC:CLIENT_ERROR

  • SDC:CONNECTIVITY

  • SDC:INTERNAL_SERVER_ERROR

  • SDC:NOT_ACCEPTABLE

  • SDC:NOT_FOUND

  • SDC:RETRY_EXHAUSTED

  • SDC:SERVER_ERROR

  • SDC:SERVICE_UNAVAILABLE

  • SDC:TIMEOUT

  • SDC:TOO_MANY_REQUESTS

  • SDC:UNAUTHORIZED

  • SDC:UNSUPPORTED_MEDIA_TYPE

Bulk - Delete Job

<sdc:delete-bulk-job>

指定したジョブ ID のジョブを削除します。この操作では、/ingest/jobs/{id} エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Job ID (ジョブ ID)

String (文字列)

ジョブの識別子。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

x

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

Response Timeout (応答タイムアウト)

Number (数値)

応答がタイムアウトするまで Mule が応答の完了を待機する時間。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

[Response Timeout (応答タイムアウト)]​ 項目の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

コネクタが要求のコンテンツをリモートサービスにストリーミングする方法。

  • AUTO​ (デフォルト)

    コネクタは、要求コンテンツに基づいて自動的に最適なストリーミング戦略を使用します。

  • ALWAYS

    コネクタは、常に要求コンテンツをストリーミングします。

  • NEVER

    コネクタは、要求コンテンツをストリーミングしません。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は ​[Target Variable (対象変数)]​ 項目に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

String (文字列)

Attributes Type (属性型)

次の設定の場合

スロー

  • SDC:BAD_REQUEST

  • SDC:CLIENT_ERROR

  • SDC:CONNECTIVITY

  • SDC:INTERNAL_SERVER_ERROR

  • SDC:NOT_ACCEPTABLE

  • SDC:NOT_FOUND

  • SDC:RETRY_EXHAUSTED

  • SDC:SERVER_ERROR

  • SDC:SERVICE_UNAVAILABLE

  • SDC:TIMEOUT

  • SDC:TOO_MANY_REQUESTS

  • SDC:UNAUTHORIZED

  • SDC:UNSUPPORTED_MEDIA_TYPE

Bulk - Get Job

<sdc:get-bulk-job>

指定したジョブ ID のジョブの詳細を取得します。この操作では、/api/v1/ingest/jobs/{id} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Job ID (ジョブ ID)

String (文字列)

ジョブの識別子。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

x

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

Response Timeout (応答タイムアウト)

Number (数値)

応答がタイムアウトするまで Mule が応答の完了を待機する時間。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

[Response Timeout (応答タイムアウト)]​ 項目の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

コネクタが要求のコンテンツをリモートサービスにストリーミングする方法。

  • AUTO​ (デフォルト)

    コネクタは、要求コンテンツに基づいて自動的に最適なストリーミング戦略を使用します。

  • ALWAYS

    コネクタは、常に要求コンテンツをストリーミングします。

  • NEVER

    コネクタは、要求コンテンツをストリーミングしません。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は ​[Target Variable (対象変数)]​ 項目に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

Any (任意)

Attributes Type (属性型)

次の設定の場合

スロー

  • SDC:BAD_REQUEST

  • SDC:CLIENT_ERROR

  • SDC:CONNECTIVITY

  • SDC:INTERNAL_SERVER_ERROR

  • SDC:NOT_ACCEPTABLE

  • SDC:NOT_FOUND

  • SDC:RETRY_EXHAUSTED

  • SDC:SERVER_ERROR

  • SDC:SERVICE_UNAVAILABLE

  • SDC:TIMEOUT

  • SDC:TOO_MANY_REQUESTS

  • SDC:UNAUTHORIZED

  • SDC:UNSUPPORTED_MEDIA_TYPE

Streaming - Insert Objects

<sdc:insert-objects>

オブジェクトを挿入するために使用します。この操作では、/ingest/connectors/{connector-name}/{object-name} エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Source API name (ソース API 参照名)

String (文字列)

ソース API 参照名を取り込みます。

x

Object name (オブジェクト名)

String (文字列)

データの読み込み先のコレクションの名前。

x

Body (本文)

Any (任意)

使用するコンテンツ。

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

x

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

Response Timeout (応答タイムアウト)

Number (数値)

応答がタイムアウトするまで Mule が応答の完了を待機する時間。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

[Response Timeout (応答タイムアウト)]​ 項目の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

コネクタが要求のコンテンツをリモートサービスにストリーミングする方法。

  • AUTO​ (デフォルト)

    コネクタは、要求コンテンツに基づいて自動的に最適なストリーミング戦略を使用します。

  • ALWAYS

    コネクタは、常に要求コンテンツをストリーミングします。

  • NEVER

    コネクタは、要求コンテンツをストリーミングしません。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は ​[Target Variable (対象変数)]​ 項目に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

String (文字列)

Attributes Type (属性型)

次の設定の場合

スロー

  • SDC:BAD_REQUEST

  • SDC:CLIENT_ERROR

  • SDC:CONNECTIVITY

  • SDC:INTERNAL_SERVER_ERROR

  • SDC:NOT_ACCEPTABLE

  • SDC:NOT_FOUND

  • SDC:RETRY_EXHAUSTED

  • SDC:SERVER_ERROR

  • SDC:SERVICE_UNAVAILABLE

  • SDC:TIMEOUT

  • SDC:TOO_MANY_REQUESTS

  • SDC:UNAUTHORIZED

  • SDC:UNSUPPORTED_MEDIA_TYPE

Streaming - Delete Objects

<sdc:delete-objects>

オブジェクトを削除するために使用します。この操作では、/ingest/connectors/{connector-name}/{object-name} エンドポイントに対する HTTP DELETE 要求を行います。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Source API name (ソース API 参照名)

String (文字列)

ソース API 参照名を取り込みます。

x

Object name (オブジェクト名)

String (文字列)

データの削除元のコレクションの名前。

x

ID

Array of String (文字列の配列)

削除する ID のカンマ区切りリスト。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

x

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

#[null]

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

Response Timeout (応答タイムアウト)

Number (数値)

応答がタイムアウトするまで Mule が応答の完了を待機する時間。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

[Response Timeout (応答タイムアウト)]​ 項目の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

コネクタが要求のコンテンツをリモートサービスにストリーミングする方法。

  • AUTO​ (デフォルト)

    コネクタは、要求コンテンツに基づいて自動的に最適なストリーミング戦略を使用します。

  • ALWAYS

    コネクタは、常に要求コンテンツをストリーミングします。

  • NEVER

    コネクタは、要求コンテンツをストリーミングしません。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は ​[Target Variable (対象変数)]​ 項目に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

String (文字列)

Attributes Type (属性型)

次の設定の場合

スロー

  • SDC:BAD_REQUEST

  • SDC:CLIENT_ERROR

  • SDC:CONNECTIVITY

  • SDC:INTERNAL_SERVER_ERROR

  • SDC:NOT_ACCEPTABLE

  • SDC:NOT_FOUND

  • SDC:RETRY_EXHAUSTED

  • SDC:SERVER_ERROR

  • SDC:SERVICE_UNAVAILABLE

  • SDC:TIMEOUT

  • SDC:TOO_MANY_REQUESTS

  • SDC:UNAUTHORIZED

  • SDC:UNSUPPORTED_MEDIA_TYPE

Query

<sdc:query>

クエリで使用します。この操作では、/query エンドポイントに対する HTTP POST 要求を行います。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Body (本文)

Any (任意)

使用するコンテンツ。

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

x

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。

Custom Query Parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。指定したクエリパラメーターは設定で指定したデフォルトクエリパラメーターとマージされます。

Custom Headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。指定したカスタムヘッダーは設定で指定したデフォルトヘッダーとマージされます。

Response Timeout (応答タイムアウト)

Number (数値)

応答がタイムアウトするまで Mule が応答の完了を待機する時間。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

[Response Timeout (応答タイムアウト)]​ 項目の時間単位。

Streaming Type (ストリーミング種別)

Enumeration (列挙)。次のいずれかになります。

  • AUTO

  • ALWAYS

  • NEVER

コネクタが要求のコンテンツをリモートサービスにストリーミングする方法。

  • AUTO​ (デフォルト)

    コネクタは、要求コンテンツに基づいて自動的に最適なストリーミング戦略を使用します。

  • ALWAYS

    コネクタは、常に要求コンテンツをストリーミングします。

  • NEVER

    コネクタは、要求コンテンツをストリーミングしません。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は ​[Target Variable (対象変数)]​ 項目に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

Any (任意)

Attributes Type (属性型)

次の設定の場合

スロー

  • SDC:BAD_REQUEST

  • SDC:CLIENT_ERROR

  • SDC:CONNECTIVITY

  • SDC:INTERNAL_SERVER_ERROR

  • SDC:NOT_ACCEPTABLE

  • SDC:NOT_FOUND

  • SDC:RETRY_EXHAUSTED

  • SDC:SERVER_ERROR

  • SDC:SERVICE_UNAVAILABLE

  • SDC:TIMEOUT

  • SDC:TOO_MANY_REQUESTS

  • SDC:UNAUTHORIZED

  • SDC:UNSUPPORTED_MEDIA_TYPE

Default Header (デフォルトヘッダー)

すべてのアウトバウンド要求に自動的に追加されるヘッダー。

項目 説明 デフォルト値 必須

Key (キー)

String (文字列)

この型のキー。

x

Value (値)

String (文字列)

この型の値。

x

Default Query Param (デフォルトクエリパラメーター)

すべてのアウトバウンド要求に自動的に追加されるクエリパラメーター。

項目 説明 デフォルト値 必須

Key (キー)

String (文字列)

この型のキー。

x

Value (値)

String (文字列)

この型の値。

x

Proxy (プロキシ)

アウトバウンド接続のプロキシを設定します。

項目 説明 デフォルト値 必須

Host (ホスト)

String (文字列)

プロキシサーバーのホスト名または IP アドレス。

x

Port (ポート)

Number (数値)

プロキシサーバーのポート。

x

Username (ユーザー名)

String (文字列)

プロキシサーバーに対して認証するユーザー名。

Password (パスワード)

String (文字列)

プロキシサーバーに対して認証するパスワード。

Non Proxy Hosts (非プロキシホスト)

String (文字列)

プロキシを使用してはならないホストのカンマ区切りリスト。

TLS

Mule アプリケーションのセキュアな通信を提供するように TLS を設定します。

項目 説明 デフォルト値 必須

Enabled Protocols (有効化されたプロトコル)

String (文字列)

このコンテキストで有効化されたプロトコルのカンマ区切りリスト。

Enabled Cipher Suites (有効化された暗号化スイート)

String (文字列)

このコンテキストで有効化された暗号化スイートのカンマ区切りリスト。

Trust Store (トラストストア)

TLS トラストストアを設定します。

Key Store (キーストア)

TLS キーストアを設定します。

Revocation Check (取り消し確認)

証明書を検証する方法を設定します。

Truststore (トラストストア)

TLS 用のトラストストアを設定します。

項目 説明 デフォルト値 必須

Path (パス)

String (文字列)

トラストストアへのパス。Mule では、可能であれば、現在のクラスパスとファイルシステムへの相対的なパスを解決します。

Password (パスワード)

String (文字列)

トラストストアを保護するために使用するパスワード。

Type (型)

String (文字列)

トラストストアの型。

Algorithm (アルゴリズム)

String (文字列)

トラストストアで使用する暗号化アルゴリズム。

Insecure (安全ではない)

Boolean (ブール)

true​ の場合、Mule では証明書の検証の実行を停止します。これを ​true​ に設定すると、接続が攻撃に対して脆弱になる可能性があります。

Keystore (キーストア)

TLS プロトコル用のキーストアを設定します。生成したキーストアには、非公開キーと公開証明書が格納されます。

項目 説明 デフォルト値 必須

Path (パス)

String (文字列)

キーストアへのパス。Mule では、可能であれば、現在のクラスパスとファイルシステムへの相対的なパスを解決します。

Type (型)

String (文字列)

使用するストアの型。

Alias (別名)

String (文字列)

キーストアに複数の非公開キーが含まれている場合に使用するキーの別名。デフォルトでは、Mule はファイル内の最初のキーを使用します。

Key Password (キーパスワード)

String (文字列)

非公開キーを保護するために使用するパスワード。

Password (パスワード)

String (文字列)

キーストアを保護するために使用するパスワード。

Algorithm (アルゴリズム)

String (文字列)

キーストアで使用する暗号化アルゴリズム。

Standard Revocation Check (標準の取り消し確認)

TLS 証明書の標準取り消し確認を設定します。

項目 説明 デフォルト値 必須

Only End Entities (最後のエンティティのみ)

Boolean (ブール)

証明書チェーン内で確認する要素:

  • true

    証明書チェーンの最後の要素のみを確認します。

  • false

    証明書チェーンのすべての要素を確認します。

Prefer Crls (CRL を優先)

Boolean (ブール)

証明書の有効性を確認する方法:

  • true

    証明書失効リスト (CRL) で証明書の有効性を確認します。

  • false

    オンライン証明書状況プロトコル (OCSP) を使用して証明書の有効性を確認します。

No Fallback (代替なし)

Boolean (ブール)

証明書の有効性を確認するための第 2 の方法を使用するかどうか:

  • true

    [Prefer Crls (CRL を優先)]​ 項目で指定されていない方法 (第 2 の方法) を使用して証明書の有効性を確認します。

  • false

    証明書の有効性を確認するための第 2 の方法を使用しません。

Soft Fail (ソフトフェール)

Boolean (ブール)

取り消しサーバーに到達できない場合や取り消しサーバーが混雑している場合の処理:

  • true

    検証エラーを回避します。

  • false

    検証の失敗を許可します。

Custom OCSP Responder (カスタム OCSP レスポンダー)

証明書の取り消し確認のカスタム OCSP レスポンダーを設定します。

項目 説明 デフォルト値 必須

Url

String (文字列)

OCSP レスポンダーの URL。

Cert Alias (証明書の別名)

String (文字列)

OCSP 応答の署名証明書の別名。指定した場合、別名はトラストストアに存在する必要があります。

CRL File (CRL ファイル)

証明書失効リスト (CRL) ファイルの場所を指定します。

項目 説明 デフォルト値 必須

Path (パス)

String (文字列)

CRL ファイルへのパス。

Reconnection (再接続)

操作の再接続戦略を設定します。

項目 説明 デフォルト値 必須

Fails Deployment (デプロイメントに失敗)

Boolean (ブール)

アプリケーションのデプロイ時に、関連する再接続戦略をすべて実行した後、接続テストに合格しない場合の処理:

  • true

    デプロイメントの失敗を許可します。

  • false

    接続テストの結果を無視します。

Reconnection Strategy (再接続戦略)

使用する再接続戦略。

Reconnect (再接続)

標準再接続戦略を設定し、再接続の頻度と、コネクタソースまたは操作で実行できる再接続の試行回数を指定します。

項目 説明 デフォルト値 必須

Frequency (頻度)

Number (数値)

再接続を試行する頻度 (ミリ秒)。

Blocking

Boolean (ブール)

false​ の場合、再接続戦略が個別の非ブロックスレッドで実行されます。

Count (数)

Number (数値)

Mule アプリケーションで実行できる再接続の試行回数。

Reconnect Forever (繰り返し再接続)

Mule アプリケーションが実行されている間はコネクタソースや操作によって指定された頻度で再接続が試行される Forever 再接続戦略を設定します。

項目 説明 デフォルト値 必須

Frequency (頻度)

Number (数値)

Mule アプリケーションでリモートサービスまたは API への再接続を試行する頻度 (ミリ秒)。

Blocking

Boolean (ブール)

false​ の場合、再接続戦略が個別の非ブロックスレッドで実行されます。

Expiration Policy (有効期限ポリシー)

動的設定インスタンスがアイドル状態を続けられる最小時間を設定します。この時間が経過すると、Mule Runtime で期限切れに相当するとみなされます。

項目 説明 デフォルト値 必須

Max Idle Time (最大アイドル時間)

Number (数値)

有効期限の対象とみなされるまで、動的設定インスタンスがアイドル状態を維持できる最大時間のスカラー時間値。

Time Unit (時間単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

[Max Idle Time (最大アイドル時間)]​ 項目の時間単位。

HTTP Response Attributes (HTTP 応答属性)

項目 説明 デフォルト値 必須

Status Code (状況コード)

Number (数値)

応答の HTTP 状況コード。

x

Headers (ヘッダー)

Object (オブジェクト)

メッセージ内の HTTP ヘッダーのマッピング。

x

Reason Phrase (理由を示す語句)

String (文字列)

応答の HTTP の理由を示す語句。

x

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)

データが最大バッファサイズを超えた場合に要求が失敗するメモリ内ストリーミング戦略を設定します。ユースケースで最適なバッファサイズは、必ずパフォーマンステストを実施して決めてください。

項目 説明 デフォルト値 必須

Initial Buffer Size (初期バッファサイズ)

Number (数値)

データストリームに割り当てるメモリの初期容量。ストリーミングされたデータがこの値を超える場合は、​[Buffer Size Increment (バッファサイズ増分)]​ の単位で ​[Max In Memory Size (最大メモリ内サイズ)]​ 値を上限としてバッファが拡張されます。

Buffer Size Increment (バッファサイズ増分)

Number (数値)

バッファサイズが初期サイズを超えた場合に、拡張する量。値を ​0​ またはそれ以下に設定すると、バッファは拡張されません。

Max Buffer Size (最大バッファサイズ)

Number (数値)

バッファの最大サイズ。バッファサイズがこの値を超える場合、​STREAM_MAXIMUM_SIZE_EXCEEDED​ エラーが発生します。​0​ 以下の値は無制限を意味します。

Buffer Unit (バッファ単位)

Enumeration (列挙)。次のいずれかになります。

  • BYTE (バイト)

  • KB

  • MB

  • GB

[Initial Buffer Size (初期バッファサイズ)]​ 項目、​[Buffer Size Increment (バッファサイズ増分)]​ 項目、​[Buffer Unit (バッファ単位)]​ 項目の単位。

Repeatable File Store Stream (反復可能なファイルストアストリーム)

反復可能なファイルストアストリーミング戦略を設定します。この戦略では、ストリームコンテンツの一部がメモリ内に格納されます。ストリームのコンテンツが、設定されたバッファサイズよりも大きい場合、Mule はバッファのコンテンツをディスクにバックアップしてからメモリをクリアします。

項目 説明 デフォルト値 必須

In Memory Size (メモリ内サイズ)

Number (数値)

ストリームのデータで使用できるメモリの最大量。メモリ量がこの値を超えると、コンテンツはディスクにバッファされます。パフォーマンスを最適化する方法は、次のとおりです。

  • バッファサイズを大きくすると、Mule がバッファをディスクに書き込む回数を減らせます。これによってパフォーマンスが高まりますが、より多くのメモリが必要になるため、アプリケーションが処理できる同時要求数が制限されます。

  • バッファサイズを小さくすると、メモリの負荷は低減しますが、応答時間が長くなります。

Buffer Unit (バッファ単位)

Enumeration (列挙)。次のいずれかになります。

  • BYTE (バイト)

  • KB

  • MB

  • GB

[In Memory Size (メモリ内サイズ)]​ 項目の単位。