Xero Accounting Connector 1.1 リファレンス

Xero Accounting 用 Anypoint Connector (Xero Connector) により、Xero Accounting API にアクセスできます。

設定

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

Name (名前)

String (文字列)

コネクタが参照に使用する設定の名前。

x

Connection (接続)

この設定に指定する接続型。

x

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

Number (数値)

リモートサービスへの要求のタイムアウト。

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

他のコンポーネント内の要素を参照するために使用するこの要素の識別子。

x

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

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

接続種別

Oauth2 Connection Provider (OAuth2 接続プロバイダー)

OAuth 2.0 を使用して、ユーザーアカウントをホストするサービスにユーザー認証を委任します。詳細は、​「コネクタの OAuth 2.0 の設定」​または​「CloudHub でのコネクタの OAuth 2.0 の設定」​を参照してください。

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

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

クエリパラメーター

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

Number (数値)

リモートサービスへの接続を確立するためのタイムアウト。

30

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

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

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

SECONDS (秒)

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

Boolean (ブール)

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

true

Max Connections (最大接続数)

Number (数値)

同時に開いておくことができるアウトバウンド接続の最大数。

-1

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

Number (数値)

接続が終了するまでのアイドル状態を維持できる時間のタイムアウト。

30

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

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

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

SECONDS (秒)

Proxy Config (プロキシ設定)

プロキシ経由のアウトバウンド接続の再利用可能な設定要素。

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

Boolean (ブール)

受信した応答ストリーミングするかどうか。

false

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

Number (数値)

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

-1

Base Uri (ベース URI)

String (文字列)

パラメーターのベース URI。各インスタンスまたはテナントが独自のベース URI を取得します。

https://api.xero.com/api.xro/2.0

Protocol (プロトコル)

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

  • HTTP

  • HTTPS

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

HTTP

TLS Configuration (TLS 設定)

TLS

Reconnection (再接続)

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

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

String (文字列)

サービスプロバイダーに登録されている OAuth consumerKey。

x

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

String (文字列)

サービスプロバイダーに登録されている OAuth consumerSecret。

x

Authorization Url (認証 URL)

String (文字列)

サービスプロバイダーの認証エンドポイント URL。

https://login.xero.com/identity/connect/authorize

Access Token Url (アクセストークン URL)

String (文字列)

サービスプロバイダーの accessToken エンドポイント URL。

https://identity.xero.com/connect/token

Scopes (スコープ)

String (文字列)

OAuth ダンス時に要求する OAuth スコープ。指定しない場合、デフォルトではアノテーションで指定されたスコープになります。

  • メール

  • openid

  • profile

  • accounting.transactions

  • accounting.transactions.read

  • accounting.reports.read

  • accounting.reports.tenninetynine.read

  • accounting.journals.read

  • accounting.settings

  • accounting.settings.read

  • accounting.contacts

  • accounting.contacts.read

  • accounting.attachments

  • accounting.attachments.read

  • assets

  • assets.read

  • bankfeeds

  • files

  • files.read

  • payroll

  • payroll.read

  • payroll.employees

  • payroll.employees.read

  • payroll.leaveapplications

  • payroll.leaveapplications.read

  • payroll.payitems

  • payroll.payitems.read

  • payroll.payrollcalendars

  • payroll.payrollcalendars.read

  • payroll.payruns

  • payroll.payruns.read

  • payroll.payslip

  • payroll.payslip.read

  • payroll.settings.read

  • payroll.superfunds

  • payroll.superfunds.read

  • payroll.superfundproducts.read

  • payroll.timesheets

  • payroll.timesheets.read

  • paymentservices

  • projects

  • projects.read

Resource Owner Id (リソースオーナー ID)

String (文字列)

他に参照されていない場合に各コンポーネントで使用するリソースオーナー ID。

Before (前)

String (文字列)

OAuth ダンスを開始する直前に実行するフローの名前。

After (後)

String (文字列)

アクセストークンが受信された直後に実行するフローの名前。

リスナー設定

String (文字列)

アクセストークンコールバックエンドポイントをキャッシュするリスナーの作成に使用する HTTP 設定。

x

Callback Path (コールバックパス)

String (文字列)

アクセストークンコールバックエンドポイントのパス。

x

Authorize Path (認証パス)

String (文字列)

