54.2. コンポーネントオプション
Salesforce コンポーネントは、以下に示す 90 個のオプションをサポートしています。
名前 | 説明 | デフォルト | タイプ |
---|---|---|---|
apexMethod (共通) | APEX メソッド名。 | String | |
apexQueryParams (共通) | APEX メソッドのクエリーパラメーター。 | マップ | |
apiVersion (共通) | Salesforce API バージョン。 | 53.0 | String |
backoffIncrement (共通) | CometD 自動再接続を超えた失敗に対するストリーミング接続の再起動を試みるバックオフ間隔の増分。 | 1000 | long |
batchId (共通) | Bulk API バッチ ID。 | String | |
contentType (共通) | Bulk API コンテンツタイプ。XML、CSV、ZIP_XML、ZIP_CSV のいずれかです。 列挙値:
| ContentType | |
defaultReplayId (共通) | initialReplayIdMap に値が見つからない場合のデフォルトの replayId 設定。 | -1 | Long |
fallBackReplayId (共通) | Invalid Replay Id レスポンスの後にフォールバックする ReplayId。 | -1 | Long |
format (共通) | Salesforce API 呼び出しに使用するペイロード形式 (JSON または XML) のデフォルトは JSON です。Camel 3.12 以降、このオプションは Raw 操作にのみ適用されます。 列挙値:
| PayloadFormat | |
httpClient (共通) | Salesforce への接続に使用するカスタム Jetty Http クライアント。 | SalesforceHttpClient | |
httpClientConnectionTimeout (共通) | Salesforce サーバーへの接続時に HttpClient によって使用される接続タイムアウト。 | 60000 | long |
httpClientIdleTimeout (共通) | Salesforce サーバーからの応答を待機するときに HttpClient によって使用されるタイムアウト。 | 10000 | long |
httpMaxContentLength (共通) | HTTP 応答のコンテンツの最大長。 | Integer | |
httpRequestBufferSize (共通) | HTTP リクエストのバッファーサイズ。大規模な SOQL クエリーでは、値を増やす必要がある場合があります。 | 8192 | Integer |
includeDetails (共通) | Salesforce1 Analytics レポートに詳細を含めます。デフォルトは false です。 | Boolean | |
initialReplayIdMap (共通) | チャンネル名ごとに開始する Replay ID。 | Map | |
instanceId (共通) | Salesforce1 Analytics レポート実行インスタンス ID。 | String | |
jobId (共通) | Bulk API ジョブ ID。 | String | |
limit (共通) | 返されるレコード数の制限。一部の API に適用されます。Salesforce のドキュメントを確認してください。 | Integer | |
locator (共通) | クエリージョブの結果を取得するために使用する、salesforce Bulk 2.0 API によって提供されるロケーター。 | String | |
maxBackoff (共通) | CometD 自動再接続を超えた障害に対するストリーミング接続の再起動試行の最大バックオフ間隔。 | 30000 | long |
maxRecords (共通) | Bulk 2.0 クエリーの結果セットごとに取得するレコードの最大数。リクエストには引き続きサイズ制限が適用されます。非常に多数のクエリー結果を処理している場合、Salesforce からすべてのデータを受信する前にタイムアウトが発生することがあります。タイムアウトを防ぐには、クライアントが受信することを期待しているレコードの最大数を maxRecords パラメーターで指定します。これにより、この値を最大サイズとして、結果がより小さなセットに分割されます。 | Integer | |
notFoundBehaviour (共通) | Salesforce API から受信した 404 not found ステータスの動作を設定します。本文を NULL NotFoundBehaviour#NULL に設定する必要があるか、エクスチェンジで例外を通知する必要があります NotFoundBehaviour#EXCEPTION - デフォルト。 列挙値:
| EXCEPTION | NotFoundBehaviour |
notifyForFields (共通) | フィールドの通知、オプションは ALL、REFERENCED、SELECT、WHERE です。 列挙値:
| NotifyForFieldsEnum | |
notifyForOperationCreate (共通) | 作成操作を通知します。デフォルトは false (API バージョン = 29.0) です。 | Boolean | |
notifyForOperationDelete (共通) | 削除操作を通知します。デフォルトは false (API バージョン = 29.0) です。 | Boolean | |
notifyForOperations (共通) | 操作を通知します。オプションは ALL、CREATE、EXTENDED、UPDATE (API バージョン 29.0) です。 列挙値:
| NotifyForOperationsEnum | |
notifyForOperationUndelete (共通) | 削除取り消し操作を通知します。デフォルトは false (API バージョン = 29.0) です。 | Boolean | |
notifyForOperationUpdate (共通) | 更新操作を通知します。デフォルトは false (API バージョン = 29.0) です。 | Boolean | |
objectMapper (共通) | Salesforce オブジェクトをシリアライズ/デシリアライズするときに使用するカスタム Jackson ObjectMapper。 | ObjectMapper | |
packages (共通) | 生成された DTO クラスが含まれているパッケージ。通常、クラスは camel-salesforce-maven-plugin を使用して生成されます。生成された DTO を使用して、パラメーター/ヘッダー値で短い SObject 名を使用する利点を得る場合に設定します。複数のパッケージはコンマで区切ることができます。 | String | |
pkChunking (共通) | PK チャンクを使用します。元の Bulk API でのみ使用できます。Bulk 2.0 API は、必要に応じて PK チャンクを自動的に実行します。 | Boolean | |
pkChunkingChunkSize (共通) | PK チャンクで使用するチャンクサイズ。指定しない場合、salesforce のデフォルトは 100,000 です。最大サイズは 250,000 です。 | Integer | |
pkChunkingParent (共通) | 共有オブジェクトに対するクエリーの PK チャンクを有効にするときに、親オブジェクトを指定します。チャンクは、共有オブジェクトのレコードではなく、親オブジェクトのレコードに基づいています。たとえば、AccountShare に対してクエリーを実行する場合は、Account を親オブジェクトとして指定します。親オブジェクトがサポートされている限り、PK チャンクは共有オブジェクトでサポートされます。 | String | |
pkChunkingStartRow (共通) | 最初のチャンクの下限として使用する 15 文字または 18 文字のレコード ID を指定します。このパラメーターを使用して、バッチ間で失敗したジョブを再開するときに開始 ID を指定します。 | String | |
queryLocator (共通) | クエリの結果が 1 回の呼び出しで取得できるレコード数よりも多い場合に使用する、salesforce が提供するクエリロケータです。後続の呼び出しでこの値を使用して、追加のレコードを取得します。 | String | |
rawPayload (共通) | DTO の代わりに、リクエストとレスポンス (形式に応じて JSON または XML) に Raw ペイロード文字列を使用します。デフォルトでは false です。 | false | boolean |
reportId (共通) | Salesforce1 Analytics レポート ID。 | String | |
reportMetadata (共通) | フィルタリング用の Salesforce1 Analytics レポートのメタデータ。 | ReportMetadata | |
resultId (共通) | Bulk API の結果 ID。 | String | |
sObjectBlobFieldName (共通) | SObject blob フィールド名。 | String | |
sObjectClass (共通) | 完全修飾 SObject クラス名。通常は camel-salesforce-maven-plugin を使用して生成されます。 | String | |
sObjectFields (共通) | 取得する SObject フィールド。 | String | |
sObjectId (共通) | API で必要な場合は SObject ID。 | String | |
sObjectIdName (共通) | sObject 外部 ID 項目名。 | String | |
sObjectIdValue (共通) | sObject 外部 ID 項目の値。 | String | |
sObjectName (共通) | API で必要またはサポートされている場合の sObject 名。 | String | |
sObjectQuery (共通) | Salesforce SOQL クエリー文字列。 | String | |
sObjectSearch (共通) | Salesforce SOSL 検索文字列。 | String | |
updateTopic (共通) | ストリーミング API の使用時に既存のプッシュトピックを更新するかどうか。デフォルトは false です。 | false | boolean |
config (common (上級)) | グローバルエンドポイント設定 - すべてのエンドポイントに共通の値を設定するために使用します。 | SalesforceEndpointConfig | |
httpClientProperties (共通 (上級)) | 基になる HTTP クライアントで設定できるプロパティーを設定するために使用されます。利用可能なすべてのオプションについては、SalesforceHttpClient と Jetty HttpClient のプロパティーを参照してください。 | マップ | |
longPollingTransportProperties (common (上級)) | ストリーミング API によって使用される BayeuxClient (CometD) によって使用される LongPollingTransport で設定できる任意のプロパティーを設定するために使用されます。 | マップ | |
workerPoolMaxSize (共通 (上級)) | HTTP 応答の処理に使用されるスレッドプールの最大サイズ。 | 20 | int |
workerPoolSize (common (上級)) | HTTP 応答の処理に使用されるスレッドプールのサイズ。 | 10 | int |
bridgeErrorHandler (consumer) | consumer の Camel ルーティングエラーハンドラーへのブリッジを許可します。よって、consumer が受信メッセージなどの取得を試行している間に発生した例外は、メッセージとして処理され、ルーティングエラーハンドラーによって処理されます。デフォルトでは、consumer は org.apache.camel.spi.ExceptionHandler を使用して例外に対応し、WARN または ERROR レベルでログに記録され、無視されます。 | false | boolean |
allOrNone (producer) | 失敗したレコードがある場合にすべてのレコードをロールバックすることを示す複合 API オプション。 | false | boolean |
apexUrl (producer) | APEX メソッドの URL。 | String | |
compositeMethod (producer) | 複合 (raw) 方式。 | String | |
lazyStartProducer (producer) | 最初のメッセージで producer をレイジーに起動すべきかどうか。レイジーに起動することで、起動時に producer が失敗し、それによりルートが失敗する可能性がある状況で、CamelContext およびルートの起動を許可します。レイジーな起動を延期すると、Camel のルーティングエラーハンドラー経由でメッセージのルーティング中に起動の失敗を処理できます。最初のメッセージが処理されるときに、producer の作成および起動に若干時間がかかり、合計処理時間が長くなる可能性があることに注意してください。 | false | boolean |
rawHttpHeaders (producer) | Raw 操作の HTTP パラメーターとして含めるメッセージヘッダーのコンマ区切りリスト。 | String | |
rawMethod (producer) | Raw 操作に使用する HTTP メソッド。 | String | |
rawPath (producer) | ドメイン名の後のエンドポイント URL の部分。例: /services/data/v52.0/sobjects/Account/。 | String | |
rawQueryParameters (producer) | Raw 操作のクエリーパラメーターとして含めるメッセージヘッダーのコンマ区切りリスト。これは自動的に行われるため、値を URL エンコードしないでください。 | String | |
autowiredEnabled (上級) | 自動ワイヤリングが有効になっているかどうか。これは、コンポーネントで設定される一致するタイプのインスタンスが 1 つあるかどうかを検出するためにレジストリーを検索することで、自動ワイアリングオプションに使用されます (オプションは自動ワイアとマーク付けされる必要があります)。これは、JDBC データソース、JMS 接続ファクトリー、AWS クライアントなどの自動設定に使用できます。 | true | boolean |
httpProxyExcludedAddresses (proxy) | HTTP プロキシーサーバーを使用しないアドレスのリスト。 | Set | |
httpProxyHost (proxy) | 使用する HTTP プロキシーサーバーのホスト名。 | String | |
httpProxyIncludedAddresses (proxy) | HTTP プロキシーサーバーを使用するアドレスのリスト。 | Set | |
httpProxyPort (proxy) | 使用する HTTP プロキシーサーバーのポート番号。 | Integer | |
httpProxySocks4 (proxy) | true に設定すると、SOCKS4 プロキシーとして使用するように HTTP プロキシーが設定されます。 | false | boolean |
authenticationType (セキュリティー) | 使用する明示的な認証方法で、USERNAME_PASSWORD、REFRESH_TOKEN、または JWT のいずれかです。Salesforce コンポーネントは、プロパティーセットから使用する認証方法を自動決定できます。このプロパティーを設定してあいまいさを排除します。 列挙値:
| AuthenticationType | |
clientId (セキュリティー) | Salesforce インスタンス設定で設定された接続アプリケーションの 必須 OAuth consumerキー。通常、接続アプリケーションを設定する必要がありますが、パッケージをインストールすることで提供できます。 | String | |
clientSecret (security) | Salesforce インスタンス設定で設定された接続アプリケーションの OAuth consumerシークレット。 | String | |
httpProxyAuthUri (security) | HTTP プロキシーサーバーに対する認証で使用されます。httpProxyUsername と httpProxyPassword を認証に使用するには、プロキシーサーバーの URI と一致する必要があります。 | String | |
httpProxyPassword (security) | HTTP プロキシーサーバーに対する認証に使用するパスワード。 | String | |
httpProxyRealm (security) | HTTP プロキシーサーバーに対するプリエンプティブ Basic/Digest 認証方式で使用される、プロキシーサーバーのレルム。 | String | |
httpProxySecure (セキュリティー) | false に設定すると、HTTP プロキシーへのアクセス時に TLS の使用が無効になります。 | true | boolean |
httpProxyUseDigestAuth (security) | true に設定すると、HTTP プロキシーへの認証時にダイジェスト認証が使用されます。それ以外の場合は、基本認証方法が使用されます。 | false | boolean |
httpProxyUsername (security) | HTTP プロキシーサーバーに対する認証に使用するユーザー名。 | String | |
instanceUrl (セキュリティー) | 認証後に使用される Salesforce インスタンスの URL。デフォルトでは、認証の成功時に Salesforce から受信されます。 | String | |
jwtAudience (セキュリティー) | OAuth JWT フローを使用するときに Audience クレーム (aud) に使用する値。設定されていない場合は、ログイン URL が使用されますが、これはほとんどの場合に適しています。 | String | |
keystore (security) | OAuth JWT フローで使用する KeyStore パラメーター。KeyStore には、秘密鍵と証明書を含むエントリーを 1 つだけ含める必要があります。Salesforce は証明書チェーンを検証しないため、これは簡単に自己署名証明書になる可能性があります。対応する接続アプリケーションに証明書をアップロードしていることを確認してください。 | KeyStoreParameters | |
lazyLogin (セキュリティー) | true に設定すると、コンポーネントの開始時にコンポーネントが Salesforce に対して認証されなくなります。通常、これを (デフォルトの) false に設定し、早期に認証して、認証の問題をすぐに認識します。 | false | boolean |
loginConfig (セキュリティー) | 1 つのネストされた Bean 内のすべての認証設定、そこに設定されたすべてのプロパティーは、コンポーネントでも直接設定できます。 | SalesforceLoginConfig | |
loginUrl (セキュリティー) | 認証に使用される Salesforce インスタンスの 必須 URL。デフォルトでは https://login.salesforce.com に設定されています。 | String | |
password (security) | アクセストークンにアクセスするために OAuth フローで使用されるパスワード。パスワード OAuth フローは簡単に開始できますが、他のフローよりも安全性が低いと見なされるため、一般的には避けるべきです。セキュリティートークンを使用する場合は、パスワードの末尾にセキュリティートークンを追加してください。 | String | |
refreshToken (セキュリティー) | リフレッシュトークン OAuth フローですでに取得されているリフレッシュトークン。Web アプリケーションをセットアップして、リフレッシュトークンを受け取るコールバック URL を設定するか、https://login.salesforce.com/services/oauth2/success または https://test.salesforce.com/services/oauth2/success で組み込みのコールバックを使用して設定し、フローの最後で URL から refresh_token を取得する必要があります。開発組織では、Salesforce がコールバック Web アプリケーションを localhost でホストすることを許可していることに注意してください。 | String | |
sslContextParameters (security) | 使用する SSL パラメーター。使用可能なすべてのオプションについては、SSLContextParameters クラスを参照してください。 | SSLContextParameters | |
useGlobalSslContextParameters (security) | グローバル SSL コンテキストパラメーターの使用を有効にします。 | false | boolean |
userName (セキュリティー) | アクセストークンにアクセスするために OAuth フローで使用されるユーザー名。パスワード OAuth フローは簡単に開始できますが、他のフローよりも安全性が低いと見なされるため、一般的には避けるべきです。 | String |