Class EventMeshesService

Hierarchy

  • EventMeshesService

Constructors

constructor

Methods

createEventMesh deleteEventMesh getEventMesh getEventMeshes updateEventMesh

Constructors

constructor

Methods

Static createEventMesh

  • Create an event mesh Create an event mesh.

    Returns

    EventMeshResponse Created an event mesh. The newly saved event mesh is returned in the response body.

    Throws

    ApiError

    Parameters

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

        Event mesh. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<EventMeshResponse>

Static deleteEventMesh

  • Delete an event mesh Use this API to delete an event mesh.

    Token Permissions: [ modeled_event_mesh:delete:* ]

    Returns

    void

    Throws

    ApiError

    Parameters

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

        The ID of the event mesh. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<void>

Static getEventMesh

  • Get an event mesh Get a single event mesh by its ID.

    Token Permissions: [ modeled_event_mesh:get:{id} ]

    Returns

    EventMeshResponse The event mesh.

    Throws

    ApiError

    Parameters

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

        The ID of the event mesh. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<EventMeshResponse>

Static getEventMeshes

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

    Token Permissions: [ modeled_event_mesh:get:* ]

    Returns

    EventMeshesResponse The list of event meshes and the accompanying metadata.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          environmentId?: string;
          name?: string;
          pageNumber?: number;
          pageSize?: number;
          xContextId?: string;
      }
      • Optional environmentId?: string

        Match only event meshes in the given environment *

      • Optional name?: string

        Name of the event mesh to match on. *

      • Optional pageNumber?: number

        The page number to get. *

      • Optional pageSize?: number

        The number of event meshes to get per page. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<EventMeshesResponse>

Static updateEventMesh

  • Update an event mesh Use this API to update an event mesh. You only need to specify the fields that need to be updated.

    Returns

    EventMeshResponse The updated event mesh.

    Throws

    ApiError

    Parameters

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

        The ID of the event mesh to update. *

      • requestBody: EventMesh

        The event mesh. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<EventMeshResponse>

Settings

Member Visibility

Theme