1. Homepage
  2. Salesforce Data Cloud Connector (1.2)

  3. Salesforce Data Cloud Connector リファレンス

All Connectors

Salesforce Data Cloud Connector 1.2 リファレンス - Mule 4

Salesforce Data Cloud 用 Anypoint Connector (Salesforce Data Cloud Connector) を使用すると、Mule ユーザーは Salesforce Data Cloud API エンドポイントと簡単に統合できます。ユーザーはサードパーティからのデータ取得の自由化、Data Cloud データレークへのクエリ、顧客プロファイル情報や計算済みインサイトの検索とクエリ、データアクションイベントのコンシュームによって、Data Cloud インスタンスで顧客の全体像を強化することができます。

設定

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 (有効期限ポリシー)

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

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

接続種別

OAuth JWT

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

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

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

Default Header (デフォルトヘッダー)​ の配列。

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

クエリパラメーター

Default Query Param (デフォルトクエリパラメーター)​ の配列。

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

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 (プロキシ設定)

Proxy (プロキシ)

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

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 (再接続)

Reconnection (再接続)

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

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

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

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

Default Header (デフォルトヘッダー)​ の配列。

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

クエリパラメーター

Default Query Param (デフォルトクエリパラメーター)​ の配列。

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

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 (プロキシ設定)

Proxy (プロキシ)

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

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 (再接続)

Reconnection (再接続)

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

データアクション Web フックの設定

Web フックソースの設定要素。

パラメーター

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

Name (名前)

String (文字列)

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

x

Connection (接続)

リスナー

この設定の接続種別。

x

Base Path (ベースパス)

String (文字列)

この設定を参照するすべての要求で使用されるベースパス。

Name (名前)

String (文字列)

他のコンポーネント内での参照に使用されるこの要素の ID。

x

接続種別

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

TLS_C​onfig

TLS

TLS 設定要素への参照。この設定で HTTPS を有効にします。

Protocol (プロトコル)

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

  • HTTP

  • HTTPS

通信に使用するプロトコル。HTTPS を使用すると、HTTP 通信が TLS または SSL を使用して保護されます。プロトコルとして HTTPS が設定されている場合、ユーザーはこのリスナー設定の ​tls:context​ 子要素でキーストアを設定する必要があります。

HTTP

Host (ホスト)

String (文字列)

要求が送信されるホスト。

x

Port (ポート)

Number (数値)

要求が受信されるポート。

x

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

Boolean (ブール)

false​ の場合、各接続は最初の要求が完了すると終了します。

true

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

Number (数値)

接続が終了するまでのアイドル状態を維持できる時間 (ミリ秒)。この属性の値は、永続接続が有効になっている場合にのみ使用されます。タイムアウトが発生する前に既存の接続に要求を送信するときに ​Remotely closed​ (リモートで終了されました) 例外が発生するのを避けるために、リスナーのデフォルトのタイムアウトはリクエスターのデフォルトのタイムアウトよりも長くなっています。

40000

Reconnection (再接続)

Reconnection (再接続)

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

関連操作

関連付けられたソース

操作

Bulk - Create Job

<sdc:create-bulk-job>

非同期処理のために Salesforce Data Cloud にデータを送信する一括操作を表すジョブを作成します。この操作では、/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 (属性型)

HTTP Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • 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 (文字列)

Create Job​ 要求からレスポンスボディに返されたジョブ 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 (属性型)

HTTP Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • 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>

