Class ReplicatedTopicService

Hierarchy

  • ReplicatedTopicService

Constructors

constructor

Methods

createMsgVpnReplicatedTopic deleteMsgVpnReplicatedTopic getMsgVpnReplicatedTopic getMsgVpnReplicatedTopics replaceMsgVpnReplicatedTopic updateMsgVpnReplicatedTopic

Constructors

constructor

Methods

Static createMsgVpnReplicatedTopic

  • Create a Replicated Topic object. Create a Replicated Topic 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.

    To indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site.

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

    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

    MsgVpnReplicatedTopicResponse The Replicated Topic object's attributes after being created, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

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

        The Replicated Topic 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<MsgVpnReplicatedTopicResponse | SempMetaOnlyResponse>

Static deleteMsgVpnReplicatedTopic

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

    To indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site.

    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;
          replicatedTopic: string;
          xContextId?: string;
      }
      • msgVpnName: string

        The name of the Message VPN. *

      • replicatedTopic: string

        The topic for applying replication. Published messages matching this topic will be replicated to the standby site. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<SempMetaOnlyResponse>

Static getMsgVpnReplicatedTopic

  • Get a Replicated Topic object. Get a Replicated Topic object.

    To indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site.

    Attribute Identifying Write-Only Deprecated Opaque
    msgVpnName x
    replicatedTopic 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

    MsgVpnReplicatedTopicResponse The Replicated Topic object's attributes, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          msgVpnName: string;
          opaquePassword?: string;
          replicatedTopic: string;
          select?: 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. *

      • replicatedTopic: string

        The topic for applying replication. Published messages matching this topic will be replicated to the standby site. *

      • 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<MsgVpnReplicatedTopicResponse | SempMetaOnlyResponse>

Static getMsgVpnReplicatedTopics

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

    To indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site.

    Attribute Identifying Write-Only Deprecated Opaque
    msgVpnName x
    replicatedTopic 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

    MsgVpnReplicatedTopicsResponse The list of Replicated Topic 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<MsgVpnReplicatedTopicsResponse | SempMetaOnlyResponse>

Static replaceMsgVpnReplicatedTopic

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

    To indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site.

    Attribute Identifying Const Read-Only Write-Only Requires-Disable Deprecated Opaque
    msgVpnName x x
    replicatedTopic x x

    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

    MsgVpnReplicatedTopicResponse The Replicated Topic object's attributes after being replaced, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

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

        The Replicated Topic 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. *

      • replicatedTopic: string

        The topic for applying replication. Published messages matching this topic will be replicated to the standby site. *

      • 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<MsgVpnReplicatedTopicResponse | SempMetaOnlyResponse>

Static updateMsgVpnReplicatedTopic

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

    To indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site.

    Attribute Identifying Read-Only Write-Only Requires-Disable Deprecated Opaque
    msgVpnName x x
    replicatedTopic x x

    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

    MsgVpnReplicatedTopicResponse The Replicated Topic object's attributes after being updated, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

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

        The Replicated Topic 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. *

      • replicatedTopic: string

        The topic for applying replication. Published messages matching this topic will be replicated to the standby site. *

      • 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<MsgVpnReplicatedTopicResponse | SempMetaOnlyResponse>

Settings

Member Visibility

Theme