Class: MemoriClient::Backend::V2::Process

Inherits:
Resource show all
Defined in:
lib/memori_client/backend/v2/process.rb

Overview

Generated on 2025-01-27 16:56:15 +0000

Class Method Summary collapse

Methods inherited from Resource

build_url

Methods inherited from Resource

build_arguments, build_url, exec_http_request, validate_payload!

Class Method Details

.get_process_status(strToken:, strProcessID:) ⇒ Object

‘GET /api/v2/ProcessStatus/strToken/strProcessID`

Gets the status of an Process object.

‘get_process_status(strToken:, strProcessID:)`

Parameters:

  • strToken (string) —

    The login token. required

  • strProcessID (string) —

    The Process object ID. required



47
48
49
50
51
 
# File 'lib/memori_client/backend/v2/process.rb', line 47

def self.get_process_status(strToken:, strProcessID:)
  args = build_arguments(binding)

  exec_http_request('get', '/api/v2/ProcessStatus/{strToken}/{strProcessID}', **args)
end

.list_memori_processes(strToken:, strMemoriID:, strType: nil) ⇒ Object

‘GET /api/v2/MemoriProcesses/strToken/strMemoriID/strType`

Gets a list of Process objects for the specified Memori.

‘list_memori_processes(strToken:, strMemoriID:, strType: nil)`

Parameters:

  • strToken (string) —

    The login token. required

  • strMemoriID (string) —

    The ID of the Memori object. required

  • strType (string) (defaults to: nil) —

    Optional filter for Process type. optional



31
32
33
34
35
 
# File 'lib/memori_client/backend/v2/process.rb', line 31

def self.list_memori_processes(strToken:, strMemoriID:, strType: nil)
  args = build_arguments(binding)

  exec_http_request('get', '/api/v2/MemoriProcesses/{strToken}/{strMemoriID}/{strType}', **args)
end

.list_processes(strToken:, strType: nil) ⇒ Object

‘GET /api/v2/Processes/strToken/strType`

Gets a list of Process objects started by the currently logged in User.

‘list_processes(strToken:, strType: nil)`

Parameters:

  • strToken (string) —

    The login token. required

  • strType (string) (defaults to: nil) —

    Optional filter for Process type. optional



13
14
15
16
17
 
# File 'lib/memori_client/backend/v2/process.rb', line 13

def self.list_processes(strToken:, strType: nil)
  args = build_arguments(binding)

  exec_http_request('get', '/api/v2/Processes/{strToken}/{strType}', **args)
end

.stop_process(strToken:, strProcessID:) ⇒ Object

‘POST /api/v2/StopProcess/strToken/strProcessID`

Interrupts an ongoing Process object.

‘stop_process(strToken:, strProcessID:)`

Parameters:

  • strToken (string) —

    The login token. required

  • strProcessID (string) —

    The Process object ID. required



63
64
65
66
67
 
# File 'lib/memori_client/backend/v2/process.rb', line 63

def self.stop_process(strToken:, strProcessID:)
  args = build_arguments(binding)

  exec_http_request('post', '/api/v2/StopProcess/{strToken}/{strProcessID}', **args)
end