OAuth ダンスをトリガーするローカル HTTP エンドポイントのパス。

x

External Callback Url (外部コールバック URL)

String (文字列)

コールバックエンドポイントがプロキシの背後にあるか、直接 URL 以外でアクセスする必要がある場合、このパラメーターを使用して OAuth プロバイダーに、コールバックへのアクセスに使用すべき URL を指示します。

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

String (文字列)

各リソースオーナーのデータを保存するオブジェクトストアを設定します。設定されていない場合、Mule ではデフォルトのオブジェクトストアが使用されます。

On New Or Updated Contact Trigger

<xero-accounting:on-new-or-updated-contact-trigger>

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Modified Since (変更基準日)

String (文字列)

現時点で開始されるレコードを取得します。

x

Xero tenant ID (Xero テナント ID)

String (文字列)

テナントの Xero 識別子。

x

Config Ref (設定参照)

ConfigurationProvider

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

x

Primary Node Only (プライマリノードのみ)

Boolean (ブール)

クラスターでの Mule インスタンスの実行時、このソースをプライマリノード上でのみ実行するかどうかを決定します。

Scheduling Strategy (スケジュール戦略)

scheduling-strategy

ポーリングをトリガーするスケジューラーを設定します。

x

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

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

Redelivery Policy (再配信ポリシー)

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

Reconnection Strategy (再接続戦略)

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

出力

Any (任意)

Attributes Type (属性型)

次の設定の場合

On New Or Updated Invoices Trigger

<xero-accounting:on-new-or-updated-invoices-trigger>

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Modified Since (変更基準日)

String (文字列)

現時点で開始されるレコードを取得します。

x

Xero tenant ID (Xero テナント ID)

String (文字列)

テナントの Xero 識別子。

x

Config Ref (設定参照)

ConfigurationProvider

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

x

Primary Node Only (プライマリノードのみ)

Boolean (ブール)

クラスターでの Mule インスタンスの実行時、このソースをプライマリノード上でのみ実行するかどうかを決定します。

Scheduling Strategy (スケジュール戦略)

scheduling-strategy

ポーリングをトリガーするスケジューラーを設定します。

x

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

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

Redelivery Policy (再配信ポリシー)

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

Reconnection Strategy (再接続戦略)

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

出力

Any (任意)

Attributes Type (属性型)

次の設定の場合

On New Or Updated Items Trigger

<xero-accounting:on-new-or-updated-items-trigger>

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Modified Since (変更基準日)

String (文字列)

現時点で開始されるレコードを取得します。

x

Xero tenant ID (Xero テナント ID)

String (文字列)

テナントの Xero 識別子。

x

Config Ref (設定参照)

ConfigurationProvider

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

x

Primary Node Only (プライマリノードのみ)

Boolean (ブール)

クラスターでの Mule インスタンスの実行時、このソースをプライマリノード上でのみ実行するかどうかを決定します。

Scheduling Strategy (スケジュール戦略)

scheduling-strategy

ポーリングをトリガーするスケジューラーを設定します。

x

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

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

Redelivery Policy (再配信ポリシー)

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

Reconnection Strategy (再接続戦略)

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

出力

Any (任意)

Attributes Type (属性型)

次の設定の場合

On New Or Updated Payments Trigger

<xero-accounting:on-new-or-updated-payments-trigger>

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Modified Since (変更基準日)

String (文字列)

現時点で開始されるレコードを取得します。

x

Xero tenant ID (Xero テナント ID)

String (文字列)

テナントの Xero 識別子。

x

Config Ref (設定参照)

ConfigurationProvider

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

x

Primary Node Only (プライマリノードのみ)

Boolean (ブール)

クラスターでの Mule インスタンスの実行時、このソースをプライマリノード上でのみ実行するかどうかを決定します。

Scheduling Strategy (スケジュール戦略)

scheduling-strategy

ポーリングをトリガーするスケジューラーを設定します。

x

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

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

Redelivery Policy (再配信ポリシー)

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

Reconnection Strategy (再接続戦略)

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

出力

Any (任意)

Attributes Type (属性型)

次の設定の場合

Create Contacts

<xero-accounting:create-contacts>

Xero 組織の 1 件以上の取引先責任者を更新または作成します。この操作では、/Contacts エンドポイントに対する HTTP POST 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Summarize Errors (要約エラー)

