# mulesoft Cloudhub Connector - Full Documentation # CloudHub Connector 1.0 CloudHub 用 Anypoint Connector (CloudHub Connector) を使用すると、Mule アプリケーションから CloudHub API に接続できます。 互換性と修正された問題については、​[「CloudHub Connector リリースノート」](https://docs.mulesoft.com/jp/release-notes/connector/cloudhub-connector-release-notes-mule-4)​を参照してください。 ## [](#cloudhub-設定の作成)CloudHub 設定の作成 基本の CloudHub 設定には次のプロパティが含まれます。 - Username (ユーザー名) Anypoint Platform アカウントのユーザー - Password (パスワード) 指定されたユーザーのパスワード - Environment (環境) 使用する CloudHub 環境。Anypoint Platform でデフォルトとして定義された環境になります。 最小限の CloudHub 設定 ```xml ``` ## [](#pom-ファイル情報)POM ファイル情報 Anypoint Studio 外でアプリケーションを作成する場合は、POM ファイルを次のように更新します。 ```xml com.mulesoft.connectors mule-cloudhub-connector x.x.x mule-plugin ``` `x.x.x`​ を使用しているコネクタに対応するバージョンに置き換えます。 最新の ​`pom.xml`​ ファイル情報を取得する手順は、次のとおりです。 1. [Anypoint Exchange](https://www.mulesoft.com/exchange/)​ に移動します。 2. Exchange で、​**\[Login (ログイン)\]**​ をクリックし、Anypoint Platform のユーザー名とパスワードを指定します。 3. Exchange で、「​`hdfs`​」を検索します。 4. **\[Dependency Snippets (連動関係スニペット)\]**​ をクリックします。 ## [](#使用可能な環境の表示)使用可能な環境の表示 ユーザー名とパスワードが適切に設定されると、使用可能な環境を取得して、容易に設定することができます。 ![使用可能な環境](/mulesoft/current/ja-jp/cloudhub-connector/1.0/_images/cloudhub-environment-value-provider.gif) CloudHub Connector は、​`/account`​ API エンドポイントから使用可能な環境を取得できず、空のドロップダウンリストが表示されることがあります。​**\[OAuth Client Credentials (OAuth クライアントログイン情報)\]**​ 接続種別を使用している場合​**、\[Environment (環境)\]**​ 項目は省略可能であるため、ドロップダウンリストが空でも問題は発生しません。 ## [](#cloudhub-環境の使用)CloudHub 環境の使用 アプリケーションのデプロイメント環境を指定するには、​[`environment.id`](#environment.id-sysprop)​ システムプロパティを使用します。 デプロイ環境の使用 ```xml ``` ## [](#creating-notifications)通知の作成 ユーザーが通知を作成するには、指定された環境に対する Runtime Manager の ​`Read application`​ 権限が必要です。 ユーザーへの権限の割り当てについては、​[「ユーザーへの権限とロールの付与」](https://docs.mulesoft.com/jp/access-management/users#granting-permissions-and-roles-to-users)​を参照してください。 通知を作成するには、Create Notification 操作を使用します。 この操作には、通知メッセージと関連ドメインが必要です。 [`domain`](#domain-sysprop)​ システムプロパティを使用して、ドメインを指定できます。 以下を設定することもできます。 - **Custom properties (カスタムプロパティ)** 作成した通知に追加の情報を提供するオープンオブジェクト - **Priority (優先度)** 通知の優先度を指定します。 - ERROR - INFO - WARN - トランザクション ID 作成した通知に関連付けられたトランザクション ID ```xml ``` ![通知の作成](/mulesoft/current/ja-jp/cloudhub-connector/1.0/_images/cloudhub-create-notification.png) Figure 1. Studio での設定 ## [](#listing-notifications)List Notifications 通知をコンシュームするには、List Notifications 操作を使用します。 この操作で必要なことは、通知の取得元のドメインを指定することのみです。 [`domain`](#domain-sysprop)​ システムプロパティを使用して、ドメインを指定できます。 以下を設定することもできます。 - Limit (制限) 取得する通知数を指定します (デフォルトは ​`-1`​ です。この値は使用可能な通知すべてを示します)。 - Status (状況) 通知を絞り込み、未読、既読、またはすべてを取得します (デフォルトは ​`unread`​ です。この値は、未読としてマークされた通知のみを取得します)。 - Search (検索) 指定したテキストを含む通知のみを取得します。 ```xml ``` ![Listing Notifications](/mulesoft/current/ja-jp/cloudhub-connector/1.0/_images/cloudhub-list-notifications.png) Figure 2. Studio での設定 この操作では、次の構造を持つ通知のリストが返されます。 ```yaml Notification: type: object properties: id: string domain: string priority?: string read: boolean readOn?: datetime createdAt: datetime href: string properties: object ``` ## [](#marking-notification)通知を既読としてマーク Mark Notification 操作を使用して、通知を既読としてマークします。 コンシュームされた通知は既読としてマークされるため、次に通知が読み取られるときに未読の通知のみが取得されます。 Mark Notification 操作には通知 ID のみが必要です。これは、​[通知オブジェクト](#notification-object)​の ​`id`​ プロパティから取得できます。 通知を既読としてマークする例 ```xml ``` ## [](#listing-applications)List Applications コネクタを使用すると、特定の環境で使用可能なすべてのアプリケーションを取得できます。設定は必要ありません。 ```xml ``` 情報の取得方法をカスタマイズし、アプリケーションに関するより少ない情報またはより多くの情報を取得できます。 ## [](#retrieving-app-info)アプリケーションの取得 コネクタでアプリケーションのデプロイに関する情報を取得します。 必要な唯一の設定は、ドメインとアプリケーション名を指定することです。 [`domain`](#domain-sysprop)​ システムプロパティを使用して、ドメインを指定できます。 ```xml ``` この操作は、アプリケーションのデプロイメントに関するすべての情報を返します。 ## [](#役に立つ-cloudhub-システムプロパティ)役に立つ CloudHub システムプロパティ
名前 情報 使用方法

