CLASS ndi.cloud.api.implementation.compute.AbortSession

 ABORTSESSION Implementation class for aborting a compute session.

Superclasses

ndi.cloud.api.call, handle

Properties

Property	Description
sessionId
cloudOrganizationID
cloudDatasetID
cloudFileID
cloudUserID
cloudDocumentID
page
pageSize
endpointName

Methods

Method	Description
AbortSession	ABORTSESSION Creates a new AbortSession API call object.
addlistener	Create event listener bound to event source
delete	Delete handle object
eq	Determine equality
execute	EXECUTE Performs the API call to abort the session.
findobj	Find handle objects
findprop	Find matlab.metadata.Property object
ge	Determine greater than or equal to
gt	Determine greater than
isvalid	Determine valid handles
le	Determine less than or equal to
listener	Create event listener without binding to event source
lt	Determine less than
ne	Determine inequality
notify	Notify listeners that event is occurring

Methods help

AbortSession - ABORTSESSION Creates a new AbortSession API call object.

THIS = ndi.cloud.api.implementation.compute.AbortSession('sessionId', ID)

    Inputs:
        'sessionId' - The ID of the session to abort.

    Documentation for ndi.cloud.api.implementation.compute.AbortSession/AbortSession
       doc ndi.cloud.api.implementation.compute.AbortSession

---

addlistener - Create event listener bound to event source

This MATLAB function creates a listener for the event EventName.

    Syntax
      el = addlistener(hSource,EventName,callback)
      el = addlistener(hSource,PropertyName,EventName,callback)
      addlistener(___)

    Input Arguments
      hSource - Event source
        handle array
      EventName - Name of event
        character vector | string scalar
      PropertyName - Name of property
        character vector | string | matlab.metadata.Property object
      callback - Listener callback
        function handle

    Output Arguments
      el - Listener object
        event.listener or event.proplistener

    Examples
      web /opt/hostedtoolcache/MATLAB/2025.2.999/x64/help/matlab/ref/handle.addlistener.html#d126e729273

    See also notify, event.listener, listener

    Introduced in MATLAB in R2008a

Help for ndi.cloud.api.implementation.compute.AbortSession/addlistener is inherited from superclass handle

    Documentation for ndi.cloud.api.implementation.compute.AbortSession/addlistener
       doc addlistener

---

delete - Delete handle object

This MATLAB function deletes the handle object.

    Syntax
      delete(H)

    Input Arguments
      H - Handle object
        handle object or array of handle objects

    See also isvalid

Help for ndi.cloud.api.implementation.compute.AbortSession/delete is inherited from superclass handle

    Documentation for ndi.cloud.api.implementation.compute.AbortSession/delete
       doc handle/delete

---

eq - Determine equality

This MATLAB function returns a logical array or a table of logical
    values with elements set to logical 1 (true) where inputs A and B are
    equal; otherwise, the element is logical 0 (false).

    Syntax
      A == B
      eq(A,B)

    Input Arguments
      A - Operands
        scalars | vectors | matrices | multidimensional arrays | tables |
        timetables
      B - Operands
        scalars | vectors | matrices | multidimensional arrays | tables |
        timetables

    Examples
      openExample('matlab/EqualityOfTwoVectorsExample')
      openExample('matlab/FindCharactersInStringExample')
      openExample('matlab/FindValuesInCategoricalArrayExample')
      openExample('matlab/CompareFloatingPointNumbersExample')
      openExample('matlab/CompareDatetimeValuesExample')
      openExample('matlab/CompareTablesExample')

    See also isapprox, ge, gt, le, lt, ne

    Introduced in MATLAB before R2006a
    Documentation for eq
       doc eq

---

execute - EXECUTE Performs the API call to abort the session.

[B, ANSWER, APIRESPONSE, APIURL] = EXECUTE(THIS)

---

findobj - Find handle objects