Boolean (ブール)

false の場合、200 OK と、正常に作成されたオブジェクトと検証エラーの組み合わせを返します。

false

Xero tenant ID (Xero テナント ID)

String (文字列)

テナントの Xero 識別子。

x

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

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

x

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

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

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

Object (オブジェクト)

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

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

Object (オブジェクト)

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

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

Number (数値)

リモートサービスへの要求のタイムアウト。

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

次の設定の場合

スロー

  • XERO-ACCOUNTING:BAD_REQUEST​

  • XERO-ACCOUNTING:CLIENT_ERROR​

  • XERO-ACCOUNTING:CONNECTIVITY

  • XERO-ACCOUNTING:INTERNAL_SERVER_ERROR​

  • XERO-ACCOUNTING:NOT_ACCEPTABLE​

  • XERO-ACCOUNTING:NOT_FOUND​

  • XERO-ACCOUNTING:RETRY_EXHAUSTED​

  • XERO-ACCOUNTING:SERVER_ERROR​

  • XERO-ACCOUNTING:SERVICE_UNAVAILABLE​

  • XERO-ACCOUNTING:TIMEOUT

  • XERO-ACCOUNTING:TOO_MANY_REQUESTS​

  • XERO-ACCOUNTING:UNAUTHORIZED

  • XERO-ACCOUNTING:UNSUPPORTED_MEDIA_TYPE​

Create Invoices

<xero-accounting:create-invoices>

1 つ以上の売上請求書または購入請求書を更新または作成します。この操作では、/Invoices エンドポイントに対する HTTP POST 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Summarize Errors (要約エラー)

Boolean (ブール)

false の場合、200 OK と、正常に作成されたオブジェクトと検証エラーの組み合わせを返します。

false

unitdp (単位の小数位)

Number (数値)

(単位の小数位) 単位量に小数第 4 位を使用することもできます。

Xero tenant ID (Xero テナント ID)

String (文字列)

テナントの Xero 識別子。

x

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

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

x

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

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

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

Object (オブジェクト)

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

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

Object (オブジェクト)

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

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

Number (数値)

リモートサービスへの要求のタイムアウト。

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

次の設定の場合

スロー

  • XERO-ACCOUNTING:BAD_REQUEST​

  • XERO-ACCOUNTING:CLIENT_ERROR​

  • XERO-ACCOUNTING:CONNECTIVITY

  • XERO-ACCOUNTING:INTERNAL_SERVER_ERROR​

  • XERO-ACCOUNTING:NOT_ACCEPTABLE​

  • XERO-ACCOUNTING:NOT_FOUND​

  • XERO-ACCOUNTING:RETRY_EXHAUSTED​

  • XERO-ACCOUNTING:SERVER_ERROR​

  • XERO-ACCOUNTING:SERVICE_UNAVAILABLE​

  • XERO-ACCOUNTING:TIMEOUT

  • XERO-ACCOUNTING:TOO_MANY_REQUESTS​

  • XERO-ACCOUNTING:UNAUTHORIZED

  • XERO-ACCOUNTING:UNSUPPORTED_MEDIA_TYPE​

Update Or Create Items

<xero-accounting:create-items>

1 つ以上の項目を更新または作成します。この操作では、/Items エンドポイントに対する HTTP POST 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Summarize Errors (要約エラー)

Boolean (ブール)

false の場合、200 OK と、正常に作成されたオブジェクトと検証エラーの組み合わせを返します。

false

unitdp (単位の小数位)

Number (数値)

(単位の小数位) 単位量に小数第 4 位を使用することもできます。

Xero tenant ID (Xero テナント ID)

String (文字列)

テナントの Xero 識別子。

x

Body (本文)

Any (任意)

使用するコンテンツ

#[payload]

Config Ref (設定参照)

ConfigurationProvider

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

x

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

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

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

Object (オブジェクト)

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

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

Object (オブジェクト)

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

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

Number (数値)

リモートサービスへの要求のタイムアウト。

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

次の設定の場合