Domain (ドメイン)

CloudHub 内でアプリケーションがデプロイされているドメインの名前。

${domain}

Environment (環境)

アプリケーションがデプロイされている環境の ID。

${environment.id}
## [](#関連情報)関連情報 - [Anypoint Connector の概要](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Exchange を使用したコネクタ、テンプレート、およびサンプルの検出](https://docs.mulesoft.com/connectors/introduction/intro-use-exchange) - [CloudHub Connector リファレンス](https://docs.mulesoft.com/jp/cloudhub-connector/1.0/cloudhub-connector-ref) - [Anypoint Exchange の CloudHub Connector](https://www.mulesoft.com/exchange/com.mulesoft.connectors/mule-cloudhub-connector/) - [MuleSoft ヘルプセンター](https://help.mulesoft.com) # CloudHub Connector 1.0 リファレンス CloudHub 用 Anypoint Connector では、通知を作成およびリストし、CloudHub にデプロイされた作成済みアプリケーションの状況を取得できます。 リリースノート: [CloudHub Connector リリースノート](https://docs.mulesoft.com/jp/release-notes/connector/cloudhub-connector-release-notes-mule-4) ## [](#設定)設定 * * * ### [](#config)デフォルト設定 デフォルト設定 #### [](#パラメーター)パラメーター
名前 型 説明 デフォルト値 必須

Name (名前)

String (文字列)

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

x

Connection (接続)

Connection (接続)

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

x

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

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

動的設定インスタンスがアイドル状態を続けられる最小時間を設定します。この時間が経過すると、Mule Runtime で期限切れに相当するとみなされます。これは、インスタンスが有効期限の対象となった瞬間にプラットフォームでそのインスタンスが期限切れになるということではありません。必要に応じて、インスタンスがパージされます。
#### [](#接続種別)接続種別 ##### [](#config_connection)Connection (接続) CloudHubConnection を提供する接続プロバイダー。 ###### [](#パラメーター-2)パラメーター
名前 型 説明 デフォルト値 必須

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

Reconnection (再接続)

true​ の場合、関連する再接続戦略をすべて実行した後にコネクタ接続テストに合格しないと、デプロイメントが拒否されます。
#### [](#関連操作)関連操作 - [Create Notification](#createNotification) - [Get Application](#getApplication) - [List Applications](#listApplications) - [List Notifications](#listNotifications) - [Mark Notification](#markNotification) ## [](#操作)操作 ### [](#createNotification)Create Notification `` 新しい通知を作成します。 #### [](#パラメーター-3)パラメーター
名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Domain (ドメイン)

String (文字列)

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

x

Message (メッセージ)

String (文字列)

通知のメッセージ。

#[payload]

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

Object (オブジェクト)

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

Priority (優先度)

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

  • ERROR

  • INFO

  • WARN

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

String (文字列)

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

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。
#### [](#次の設定の場合)次の設定の場合 - [デフォルト設定](#config) #### [](#スロー)スロー - CLOUDHUB:CONNECTIVITY - CLOUDHUB:EXECUTION - CLOUDHUB:RETRY\_EXHAUSTED ### [](#getApplication)Get Application `` 名前で 1 つのアプリケーションを取得します。 #### [](#パラメーター-4)パラメーター
名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Domain (ドメイン)

String (文字列)

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

x

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

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

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。
#### [](#出力)出力

Type (型)

Binary (バイナリ)
#### [](#次の設定の場合-2)次の設定の場合 - [デフォルト設定](#config) #### [](#スロー-2)スロー - CLOUDHUB:CONNECTIVITY - CLOUDHUB:EXECUTION - CLOUDHUB:RETRY\_EXHAUSTED ### [](#listApplications)List Applications `` 指定した環境内のすべてのアプリケーションを取得します。 #### [](#パラメーター-5)パラメーター
名前 型 説明 デフォルト値 必須

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

接続エラーが発生した場合の再試行戦略。
#### [](#出力-2)出力

Type (型)

Binary (バイナリ)
#### [](#次の設定の場合-3)次の設定の場合 - [デフォルト設定](#config) #### [](#スロー-3)スロー - CLOUDHUB:CONNECTIVITY - CLOUDHUB:EXECUTION - CLOUDHUB:RETRY\_EXHAUSTED ### [](#listNotifications)List Notifications `` 特定のドメインで使用可能なすべての通知をリストします。 #### [](#パラメーター-6)パラメーター
名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Domain (ドメイン)

String (文字列)

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

x

Limit (制限)

Number (数値)

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

-1

Page Size (ページサイズ)

Number (数値)

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

25

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

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

状況

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

  • READ

  • UNREAD

  • ALL (すべて)

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

UNREAD

