Class TopicEndpointService

Hierarchy

  • TopicEndpointService

Constructors

constructor

Methods

createMsgVpnTopicEndpoint deleteMsgVpnTopicEndpoint getMsgVpnTopicEndpoint getMsgVpnTopicEndpoints replaceMsgVpnTopicEndpoint updateMsgVpnTopicEndpoint

Constructors

constructor

Methods

Static createMsgVpnTopicEndpoint

  • Create a Topic Endpoint object. Create a Topic Endpoint object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.

    A Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications.

    Attribute Identifying Required Read-Only Write-Only Deprecated Opaque
    msgVpnName x x
    topicEndpointName x x

    The following attributes in the request may only be provided in certain combinations with other attributes:

    Class Attribute Requires Conflicts
    EventThreshold clearPercent setPercent clearValue, setValue
    EventThreshold clearValue setValue clearPercent, setPercent
    EventThreshold setPercent clearPercent clearValue, setValue
    EventThreshold setValue clearValue clearPercent, setPercent

    A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation.

    This has been available since 2.1.

    Returns

    MsgVpnTopicEndpointResponse The Topic Endpoint object's attributes after being created, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          body: MsgVpnTopicEndpoint;
          msgVpnName: string;
          opaquePassword?: string;
          select?: string[];
          xContextId?: string;
      }
      • body: MsgVpnTopicEndpoint

        The Topic Endpoint object's attributes. *

      • msgVpnName: string

        The name of the Message VPN. *

      • Optional opaquePassword?: string

        Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the opaquePassword parameter. *

      • Optional select?: string[]

        Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the select parameter. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<MsgVpnTopicEndpointResponse | SempMetaOnlyResponse>

Static deleteMsgVpnTopicEndpoint

  • Delete a Topic Endpoint object. Delete a Topic Endpoint object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.

    A Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications.

    A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation.

    This has been available since 2.1.

    Returns

    SempMetaOnlyResponse The request metadata.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          msgVpnName: string;
          topicEndpointName: string;
          xContextId?: string;
      }
      • msgVpnName: string

        The name of the Message VPN. *

      • topicEndpointName: string

        The name of the Topic Endpoint. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<SempMetaOnlyResponse>

Static getMsgVpnTopicEndpoint

  • Get a Topic Endpoint object. Get a Topic Endpoint object.

    A Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications.

    Attribute Identifying Write-Only Deprecated Opaque
    msgVpnName x
    topicEndpointName x

    A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation.

    This has been available since 2.1.

    Returns

    MsgVpnTopicEndpointResponse The Topic Endpoint object's attributes, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          msgVpnName: string;
          opaquePassword?: string;
          select?: string[];
          topicEndpointName: string;
          xContextId?: string;
      }
      • msgVpnName: string

        The name of the Message VPN. *

      • Optional opaquePassword?: string

        Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the opaquePassword parameter. *

      • Optional select?: string[]

        Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the select parameter. *

      • topicEndpointName: string

        The name of the Topic Endpoint. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<MsgVpnTopicEndpointResponse | SempMetaOnlyResponse>

Static getMsgVpnTopicEndpoints

  • Get a list of Topic Endpoint objects. Get a list of Topic Endpoint objects.

    A Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications.

    Attribute Identifying Write-Only Deprecated Opaque
    msgVpnName x
    topicEndpointName x

    A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation.

    This has been available since 2.1.

    Returns

    MsgVpnTopicEndpointsResponse The list of Topic Endpoint objects' attributes, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          count?: number;
          cursor?: string;
          msgVpnName: string;
          opaquePassword?: string;
          select?: string[];
          where?: string[];
          xContextId?: string;
      }
      • Optional count?: number

        Limit the count of objects in the response. See the documentation for the count parameter. *

      • Optional cursor?: string

        The cursor, or position, for the next page of objects. See the documentation for the cursor parameter. *

      • msgVpnName: string

        The name of the Message VPN. *

      • Optional opaquePassword?: string

        Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the opaquePassword parameter. *

      • Optional select?: string[]

        Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the select parameter. *

      • Optional where?: string[]

        Include in the response only objects where certain conditions are true. See the the documentation for the where parameter. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<MsgVpnTopicEndpointsResponse | SempMetaOnlyResponse>

Static replaceMsgVpnTopicEndpoint

  • Replace a Topic Endpoint object. Replace a Topic Endpoint object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.

    A Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications.

    Attribute Identifying Const Read-Only Write-Only Requires-Disable Deprecated Opaque
    accessType x
    msgVpnName x x
    owner x
    permission x
    respectMsgPriorityEnabled x
    topicEndpointName x x

    The following attributes in the request may only be provided in certain combinations with other attributes:

    Class Attribute Requires Conflicts
    EventThreshold clearPercent setPercent clearValue, setValue
    EventThreshold clearValue setValue clearPercent, setPercent
    EventThreshold setPercent clearPercent clearValue, setValue
    EventThreshold setValue clearValue clearPercent, setPercent

    A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation.

    This has been available since 2.1.

    Returns

    MsgVpnTopicEndpointResponse The Topic Endpoint object's attributes after being replaced, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          body: MsgVpnTopicEndpoint;
          msgVpnName: string;
          opaquePassword?: string;
          select?: string[];
          topicEndpointName: string;
          xContextId?: string;
      }
      • body: MsgVpnTopicEndpoint

        The Topic Endpoint object's attributes. *

      • msgVpnName: string

        The name of the Message VPN. *

      • Optional opaquePassword?: string

        Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the opaquePassword parameter. *

      • Optional select?: string[]

        Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the select parameter. *

      • topicEndpointName: string

        The name of the Topic Endpoint. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<MsgVpnTopicEndpointResponse | SempMetaOnlyResponse>

Static updateMsgVpnTopicEndpoint

  • Update a Topic Endpoint object. Update a Topic Endpoint object. Any attribute missing from the request will be left unchanged.

    A Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications.

    Attribute Identifying Read-Only Write-Only Requires-Disable Deprecated Opaque
    accessType x
    msgVpnName x x
    owner x
    permission x
    respectMsgPriorityEnabled x
    topicEndpointName x x

    The following attributes in the request may only be provided in certain combinations with other attributes:

    Class Attribute Requires Conflicts
    EventThreshold clearPercent setPercent clearValue, setValue
    EventThreshold clearValue setValue clearPercent, setPercent
    EventThreshold setPercent clearPercent clearValue, setValue
    EventThreshold setValue clearValue clearPercent, setPercent

    A SEMP client authorized with a minimum access scope/level of "vpn/read-write" is required to perform this operation.

    This has been available since 2.1.

    Returns

    MsgVpnTopicEndpointResponse The Topic Endpoint object's attributes after being updated, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          body: MsgVpnTopicEndpoint;
          msgVpnName: string;
          opaquePassword?: string;
          select?: string[];
          topicEndpointName: string;
          xContextId?: string;
      }
      • body: MsgVpnTopicEndpoint

        The Topic Endpoint object's attributes. *

      • msgVpnName: string

        The name of the Message VPN. *

      • Optional opaquePassword?: string

        Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the opaquePassword parameter. *

      • Optional select?: string[]

        Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the select parameter. *

      • topicEndpointName: string

        The name of the Topic Endpoint. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<MsgVpnTopicEndpointResponse | SempMetaOnlyResponse>

Settings

Member Visibility

Theme