Class TopicDomainsService

Hierarchy

  • TopicDomainsService

Constructors

constructor

Methods

createTopicDomain deleteTopicDomain getTopicDomain getTopicDomains

Constructors

constructor

Methods

Static createTopicDomain

  • Create a topic domain Topic Domains govern the format of topic addresses within an application domain

    Token Permissions: [ topic_domain:create:* ]

    Returns

    TopicDomainResponse Created a topic domain. Returns the newly saved topic domain in the response body.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          requestBody: TopicDomain;
          xContextId?: string;
      }
      • requestBody: TopicDomain
      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<TopicDomainResponse>

Static deleteTopicDomain

  • Delete a topic domain Use this API to delete a topic domain.

    Token Permissions: [ topic_domain:delete:* ]

    Returns

    void

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          id: string;
          xContextId?: string;
      }
      • id: string

        The ID of the topic domain *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<void>

Static getTopicDomain

  • Get a topic domain Use this API to get a single topic domain by its ID.

    Token Permissions: [ topic_domain:get:* ]

    Returns

    TopicDomainResponse The topic domain.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          id: string;
          xContextId?: string;
      }
      • id: string

        The ID of the topic domain. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<TopicDomainResponse>

Static getTopicDomains

  • Get a list of the topic domains Use this API to get a list of topic domains that match the given parameters.

    Token Permissions: [ event_designer:access ]

    Returns

    TopicDomainsResponse Get a list of topic domains and the accompanying metadata.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          applicationDomainId?: string;
          applicationDomainIds?: string[];
          brokerType?: string;
          ids?: string[];
          pageNumber?: number;
          pageSize?: number;
          xContextId?: string;
      }
      • Optional applicationDomainId?: string
      • Optional applicationDomainIds?: string[]

        Match only topic domains with the given application domain ids separated by commas. *

      • Optional brokerType?: string

        Match only topic domains with the given brokerType. *

      • Optional ids?: string[]

        Match only topic domains with the given IDs separated by commas. *

      • Optional pageNumber?: number

        The page number to get. *

      • Optional pageSize?: number

        The number of topic domains to get per page. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<TopicDomainsResponse>

Settings

Member Visibility

Theme