Class TopicEndpointTemplateService

Hierarchy

  • TopicEndpointTemplateService

Constructors

constructor

Methods

createMsgVpnTopicEndpointTemplate deleteMsgVpnTopicEndpointTemplate getMsgVpnTopicEndpointTemplate getMsgVpnTopicEndpointTemplates replaceMsgVpnTopicEndpointTemplate updateMsgVpnTopicEndpointTemplate

Constructors

constructor

Methods

Static createMsgVpnTopicEndpointTemplate

  • Create a Topic Endpoint Template object. Create a Topic Endpoint Template 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 Template provides a mechanism for specifying the initial state for client created topic endpoints.

    Attribute Identifying Required Read-Only Write-Only Deprecated Opaque
    msgVpnName x x
    topicEndpointTemplateName 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.14.

    Returns

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

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

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

        The Topic Endpoint Template 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<MsgVpnTopicEndpointTemplateResponse | SempMetaOnlyResponse>

Static deleteMsgVpnTopicEndpointTemplate

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

    A Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints.

    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.14.

    Returns

    SempMetaOnlyResponse The request metadata.

    Throws

    ApiError

    Parameters

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

        The name of the Message VPN. *

      • topicEndpointTemplateName: string

        The name of the Topic Endpoint Template. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<SempMetaOnlyResponse>

Static getMsgVpnTopicEndpointTemplate

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

    A Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints.

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

    Returns

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

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

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

      • topicEndpointTemplateName: string

        The name of the Topic Endpoint Template. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<MsgVpnTopicEndpointTemplateResponse | SempMetaOnlyResponse>

Static getMsgVpnTopicEndpointTemplates

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

    A Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints.

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

    Returns

    MsgVpnTopicEndpointTemplatesResponse The list of Topic Endpoint Template 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<MsgVpnTopicEndpointTemplatesResponse | SempMetaOnlyResponse>

Static replaceMsgVpnTopicEndpointTemplate

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

    A Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints.

    Attribute Identifying Const Read-Only Write-Only Requires-Disable Deprecated Opaque
    msgVpnName x x
    topicEndpointTemplateName 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.14.

    Returns

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

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

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

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

      • topicEndpointTemplateName: string

        The name of the Topic Endpoint Template. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<MsgVpnTopicEndpointTemplateResponse | SempMetaOnlyResponse>

Static updateMsgVpnTopicEndpointTemplate

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

    A Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints.

    Attribute Identifying Read-Only Write-Only Requires-Disable Deprecated Opaque
    msgVpnName x x
    topicEndpointTemplateName 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.14.

    Returns

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

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

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

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

      • topicEndpointTemplateName: string

        The name of the Topic Endpoint Template. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<MsgVpnTopicEndpointTemplateResponse | SempMetaOnlyResponse>

Settings

Member Visibility

Theme