スロー

  • XERO-ACCOUNTING:BAD_REQUEST​

  • XERO-ACCOUNTING:CLIENT_ERROR​

  • XERO-ACCOUNTING:CONNECTIVITY

  • XERO-ACCOUNTING:INTERNAL_SERVER_ERROR​

  • XERO-ACCOUNTING:NOT_ACCEPTABLE​

  • XERO-ACCOUNTING:NOT_FOUND​

  • XERO-ACCOUNTING:RETRY_EXHAUSTED​

  • XERO-ACCOUNTING:SERVER_ERROR​

  • XERO-ACCOUNTING:SERVICE_UNAVAILABLE​

  • XERO-ACCOUNTING:TIMEOUT

  • XERO-ACCOUNTING:TOO_MANY_REQUESTS​

  • XERO-ACCOUNTING:UNAUTHORIZED

  • XERO-ACCOUNTING:UNSUPPORTED_MEDIA_TYPE​

Get Contacts

<xero-accounting:get-contacts>

Xero 組織のすべての取引先責任者を取得します。この操作では、/Contacts エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

ID

Array of String (文字列の配列)

取引先責任者 ID のカンマ区切りのリストで絞り込みます。これにより、1 回のコールで特定のセットの取引先責任者を取得できます。

page (ページ)

Number (数値)

例: page=1​。最大 100 件の取引先責任者が 1 回の API コールで返されます。

1

Include Archived (アーカイブ済みを含める)

Boolean (ブール)

例: includeArchived=true​。状況が ARCHIVED (アーカイブ済み) の取引先責任者が応答に含まれます。

false

order (注文)

String (文字列)

要素で並び替えます。

ただし

String (文字列)

要素で絞り込みます。

Xero tenant ID (Xero テナント ID)

String (文字列)

テナントの Xero 識別子。

x

If Modified Since (更新基準日)

String (文字列)

このタイムスタンプ以降に作成または変更されたレコードのみが返されます。

Output Mime Type (出力 MIME タイプ)

String (文字列)

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

Config Ref (設定参照)

ConfigurationProvider

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

x

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

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

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

Object (オブジェクト)

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

#[null]

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

Object (オブジェクト)

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

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

Number (数値)

リモートサービスへの要求のタイムアウト。

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 の配列

次の設定の場合

スロー

  • XERO-ACCOUNTING:BAD_REQUEST​

  • XERO-ACCOUNTING:CLIENT_ERROR​

  • XERO-ACCOUNTING:CONNECTIVITY

  • XERO-ACCOUNTING:INTERNAL_SERVER_ERROR​

  • XERO-ACCOUNTING:NOT_ACCEPTABLE​

  • XERO-ACCOUNTING:NOT_FOUND​

  • XERO-ACCOUNTING:SERVER_ERROR​

  • XERO-ACCOUNTING:SERVICE_UNAVAILABLE​

  • XERO-ACCOUNTING:TIMEOUT

  • XERO-ACCOUNTING:TOO_MANY_REQUESTS​

  • XERO-ACCOUNTING:UNAUTHORIZED

  • XERO-ACCOUNTING:UNSUPPORTED_MEDIA_TYPE​

Get Contacts By Contact ID

<xero-accounting:get-contacts-by-contact-id>

一意の取引先責任者 ID を使用して Xero 組織の特定の取引先責任者を取得します。この操作では、/Contacts/{ContactID} エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Contact ID (取引先責任者 ID)

String (文字列)

取引先責任者の一意の識別子。

x

Xero tenant ID (Xero テナント ID)

String (文字列)

テナントの Xero 識別子。

x

Config Ref (設定参照)

ConfigurationProvider

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

x

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

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

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

Object (オブジェクト)

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

#[null]

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

Object (オブジェクト)

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

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

Number (数値)

リモートサービスへの要求のタイムアウト。

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

次の設定の場合

スロー

  • XERO-ACCOUNTING:BAD_REQUEST​

  • XERO-ACCOUNTING:CLIENT_ERROR​

  • XERO-ACCOUNTING:CONNECTIVITY

  • XERO-ACCOUNTING:INTERNAL_SERVER_ERROR​

  • XERO-ACCOUNTING:NOT_ACCEPTABLE​

  • XERO-ACCOUNTING:NOT_FOUND​

  • XERO-ACCOUNTING:RETRY_EXHAUSTED​

  • XERO-ACCOUNTING:SERVER_ERROR​

  • XERO-ACCOUNTING:SERVICE_UNAVAILABLE​

  • XERO-ACCOUNTING:TIMEOUT

  • XERO-ACCOUNTING:TOO_MANY_REQUESTS​

  • XERO-ACCOUNTING:UNAUTHORIZED

  • XERO-ACCOUNTING:UNSUPPORTED_MEDIA_TYPE​