Search (検索)

String (文字列)

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

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。
#### [](#出力-3)出力

Type (型)

Notification (通知)​ の配列
#### [](#次の設定の場合-4)次の設定の場合 - [デフォルト設定](#config) #### [](#スロー-4)スロー - CLOUDHUB:CONNECTIVITY - CLOUDHUB:EXECUTION ### [](#markNotification)Mark Notification `` 通知を既読または未読としてマークします。 #### [](#パラメーター-7)パラメーター
名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Notification Id (通知 ID)

String (文字列)

通知の ID。

x

Mark As (マーク)

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

  • READ

  • UNREAD

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

x

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。
#### [](#次の設定の場合-5)次の設定の場合 - [デフォルト設定](#config) #### [](#スロー-5)スロー - CLOUDHUB:CONNECTIVITY - CLOUDHUB:EXECUTION - CLOUDHUB:RETRY\_EXHAUSTED ## [](#型)型 ### [](#Reconnection)Reconnection (再接続)
項目 型 説明 デフォルト値 必須

Fails Deployment (デプロイメントに失敗)

Boolean (ブール)

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

Reconnection Strategy (再接続戦略)

使用する再接続戦略。
### [](#reconnect)Reconnect (再接続)
項目 型 説明 デフォルト値 必須

Frequency (頻度)

Number (数値)

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

Count (数)

Number (数値)

再接続の試行回数。

blocking (ブロック)

Boolean (ブール)

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

true
### [](#reconnect-forever)Reconnect Forever (繰り返し再接続)
項目 型 説明 デフォルト値 必須

Frequency (頻度)

Number (数値)

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

blocking (ブロック)

Boolean (ブール)

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

true
### [](#ExpirationPolicy)Expiration Policy (有効期限ポリシー)
項目 型 説明 デフォルト値 必須

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

Number (数値)

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

Time Unit (時間単位)

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

maxIdleTime 属性の時間単位
### [](#repeatable-in-memory-stream)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)Repeatable File Store Stream (反復可能なファイルストアストリーム)
項目 型 説明 デフォルト値 必須

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

Number (数値)

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

Buffer Unit (バッファ単位)

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

  • BYTE (バイト)

  • KB

  • MB

  • GB

maxInMemorySize で表される単位
### [](#Notification)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)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)Repeatable File Store Iterable (反復可能なファイルストアイテラブル)
項目 型 説明 デフォルト値 必須

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

Number (数値)

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

Buffer Unit (バッファ単位)

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

  • BYTE (バイト)

  • KB

  • MB

  • GB