Salesforce Data Cloud から 1 つ以上のレコードを削除します。この操作では、/ingest/sources/{source-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

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 (再接続戦略)

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

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • 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

Insights - List Metadata

<sdc:get-all-calculated-insight-metadata>

メタデータには計算済みインサイトの一部であるディメンションと基準が含まれます。この操作では、/insight/metadata エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

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 (再接続戦略)

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

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • 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 (文字列)

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

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 (属性型)

HTTP Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • 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

Insights - Get Metadata

<sdc:get-calculated-insight-metadata>

メタデータには計算済みインサイトの一部であるディメンションと基準が含まれます。この操作では、/insight/metadata/{ci-name} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

ci_name

String (文字列)

計算済みインサイト名 (​IndividualChildrenCount__cio​ など)。

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 (属性型)

HTTP Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • 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

Insights - Get Insights

<sdc:get-calculated-insight-with-filters-fields-and-limit>

計算済みインサイトを照会するにはこの API を使用します。ユーザーはさまざまなディメンション、基準、検索条件を選択することによって、分析や絞り込みを行うことができます。この操作では、/insight/calculated-insights/{ci-name} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

ci_name

String (文字列)

計算済みインサイト名。

x

dimensions (ディメンション)

String (文字列)

予測するディメンションのカンマ区切りリスト。デフォルトでは、このパラメーターにはすべての使用可能なディメンションが含まれます。

measures (基準)

String (文字列)

予測する基準のカンマ区切りリスト。デフォルトでは、このパラメーターにはすべての使用可能な基準が含まれます。

limit (制限)

Number (数値)

返す項目の数。返す項目の最大数は 4999 です。

4999

offset (オフセット)

Number (数値)

返す前にスキップする行数。

Filter (検索条件)

String (文字列)

このパラメーターは特定の型の結果のみを選択するために select クエリに追加されます。

orderby

String (文字列)

結果セットを昇順または降順に並び替えるための値のカンマ区切りリスト。

timeGranularity

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

  • HOUR

  • DAY

  • MONTH

  • QUARTER

  • YEAR

ci​ に 1 つ以上の時間ディメンションがある場合の、ユーザーが指定する粒度。

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 (属性型)

HTTP Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • 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

Profile - Search Records With Insight

<sdc:get-computed-view-for-profile>

インデックスと検索条件に基づいてデータモデルオブジェクトと計算済みビューを返します。この操作では、/profile/{dataModelName}/{id}/calculated-insights/{ci_name} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

dataModelName

String (文字列)

データモデルオブジェクトの API 参照名。

x

id

String (文字列)

インデックス化された列の値。

x

ci_name

String (文字列)

計算済みインサイト名。

x

searchKey

String (文字列)

オブジェクトの ID が主キーと異なる場合のインデックス名。

dimensions (ディメンション)

String (文字列)

計算済みビューからの結果に含まれるディメンション名のカンマ区切りリスト。デフォルトでは、このパラメーターにはすべてのディメンションが含まれます。

measures (基準)

String (文字列)

計算済みビューからの結果に含まれる基準名のカンマ区切りリスト。デフォルトでは、このパラメーターにはすべての基準が含まれます。

limit (制限)

Number (数値)

返す項目の数。

Filter (検索条件)

String (文字列)

検索条件は親オブジェクトにのみ適用されます。

offset (オフセット)

Number (数値)

返す前にスキップする行数。

orderby

String (文字列)

結果セットを昇順または降順に並び替えるための値のカンマ区切りリスト。

timeGranularity

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

  • HOUR

  • DAY

  • MONTH

  • QUARTER

  • YEAR

ci​ に 1 つ以上の時間ディメンションがある場合の、ユーザーが指定する粒度。

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 (再接続戦略)

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

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • 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

Profile - Get Metadata

<sdc:get-meta>

データモデルオブジェクトのメタデータを返します。メタデータには項目、データ型、ルックアップに使用できるインデックスのリストが含まれます。この操作では、/profile/metadata/{dataModelName} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

dataModelName

String (文字列)

データモデルオブジェクトの API 参照名。

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 (属性型)

HTTP Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • 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

Profile - List Metadata

<sdc:get-meta-by-category>

データモデルオブジェクト、その項目、カテゴリのリストを返します。この操作では、/profile/metadata エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

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 (再接続戦略)

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

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • 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 v2 - Get Next Batch

<sdc:get-next-batch-ansi-sql-v2>

最初の POST 要求からのデータの次のバッチを返します。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Next Batch Id (次のバッチ ID)

String (文字列)

batchId を使用して次のバッチのデータを取得します。

x

Enable arrow stream (矢印ストリームを有効化)

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

  • TRUE

  • FALSE

矢印ストリームまたは JSON 形式の応答データを取得するかどうかを決定します。​true​ の値では、データを矢印ストリーム形式で返します。

FALSE

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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • 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​

Profile - Search Records By Id

<sdc:get-parent>

検索インデックスと検索条件に基づいてデータモデルオブジェクトを返します。主キーまたはセカンダリキーに基づいてオブジェクトレコードを取得するにはこの API コールを使用します。レコードが見つからなかった場合は空のリストを返します。この操作では、/profile/{dataModelName}/{id} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

dataModelName

String (文字列)

データモデルオブジェクトの API 参照名。

x

Id

String (文字列)

主キーまたはセカンダリキー項目の値。指定しない場合のデフォルトは主キーです。

x

searchKey

String (文字列)

主キー以外の項目が使用される場合のキー項目の名前。

fields (項目)

String (文字列)

結果に含める個別の項目名のカンマ区切りリスト。このパラメーターを指定しない場合、任意の項目セットが返されます。

Filter (検索条件)

String (文字列)

角括弧内に指定した等式のカンマ区切りリスト。

limit (制限)

Number (数値)

返すレコードの数。

orderby

String (文字列)

結果セットを昇順または降順に並び替えるための値のカンマ区切りリスト。この項目は API バージョン 52.0 以降で使用できます。

offset (オフセット)

Number (数値)

返す前にスキップする行数。この項目は API バージョン 52.0 以降で使用できます。

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 (属性型)

HTTP Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • 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

Profile - Search Records With Child Records

<sdc:get-parent-and-child>

インデックスと検索条件に基づいてデータモデルオブジェクトと子オブジェクトを返します。この操作では、/profile/{dataModelName}/{id}/{childDataModelName} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

dataModelName

String (文字列)

データモデルオブジェクトの API 参照名。

x

id

String (文字列)

インデックス化された列の値。

x

childDataModelName

String (文字列)

子データモデルオブジェクトの API 参照名。

x

searchKey

String (文字列)

オブジェクトの ID が主キーと異なる場合のインデックス名。

fields (項目)

String (文字列)

子エンティティからの結果に含まれる項目名のカンマ区切りリスト。指定されていない場合は、アルファベット順に最初の 10 件の項目が使用されます。

limit (制限)

Number (数値)

返す項目の数。

Filter (検索条件)

String (文字列)

検索条件は親オブジェクトにのみ適用されます。

offset (オフセット)

Number (数値)

返す前にスキップする行数。

orderby

String (文字列)

結果セットを昇順または降順に並び替えるための値のカンマ区切りリスト。

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 (再接続戦略)

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

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • 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

Profile - Search Records

<sdc:get-parent-with-filters>

検索条件に基づいてデータモデルオブジェクトを返します。選択した検索条件を適用した後にオブジェクトレコードを取得するにはこの API コールを使用します。この操作では、/profile/{dataModelName} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

dataModelName

String (文字列)

データモデルオブジェクトの API 参照名。

x

Filter (検索条件)

String (文字列)

角括弧内に指定した等式のカンマ区切りリスト。

x

fields (項目)

String (文字列)

結果に含める個別の項目名のカンマ区切りリスト。このパラメーターを指定しない場合、任意の項目セットが返されます。

limit (制限)

Number (数値)

返すレコードの数。

orderby

String (文字列)

結果セットを昇順または降順に並び替えるための値のカンマ区切りリスト。この項目は API バージョン 52.0 以降で使用できます。

offset (オフセット)

Number (数値)

返す前にスキップする行数。この項目は API バージョン 52.0 以降で使用できます。

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 (再接続戦略)

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

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • 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>

新しいレコードを作成するか、Salesforce Data Cloud 内の既存のレコードを更新します。この操作では、/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

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 (再接続戦略)

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

出力

型

String (文字列)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • 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 (属性型)

HTTP Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • 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 v2

<sdc:query-ansi-sql-v2>

Query V2 では、ANSI 標準の SQL クエリをサポートしており、結果をレコードの配列として返します。この API をコールした場合に想定される入力は自由形式の SQL です。入力オブジェクトにはデータストリーム、プロファイル及びエンゲージメントのデータモデルオブジェクト、統合データモデルオブジェクトが含まれます。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Enable arrow stream (矢印ストリームを有効化)

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

  • TRUE

  • FALSE

矢印ストリームまたは JSON 形式の応答データを取得するかどうかを決定します。​true​ の値では、データを矢印ストリーム形式で返します。

FALSE

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 (再接続戦略)

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

出力

Type (型)

Any (任意)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • 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 のジョブを終了または中止します。この操作では、/ingest/jobs/{id} エンドポイントに対する HTTP PATCH 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Job ID (ジョブ ID)

String (文字列)

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

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 (属性型)

HTTP Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • 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>

指定した CSV データを使用してジョブのデータをアップロードします。この操作では、/ingest/jobs/{id}/batches エンドポイントに対する HTTP PUT 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

id

String (文字列)

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

x

Body (本文)

String (文字列)

使用するコンテンツ。

#[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 (属性型)

HTTP Response Attributes (HTTP 応答属性)

次の設定の場合

スロー

  • 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

ソース

データアクション Web フック

<sdc:webhook-listener>​ Salesforce Data Cloud のデータアクション Web フックのリスナー。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Path (パス)

String (文字列)

MuleSoft Salesforce Data Cloud データアクション Web フック設定からの相対パス。

/

Signing Key (署名キー)

String (文字列)

Salesforce Data Cloud データアクションターゲットからコピーされたシークレットキー。

x

Signing Algorithm (署名アルゴリズム)

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

  • HmacSHA256

Salesforce Data Cloud データアクションターゲットからコピーされた署名アルゴリズム。

x

Output Mime Type (出力 MIME タイプ)

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

On Capacity Overload (容量過負荷時)

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

  • FAIL

  • DROP

フローで処理可能な容量を超えたメッセージを受信した場合に Runtime によって適用される戦略。

FAIL

Config Ref (設定参照)

ConfigurationProvider

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

x

Redelivery Policy (再配信ポリシー)

Redelivery Policy (再配信ポリシー)

同じメッセージの再配信を処理するためのポリシーを定義します。

Reconnection Strategy (再接続戦略)

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

出力

Type (型)

String (文字列)

次の設定の場合

種別

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 (トラストストア)

Truststore (トラストストア)

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

Key Store (キーストア)

Keystore (キーストア)

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 アプリケーションが実行されている限り、コネクタ操作のソースまたは操作で、指定した頻度で再接続を試行します。

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

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 (数値)

x

Headers (ヘッダー)

Object (オブジェクト)

x

Reason Phrase (理由を示す語句)

String (文字列)

x

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

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

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

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

Number (数値)

ストリームをコンシュームし、ストリームへのランダムアクセスを提供する目的で割り当てられるメモリの容量。ストリームに含まれているデータがこのバッファに適合できる量を超えている場合、bufferSizeIncrement 属性に従ってバッファが拡張され、上限は maxInMemorySize となります。

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 (メモリ内サイズ)]​ 項目の単位。