This MATLAB function returns the objects listed in H and all of their
    descendants.

    Syntax
      Hmatch = findobj(H)
      Hmatch = findobj(H,property,value,...,property,value)
      Hmatch = findobj(H,'-not',property,value)
      Hmatch = findobj(H,'-regexp',property,expression)
      Hmatch = findobj(H,property,value,logicaloperator,property,value)
      Hmatch = findobj(H,'-function',fh)
      Hmatch = findobj(H,'-function',property,fh)
      Hmatch = findobj(H,'-class',class)
      Hmatch = findobj(H,'-isa',class)
      Hmatch = findobj(H,'-property',property)
      Hmatch = findobj(H,'-method',methodname)
      Hmatch = findobj(H,'-event',eventname)
      Hmatch = findobj(H,'-depth',d,___)

    Input Arguments
      H - Objects to search from
        handle array
      property - Property name
        character vector | string scalar
      class - Class of object to find
        character vector | string scalar | string scalar |
        matlab.metadata.Class instance
      value - Property value
        any value
      methodname - Method name
        character vector | string scalar
      eventname - Event name
        character vector | string scalar
      d - Depth of search
        integer >= 0
      fh - Function handle
        function handle

    Output Arguments
      Hmatch - Objects found by search
        handle array

    Examples
      web /opt/hostedtoolcache/MATLAB/2025.2.999/x64/help/matlab/ref/handle.findobj.html#mw_17437b0f-a588-40bf-bae5-dcdd410a410e

    See also findprop

    Introduced in MATLAB in R2008a

Help for ndi.cloud.api.implementation.compute.AbortSession/findobj is inherited from superclass handle

    Documentation for ndi.cloud.api.implementation.compute.AbortSession/findobj
       doc handle/findobj

---

findprop - Find matlab.metadata.Property object

This MATLAB function returns the matlab.metadata.Property object
    associated with the named property of the object h.

    Syntax
      mp = findprop(h,property)

    Input Arguments
      h - handle object
        scalar handle
      property - Name of property
        character vector | string scalar

    Output Arguments
      mp - matlab.metadata.Property object
        matlab.metadata.Property | matlab.metadata.DynamicProperty

    Examples
      openExample('matlab/DisplayPropertyAttributesExample')

    See also matlab.metadata.Property, findobj,
      matlab.metadata.DynamicProperty

Help for ndi.cloud.api.implementation.compute.AbortSession/findprop is inherited from superclass handle

    Documentation for ndi.cloud.api.implementation.compute.AbortSession/findprop
       doc handle/findprop

---

ge - Determine greater than or equal to

This MATLAB function returns a logical array or a table of logical
    values with elements set to logical 1 (true) where A is greater than or
    equal to B; otherwise, the element is logical 0 (false).

    Syntax
      A >= B
      ge(A,B)

    Input Arguments
      A - Operands
        scalars | vectors | matrices | multidimensional arrays | tables |
        timetables
      B - Operands
        scalars | vectors | matrices | multidimensional arrays | tables |
        timetables

    Examples
      openExample('matlab/TestVectorElementsExample')
      openExample('matlab/ReplaceElementsofMatrixExample')
      openExample('matlab/CompareValuesinCategoricalArrayExample')
      openExample('matlab/TestComplexNumbersExample')
      openExample('matlab/TestDurationValuesGeExample')
      openExample('matlab/CompareTablesGEExample')

    See also eq, lt, gt, le, ne

    Introduced in MATLAB before R2006a
    Documentation for ge
       doc ge

---

gt - Determine greater than

This MATLAB function returns a logical array or a table of logical
    values with elements set to logical 1 (true) where A is greater than B;
    otherwise, the element is logical 0 (false).

    Syntax
      A > B
      gt(A,B)

    Input Arguments
      A - Operands
        scalars | vectors | matrices | multidimensional arrays | tables |
        timetables
      B - Operands
        scalars | vectors | matrices | multidimensional arrays | tables |
        timetables

    Examples
      openExample('matlab/TestVectorElementsGreaterThanExample')
      openExample('matlab/ReplaceElementsofMatrixGreaterExample')
      openExample('matlab/CompareValuesinCategoricalArrayGreaterExample')
      openExample('matlab/TestComplexNumbersGreaterExample')
      openExample('matlab/CompareDatesExample')
      openExample('matlab/CompareTablesGTExample')

    See also eq, ge, lt, le, ne

    Introduced in MATLAB before R2006a
    Documentation for gt
       doc gt

---

isvalid - Determine valid handles

This MATLAB function returns a logical array in which each element is
    true if the corresponding element in H is a valid handle.

    Syntax
      B = isvalid(H)

    Input Arguments
      H - Input array
        handle array

    Output Arguments
      B - Result of validity test
        logical

    See also delete

Help for ndi.cloud.api.implementation.compute.AbortSession/isvalid is inherited from superclass handle

    Documentation for ndi.cloud.api.implementation.compute.AbortSession/isvalid
       doc handle/isvalid

---

le - Determine less than or equal to