maxInMemorySize で表される単位
## [](#関連情報)関連情報 [MuleSoft ヘルプセンター](https://help.mulesoft.com) # CloudHub Connector 1.1 CloudHub 用 Anypoint Connector (CloudHub Connector) を使用すると、Mule アプリケーションから CloudHub API に接続できます。 互換性と修正された問題については、​[「CloudHub Connector リリースノート」](https://docs.mulesoft.com/jp/release-notes/connector/cloudhub-connector-release-notes-mule-4)​を参照してください。 ## [](#cloudhub-設定の作成)CloudHub 設定の作成 CloudHub Connector 接続では、次の認証種別を使用します。 - 基本認証 ユーザー名とパスワードを使用して認証を行います。 - OAuth Client Credentials (OAuth クライアントログイン情報) ユーザーアカウントをホストするサービスにユーザー認証を委任します。 基本の CloudHub 設定には次のプロパティが含まれます。 - 接続プロバイダー いずれかの認証種別 (\[Basic Authentication (基本認証)\] または \[OAuth Client Credentials (OAuth クライアントログイン情報)\]) - ログイン情報 選択した認証種別に応じて、ユーザー名とパスワード、またはクライアント ID とクライアントシークレットを指定する必要があります。 - 環境 使用する CloudHub 環境。Anypoint Platform でデフォルトとして定義された環境になります。 基本認証を使用した CloudHub 設定の例: ```xml ``` OAuth クライアントログイン情報認証を使用した CloudHub 設定の例: ```xml ``` ## [](#pom-ファイル情報)POM ファイル情報 Anypoint Studio 外でアプリケーションを作成する場合は、POM ファイルを次のように更新します。 ```xml com.mulesoft.connectors mule-cloudhub-connector x.x.x mule-plugin ``` `x.x.x`​ を使用しているコネクタに対応するバージョンに置き換えます。 最新の ​`pom.xml`​ ファイル情報を取得する手順は、次のとおりです。 1. [Anypoint Exchange](https://www.mulesoft.com/exchange/)​ に移動します。 2. Exchange で、​**\[Login (ログイン)\]**​ をクリックし、Anypoint Platform のユーザー名とパスワードを指定します。 3. Exchange で、「​`cloudhub`​」を検索します。 4. **\[Dependency Snippets (連動関係スニペット)\]**​ をクリックします。 ## [](#使用可能な環境の表示)使用可能な環境の表示 ログイン情報が適切に設定されると、使用可能な環境を取得して、容易に設定することができます。 ![使用可能な環境](/mulesoft/current/ja-jp/cloudhub-connector/1.1/_images/cloudhub-environments-value-provider.gif) CloudHub Connector は、​`/account`​ API エンドポイントから使用可能な環境を取得できず、空のドロップダウンリストが表示されることがあります。​**\[OAuth Client Credentials (OAuth クライアントログイン情報)\]**​ 接続種別を使用している場合​**、\[Environment (環境)\]**​ 項目は省略可能であるため、ドロップダウンリストが空でも問題は発生しません。 ## [](#cloudhub-環境の使用)CloudHub 環境の使用 アプリケーションのデプロイメント環境を指定するには、​[`environment.id`](#environment.id-sysprop)​ システムプロパティを使用します。 デプロイ環境の使用 ```xml ``` ## [](#creating-notifications)通知の作成 ユーザーが通知を作成するには、指定された環境に対する Runtime Manager の ​`Read application`​ 権限が必要です。 ユーザーへの権限の割り当てについては、​[「ユーザーへの権限とロールの付与」](https://docs.mulesoft.com/jp/access-management/users#granting-permissions-and-roles-to-users)​を参照してください。 通知を作成するには、Create Notification 操作を使用します。 この操作には、通知メッセージと関連ドメインが必要です。 [`domain`](#domain-sysprop)​ システムプロパティを使用して、ドメインを指定できます。 以下を設定することもできます。 - **Custom properties (カスタムプロパティ)** 作成した通知に追加の情報を提供するオープンオブジェクト - **Priority (優先度)** 通知の優先度を指定します。 - ERROR - INFO - WARN - トランザクション ID 作成した通知に関連付けられたトランザクション ID ```xml ``` ![通知の作成](/mulesoft/current/ja-jp/cloudhub-connector/1.1/_images/cloudhub-create-notification.png) Figure 1. Studio での設定 ## [](#listing-notifications)List Notifications 通知をコンシュームするには、List Notifications 操作を使用します。 この操作で必要なことは、通知の取得元のドメインを指定することのみです。 [`domain`](#domain-sysprop)​ システムプロパティを使用して、ドメインを指定できます。 以下を設定することもできます。 - Limit (制限) 取得する通知数を指定します (デフォルトは ​`-1`​ です。この値は使用可能な通知すべてを示します)。 - Status (状況) 通知を絞り込み、未読、既読、またはすべてを取得します (デフォルトは ​`unread`​ です。この値は、未読としてマークされた通知のみを取得します)。 - Search (検索) 指定したテキストを含む通知のみを取得します。 ```xml ``` ![Listing Notifications](/mulesoft/current/ja-jp/cloudhub-connector/1.1/_images/cloudhub-list-notifications.png) Figure 2. Studio での設定 この操作では、次の構造を持つ通知のリストが返されます。 ```yaml Notification: type: object properties: id: string domain: string priority?: string read: boolean readOn?: datetime createdAt: datetime href: string properties: object ``` ## [](#marking-notification)通知を既読としてマーク Mark Notification 操作を使用して、通知を既読としてマークします。 コンシュームされた通知は既読としてマークされるため、次に通知が読み取られるときに未読の通知のみが取得されます。 Mark Notification 操作には通知 ID のみが必要です。これは、​[通知オブジェクト](#notification-object)​の ​`id`​ プロパティから取得できます。 通知を既読としてマークする例 ```xml ``` ## [](#listing-applications)List Applications コネクタを使用すると、特定の環境で使用可能なすべてのアプリケーションを取得できます。設定は必要ありません。 ```xml ``` 情報の取得方法をカスタマイズし、アプリケーションに関するより少ない情報またはより多くの情報を取得できます。 ## [](#retrieving-app-info)アプリケーションの取得 コネクタでアプリケーションのデプロイに関する情報を取得します。 必要な唯一の設定は、ドメインとアプリケーション名を指定することです。 [`domain`](#domain-sysprop)​ システムプロパティを使用して、ドメインを指定できます。 ```xml ``` この操作は、アプリケーションのデプロイメントに関するすべての情報を返します。 ## [](#役に立つ-cloudhub-システムプロパティ)役に立つ CloudHub システムプロパティ
名前 情報 使用方法

Domain (ドメイン)

CloudHub 内でアプリケーションがデプロイされているドメインの名前。

${domain}

Environment (環境)

アプリケーションがデプロイされている環境の ID。

${environment.id}
## [](#関連情報)関連情報 - [Anypoint Connector の概要](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Exchange を使用したコネクタ、テンプレート、およびサンプルの検出](https://docs.mulesoft.com/connectors/introduction/intro-use-exchange) - [CloudHub Connector リファレンス](https://docs.mulesoft.com/jp/cloudhub-connector/1.1/cloudhub-connector-ref) - [Anypoint Exchange の CloudHub Connector](https://www.mulesoft.com/exchange/com.mulesoft.connectors/mule-cloudhub-connector/) - [MuleSoft ヘルプセンター](https://help.mulesoft.com) # CloudHub Connector 1.1 リファレンス CloudHub 用 Anypoint Connector では、通知を作成およびリストし、CloudHub にデプロイされた作成済みアプリケーションの状況を取得できます。 リリースノート: [CloudHub Connector リリースノート](https://docs.mulesoft.com/jp/release-notes/connector/cloudhub-connector-release-notes-mule-4) ## [](#設定)設定 * * * ### [](#config)デフォルト設定 デフォルト設定 #### [](#パラメーター)パラメーター
名前 型 説明 デフォルト値 必須

Name (名前)

String (文字列)

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

x

Connection (接続)

この設定の接続種別。

x

Name (名前)

String (文字列)

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

x

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

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

