CloudHub Connector 1.2 リファレンス - Mule 4

CloudHub 用 Anypoint Connector では、通知を作成およびリストし、CloudHub にデプロイされた作成済みアプリケーションの状況を取得できます。

設定


デフォルト設定

デフォルト設定

パラメーター

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

Name (名前)

String (文字列)

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

x

Connection (接続)

この設定の接続種別。

x

Name (名前)

String (文字列)

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

x

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

動的設定インスタンスがアイドル状態を続けられる最小時間を設定します。この時間が経過すると、Mule Runtime で期限切れに相当するとみなされます。これは、インスタンスが有効期限の対象となった瞬間にプラットフォームでそのインスタンスが期限切れになるということではありません。必要に応じて、インスタンスがパージされます。

接続種別

基本認証

CloudHub 接続を提供する基本的な接続プロバイダー。

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

Username (ユーザー名)

String (文字列)

Anypoint Platform アカウントのユーザー名。

x

Password (パスワード)

String (文字列)

Anypoint Platform アカウントのパスワード。

x

Environment (環境)

String (文字列)

必要に応じて、使用する Anypoint Platform 環境を指定します。デフォルトでは、Anypoint Platform でデフォルトとして定義された環境です。

Anypoint Platform URL

String (文字列)

必要に応じて、US Anypoint Platform と EU Anypoint Platform 間で切り替えることができます。

https://anypoint.mulesoft.com

Reconnection (再接続)

コネクタ操作で外部サーバーへの接続に失敗した場合に使用する再接続戦略を設定します。

OAuth Client Credentials (OAuth クライアントログイン情報)

CloudHub 接続を提供する接続プロバイダー。

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

Anypoint Platform URL

String (文字列)

必要に応じて、US Anypoint Platform と EU Anypoint Platform 間で切り替えることができます。

https://anypoint.mulesoft.com

Client Id (クライアント ID)

String (文字列)

サービスプロバイダーに登録されている OAuth クライアント ID。

x

Client Secret (クライアントシークレット)

String (文字列)

サービスプロバイダーに登録されている OAuth クライアントシークレット。

x

Environment (環境)

String (文字列)

必要に応じて、使用する Anypoint Platform 環境を指定します。デフォルトでは、Anypoint Platform でデフォルトとして定義された環境です。

Reconnection (再接続)

コネクタ操作で外部サーバーへの接続に失敗した場合に使用する再接続戦略を設定します。

操作

Create Notification

<cloudhub:create-notification>

新しい通知を作成します。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Domain (ドメイン)

String (文字列)

新しい通知をバインドするアプリケーションの名前。

x

Message (メッセージ)

String (文字列)

通知のメッセージ。

#[payload]

Custom Properties (カスタムプロパティ)

Object (オブジェクト)

通知のその他のプロパティ。

Priority (優先度)

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

  • ERROR

  • INFO

  • WARN

作成する通知の優先度。

Transaction Id (トランザクション ID)

String (文字列)

通知のトランザクション ID。

Config Ref (設定参照)

ConfigurationProvider

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

x

エラーのマッピング

エラーのマッピングのセット。

Reconnection Strategy (再接続戦略)

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

次の設定の場合

スロー

  • CLOUDHUB:CONNECTIVITY

  • CLOUDHUB:EXECUTION

  • CLOUDHUB:RETRY_EXHAUSTED

Get Application

<cloudhub:get-application>

名前で 1 つのアプリケーションを取得します。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Domain (ドメイン)

String (文字列)

アプリケーションの名前。

x

Config Ref (設定参照)

ConfigurationProvider

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

x

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

反復可能ストリームを使用すべきかどうか、およびその動作を設定します。

Target Variable (対象変数)

String (文字列)

操作の出力が格納される変数の名前

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。その式の結果は対象変数に保存されます。

#[payload]

エラーのマッピング

エラーのマッピングのセット。

Reconnection Strategy (再接続戦略)

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

出力

Any (任意)

次の設定の場合

スロー

  • CLOUDHUB:CONNECTIVITY

  • CLOUDHUB:EXECUTION

  • CLOUDHUB:RETRY_EXHAUSTED

List Applications

<cloudhub:list-applications>

指定した環境内のすべてのアプリケーションを取得します。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Retrieve Log Levels (ログレベルを取得)

Boolean (ブール)

アプリケーションのログレベルを取得する必要があるかどうか。

true

Retrieve Tracking Settings (追跡設定を取得)

Boolean (ブール)

アプリケーションの追跡設定を取得する必要があるかどうか。

true

Retrieve IP Addresses (IP アドレスを取得)

Boolean (ブール)

アプリケーションの IP アドレスを取得する必要があるかどうか。

true

Config Ref (設定参照)

ConfigurationProvider

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