Get Invoices

<xero-accounting:get-invoices>

Xero 組織のすべての請求書を取得します。この操作では、/Invoices エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

ただし

String (文字列)

要素で絞り込みます。

order (注文)

String (文字列)

要素で並び替えます。

ID

Array of String (文字列の配列)

取引先責任者 ID のカンマ区切りのリストで絞り込みます。これにより、1 回のコールで特定のセットの取引先責任者を取得できます。

page (ページ)

Number (数値)

例: page=1​。最大 100 件の取引先責任者が 1 回の API コールで返されます。

1

Xero tenant ID (Xero テナント ID)

String (文字列)

テナントの Xero 識別子。

x

If Modified Since (更新基準日)

String (文字列)

このタイムスタンプ以降に作成または変更されたレコードのみが返されます。

Output Mime Type (出力 MIME タイプ)

String (文字列)

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

Config Ref (設定参照)

ConfigurationProvider

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

x

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

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

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

Object (オブジェクト)

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

#[null]

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

Object (オブジェクト)

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

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

Number (数値)

リモートサービスへの要求のタイムアウト。

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 の配列

次の設定の場合

スロー

  • XERO-ACCOUNTING:BAD_REQUEST​

  • XERO-ACCOUNTING:CLIENT_ERROR​

  • XERO-ACCOUNTING:CONNECTIVITY

  • XERO-ACCOUNTING:INTERNAL_SERVER_ERROR​

  • XERO-ACCOUNTING:NOT_ACCEPTABLE​

  • XERO-ACCOUNTING:NOT_FOUND​

  • XERO-ACCOUNTING:SERVER_ERROR​

  • XERO-ACCOUNTING:SERVICE_UNAVAILABLE​

  • XERO-ACCOUNTING:TIMEOUT

  • XERO-ACCOUNTING:TOO_MANY_REQUESTS​

  • XERO-ACCOUNTING:UNAUTHORIZED

  • XERO-ACCOUNTING:UNSUPPORTED_MEDIA_TYPE​

Retrieves items

<xero-accounting:get-items>

項目を取得します。この操作では、/Items エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

ただし

String (文字列)

要素で絞り込みます。

order (注文)

String (文字列)

要素で並び替えます。

unitdp (単位の小数位)

Number (数値)

(単位の小数位) 単位量に小数第 4 位を使用することもできます。

Xero tenant ID (Xero テナント ID)

String (文字列)

テナントの Xero 識別子。

x

If Modified Since (更新基準日)

String (文字列)

このタイムスタンプ以降に作成または変更されたレコードのみが返されます。

Config Ref (設定参照)

ConfigurationProvider

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

x

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

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

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

Object (オブジェクト)

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

#[null]

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

Object (オブジェクト)

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

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

Number (数値)

リモートサービスへの要求のタイムアウト。

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

次の設定の場合

スロー

  • XERO-ACCOUNTING:BAD_REQUEST​

  • XERO-ACCOUNTING:CLIENT_ERROR​

  • XERO-ACCOUNTING:CONNECTIVITY

  • XERO-ACCOUNTING:INTERNAL_SERVER_ERROR​

  • XERO-ACCOUNTING:NOT_ACCEPTABLE​

  • XERO-ACCOUNTING:NOT_FOUND​

  • XERO-ACCOUNTING:RETRY_EXHAUSTED​

  • XERO-ACCOUNTING:SERVER_ERROR​

  • XERO-ACCOUNTING:SERVICE_UNAVAILABLE​

  • XERO-ACCOUNTING:TIMEOUT

  • XERO-ACCOUNTING:TOO_MANY_REQUESTS​

  • XERO-ACCOUNTING:UNAUTHORIZED

  • XERO-ACCOUNTING:UNSUPPORTED_MEDIA_TYPE​

Get Payments

<xero-accounting:get-payments>

請求書およびクレジットノートの支払を取得します。この操作では、/Payments エンドポイントに対する HTTP GET 要求を行います。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

ただし

String (文字列)

要素で絞り込みます。

order (注文)

String (文字列)

要素で並び替えます。

page (ページ)

Number (数値)

最大 100 件の支払が 1 回の API コールで返されます。