動的設定インスタンスがアイドル状態を続けられる最小時間を設定します。この時間が経過すると、Mule Runtime で期限切れに相当するとみなされます。これは、インスタンスが有効期限の対象となった瞬間にプラットフォームでそのインスタンスが期限切れになるということではありません。必要に応じて、インスタンスがパージされます。
#### [](#接続種別)接続種別 ##### [](#config_connection)基本認証 CloudHub 接続を提供する基本的な接続プロバイダー。 ###### [](#パラメーター-2)パラメーター
名前 型 説明 デフォルト値 必須

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

Reconnection (再接続)

コネクタ操作で外部サーバーへの接続に失敗した場合に使用する再接続戦略を設定します。
##### [](#Config_OauthClientCredentials)OAuth Client Credentials (OAuth クライアントログイン情報) CloudHub 接続を提供する接続プロバイダー。 ###### [](#パラメーター-3)パラメーター
名前 型 説明 デフォルト値 必須

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

Reconnection (再接続)

コネクタ操作で外部サーバーへの接続に失敗した場合に使用する再接続戦略を設定します。
#### [](#関連操作)関連操作 - [Create Notification](#createNotification) - [Get Application](#getApplication) - [List Applications](#listApplications) - [List Notifications](#listNotifications) - [Mark Notification](#markNotification) ## [](#操作)操作 ### [](#createNotification)Create Notification `` 新しい通知を作成します。 #### [](#パラメーター-4)パラメーター
名前 型 説明 デフォルト値 必須

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

接続エラーが発生した場合の再試行戦略。
#### [](#次の設定の場合)次の設定の場合 - [デフォルト設定](#config) #### [](#スロー)スロー - CLOUDHUB:CONNECTIVITY - CLOUDHUB:EXECUTION - CLOUDHUB:RETRY\_EXHAUSTED ### [](#getApplication)Get Application `` 名前で 1 つのアプリケーションを取得します。 #### [](#パラメーター-5)パラメーター
名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Domain (ドメイン)

String (文字列)

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

x

Config Ref (設定参照)

ConfigurationProvider

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

x

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

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

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

エラーのマッピング

エラーのマッピング​ の配列

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

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。
#### [](#出力)出力

Type (型)

Any (任意)
#### [](#次の設定の場合-2)次の設定の場合 - [デフォルト設定](#config) #### [](#スロー-2)スロー - CLOUDHUB:CONNECTIVITY - CLOUDHUB:EXECUTION - CLOUDHUB:RETRY\_EXHAUSTED ### [](#listApplications)List Applications `` 指定した環境内のすべてのアプリケーションを取得します。 #### [](#パラメーター-6)パラメーター
名前 型 説明 デフォルト値 必須

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

接続エラーが発生した場合の再試行戦略。
#### [](#出力-2)出力

Type (型)

Any (任意)
#### [](#次の設定の場合-3)次の設定の場合 - [デフォルト設定](#config) #### [](#スロー-3)スロー - CLOUDHUB:CONNECTIVITY - CLOUDHUB:EXECUTION - CLOUDHUB:RETRY\_EXHAUSTED ### [](#listNotifications)List Notifications `` 特定のドメインで使用可能なすべての通知をリストします。 #### [](#パラメーター-7)パラメーター
名前 型 説明 デフォルト値 必須

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

接続エラーが発生した場合の再試行戦略。
#### [](#出力-3)出力

Type (型)

Notification (通知)​ の配列
#### [](#次の設定の場合-4)次の設定の場合 - [デフォルト設定](#config) #### [](#スロー-4)スロー - CLOUDHUB:CONNECTIVITY - CLOUDHUB:EXECUTION ### [](#markNotification)Mark Notification `` 通知を既読または未読としてマークします。 #### [](#パラメーター-8)パラメーター
名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Notification Id (通知 ID)

String (文字列)

通知の ID。

x

Mark As (マーク)

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

  • READ

  • UNREAD

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

x

Config Ref (設定参照)

ConfigurationProvider

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

x

エラーのマッピング

エラーのマッピング​ の配列

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

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。
#### [](#次の設定の場合-5)次の設定の場合 - [デフォルト設定](#config) #### [](#スロー-5)スロー - CLOUDHUB:CONNECTIVITY - CLOUDHUB:EXECUTION - CLOUDHUB:RETRY\_EXHAUSTED ## [](#型)型 ### [](#Reconnection)Reconnection (再接続)
項目 型 説明 デフォルト値 必須

Fails Deployment (デプロイメントに失敗)

Boolean (ブール)

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

Reconnection Strategy (再接続戦略)

使用する再接続戦略。
### [](#reconnect)Reconnect (再接続)
項目 型 説明 デフォルト値 必須

Frequency (頻度)

Number (数値)

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

Count (数)

Number (数値)

再接続の試行回数。

blocking (ブロック)

Boolean (ブール)

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

true
### [](#reconnect-forever)Reconnect Forever (繰り返し再接続)
項目 型 説明 デフォルト値 必須

Frequency (頻度)

Number (数値)

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

blocking (ブロック)

Boolean (ブール)

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

true
### [](#ExpirationPolicy)Expiration Policy (有効期限ポリシー)
項目 型 説明 デフォルト値 必須

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

Number (数値)

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

Time Unit (時間単位)

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

maxIdleTime 属性の時間単位
### [](#ErrorMapping)エラーのマッピング
項目 型 説明 デフォルト値 必須

