CloudHub コネクタリファレンス

Create Notifications と List Notifications の機能を提供し、CloudHub に作成されたアプリケーションの状況を取得するコネクタ。

設定


設定

デフォルト設定

パラメータ

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

Name (名前)

String (文字列)

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

x 

Connection (接続)

この設定に指定できる接続型。

x 

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

動的設定インスタンスがアイドル状態になってからランタイムで失効の対象とみなされるまでの最短時間を設定します。これは、インスタンスが有効期限の対象となった瞬間にプラットフォームでそのインスタンスが期限切れになるということではありません。ランタイムによって適切と判断されたときに、インスタンスが実際にパージされます。

 

接続種別

Connection (接続)

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

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

Username (ユーザ名)

String (文字列)

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

x 

Password (パスワード)

String (文字列)

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

x 

Environment (環境)

String (文字列)

使用するプラットフォーム環境。これは省略可能です。デフォルトでは、プラットフォームでデフォルトとして定義された環境が使用されます。

 

Anypoint Platform URL

String (文字列)

これを使用して、必要に応じて US と EU 間で Anypoint Platform を切り替えます。

https://anypoint.mulesoft.com

 

Reconnection (再接続)

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

 

操作

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。

 

Reconnection Strategy (再接続戦略)

接続エラー時の再試行戦略

 

次の設定の場合

スロー

  • CLOUDHUB:CONNECTIVITY  

  • CLOUDHUB:EXECUTION  

  • CLOUDHUB:RETRY_EXHAUSTED  

Get Application

<cloudhub:get-application>

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

パラメータ

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x 

Domain (ドメイン)

String (文字列)

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

x 

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

反復可能なストリームを使用するかどうかと、それらの動作を設定します。

 

Target Variable (対象変数)

String (文字列)

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

 

Target Value (対象値)

String (文字列)

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

#[payload]

 

Reconnection Strategy (再接続戦略)

接続エラー時の再試行戦略

 

出力

Binary (バイナリ)

次の設定の場合

スロー

  • 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

 

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

接続エラー時の再試行戦略

 

出力

Binary (バイナリ)

次の設定の場合

スロー

  • 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

 

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

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

 

Status (状況)

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

  • READ

  • UNREAD

  • ALL

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

UNREAD

 

Search (検索)

String (文字列)

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

 

Target Variable (対象変数)

String (文字列)

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

 

Target Value (対象値)

String (文字列)

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

#[payload]

 

Reconnection Strategy (再接続戦略)

接続エラー時の再試行戦略

 

出力

Type (型)

Array of 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 

Reconnection Strategy (再接続戦略)

接続エラー時の再試行戦略

 

次の設定の場合

スロー

  • CLOUDHUB:CONNECTIVITY  

  • CLOUDHUB:EXECUTION  

  • CLOUDHUB:RETRY_EXHAUSTED  

Reconnection (再接続)

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

Fails Deployment (デプロイに失敗)

Boolean

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

Reconnection Strategy (再接続戦略)

使用する再接続戦略。

Reconnect (再接続)

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

Frequency (頻度)

Number (数値)

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

Count (カウント)

Number (数値)

再接続の試行回数。

Reconnect Forever (繰り返し再接続)

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

Frequency (頻度)

Number (数値)

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

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

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

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

Number (数値)

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

Time Unit (時間単位)

Enumeration (列挙)。次のいずれか:

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時)

  • DAYS (日)

maxIdleTime 属性に使用できる時間単位。

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 (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 で表される単位。

Was this article helpful?

💙 Thanks for your feedback!

Edit on GitHub