1

Xero tenant ID (Xero テナント ID)

String (文字列)

テナントの Xero 識別子。

x

If Modified Since (更新基準日)

String (文字列)

このタイムスタンプ以降に作成または変更されたレコードのみが返されます。

Output Mime Type (出力 MIME タイプ)

String (文字列)

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

Config Ref (設定参照)

ConfigurationProvider

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

x

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

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

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

Object (オブジェクト)

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

#[null]

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

Object (オブジェクト)

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

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

Number (数値)

リモートサービスへの要求のタイムアウト。

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 の配列

次の設定の場合

スロー

  • XERO-ACCOUNTING:BAD_REQUEST​

  • XERO-ACCOUNTING:CLIENT_ERROR​

  • XERO-ACCOUNTING:CONNECTIVITY

  • XERO-ACCOUNTING:INTERNAL_SERVER_ERROR​

  • XERO-ACCOUNTING:NOT_ACCEPTABLE​

  • XERO-ACCOUNTING:NOT_FOUND​

  • XERO-ACCOUNTING:SERVER_ERROR​

  • XERO-ACCOUNTING:SERVICE_UNAVAILABLE​

  • XERO-ACCOUNTING:TIMEOUT

  • XERO-ACCOUNTING:TOO_MANY_REQUESTS​

  • XERO-ACCOUNTING:UNAUTHORIZED

  • XERO-ACCOUNTING:UNSUPPORTED_MEDIA_TYPE​

Unauthorize

<xero-accounting:unauthorize>

特定のリソースオーナー ID のアクセストークン情報をすべて削除して、認証ダンスが繰り返されない限り、そのユーザー向けの操作を実行できないようにします。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Resource Owner Id (リソースオーナー ID)

String (文字列)

アクセスを無効にするリソースオーナーの ID。

Config Ref (設定参照)

ConfigurationProvider

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

x

次の設定の場合

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

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

Key (キー)

String (文字列)

x

Value (値)

String (文字列)

x

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

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

Key (キー)

String (文字列)

x

Value (値)

String (文字列)

x

Proxy (プロキシ)

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

Host (ホスト)

String (文字列)

x

Port (ポート)

Number (数値)

x

Username (ユーザー名)

String (文字列)

Password (パスワード)

String (文字列)

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

String (文字列)

TLS

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

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

String (文字列)

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

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

String (文字列)

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

Trust Store (トラストストア)

Key Store (キーストア)

Revocation Check (取り消し確認)

Truststore (トラストストア)

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

Path (パス)

String (文字列)

トラストストアの場所 (可能な場合、現在のクラスパスとファイルシステムを基準として解決されます)。

Password (パスワード)

String (文字列)

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

Type (型)

String (文字列)

使用するトラストストアの型。

Algorithm (アルゴリズム)

String (文字列)

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

Insecure (安全ではない)

Boolean (ブール)

true の場合、証明書の検証が実行されず、攻撃に対して接続が脆弱になります。各自の責任で使用してください。

Keystore (キーストア)

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

Path (パス)

String (文字列)

キーストアの場所 (可能な場合、現在のクラスパスとファイルシステムを基準として解決されます)。

Type (型)

String (文字列)

使用するキーストアの型。

Alias (別名)

String (文字列)

キーストアに多数の非公開キーがある場合、この属性は、使用するキーの別名を示します。定義しない場合、デフォルトでファイル内の最初の鍵が使用されます。

Key Password (キーパスワード)

String (文字列)

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

Password (パスワード)

String (文字列)

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

Algorithm (アルゴリズム)

String (文字列)

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

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

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

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

Boolean (ブール)

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

Prefer Crls (CRL を優先)

Boolean (ブール)

最初に OCSP ではなく CRL を試みます。

No Fallback (代替なし)

Boolean (ブール)

第 2 の確認方法 (以前に選択されていない方法) を使用しません。

Soft Fail (ソフトフェール)

Boolean (ブール)

取り消しサーバーに到達できない場合や取り消しサーバーが混雑している場合に検証エラーを回避します。

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

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

Url

String (文字列)

OCSP レスポンダーの URL。

Cert Alias (証明書の別名)

String (文字列)

(トラストストアに含まれている) OCSP 応答の署名証明書の別名 (存在する場合)。

CRL File (CRL ファイル)

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

