Notifications2Subscription

com.apama.cumulocity.notifications2
Event Notifications2Subscription

A subscription for a particular tenant to Notifications 2.0 messages from Cumulocity. Create a Notifications2Subscription using the static create() method.

Since:: 10.15.5.0

Listens:: com.apama.cumulocity.GenericResponse -; com.apama.cumulocity.GenericResponseComplete -

Field summary
`string`	`serviceURLToUse` The Notifications 2.0 service URL to use.
`string`	`subscriberNameToUse` The Notifications 2.0 subscriber name to use.
`string`	`subscriptionNameToUse` The name of the subscription being used.
`string`	`subscriptionTypeToUse` The type of the subscription being used.
`optional<sequence<string>>`	`apiFilterToUse` The types of events to which to subscribe e.g. ["alarms", "measurements"].
`optional<string>`	`typeFilterToUse` Allows filtering by the 'type' property of messages. It can be an OData expression.
`com.apama.cumulocity.TenantDetails`	`tenantDetailsToUse` The Cumulocity tenant from which messages should be received.
`integer`	`numberOfClientsToUse` The number of chains to create for the tenant.
`string`	`tlsCertFilePathToUse` Path of the TLS certificate file.
`boolean`	`tlsEnableInsecureConnection` Allow use of an insecure connection.
`integer`	`receiverQueueSize` The number of unacknowledged messages stored in the Notifications 2.0 queue.
`integer`	`unAckedMessagesTimeoutMs` The timeout for when an unacknowledged message will be redelivered if not acknowledged after received.
`action<boolean>`	`callback` A callback which will be called to indicate the status of the subscription operation.
`sequence<com.softwareag.connectivity.Chain>`	`chains` The underlying connectivity chains for the subscription.
`boolean`	`stopping` Indicating if the service is stopping.
`boolean`	`active` Whether a connection to Pulsar has been established for the requested subscription. This value should only be used to confirm the initial connection; subsequent disconnection does not currently cause the value to return to false.

Action summary
`com.apama.cumulocity.notifications2.Notifications2Subscription`	`static` `create(string pulsarServiceURL, string subscriberName, string subscriptionName, string subscriptionType, optional<sequence<string>> apiFilter, optional<string> typeFilter, com.apama.cumulocity.TenantDetails tenantDetails, integer numberOfClients, string tlsCertFilePath, boolean tlsAllowInsecureConnection, integer receiverQueueSize, integer unAckedMessagesTimeoutMs, action<boolean> callbackToUse)` Creates a new Notifications2Subscription event.
`void`	`shutDown(action<boolean> callback)` Shuts down the underlying connectivity chain for the Notifications 2.0 subscription.

Action summary

com.apama.cumulocity.notifications2.Notifications2Subscription static create(string pulsarServiceURL, string subscriberName, string subscriptionName, string subscriptionType, optional<sequence<string>> apiFilter, optional<string> typeFilter, com.apama.cumulocity.TenantDetails tenantDetails, integer numberOfClients, string tlsCertFilePath, boolean tlsAllowInsecureConnection, integer receiverQueueSize, integer unAckedMessagesTimeoutMs, action<boolean> callbackToUse)

Creates a new Notifications2Subscription event.

void shutDown(action<boolean> callback)

Shuts down the underlying connectivity chain for the Notifications 2.0 subscription.

Field detail

active

boolean active

Whether a connection to Pulsar has been established for the requested subscription. This value should only be used to confirm the initial connection; subsequent disconnection does not currently cause the value to return to false.

apiFilterToUse

optional<sequence<string>> apiFilterToUse

The types of events to which to subscribe e.g. ["alarms", "measurements"].

callback

action<boolean> callback

A callback which will be called to indicate the status of the subscription operation.

chains

sequence<com.softwareag.connectivity.Chain> chains

The underlying connectivity chains for the subscription.

numberOfClientsToUse

integer numberOfClientsToUse

The number of chains to create for the tenant.

receiverQueueSize

integer receiverQueueSize

The number of unacknowledged messages stored in the Notifications 2.0 queue.

serviceURLToUse

string serviceURLToUse

The Notifications 2.0 service URL to use.

stopping

boolean stopping

Indicating if the service is stopping.

subscriberNameToUse

string subscriberNameToUse

The Notifications 2.0 subscriber name to use.

subscriptionNameToUse

string subscriptionNameToUse

The name of the subscription being used.

subscriptionTypeToUse

string subscriptionTypeToUse

The type of the subscription being used.

tenantDetailsToUse

com.apama.cumulocity.TenantDetails tenantDetailsToUse

The Cumulocity tenant from which messages should be received.

tlsCertFilePathToUse

string tlsCertFilePathToUse

Path of the TLS certificate file.

tlsEnableInsecureConnection

boolean tlsEnableInsecureConnection

Allow use of an insecure connection.

typeFilterToUse

optional<string> typeFilterToUse

Allows filtering by the 'type' property of messages. It can be an OData expression.

unAckedMessagesTimeoutMs

integer unAckedMessagesTimeoutMs

The timeout for when an unacknowledged message will be redelivered if not acknowledged after received.

Action detail

create

com.apama.cumulocity.notifications2.Notifications2Subscription static create(string pulsarServiceURL, string subscriberName, string subscriptionName, string subscriptionType, optional<sequence<string>> apiFilter, optional<string> typeFilter, com.apama.cumulocity.TenantDetails tenantDetails, integer numberOfClients, string tlsCertFilePath, boolean tlsAllowInsecureConnection, integer receiverQueueSize, integer unAckedMessagesTimeoutMs, action<boolean> callbackToUse)

Creates a new Notifications2Subscription event.

Parameters:: pulsarServiceURL - The Notifications 2.0 service URL.; subscriberName - The Notifications 2.0 subscriber name.; subscriptionName - The name of the subscription being used.; subscriptionType - The type of the subscription to use.; apiFilter - The types of events to which to subscribe e.g. ["alarms", "measurements"].; typeFilter - An optional filter string for filtering by the 'type' property of messages. It can be an OData expression.; tenantDetails - The Cumulocity tenant from which messages should be received.; numberOfClients - The number of client chains to create.; tlsCertFilePath - Path of the TLS certificate file.; tlsAllowInsecureConnection - Allow use of an insecure connection.; receiverQueueSize - The number of unacknowledged messages stored in the Notifications 2.0 queue.; unAckedMessagesTimeoutMs - The timeout for when an unacknowledged message will be redelivered if not acknowledged after received.; callbackToUse - A callback which will be called with the tenant ID when Apama is able to receive messages.

Returns:: A new Notifications2Subscription event.

Listens:: com.apama.cumulocity.GenericResponse -; com.apama.cumulocity.GenericResponseComplete -

shutDown

void shutDown(action<boolean> callback)

Shuts down the underlying connectivity chain for the Notifications 2.0 subscription.

Parameters:: callback

com.apama.cumulocity.notifications2Event Notifications2Subscription