This MATLAB function returns a logical array or a table of logical
    values with elements set to logical 1 (true) where A is less than or
    equal to B; otherwise, the element is logical 0 (false).

    Syntax
      A <= B
      le(A,B)

    Input Arguments
      A - Operands
        scalars | vectors | matrices | multidimensional arrays | tables |
        timetables
      B - Operands
        scalars | vectors | matrices | multidimensional arrays | tables |
        timetables

    Examples
      openExample('matlab/TestVectorElementsLessThanOrEqualExample')
      openExample('matlab/ReplaceElementsOfMatrixLessThanOrEqualExample')
      openExample('matlab/CompareValuesInCategoricalArrayLessThanOrEqualExample')
      openExample('matlab/TestComplexNumbersLessThanEqualExample')
      openExample('matlab/TestDurationValuesExample')
      openExample('matlab/CompareTablesLEExample')

    See also eq, ge, gt, lt, ne

    Introduced in MATLAB before R2006a
    Documentation for le
       doc le

---

listener - Create event listener without binding to event source

This MATLAB function creates a listener for the event EventName.

    Syntax
      eL = listener(hSource,EventName,callback)
      eL = listener(hSource,PropertyName,EventName,callback)

    Input Arguments
      hSource - Handle object that is the source of the event
        handle array
      EventName - Name of the event that is triggered on the source objects
        character vector or string scalar
      PropertyName - Name of property
        character vector | string | matlab.metadata.Property object
      callback - Listener callback
        function handle

    Output Arguments
      el - Listener object
        event.listener or event.proplistener

    Examples
      web /opt/hostedtoolcache/MATLAB/2025.2.999/x64/help/matlab/ref/handle.listener.html#d126e729602

    See also notify, event.listener

    Introduced in MATLAB in R2017b

Help for ndi.cloud.api.implementation.compute.AbortSession/listener is inherited from superclass handle

    Documentation for ndi.cloud.api.implementation.compute.AbortSession/listener
       doc handle/listener

---

lt - Determine less than

This MATLAB function returns an array or a table of logical values with
    elements set to logical 1 (true) where A is less than B; otherwise, the
    element is logical 0 (false).

    Syntax
      A < B
      lt(A,B)

    Input Arguments
      A - Operands
        scalars | vectors | matrices | multidimensional arrays | tables |
        timetables
      B - Operands
        scalars | vectors | matrices | multidimensional arrays | tables |
        timetables

    Examples
      openExample('matlab/TestVectorElementsLessThanExample')
      openExample('matlab/ReplaceElementsofMatrixLessThanExample')
      openExample('matlab/CompareValuesinCategoricalArrayLessThanExample')
      openExample('matlab/TestComplexNumbersLessThanExample')
      openExample('matlab/CompareDatesLessThanExample')
      openExample('matlab/CompareTablesLTExample')

    See also eq, ge, gt, le, ne

    Introduced in MATLAB before R2006a
    Documentation for lt
       doc lt

---

ne - Determine inequality

This MATLAB function returns a logical array or a table of logical
    values with elements set to logical 1 (true) where inputs A and B are
    not equal; otherwise, the element is logical 0 (false).

    Syntax
      A ~= B
      ne(A,B)

    Input Arguments
      A - Operands
        scalars | vectors | matrices | multidimensional arrays | tables |
        timetables
      B - Operands
        scalars | vectors | matrices | multidimensional arrays | tables |
        timetables

    Examples
      openExample('matlab/InequalityOfTwoVectorsExample')
      openExample('matlab/FindCharactersInStringNotEqualExample')
      openExample('matlab/FindValuesInCategoricalArrayNotEqualExample')
      openExample('matlab/CompareFloatingPointNumbersNotEqualExample')
      openExample('matlab/InequalityOfTwoDatetimeArraysExample')
      openExample('matlab/CompareTablesNEExample')

    See also ge, gt, le, lt, eq

    Introduced in MATLAB before R2006a
    Documentation for ne
       doc ne

---

notify - Notify listeners that event is occurring

This MATLAB function notifies listeners that the named event is taking
    place on the handle objects in H.

    Syntax
      notify(H,EventName)
      notify(H,EventName,data)

    Input Arguments
      H - Event source
        handle array
      EventName - Name of event
        character vector | string scalar
      data - User-defined event data
        subclass of event.EventData

    See also addlistener, listener

    Introduced in MATLAB in R2008a

Help for ndi.cloud.api.implementation.compute.AbortSession/notify is inherited from superclass handle

    Documentation for ndi.cloud.api.implementation.compute.AbortSession/notify
       doc handle/notify

---