Contact Free trial Login

CloudHub Connector Reference

Connector that provides the capability of Create and List Notifications and retrieve the status of created applications on CloudHub.

Configurations


Config

Default configuration

Parameters

Name Type Description Default Value Required

Name

String

The name for this configuration. Connectors reference the configuration with this name.

x 

Connection

The connection types that can be provided to this configuration.

x 

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before the runtime considers it eligible for expiration. This does not mean that the platform expires the instance at the exact moment that it becomes eligible. The runtime actually purges the instances as it sees fit.

 

Connection Types

Connection

Connection Provider that provides CloudHubConnection.

Parameters
Name Type Description Default Value Required

Username

String

Username of the Anypoint Platform Account

x 

Password

String

Password of the Anypoint Platform Account

x 

Environment

String

Platform Environment to use. It is Optional, and by default will be used the one defined as Default in the platform.

 

Anypoint Platform URL

String

This is used to change between the US and EU Anypoint Platform if is required.

https://anypoint.mulesoft.com

 

Reconnection

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

 

Operations

Create Notification

<cloudhub:create-notification>

Creates a new Notification

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Domain

String

Name of the application to bind the new notification

x 

Message

String

Notification's message

#[payload]

 

Custom Properties

Object

Additional properties for the notification

 

Priority

Enumeration, one of:

  • ERROR

  • INFO

  • WARN

 

Transaction Id

String

Transaction ID for the Notification

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

For Configurations

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

String

The name of the configuration to use.

x 

Domain

String

The name of the application

x 

Streaming Strategy

Configure if repeatable streams should be used and their behavior

 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

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]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Binary

For Configurations

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

String

The name of the configuration to use.

x 

Retrieve Log Levels

Boolean

Whether should retrieve Application log levels

true

 

Retrieve Tracking Settings

Boolean

Whether should retrieve Application tracking settings

true

 

Retrieve IP Addresses

Boolean

Whether should retrieve Application IP Addresses

true

 

Streaming Strategy

Configure if repeatable streams should be used and their behavior

 

Retrieve Statistics

Boolean

Whether should retrieve Application statistics

false

 

Period

Number

Time of statistics to gather

1

 

Period Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time Unit of the period

HOURS

 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

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]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Binary

For Configurations

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

String

The name of the configuration to use.

x 

Domain

String

Name of the application to gather notifications from

x 

Limit

Number

Number of notifications to retrieve. -1 means everything available.

-1

 

Page Size

Number

Size of the page to retrieve per iteration. This only should be changed for performance purposes.

25

 

Streaming Strategy

Configure if repeatable streams should be used and their behavior

 

Status

Enumeration, one of:

  • READ

  • UNREAD

  • ALL

Filters the notifications by status. Read, Unread or All.

UNREAD

 

Search

String

If specified, only return notifications where the message contains this string. (Case Insensitive)

 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

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]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Array of Notification

For Configurations

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

String

The name of the configuration to use.

x 

Notification Id

String

ID of the notification

x 

Mark As

Enumeration, one of:

  • READ

  • UNREAD

Action to do. Mark as Read or Unread

x 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

For Configurations

Throws

  • CLOUDHUB:CONNECTIVITY  

  • CLOUDHUB:EXECUTION  

  • CLOUDHUB:RETRY_EXHAUSTED  

Types

Reconnection

Field Type Description Default Value Required

Fails Deployment

Boolean

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

The reconnection strategy to use

Reconnect

Field Type Description Default Value Required

Frequency

Number

How often (in ms) to reconnect

Count

Number

How many reconnection attempts to make

Reconnect Forever

Field Type Description Default Value Required

Frequency

Number

How often (in ms) to reconnect

Expiration Policy

Field Type Description Default Value Required

Max Idle Time

Number

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

  • DAYS

A time unit that qualifies the maxIdleTime attribute

Repeatable In Memory Stream

Field Type Description Default Value Required

Initial Buffer Size

Number

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

Number

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

Number

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:

  • BYTE

  • KB

  • MB

  • GB

The unit in which all these attributes are expressed

Repeatable File Store Stream

Field Type Description Default Value Required

Max In Memory Size

Number

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:

  • BYTE

  • KB

  • MB

  • GB

The unit in which maxInMemorySize is expressed

Notification

Field Type Description Default Value Required

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

Field Type Description Default Value Required

Initial Buffer Size

Number

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 exapands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize. Default value is 100 instances.

Buffer Size Increment

Number

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

Number

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

Number

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:

  • BYTE

  • KB

  • MB

  • GB

The unit in which maxInMemorySize is expressed

Was this article helpful?

💙 Thanks for your feedback!

Edit on GitHub