エラーのマッピング

Mule フローの各操作で、可能性のあるエラー種別を選択したカスタムエラー種別にマップできます。

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

Source (ソース)

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

  • ANY

  • REDELIVERY_EXHAUSTED​

  • TRANSFORMATION

  • EXPRESSION

  • SECURITY

  • CLIENT_SECURITY​

  • SERVER_SECURITY​

  • ROUTING

  • CONNECTIVITY

  • RETRY_EXHAUSTED​

  • TIMEOUT

変換先

String (文字列)

x

Redelivery Policy (再配信ポリシー)

エラーを生成する要求を実行するための再配信ポリシーを設定します。再配信ポリシーは、フロー内のあらゆる提供元に追加できます。

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

Max Redelivery Count (最大再配信数)

Number (数値)

再配信される要求の最大処理失敗回数。この回数を超えると、​REDELIVERY_EXHAUSTED​ エラーが返されます。

Message Digest Algorithm (メッセージダイジェストアルゴリズム)

String (文字列)

[Use Secure Hash (セキュアハッシュを使用)]​ 項目が ​true​ の場合に使用するセキュアハッシュアルゴリズム。メッセージのペイロードが Java オブジェクトの場合、Mule ではこの値が無視され、ペイロードの ​hashCode()​ が返した値が返されます。

Message Identifier (メッセージ識別子)

Redelivery Policy Message Identifier (再配信ポリシーメッセージ識別子)

メッセージを識別するために使用する戦略を定義します。

Object Store (オブジェクトストア)

ObjectStore

各メッセージの再配信カウンターが保存されるオブジェクトストアを設定します。

Redelivery Policy Message Identifier (再配信ポリシーメッセージ識別子)

再配信されたメッセージを識別する方法と、メッセージがいつ再配信されたのかを見つける方法を設定します。

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

Use Secure Hash (セキュアハッシュを使用)

Boolean (ブール)

true​ の場合、Mule では再配信されたメッセージの識別にセキュアハッシュアルゴリズムを使用します。

Id Expression (ID 式)

String (文字列)

メッセージがいつ再配信されたのかを判断する 1 つ以上の式。このプロパティは、​[Use Secure Hash (セキュアハッシュを使用)]​ 項目が ​false​ の場合にのみ設定できます。

関連情報