CloudHub Connector 1.2 Reference | MuleSoft Documentation
# CloudHub Connector 1.2 Reference
Anypoint Connector for CloudHub enables you to create and list notifications and to retrieve the status of created applications that are deployed to CloudHub.
Release Notes: CloudHub Connector Release Notes
## Configurations
### Default Configuration
Default configuration
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
The name for this configuration. Connectors reference the configuration with this name.  
Connection | 
  * Basic Authentication
  * OAuth Client Credentials

| Connection types for this configuration.  
ID used to reference this configuration.  
Expiration Policy |  Expiration Policy | Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration. This does not mean that the platform expires the instance at the exact moment that it becomes eligible. Mule purges the instances as appropriate.  
#### Connection Types
##### Basic Authentication
Basic connection provider that provides CloudHub connection.
###### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Username | Username of the Anypoint Platform Account  
Password | Password of the Anypoint Platform Account  
Environment | Optionally specifies the Anypoint Platform environment to use: by default, the environment defined as the default in Anypoint Platform.  
Anypoint Platform URL | Enables you to change between the US Anypoint Platform and the EU Anypoint Platform, if required. | `https://anypoint.mulesoft.com`  
Reconnection |  | Configures a reconnection strategy to use when a connector operation fails to connect to an external server.  
##### OAuth Client Credentials
Connection provider that provides CloudHub connection.
###### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Anypoint Platform URL | Enables you to change between the US Anypoint Platform and the EU Anypoint Platform, if required. | `https://anypoint.mulesoft.com`  
Client Id | OAuth client ID, as registered with the service provider.  
Client Secret | OAuth client secret, as registered with the service provider.  
Environment | Optionally specifies the Anypoint Platform environment to use: by default, the environment defined as the default in Anypoint Platform.  
Reconnection |  | Configures a reconnection strategy to use when a connector operation fails to connect to an external server.  
#### Associated Operations
  * Create Notification
  * Get Application
  * List Applications
  * List Notifications
  * Mark Notification


## Operations
### Create Notification
`<cloudhub:create-notification>`
Creates a new Notification
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Name of the application to bind the new notification  
Notification’s message | #[payload]  
Custom Properties | Additional properties for the notification  
Priority |  Enumeration, one of:
  * ERROR

| Priority of the notification to create.  
Transaction Id | Transaction ID for the Notification  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
Error Mappings |  Array of Error Mapping | Set of error mappings.  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
#### For Configurations
  * Default Configuration


#### Throws
  * CLOUDHUB:CONNECTIVITY
  * CLOUDHUB:EXECUTION
  * CLOUDHUB:RETRY_EXHAUSTED


### Get Application
`<cloudhub:get-application>`
Retrieves a single application by name.
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
The name of the application  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configure if repeatable streams should be used and their behavior  
Target Variable | The name of a variable on which the operation’s output will be placed  
Target Value | An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable | #[payload]  
Error Mappings |  Array of Error Mapping | Set of error mappings.  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
#### For Configurations
  * Default Configuration


#### Throws
  * CLOUDHUB:CONNECTIVITY
  * CLOUDHUB:EXECUTION
  * CLOUDHUB:RETRY_EXHAUSTED


### List Applications
`<cloudhub:list-applications>`
Retrieves all applications in the specified environment.
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Retrieve Log Levels | Whether should retrieve Application log levels  
Retrieve Tracking Settings | Whether should retrieve Application tracking settings  
Retrieve IP Addresses | Whether should retrieve Application IP Addresses  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configure if repeatable streams should be used and their behavior  
Retrieve Statistics | Whether should retrieve Application statistics  
Time of statistics to gather  
Period Time Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time Unit of the period  
Target Variable | The name of a variable on which the operation’s output will be placed  
Target Value | An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable | #[payload]  
Error Mappings |  Array of Error Mapping | Set of error mappings.  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
#### For Configurations
  * Default Configuration


#### Throws
  * CLOUDHUB:CONNECTIVITY
  * CLOUDHUB:EXECUTION
  * CLOUDHUB:RETRY_EXHAUSTED


### List Notifications
`<cloudhub:list-notifications>`
Lists all the available notifications for a giver domain.
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Name of the application to gather notifications from  
Number of notifications to retrieve. -1 means everything available.  
Page Size | Size of the page to retrieve per iteration. This only should be changed for performance purposes.  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
Streaming Strategy | 
  * Repeatable In Memory Iterable
  * Repeatable File Store Iterable
  * non-repeatable-iterable

| Configure if repeatable streams should be used and their behavior  
Enumeration, one of:
  * UNREAD

