Class MessagingServiceScanDataService

Hierarchy

  • MessagingServiceScanDataService

Constructors

constructor

Methods

getMessagingServiceScanData getMessagingServiceScansData

Constructors

constructor

Methods

Static getMessagingServiceScanData

  • Get a messaging service scan data Use this API to get a single messaging service scan data by its ID.

    Token Permissions: [ messaging_service_scan:read ]

    Returns

    MessagingServiceScanDataResponse The messaging service scan data.

    Throws

    ApiError

    Parameters

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

        The ID of the messaging service scan data. *

      • scanId: string

        The ID of the messaging service scan. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<MessagingServiceScanDataResponse>

Static getMessagingServiceScansData

  • Get a list of messaging service scan data Use this API to get a list of messaging service scan data that match the given parameters.

    Token Permissions: [ messaging_service_scan:read ]

    Returns

    MessagingServiceScanDataListResponse The list of messaging service scan data and the accompanying metadata.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          collectionTypes?: ("brokerConfiguration" | "clusterConfiguration" | "consumerGroups" | "consumerGroupConfiguration" | "overrideTopicConfiguration" | "queueConfiguration" | "queueListing" | "schema" | "subscriptionConfiguration" | "topicConfiguration" | "topicListing")[];
          ids?: string[];
          pageNumber?: number;
          pageSize?: number;
          scanId: string;
          sort?: string;
          xContextId?: string;
      }
      • Optional collectionTypes?: ("brokerConfiguration" | "clusterConfiguration" | "consumerGroups" | "consumerGroupConfiguration" | "overrideTopicConfiguration" | "queueConfiguration" | "queueListing" | "schema" | "subscriptionConfiguration" | "topicConfiguration" | "topicListing")[]

        Match only scan data whose dataCollectionType matches the given list. *

      • Optional ids?: string[]

        The IDs of the messaging service scan data. *

      • Optional pageNumber?: number

        The page number to get. *

      • Optional pageSize?: number

        The number of messaging service scan data to get per page. *

      • scanId: string

        The ID of the messaging service scan we want data for. *

      • Optional sort?: string

        The name of the field to sort on. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<MessagingServiceScanDataListResponse>

Settings

Member Visibility

Theme