Path (パス)

String (文字列)

CRL ファイルへのパス。

Reconnection (再接続)

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

Fails Deployment (デプロイに失敗)

Boolean (ブール)

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

Reconnection Strategy (再接続戦略)

使用する再接続戦略。

Reconnect (再接続)

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

Frequency (頻度)

Number (数値)

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

Blocking

Boolean (ブール)

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

Count (数)

Number (数値)

再接続の試行回数。

Reconnect Forever (繰り返し再接続)

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

Frequency (頻度)

Number (数値)

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

Blocking

Boolean (ブール)

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

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

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

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

Number (数値)

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

Time Unit (時間単位)

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

maxIdleTime 属性の時間単位

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 以下に設定すると、バッファが拡張されません。つまり、バッファがフルになると、​STREAM_MAXIMUM_SIZE_EXCEEDED​ エラーが発生します。

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

Number (数値)

使用するメモリの最大量。これを超えると、​STREAM_MAXIMUM_SIZE_EXCEEDED​ エラーが発生します。0 以下の値は無制限を意味します。

Buffer Unit (バッファ単位)

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

  • BYTE (バイト)

  • KB

  • MB

  • GB

これらのすべての属性の単位

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

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

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

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

Number (数値)

データをメモリ内に保持するためにストリームで使用する最大メモリを定義します。これを超えると、ディスクのコンテンツがバッファされます。

Buffer Unit (バッファ単位)

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

  • BYTE (バイト)

  • KB

  • MB

  • GB

maxInMemorySize で表される単位

Redelivery Policy (再配信ポリシー)

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

Max Redelivery Count (最大再配信数)

Number (数値)

正常に処理されずにプロセス失敗メッセージがトリガーされるまでにメッセージを再配信できる最大回数。

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

String (文字列)

使用するセキュアハッシュアルゴリズム。設定しない場合、デフォルトの SHA-256 になります。

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

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

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

ObjectStore

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

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

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

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

Boolean (ブール)

再配信されたメッセージの識別にセキュアハッシュアルゴリズムを使用するかどうか。

Id Expression (ID 式)

String (文字列)

メッセージがいつ再配信されたのかを判断するために使用する 1 つ以上の式を定義します。このプロパティは、useSecureHash が false の場合にのみ設定できます。

Repeatable In Memory Iterable (反復可能なメモリ内イテラブル)

この設定は Mule Kernel のデフォルトであり、デフォルトのバッファサイズを 500 個のオブジェクトに設定します。クエリ結果がこのサイズを超えると、設定された最大バッファサイズに到達するまで、デフォルトの拡張単位である 100 個ずつバッファが拡張されます。ストリームがこの制限を超えると、アプリケーションは失敗します。

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

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

Number (数値)

ストリームを使用し、ランダムアクセスを提供するために、最初にメモリ内に保持するインスタンスの数。ストリームのデータ量がこのバッファサイズを超える場合は、bufferSizeIncrement 属性に従って、maxInMemorySize を上限としてバッファが拡張されます。デフォルト値は 100 インスタンスです。

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

Number (数値)

バッファサイズが初期サイズを超えた場合に、どれだけ拡張するか。値を 0 以下に設定すると、バッファが拡張されません。つまり、バッファがフルになると、​STREAM_MAXIMUM_SIZE_EXCEEDED​ エラーが発生します。デフォルト値は 100 インスタンスです。

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

Number (数値)

使用するメモリの最大量。これを超えると、​STREAM_MAXIMUM_SIZE_EXCEEDED​ エラーが発生します。0 以下の値は無制限を意味します。

Repeatable File Store Iterable (反復可能なファイルストアイテラブル)

この設定は、Mule Enterprise Edition のデフォルトです。この戦略では、デフォルトの設定済みメモリ内バッファとして 500 個のオブジェクトを使用します。このバッファサイズよりも多くの結果がクエリで返されると、Mule はオブジェクトをシリアル化して、ディスクに書き込みます。

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

In Memory Objects (メモリ内オブジェクト)

Number (数値)

メモリ内に保持されるインスタンスの最大数。これ以上の量が必要な場合、ディスク上のコンテンツがバッファされます。

Buffer Unit (バッファ単位)

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

  • BYTE (バイト)

  • KB

  • MB

  • GB

maxInMemorySize で表される単位