Source (ソース)

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

  • ANY

  • REDELIVERY_EXHAUSTED​

  • TRANSFORMATION

  • EXPRESSION

  • SECURITY

  • CLIENT_SECURITY​

  • SERVER_SECURITY​

  • ROUTING

  • CONNECTIVITY

  • RETRY_EXHAUSTED​

  • TIMEOUT

ソース。

Target (対象)

String (文字列)

対象。

x
### [](#repeatable-in-memory-stream)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)Repeatable File Store Stream (反復可能なファイルストアストリーム)
項目 型 説明 デフォルト値 必須

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

Number (数値)

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

Buffer Unit (バッファ単位)

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

  • BYTE (バイト)

  • KB

  • MB

  • GB

maxInMemorySize で表される単位
### [](#Notification)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)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)Repeatable File Store Iterable (反復可能なファイルストアイテラブル)
項目 型 説明 デフォルト値 必須

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

Number (数値)

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

Buffer Unit (バッファ単位)

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

  • BYTE (バイト)

  • KB

  • MB

  • GB

maxInMemorySize で表される単位
## [](#関連情報)関連情報 [MuleSoft ヘルプセンター](https://help.mulesoft.com) # CloudHub Connector 1.2 CloudHub 用 Anypoint Connector (CloudHub Connector) を使用すると、Mule アプリケーションから CloudHub API に接続できます。 互換性と修正された問題については、​[「CloudHub Connector リリースノート」](https://docs.mulesoft.com/jp/release-notes/connector/cloudhub-connector-release-notes-mule-4)​を参照してください。 ## [](#cloudhub-設定の作成)CloudHub 設定の作成 CloudHub Connector 接続では、次の認証種別を使用します。 - 基本認証 ユーザー名とパスワードを使用して認証を行います。 - OAuth Client Credentials (OAuth クライアントログイン情報) ユーザーアカウントをホストするサービスにユーザー認証を委任します。 基本の CloudHub 設定には次のプロパティが含まれます。 - 接続プロバイダー いずれかの認証種別 (\[Basic Authentication (基本認証)\] または \[OAuth Client Credentials (OAuth クライアントログイン情報)\]) - ログイン情報 選択した認証種別に応じて、ユーザー名とパスワード、またはクライアント ID とクライアントシークレットを指定する必要があります。 - 環境 使用する CloudHub 環境。Anypoint Platform でデフォルトとして定義された環境になります。 基本認証を使用した CloudHub 設定の例: ```xml ``` OAuth クライアントログイン情報認証を使用した CloudHub 設定の例: ```xml ``` ## [](#pom-ファイル情報)POM ファイル情報 Anypoint Studio 外でアプリケーションを作成する場合は、POM ファイルを次のように更新します。 ```xml com.mulesoft.connectors mule-cloudhub-connector x.x.x mule-plugin ``` `x.x.x`​ を使用しているコネクタに対応するバージョンに置き換えます。 最新の ​`pom.xml`​ ファイル情報を取得する手順は、次のとおりです。 1. [Anypoint Exchange](https://www.mulesoft.com/exchange/)​ に移動します。 2. Exchange で、​**\[Login (ログイン)\]**​ をクリックし、Anypoint Platform のユーザー名とパスワードを指定します。 3. Exchange で、「​`cloudhub`​」を検索します。 4. **\[Dependency Snippets (連動関係スニペット)\]**​ をクリックします。 ## [](#使用可能な環境の表示)使用可能な環境の表示 ログイン情報が適切に設定されると、使用可能な環境を取得して、容易に設定することができます。 ![使用可能な環境](/mulesoft/current/ja-jp/cloudhub-connector/latest/_images/cloudhub-environments-value-provider.gif) CloudHub Connector は、​`/account`​ API エンドポイントから使用可能な環境を取得できず、空のドロップダウンリストが表示されることがあります。​**\[OAuth Client Credentials (OAuth クライアントログイン情報)\]**​ 接続種別を使用している場合​**、\[Environment (環境)\]**​ 項目は省略可能であるため、ドロップダウンリストが空でも問題は発生しません。

