Finishing the queue methods.

replay_error
Pedro de Oliveira Guedes 2022-01-19 08:42:57 -03:00
parent f898670528
commit 4045de0753
1 changed files with 41 additions and 2 deletions

View File

@ -475,7 +475,7 @@ class Replay:
def queue_get_my_data (self):
"""
## Queue Get My Data
Este método é uma extensão do método "queue_get_data". Ele elimina a necessidade de se adicionar o identificador do robô na fila.
Este método é uma extensão do método "queue_get_data". Ele elimina a necessidade de se adicionar o identificador do robô na fila, que a variável de ambiente é buscada dentro do método. Além disso, é interessante ressaltar que este método faz a busca de informações sobre o robô que está atualmente rodando.
---
#### Parâmetros:
@ -492,7 +492,7 @@ class Replay:
def queue_get_my_json (self):
"""
## Queue Get My JSON
Este método é uma extensão do método "queue_get_my_data", mas ele faz com que o objeto seja um dicionário ao invés de uma string.
Este método é uma extensão do método "queue_get_my_data", mas ele faz com que o objeto seja um dicionário ao invés de uma string. Além disso, é interessante ressaltar que este método faz a busca de informações sobre o robô que está atualmente rodando.
---
#### Parâmetros:
@ -506,3 +506,42 @@ class Replay:
return json.loads(str_obj)
def queue_abort (self):
"""
## Queue Abort
Este método é utilizado para abortar o processo atual que está sendo executado na fila. É equivalente ao botão "Abortar" presente na aba de "Fila" no Console do Replay.
É possível abortar mais de um executável na fila. Basta adicioná-lo, esperar que seja executado e então utilizar o método abort.
#### Lembre-se sempre que este método somente surte efeito no processo ATUAL executado pela fila.
---
#### Parâmetros:
---
---
#### Retorna:
- "ok": caso tudo tenha ocorrido corretamente e o método tenha abortado um elemento da fila.
- None: caso o método tenha sido executado e não haja mais nenhum robô na fila sendo executado atualmente.
"""
try:
self.__request_get__("/api/v1/queue/abort")
except:
return "ok"
def queue_enqueue (self, job_id: int):
"""
## Queue Enqueue
Este método adiciona a fila um robô cujo ID tenha sido passado como parâmetro.
---
#### Parâmetros:
- job_id: Identificador do robô que se quer adicionar à fila na base de dados do replay.
---
#### Retorna:
-> "ok" caso o robô tenha sido adicionado à fila corretamente.
"""
return self.__request_get__(f"/api/v1/robots/op/enqueue/{job_id}")