Módulo SiemplifyJob
classe SiemplifyJob.SiemplifyJob
Bases: Siemplify
Pontos finais: external/v1/sdk/GetFailedETLOperations
extract_job_param
extract_job_param(param_name, default_value=None, input_type=<class 'str'>, is_mandatory=False, print_value=False)
Obter um parâmetro de configuração da instância de integração.
Parâmetros
| Nome do parâmetro | Tipo de parâmetro | Definição | Valores possíveis | Comentários |
|---|---|---|---|---|
| param_name | {string} | Nome do parâmetro a obter | N/A | N/A |
| default_value | {any} | O valor predefinido do parâmetro | (Opcional) O valor indicado é devolvido se o parâmetro não tiver sido definido (se is_mandatory estiver definido como False).None por predefinição |
|
| input_type | {obj} | O tipo do parâmetro | N/A | (Opcional) O valor devolvido é convertido no tipo de entrada selecionado. {str} por predefinição |
| is_mandatory | {boolean} | Define se o parâmetro é obrigatório | N/A | (Opcional) Se for definido como Verdadeiro e o parâmetro não tiver sido preenchido, é gerada uma exceção. False por predefinição |
| print_value | {boolean} | Define se o valor obtido do parâmetro deve ser apresentado nos registos. | N/A | (Opcional)False por predefinição |
Devoluções
O valor do parâmetro, string por predefinição, a menos que input_type seja especificado.
Exemplo
from SiemplifyJob import SiemplifyJob
siemplify = SiemplifyJob()
param_value= siemplify.extract_job_param(
"Logs Folder",
default_value="C:\\Siemplify_Server\\Scripting\\JobLogs",
input_type=str,
is_mandatory=False,
print_value=False)
Comportamento dos resultados
O valor do parâmetro selecionado é devolvido, convertido para o tipo selecionado.
Valor do resultado
C:\Siemplify_Server\Scripting\SampleJob\Logs
fetch_and_save_timestamp
fetch_and_save_timestamp(datetime_format=False, timezone=False, new_timestamp=1683034181430)
Obter a data/hora e guardá-la no contexto do registo.
Parâmetros
| Nome do parâmetro | Tipo de parâmetro | Definição | Valores possíveis | Comentários |
|---|---|---|---|---|
| datetime_format | {boolean} | Formato de data/hora | True para obter no formato de data/hora,False para Unix |
False por predefinição (opcional) |
| fuso horário | O parâmetro já não é suportado | |||
| new_timestamp | {int} | A data/hora a guardar | N/A | Hora de época Unix por predefinição (opcional) |
fetch_timestamp
fetch_timestamp(datetime_format=False, timezone=False)
Obtenha a indicação de tempo guardada com o save_timestamp.
Parâmetros
| Nome do parâmetro | Tipo de parâmetro | Definição | Valores possíveis | Comentários |
|---|---|---|---|---|
| datetime_format | {boolean} | Se True, devolve a data/hora como data/hora.Caso contrário, devolve no formato Unix |
Verdadeiro/Falso | False por predefinição (opcional) |
| fuso horário | O parâmetro já não é suportado | |||
Devoluções
Tempo/data e hora Unix guardados.
get_configuration
get_configuration(provider, environment=None, integration_instance=None)
Obtenha a configuração da integração.
Parâmetros
| Nome do parâmetro | Tipo de parâmetro | Definição | Valores possíveis | Comentários |
|---|---|---|---|---|
| provider | {string} | Nome da integração | VirusTotal | O nome do fornecedor de integração é sensível a maiúsculas e minúsculas. É apresentado um erro se a integração não estiver instalada ou se a string não existir |
| ambiente | {string} | Configuração para um ambiente específico ou "todos" | N/A | (Opcional) Se forem fornecidas, as credenciais são obtidas a partir da configuração do ambiente correspondente. Se não for indicado nenhum ambiente, o ambiente de caso é usado por predefinição. Se não existir uma configuração para esse ambiente específico, é devolvida a configuração predefinida |
| integration_instance | {string} | Identificador da instância de integração | N/A | N/A |
Devoluções
Detalhes da configuração {dict}
Exemplo
from SiemplifyJob import SiemplifyJob
siemplify = SiemplifyJob()
siemplify.get_configuration(provider="VirusTotal", environment="")
Comportamento dos resultados
É devolvido um dicionário com as credenciais guardadas para a integração a partir do Google Security Operations Marketplace.
Valor do resultado
{
u'AgentIdentifier': None,
u'Api Key': u'c0c412#########################4f85b22e707',
u'Verify SSL': u'True',
u'RunRemotely': u'False'
}
get_failed_actions
get_failed_actions(number_of_hours)
Obtenha todas as tarefas de ETL que falharam no número de horas especificado.
Devoluções
{dict} tarefas com falha
{'Id':{string}, 'Name':{string}, 'Message':{string}, WorkflowId = {string}, CreationTime: {string}, CaseId:{string}}
get_failed_etljobs
get_failed_etljobs(number_of_hours)
Obtenha todas as tarefas de ETL que falharam no número de horas especificado.
Devoluções
{dict} tarefas com falha
{ 'Id': {string}, 'Name': {string}, Message: {string}, CreationTime: {string}}
get_faulted_connectors
get_faulted_connectors(start_unix_time, end_unix_time)
Receba todos os conetores que falharam no intervalo de tempo entre start_unix_time e end_unix_time.
Devoluções
{dict} conetores com falhas
Valor do resultado
{'Name': {string}, 'Message': {string}, 'CreationTime': {string}}
get_faulted_jobs
get_faulted_jobs(number_of_hours)
Obter todas as tarefas que falharam no número de horas especificado.
Devoluções
{[dict]} tarefas com falha
Valor do resultado
[{'Id': {long}, 'Name':{string}, 'Message':{string}, 'CreationTime':{string}}]
get_job_context_property
get_job_context_property(identifier, property_key)
Obtenha um valor de contexto de trabalho pela chave fornecida.
Parâmetros
| Nome do parâmetro | Tipo de parâmetro | Definição | Valores possíveis | Comentários |
|---|---|---|---|---|
| identificador | {string} | Identificador de contexto | N/A | N/A |
| property_key | {string} | A chave da propriedade a obter | N/A | N/A |
get_scoped_job_context_property
get_scoped_job_context_property(property_key)
Obtenha a propriedade de contexto do trabalho com âmbito através do identificador exclusivo de um trabalho.
Parâmetros
| Nome do parâmetro | Tipo de parâmetro | Definição | Valores possíveis | Comentários |
|---|---|---|---|---|
| property_key | {string} | A chave da propriedade de contexto da tarefa | N/A | N/A |
Devoluções
Valor de uma chave específica.
get_system_info
get_system_info(start_time_unixtime_ms)
property log_location
save_publisher_logs
save_publisher_logs(records)
Guardar registos de registo do publicador.
Parâmetros
| Nome do parâmetro | Tipo de parâmetro | Definição | Valores possíveis | Comentários |
|---|---|---|---|---|
| registos | {list} | Registos a guardar | N/A | N/A |
save_timestamp
save_timestamp(datetime_format=False, timezone=False, new_timestamp=1683034181430)
Guardar indicação de tempo.
Parâmetros
| Nome do parâmetro | Tipo de parâmetro | Definição | Valores possíveis | Comentários |
|---|---|---|---|---|
| datetime_format | {boolean} | N/A | True para o formato de data/hora e False para o formato Unix |
A predefinição é False (opcional) |
| fuso horário | O parâmetro já não é suportado | |||
| new_timestamp | {long} | Data/hora para guardar no contexto | N/A | A data/hora é predefinida como a data/hora Unix da chamada do método |
send_mail
send_mail(subject, message, recipients, attachment_file_name, attachment_content)
Enviar um email (anexos permitidos).
Parâmetros
| Nome do parâmetro | Tipo de parâmetro | Definição | Valores possíveis | Comentários |
|---|---|---|---|---|
| assunto | {string} | Assunto do email | N/A | N/A |
| mensagem | {string} | Mensagem de email | N/A | N/A |
| attachment_file_name | {string} | Nome do ficheiro do anexo | N/A | N/A |
| destinatários | {[{string}]} | Lista de destinatários | N/A | N/A |
set_job_context_property
set_job_context_property(identifier, property_key, property_value)
Defina a propriedade de contexto da tarefa com âmbito usando o identificador exclusivo de uma tarefa.
Parâmetros
| Nome do parâmetro | Tipo de parâmetro | Definição | Valores possíveis | Comentários |
|---|---|---|---|---|
| identificador | {string} | Identificador de contexto | N/A | N/A |
| property_key | {string} | A chave da propriedade de contexto da tarefa | N/A | N/A |
| property_value | {string} | O valor da propriedade de contexto da tarefa | N/A | N/A |
set_scoped_job_context_property
set_scoped_job_context_property(property_key, property_value)
Defina a propriedade de contexto da tarefa com âmbito usando o identificador exclusivo de uma tarefa.
Parâmetros
| Nome do parâmetro | Tipo de parâmetro | Definição | Valores possíveis | Comentários |
|---|---|---|---|---|
| property_key | {string} | A chave da propriedade de contexto da tarefa | N/A | N/A |
| property_value | {string} | O valor da propriedade de contexto da tarefa | N/A | N/A |