| Filters the notifications by status. Read, Unread or All.  
If specified, only return notifications where the message contains this string. (Case Insensitive)  
Target Variable | The name of a variable on which the operation’s output will be placed  
Target Value | An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable | #[payload]  
Error Mappings |  Array of Error Mapping | Set of error mappings.  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
#### Output
Array of Notification  
---  
#### For Configurations
  * Default Configuration


#### Throws
  * CLOUDHUB:CONNECTIVITY
  * CLOUDHUB:EXECUTION


### Mark Notification
`<cloudhub:mark-notification>`
Marks a notification as Read or Unread.
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Notification Id | ID of the notification  
Enumeration, one of:
  * UNREAD

| Action to do. Mark as Read or Unread  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
Error Mappings |  Array of Error Mapping | Set of error mappings.  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
#### For Configurations
  * Default Configuration


#### Throws
  * CLOUDHUB:CONNECTIVITY
  * CLOUDHUB:EXECUTION
  * CLOUDHUB:RETRY_EXHAUSTED


## Types
### Reconnection
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Fails Deployment | When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment will fail if the test doesn’t pass after exhausting the associated reconnection strategy  
Reconnection Strategy | 
  *   * Reconnect Forever
#### Throws
  * CLOUDHUB:CONNECTIVITY
  * CLOUDHUB:EXECUTION


### Mark Notification
`<cloudhub:mark-notification>`
Marks a notification as Read or Unread.
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Notification Id | ID of the notification  
Enumeration, one of:
  * UNREAD

| Action to do. Mark as Read or Unread  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component.  
Error Mappings |  Array of Error Mapping | Set of error mappings.  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
#### For Configurations
  * Default Configuration


#### Throws
  * CLOUDHUB:CONNECTIVITY
  * CLOUDHUB:EXECUTION
  * CLOUDHUB:RETRY_EXHAUSTED


## Types
### Reconnection
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Fails Deployment | When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment will fail if the test doesn’t pass after exhausting the associated reconnection strategy  
Reconnection Strategy | 
  *   * Reconnect Forever

| The reconnection strategy to use  
### Reconnect
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
How often to reconnect (in milliseconds).  
The number of reconnection attempts to make.  
If false, the reconnection strategy runs in a separate, non-blocking thread.  
### Reconnect Forever
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
How often in milliseconds to reconnect.  
If false, the reconnection strategy runs in a separate, non-blocking thread.  
### Expiration Policy
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Max Idle Time | A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration  
Time Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the maxIdleTime attribute  
### Error Mapping
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Enumeration, one of:
  * REDELIVERY_EXHAUSTED
  * TRANSFORMATION
  * EXPRESSION
  * SECURITY
  * CLIENT_SECURITY
  * SERVER_SECURITY
  * ROUTING
  * CONNECTIVITY
  * RETRY_EXHAUSTED
  * TIMEOUT

  
### Repeatable In Memory Stream
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Initial Buffer Size | This is the amount of memory that will be allocated in order to consume the stream and provide random access to it. If the stream contains more data than can be fit into this buffer, then the buffer expands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize.  
Buffer Size Increment | This is by how much will be buffer size expands if it exceeds its initial size. Setting a value of zero or lower will mean that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised when the buffer gets full.  
Max Buffer Size | This is the maximum amount of memory that will be used. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised. A value lower or equal to zero means no limit.  
Buffer Unit |  Enumeration, one of: | The unit in which all these attributes are expressed  
### Repeatable File Store Stream
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Max In Memory Size | Defines the maximum memory that the stream should use to keep data in memory. If more than that is consumed then it will start to buffer the content on disk.  
Buffer Unit |  Enumeration, one of: | The unit in which maxInMemorySize is expressed  
### Notification
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Created At  
### Repeatable In Memory Iterable
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Initial Buffer Size | This is the amount of instances to be initially allowed to be kept in memory in order to consume the stream and provide random access to it. If the stream contains more data than can fit into this buffer, then it expands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize. Default value is 100 instances.  
Buffer Size Increment | This is by how much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised when the buffer gets full. Default value is 100 instances.  
Max Buffer Size | This is the maximum amount of memory that will be used. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised. A value lower or equal to zero means no limit.  
### Repeatable File Store Iterable
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Max In Memory Size | This is the maximum amount of instances that will be kept in memory. If more than that is required, then it will start to buffer the content on disk.  
Buffer Unit |  Enumeration, one of: | The unit in which maxInMemorySize is expressed  
## See Also
MuleSoft Help Center