Package com.seeq.api
Class SubscriptionsApi
java.lang.Object
com.seeq.api.SubscriptionsApi
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptiongetChannels
(Integer offset, Integer limit) List channels and their subscriptionsList channels and their subscriptionsgetChannelsWithHttpInfo
(Integer offset, Integer limit) List channels and their subscriptionslong
void
setApiClient
(ApiClient apiClient) void
setRetryTimeout
(long retryTimeout) subscribe
(SubscriptionInputV1 body) Subscribe to websocket messages published to the specified channelsubscribeWithHeadersAndHttpInfo
(SubscriptionInputV1 body, Map<String, String> customHeaders) Subscribe to websocket messages published to the specified channelSubscribe to websocket messages published to the specified channelunsubscribe
(String channelId) Unsubscribe from the specified channelunsubscribeWithHeadersAndHttpInfo
(String channelId, Map<String, String> customHeaders) Unsubscribe from the specified channelunsubscribeWithHttpInfo
(String channelId) Unsubscribe from the specified channelupdateSubscription
(String channelId, SubscriptionUpdateInputV1 body) Update a subscription associated with the specified channelupdateSubscriptionWithHeadersAndHttpInfo
(String channelId, SubscriptionUpdateInputV1 body, Map<String, String> customHeaders) Update a subscription associated with the specified channelupdateSubscriptionWithHttpInfo
(String channelId, SubscriptionUpdateInputV1 body) Update a subscription associated with the specified channel
-
Constructor Details
-
SubscriptionsApi
public SubscriptionsApi() -
SubscriptionsApi
-
-
Method Details
-
setRetryTimeout
public void setRetryTimeout(long retryTimeout) -
getRetryTimeout
public long getRetryTimeout() -
getApiClient
-
setApiClient
-
getChannels
List channels and their subscriptions- Parameters:
offset
- The pagination offset, the index of the first subscription that will be returned in this page of results (optional, default to 0)limit
- The pagination limit, the total number of subscriptions that will be returned in this page of results (optional, default to 40)- Returns:
- GetChannelsOutputV1
- Throws:
ApiException
- if fails to make API call
-
getChannelsWithHttpInfo
public ApiClient.ApiResponse<GetChannelsOutputV1> getChannelsWithHttpInfo(Integer offset, Integer limit) throws ApiException List channels and their subscriptions- Parameters:
offset
- The pagination offset, the index of the first subscription that will be returned in this page of results (optional, default to 0)limit
- The pagination limit, the total number of subscriptions that will be returned in this page of results (optional, default to 40)- Throws:
ApiException
- if fails to make API call
-
getChannelsWithHeadersAndHttpInfo
public ApiClient.ApiResponse<GetChannelsOutputV1> getChannelsWithHeadersAndHttpInfo(Integer offset, Integer limit, Map<String, String> customHeaders) throws ApiExceptionList channels and their subscriptions- Parameters:
offset
- The pagination offset, the index of the first subscription that will be returned in this page of results (optional, default to 0)limit
- The pagination limit, the total number of subscriptions that will be returned in this page of results (optional, default to 40)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
subscribe
Subscribe to websocket messages published to the specified channel- Parameters:
body
- Data to create the subscription (required)- Returns:
- StatusMessageBase
- Throws:
ApiException
- if fails to make API call
-
subscribeWithHttpInfo
public ApiClient.ApiResponse<StatusMessageBase> subscribeWithHttpInfo(SubscriptionInputV1 body) throws ApiException Subscribe to websocket messages published to the specified channel- Parameters:
body
- Data to create the subscription (required)- Throws:
ApiException
- if fails to make API call
-
subscribeWithHeadersAndHttpInfo
public ApiClient.ApiResponse<StatusMessageBase> subscribeWithHeadersAndHttpInfo(SubscriptionInputV1 body, Map<String, String> customHeaders) throws ApiExceptionSubscribe to websocket messages published to the specified channel- Parameters:
body
- Data to create the subscription (required)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
unsubscribe
Unsubscribe from the specified channel- Parameters:
channelId
- URI that identifies the channel to delete (required)- Returns:
- StatusMessageBase
- Throws:
ApiException
- if fails to make API call
-
unsubscribeWithHttpInfo
public ApiClient.ApiResponse<StatusMessageBase> unsubscribeWithHttpInfo(String channelId) throws ApiException Unsubscribe from the specified channel- Parameters:
channelId
- URI that identifies the channel to delete (required)- Throws:
ApiException
- if fails to make API call
-
unsubscribeWithHeadersAndHttpInfo
public ApiClient.ApiResponse<StatusMessageBase> unsubscribeWithHeadersAndHttpInfo(String channelId, Map<String, String> customHeaders) throws ApiExceptionUnsubscribe from the specified channel- Parameters:
channelId
- URI that identifies the channel to delete (required)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
updateSubscription
public StatusMessageBase updateSubscription(String channelId, SubscriptionUpdateInputV1 body) throws ApiException Update a subscription associated with the specified channel- Parameters:
channelId
- URI that identifies the channel the subscriber is updating (required)body
- Data to update the subscription (required)- Returns:
- StatusMessageBase
- Throws:
ApiException
- if fails to make API call
-
updateSubscriptionWithHttpInfo
public ApiClient.ApiResponse<StatusMessageBase> updateSubscriptionWithHttpInfo(String channelId, SubscriptionUpdateInputV1 body) throws ApiException Update a subscription associated with the specified channel- Parameters:
channelId
- URI that identifies the channel the subscriber is updating (required)body
- Data to update the subscription (required)- Throws:
ApiException
- if fails to make API call
-
updateSubscriptionWithHeadersAndHttpInfo
public ApiClient.ApiResponse<StatusMessageBase> updateSubscriptionWithHeadersAndHttpInfo(String channelId, SubscriptionUpdateInputV1 body, Map<String, String> customHeaders) throws ApiExceptionUpdate a subscription associated with the specified channel- Parameters:
channelId
- URI that identifies the channel the subscriber is updating (required)body
- Data to update the subscription (required)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-