ドロップダウンリストには、設定されたログイン情報のユーザーのメインビジネスグループに属する環境が表示されます。 同じユーザーがアクセスできる子ビジネスグループの環境を使用するには、この項目または対応する XML 属性のいずれかでその ID を手動で指定します。
## [](#cloudhub-環境の使用)CloudHub 環境の使用 アプリケーションのデプロイメント環境を指定するには、​[`environment.id`](#environment.id-sysprop)​ システムプロパティを使用します。 デプロイ環境の使用 ```xml ``` ## [](#creating-notifications)通知の作成 ユーザーが通知を作成するには、指定された環境に対する Runtime Manager の ​`Read application`​ 権限が必要です。 ユーザーへの権限の割り当てについては、​[「ユーザーへの権限とロールの付与」](https://docs.mulesoft.com/jp/access-management/users#granting-permissions-and-roles-to-users)​を参照してください。 通知を作成するには、Create Notification 操作を使用します。 この操作には、通知メッセージと関連ドメインが必要です。 [`domain`](#domain-sysprop)​ システムプロパティを使用して、ドメインを指定できます。 以下を設定することもできます。 - **Custom properties (カスタムプロパティ)** 作成した通知に追加の情報を提供するオープンオブジェクト - **Priority (優先度)** 通知の優先度を指定します。 - ERROR - INFO - WARN - トランザクション ID 作成した通知に関連付けられたトランザクション ID ```xml ``` ![通知の作成](/mulesoft/current/ja-jp/cloudhub-connector/latest/_images/cloudhub-create-notification.png) Figure 1. Studio での設定 ## [](#listing-notifications)List Notifications 通知をコンシュームするには、List Notifications 操作を使用します。 この操作で必要なことは、通知の取得元のドメインを指定することのみです。 [`domain`](#domain-sysprop)​ システムプロパティを使用して、ドメインを指定できます。 以下を設定することもできます。 - Limit (制限) 取得する通知数を指定します (デフォルトは ​`-1`​ です。この値は使用可能な通知すべてを示します)。 - Status (状況) 通知を絞り込み、未読、既読、またはすべてを取得します (デフォルトは ​`unread`​ です。この値は、未読としてマークされた通知のみを取得します)。 - Search (検索) 指定したテキストを含む通知のみを取得します。 ```xml ``` ![Listing Notifications](/mulesoft/current/ja-jp/cloudhub-connector/latest/_images/cloudhub-list-notifications.png) Figure 2. Studio での設定 この操作では、次の構造を持つ通知のリストが返されます。 ```yaml Notification: type: object properties: id: string domain: string priority?: string read: boolean readOn?: datetime createdAt: datetime href: string properties: object ``` ## [](#marking-notification)通知を既読としてマーク Mark Notification 操作を使用して、通知を既読としてマークします。 コンシュームされた通知は既読としてマークされるため、次に通知が読み取られるときに未読の通知のみが取得されます。 Mark Notification 操作には通知 ID のみが必要です。これは、​[通知オブジェクト](#notification-object)​の ​`id`​ プロパティから取得できます。 通知を既読としてマークする例 ```xml ``` ## [](#listing-applications)List Applications コネクタを使用すると、特定の環境で使用可能なすべてのアプリケーションを取得できます。設定は必要ありません。 ```xml ``` 情報の取得方法をカスタマイズし、アプリケーションに関するより少ない情報またはより多くの情報を取得できます。 ## [](#retrieving-app-info)アプリケーションの取得 コネクタでアプリケーションのデプロイに関する情報を取得します。 必要な唯一の設定は、ドメインとアプリケーション名を指定することです。 [`domain`](#domain-sysprop)​ システムプロパティを使用して、ドメインを指定できます。 ```xml ``` この操作は、アプリケーションのデプロイメントに関するすべての情報を返します。 ## [](#役に立つ-cloudhub-システムプロパティ)役に立つ CloudHub システムプロパティ
Name 情報 使用方法

Domain (ドメイン)

CloudHub 内でアプリケーションがデプロイされているドメインの名前。

${domain}

Environment (環境)

アプリケーションがデプロイされている環境の ID。

${environment.id}
## [](#関連情報)関連情報 - [Anypoint Connector の概要](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Exchange を使用したコネクタ、テンプレート、およびサンプルの検出](https://docs.mulesoft.com/connectors/introduction/intro-use-exchange) - [CloudHub Connector リファレンス](https://docs.mulesoft.com/jp/cloudhub-connector/latest/cloudhub-connector-ref) - [Anypoint Exchange の CloudHub Connector](https://www.mulesoft.com/exchange/com.mulesoft.connectors/mule-cloudhub-connector/) - [MuleSoft ヘルプセンター](https://help.mulesoft.com) # CloudHub Connector 1.2 リファレンス CloudHub 用 Anypoint Connector では、通知を作成およびリストし、CloudHub にデプロイされた作成済みアプリケーションの状況を取得できます。 リリースノート: [CloudHub Connector リリースノート](https://docs.mulesoft.com/jp/release-notes/connector/cloudhub-connector-release-notes-mule-4) ## [](#設定)設定 * * * ### [](#config)デフォルト設定 デフォルト設定 #### [](#パラメーター)パラメーター
名前 型 説明 デフォルト値 必須

Name (名前)

String (文字列)

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

x

Connection (接続)

この設定の接続種別。

x

Name (名前)

String (文字列)

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

x

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

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

動的設定インスタンスがアイドル状態を続けられる最小時間を設定します。この時間が経過すると、Mule Runtime で期限切れに相当するとみなされます。これは、インスタンスが有効期限の対象となった瞬間にプラットフォームでそのインスタンスが期限切れになるということではありません。必要に応じて、インスタンスがパージされます。
#### [](#接続種別)接続種別 ##### [](#config_connection)基本認証 CloudHub 接続を提供する基本的な接続プロバイダー。 ###### [](#パラメーター-2)パラメーター
名前 型 説明 デフォルト値 必須

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

Reconnection (再接続)

コネクタ操作で外部サーバーへの接続に失敗した場合に使用する再接続戦略を設定します。
##### [](#Config_OauthClientCredentials)OAuth Client Credentials (OAuth クライアントログイン情報) CloudHub 接続を提供する接続プロバイダー。 ###### [](#パラメーター-3)パラメーター
名前 型 説明 デフォルト値 必須

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

Reconnection (再接続)