x

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

反復可能ストリームを使用すべきかどうか、およびその動作を設定します。

Retrieve Statistics (統計を取得)

Boolean (ブール)

アプリケーションの統計を取得する必要があるかどうか。

false

Period (期間)

Number (数値)

統計を収集する時間。

1

Period Time Unit (期間単位)

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

期間の時間単位。

HOURS (時間)

Target Variable (対象変数)

String (文字列)

操作の出力が格納される変数の名前

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。その式の結果は対象変数に保存されます。

#[payload]

エラーのマッピング

エラーのマッピングのセット。

Reconnection Strategy (再接続戦略)

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

出力

Any (任意)

次の設定の場合

スロー

  • CLOUDHUB:CONNECTIVITY

  • CLOUDHUB:EXECUTION

  • CLOUDHUB:RETRY_EXHAUSTED

List Notifications

<cloudhub:list-notifications>

特定のドメインで使用可能なすべての通知をリストします。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Domain (ドメイン)

String (文字列)

通知の収集元のアプリケーションの名前。

x

Limit (制限)

Number (数値)

取得する通知数。-1 は使用可能なすべてを意味します。

-1

Page Size (ページサイズ)

Number (数値)

反復ごとに取得するページのサイズ。これは、パフォーマンス上の目的でのみ変更する必要があります。

25

Config Ref (設定参照)

ConfigurationProvider

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

x

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

反復可能ストリームを使用すべきかどうか、およびその動作を設定します。

状況

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

  • READ

  • UNREAD

  • ALL (すべて)

状況で通知を絞り込みます。Read (既読)、Unread (未読)、または All (すべて)。

UNREAD

Search (検索)

String (文字列)

指定した場合、メッセージにこの文字列が含まれる通知のみが返されます。(大文字と小文字を区別しない)。

Target Variable (対象変数)

String (文字列)

操作の出力が格納される変数の名前

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。その式の結果は対象変数に保存されます。

#[payload]

エラーのマッピング

エラーのマッピングのセット。

Reconnection Strategy (再接続戦略)

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

出力

Notification (通知)​ の配列

次の設定の場合

スロー

  • CLOUDHUB:CONNECTIVITY

  • CLOUDHUB:EXECUTION

Mark Notification

<cloudhub:mark-notification>

通知を既読または未読としてマークします。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Notification Id (通知 ID)

String (文字列)

通知の ID。

x

Mark As (マーク)

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

  • READ

  • UNREAD

実行するアクション。 既読または未読としてマークします。

x

Config Ref (設定参照)

ConfigurationProvider

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

x

エラーのマッピング

エラーのマッピングのセット。

Reconnection Strategy (再接続戦略)

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

次の設定の場合

スロー

  • CLOUDHUB:CONNECTIVITY

  • CLOUDHUB:EXECUTION

  • CLOUDHUB:RETRY_EXHAUSTED

Reconnection (再接続)

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

Fails Deployment (デプロイに失敗)

Boolean (ブール)

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

Reconnection Strategy (再接続戦略)

使用する再接続戦略。

Reconnect (再接続)

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

Frequency (頻度)

Number (数値)

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

Count (数)

Number (数値)

再接続の試行回数。

blocking (ブロック)

Boolean (ブール)

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

true

Reconnect Forever (繰り返し再接続)

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

Frequency (頻度)

Number (数値)

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

blocking (ブロック)

Boolean (ブール)

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

true

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

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

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

Number (数値)

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

Time Unit (時間単位)

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

maxIdleTime 属性の時間単位

エラーのマッピング

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

Source (ソース)

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

  • ANY

  • REDELIVERY_EXHAUSTED​

  • TRANSFORMATION

  • EXPRESSION

  • SECURITY

  • CLIENT_SECURITY​

  • SERVER_SECURITY​

  • ROUTING

  • CONNECTIVITY

  • RETRY_EXHAUSTED​

  • TIMEOUT

ソース。

Target (対象)

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 (反復可能なファイルストアストリーム)

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

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

Number (数値)

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

Buffer Unit (バッファ単位)

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

  • BYTE

  • KB

  • MB

  • GB

maxInMemorySize で表される単位

Notification (通知)

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

Id

String (文字列)

x

Domain (ドメイン)

String (文字列)

x

Message (メッセージ)

String (文字列)

Priority (優先度)

String (文字列)

Properties (プロパティ)

Any (任意)

Read

Boolean (ブール)

x

Read On (読み取り日)

DateTime

Created At (作成日時)

DateTime

x

Href

String (文字列)

x

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

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

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 (反復可能なファイルストアイテラブル)

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

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

Number (数値)

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

Buffer Unit (バッファ単位)

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

  • BYTE

  • KB

  • MB

  • GB

maxInMemorySize で表される単位