Class MessagingServicesService

Hierarchy

  • MessagingServicesService

Constructors

constructor

Methods

createMessagingService deleteMessagingService getMessagingService getMessagingServices removeAssociationMessagingService scanStartMessagingService updateMessagingService

Constructors

constructor

Methods

Static createMessagingService

  • Create a messaging service Use this API to create a messaging service.

    Token Permissions: [ messaging_service:write ]

    Returns

    MessagingServiceResponse Created a messaging service. The newly saved messaging service is returned in the response body.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          requestBody: MessagingService;
          xContextId?: string;
      }
      • requestBody: MessagingService

        The messaging service. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<MessagingServiceResponse>

Static deleteMessagingService

  • Delete a messaging service Use this API to delete a messaging service.

    Token Permissions: [ messaging_service:write ]

    Returns

    void

    Throws

    ApiError

    Parameters

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

        The ID of the messaging service. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<void>

Static getMessagingService

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

    Token Permissions: [ messaging_service:read ]

    Returns

    MessagingServiceResponse The messaging service.

    Throws

    ApiError

    Parameters

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

        The ID of the messaging service. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<MessagingServiceResponse>

Static getMessagingServices

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

    Token Permissions: [ messaging_service:read ]

    Returns

    MessagingServicesResponse The list of messaging services and the accompanying metadata.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          eventManagementAgentId?: string;
          eventMeshId?: string;
          ids?: string[];
          messagingServiceType?: string;
          pageNumber?: number;
          pageSize?: number;
          runtimeAgentId?: string;
          sort?: string;
          xContextId?: string;
      }
      • Optional eventManagementAgentId?: string
      • Optional eventMeshId?: string

        Match only messaging services in the given eventMeshId *

      • Optional ids?: string[]

        The IDs of the messaging services. *

      • Optional messagingServiceType?: string

        Match only messaging services of the given type, options are: solace, kafka. *

      • Optional pageNumber?: number

        The page number to get. *

      • Optional pageSize?: number

        The number of messaging services to get per page. *

      • Optional runtimeAgentId?: string

        Match only messaging services in the given runtimeAgentId *

      • Optional sort?: string

        Sort based on the provided parameters.
        The value can be either a standalone field name (?sort=<field>) or a field and direction, delimited by a colon (?sort=<field>:<asc|desc>). If the direction is not specified, the default is ascending. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<MessagingServicesResponse>

Static removeAssociationMessagingService

  • Remove an association between an messaging service and the requested entity Use this API to remove the association between a messaging service and either of EVENT_MESH or EVENT_MANAGEMENT_AGENT.

    Token Permissions: [ messaging_service:write ]

    Returns

    MessagingServiceResponse The updated messaging service, e.g. if the API request body had "association": "EVENT_MESH" then the resulting object would not have eventMeshId attribute.

    Throws

    ApiError

    Parameters

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

        The ID of the messaging service. *

      • requestBody: MessagingServiceRemoveAssociation

        The association object with the value matching either EVENT_MESH or EVENT_MANAGEMENT_AGENT. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<MessagingServiceResponse>

Static scanStartMessagingService

  • Initiate a scan request to run against a messaging service Use this API to make a scan request on a messaging service.

    Token Permissions: [ messaging_service:write ]

    Returns

    MessagingServiceOperationResponse Requested a scan on the messaging service. The operation object with ID set as ID of the created scan Object is returned in the response body.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          messagingServiceId: string;
          requestBody: MessagingServiceOperation;
          xContextId?: string;
      }
      • messagingServiceId: string

        The ID of the messaging service. *

      • requestBody: MessagingServiceOperation

        The messaging service. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<MessagingServiceOperationResponse>

Static updateMessagingService

  • Update a messaging service Use this API to update a messaging service. You only need to specify the fields that need to be updated. However, if you want to update anything under subObjects (i.e. anything inside messagingServiceConnections object), you need to provide the original messagingServiceConnections with the updated fields instead of just providing the changed fields.

    Token Permissions: [ messaging_service:write ]

    Returns

    MessagingServiceResponse The updated messaging service.

    Throws

    ApiError

    Parameters

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

        The ID of the messaging service to update. *

      • requestBody: MessagingService

        The messaging service. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<MessagingServiceResponse>

Settings

Member Visibility

Theme