コネクタ操作で外部サーバーへの接続に失敗した場合に使用する再接続戦略を設定します。
#### [](#関連操作)関連操作 - [Create Notification](#createNotification) - [Get Application](#getApplication) - [List Applications](#listApplications) - [List Notifications](#listNotifications) - [Mark Notification](#markNotification) ## [](#操作)操作 ### [](#createNotification)Create Notification `` 新しい通知を作成します。 #### [](#パラメーター-4)パラメーター
名前 型 説明 デフォルト値 必須

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

接続エラーが発生した場合の再試行戦略。
#### [](#次の設定の場合)次の設定の場合 - [デフォルト設定](#config) #### [](#スロー)スロー - CLOUDHUB:CONNECTIVITY - CLOUDHUB:EXECUTION - CLOUDHUB:RETRY\_EXHAUSTED ### [](#getApplication)Get Application `` 名前で 1 つのアプリケーションを取得します。 #### [](#パラメーター-5)パラメーター
名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Domain (ドメイン)

String (文字列)

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

x

Config Ref (設定参照)

ConfigurationProvider

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

x

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

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

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

エラーのマッピング

エラーのマッピング​ の配列

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

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。
#### [](#出力)出力

型

Any (任意)
#### [](#次の設定の場合-2)次の設定の場合 - [デフォルト設定](#config) #### [](#スロー-2)スロー - CLOUDHUB:CONNECTIVITY - CLOUDHUB:EXECUTION - CLOUDHUB:RETRY\_EXHAUSTED ### [](#listApplications)List Applications `` 指定した環境内のすべてのアプリケーションを取得します。 #### [](#パラメーター-6)パラメーター
名前 型 説明 デフォルト値 必須

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

接続エラーが発生した場合の再試行戦略。
#### [](#出力-2)出力

型

Any (任意)
#### [](#次の設定の場合-3)次の設定の場合 - [デフォルト設定](#config) #### [](#スロー-3)スロー - CLOUDHUB:CONNECTIVITY - CLOUDHUB:EXECUTION - CLOUDHUB:RETRY\_EXHAUSTED ### [](#listNotifications)List Notifications `` 特定のドメインで使用可能なすべての通知をリストします。 #### [](#パラメーター-7)パラメーター
名前 型 説明 デフォルト値 必須

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

接続エラーが発生した場合の再試行戦略。
#### [](#出力-3)出力

型

Notification (通知)​ の配列
#### [](#次の設定の場合-4)次の設定の場合 - [デフォルト設定](#config) #### [](#スロー-4)スロー - CLOUDHUB:CONNECTIVITY - CLOUDHUB:EXECUTION ### [](#markNotification)Mark Notification `` 通知を既読または未読としてマークします。 #### [](#パラメーター-8)パラメーター
名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Notification Id (通知 ID)

String (文字列)

通知の ID。

x

Mark As (マーク)

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

  • READ

  • UNREAD

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

x

Config Ref (設定参照)

ConfigurationProvider

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

x

エラーのマッピング

エラーのマッピング​ の配列

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

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。
#### [](#次の設定の場合-5)次の設定の場合 - [デフォルト設定](#config) #### [](#スロー-5)スロー - CLOUDHUB:CONNECTIVITY - CLOUDHUB:EXECUTION - CLOUDHUB:RETRY\_EXHAUSTED ## [](#型)型 ### [](#Reconnection)Reconnection (再接続)
項目 型 説明 デフォルト値 必須

Fails Deployment (デプロイメントに失敗)

Boolean (ブール)

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

Reconnection Strategy (再接続戦略)

使用する再接続戦略。
### [](#reconnect)Reconnect (再接続)
項目 型 説明 デフォルト値 必須

Frequency (頻度)

Number (数値)

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

Count (数)

Number (数値)

再接続の試行回数。

blocking (ブロック)

Boolean (ブール)

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

true
### [](#reconnect-forever)Reconnect Forever (繰り返し再接続)
項目 型 説明 デフォルト値 必須

Frequency (頻度)

Number (数値)

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

blocking (ブロック)

Boolean (ブール)

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

true
### [](#ExpirationPolicy)Expiration Policy (有効期限ポリシー)
項目 型 説明 デフォルト値 必須

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

Number (数値)

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

Time Unit (時間単位)

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

maxIdleTime 属性の時間単位
### [](#ErrorMapping)エラーのマッピング
項目 型 説明 デフォルト値 必須

Source (ソース)

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

  • ANY

  • REDELIVERY_EXHAUSTED​

  • TRANSFORMATION

  • EXPRESSION

  • SECURITY

  • CLIENT_SECURITY​

  • SERVER_SECURITY​

  • ROUTING

  • CONNECTIVITY

  • RETRY_EXHAUSTED​

  • TIMEOUT

ソース。

Target (対象)

String (文字列)

対象。

x
### [](#repeatable-in-memory-stream)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)Repeatable File Store Stream (反復可能なファイルストアストリーム)
項目 型 説明 デフォルト値 必須

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

Number (数値)

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

Buffer Unit (バッファ単位)

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

  • BYTE

  • KB

  • MB

  • GB

maxInMemorySize で表される単位
### [](#Notification)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)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)Repeatable File Store Iterable (反復可能なファイルストアイテラブル)
項目 型 説明 デフォルト値 必須

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

Number (数値)

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

Buffer Unit (バッファ単位)

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

  • BYTE

  • KB

  • MB

  • GB

maxInMemorySize で表される単位
## [](#関連情報)関連情報 [MuleSoft ヘルプセンター](https://help.mulesoft.com)