Package com.cumulocity.sdk.client.messaging.notifications

Class NotificationSubscriptionFilter

java.lang.Object

com.cumulocity.sdk.client.Filter

com.cumulocity.sdk.client.messaging.notifications.NotificationSubscriptionFilter

public class NotificationSubscriptionFilter
extends Filter

Constructor Summary

Constructors

Constructor	Description
NotificationSubscriptionFilter()

Method Summary

Modifier and Type	Method	Description
NotificationSubscriptionFilter	byContext(String context)	Specifies the context query parameter
NotificationSubscriptionFilter	bySource(GId source)	Specifies the source query parameter
NotificationSubscriptionFilter	bySubscription(String subscription)	Specifies the subscription query parameter.
NotificationSubscriptionFilter	byTypeFilter(String typeFilter)	Specifies the typeFilter query parameter.
String	getContext()
String	getSource()
String	getSubscription()
String	getTypeFilter()

Methods inherited from class com.cumulocity.sdk.client.Filter

encode, getQueryParams

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NotificationSubscriptionFilter

public NotificationSubscriptionFilter()

Method Detail

bySource

public NotificationSubscriptionFilter bySource(GId source)

Specifies the source query parameter

Parameters:

source - the managed object that has been subscribed to

Returns:

the filter with source set

getSource

public String getSource()

Returns:

the source parameter of the query

byContext

public NotificationSubscriptionFilter byContext(String context)

Specifies the context query parameter

Parameters:

context - the context to which the subscription is associated with.

Returns:

the filter with context set

getContext

public String getContext()

Returns:

the context parameter of the query

bySubscription

public NotificationSubscriptionFilter bySubscription(String subscription)

Specifies the subscription query parameter. Applicable only for NotificationSubscriptionApi.getSubscriptionsByFilter(NotificationSubscriptionFilter).

Parameters:

subscription - subscription name by which filtering will be done.

Returns:

the filter with subscription set

getSubscription

public String getSubscription()

Returns:

the subscription parameter of the query

byTypeFilter

public NotificationSubscriptionFilter byTypeFilter(String typeFilter)

Specifies the typeFilter query parameter. Applicable only for NotificationSubscriptionApi.getSubscriptionsByFilter(NotificationSubscriptionFilter).

Parameters:

typeFilter - single type name which will be used to filter subscriptions having this type under `subscriptionFilter.typeFilter` field.

Returns:

the filter with typeFilter set

getTypeFilter

public String getTypeFilter()

Returns:

the typeFilter parameter of the query