Package com.seeq.api

Class SubscriptionsApi

java.lang.Object
com.seeq.api.SubscriptionsApi

public class SubscriptionsApi extends Object
  • Constructor Details

    • SubscriptionsApi

      public SubscriptionsApi()
    • SubscriptionsApi

      public SubscriptionsApi(ApiClient apiClient)
  • Method Details

    • setRetryTimeout

      public void setRetryTimeout(long retryTimeout)
    • getRetryTimeout

      public long getRetryTimeout()
    • getApiClient

      public ApiClient getApiClient()
    • setApiClient

      public void setApiClient(ApiClient apiClient)
    • getChannels

      public GetChannelsOutputV1 getChannels(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)
      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 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)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • subscribe

      public StatusMessageBase subscribe(SubscriptionInputV1 body) throws ApiException
      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 ApiException
      Subscribe 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

      public StatusMessageBase unsubscribe(String channelId) throws ApiException
      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 ApiException
      Unsubscribe 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 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)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call