Modulo SiemplifyJob

class SiemplifyJob.SiemplifyJob

Basi: Siemplify

Endpoint: 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)

Recupera un parametro di configurazione dall'istanza di integrazione.

Parametri

Nome del parametro	Tipo di parametro	Definizione	Valori possibili	Commenti
param_name	{string}	Nome del parametro da recuperare	N/D	N/D
default_value	{any}	Il valore predefinito del parametro		(Facoltativo) Il valore specificato verrà restituito se il parametro non è stato impostato (se is_mandatory è impostato su False). None per impostazione predefinita
input_type	{obj}	Il tipo di parametro	N/D	(Facoltativo) Il valore restituito verrà convertito nel tipo di input selezionato. {str} per impostazione predefinita
is_mandatory	{boolean}	Definisce se il parametro è obbligatorio	N/D	(Facoltativo) Se impostato su True e il parametro non è stato compilato, verrà generata un'eccezione. False per impostazione predefinita
print_value	{boolean}	Definisce se restituire il valore recuperato del parametro nei log.	N/D	(Facoltativo) False per impostazione predefinita

Restituisce

Il valore parametro, stringa per impostazione predefinita, a meno che non sia specificato input_type.

Esempio

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 dei risultati

Il valore del parametro selezionato verrà restituito, convertito nel tipo selezionato.

Valore del risultato

C:\Siemplify_Server\Scripting\SampleJob\Logs

fetch_and_save_timestamp

fetch_and_save_timestamp(datetime_format=False, timezone=False, new_timestamp=1683034181430)

Recupera il timestamp e salvalo nel contesto della richiesta.

Parametri

Nome del parametro	Tipo di parametro	Definizione	Valori possibili	Commenti
datetime_format	{boolean}	Formato per data/ora	True per ottenere il formato data/ora, False per Unix	False per impostazione predefinita (facoltativo)
fuso orario	Parametro non più supportato
new_timestamp	{int}	Il timestamp da salvare	N/D	Ora Unix epoch per impostazione predefinita (facoltativo)

fetch_timestamp

fetch_timestamp(datetime_format=False, timezone=False)

Ottieni il timestamp salvato con save_timestamp.

Parametri

Nome del parametro	Tipo di parametro	Definizione	Valori possibili	Commenti
datetime_format	{boolean}	Se True, restituisci il timestamp come data e ora. Altrimenti, restituisci in formato Unix	Vero/Falso	False per impostazione predefinita (facoltativo)
fuso orario	Parametro non più supportato

Restituisce

Data/ora Unix salvata.

get_configuration

get_configuration(provider, environment=None, integration_instance=None)

Ottieni la configurazione dell'integrazione.

Parametri

Nome del parametro	Tipo di parametro	Definizione	Valori possibili	Commenti
provider	{string}	Nome integrazione	VirusTotal	Il nome del fornitore dell'integrazione è sensibile alle maiuscole. Verrà generato un errore se l'integrazione non è installata o se la stringa non esiste
produzione	{string}	Configurazione per un ambiente specifico o "all"	N/D	(Facoltativo) Se fornite, le credenziali verranno recuperate dalla configurazione dell'ambiente corrispondente. Se non viene indicato alcun ambiente, viene utilizzato l'ambiente del caso per impostazione predefinita. Se non è presente alcuna configurazione per quell'ambiente specifico, verrà restituita la configurazione predefinita
integration_instance	{string}	Identificatore dell'istanza di integrazione	N/D	N/D

Restituisce

Dettagli di configurazione di {dict}

Esempio

from SiemplifyJob import SiemplifyJob
siemplify = SiemplifyJob()
siemplify.get_configuration(provider="VirusTotal", environment="")

Comportamento dei risultati

Verrà restituito il dizionario con le credenziali salvate per l'integrazione da Google Security Operations Marketplace.

Valore del risultato

{
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)

Recupera tutti i job ETL non riusciti nel numero di ore specificato.

Restituisce

{dict} job non riusciti

{'Id':{string}, 'Name':{string}, 'Message':{string}, WorkflowId = {string}, CreationTime: {string}, CaseId:{string}}

get_failed_etljobs

get_failed_etljobs(number_of_hours)

Recupera tutti i job ETL non riusciti nel numero di ore specificato.

Restituisce

{dict} job non riusciti

{ 'Id': {string}, 'Name': {string}, Message: {string}, CreationTime: {string}}

get_faulted_connectors

get_faulted_connectors(start_unix_time, end_unix_time)

Ottieni tutti i connettori che hanno avuto errori tra le ore start_unix_time e le ore end_unix_time.

Restituisce

{dict} connettori non riusciti

Valore del risultato

{'Name': {string}, 'Message': {string}, 'CreationTime': {string}}

get_faulted_jobs

get_faulted_jobs(number_of_hours)

Visualizza tutti i job non riusciti nel numero di ore specificato.

Restituisce

{[dict]} job non riusciti

Valore del risultato

[{'Id': {long}, 'Name':{string}, 'Message':{string}, 'CreationTime':{string}}]

get_job_context_property

get_job_context_property(identifier, property_key)

Ottieni un valore di contesto del job in base alla chiave specificata.

Parametri

Nome del parametro	Tipo di parametro	Definizione	Valori possibili	Commenti
identificatore	{string}	Identificatore del contesto	N/D	N/D
property_key	{string}	La chiave della proprietà da recuperare	N/D	N/D

get_scoped_job_context_property

get_scoped_job_context_property(property_key)

Recupera la proprietà del contesto del job con ambito utilizzando l'identificatore univoco di un job.

Parametri

Nome del parametro	Tipo di parametro	Definizione	Valori possibili	Commenti
property_key	{string}	La chiave della proprietà di contesto del job	N/D	N/D

Restituisce

Valore di una chiave specifica.

get_system_info

get_system_info(start_time_unixtime_ms)

property log_location

save_publisher_logs

save_publisher_logs(records)

Salva i record di log del publisher.

Parametri

Nome del parametro	Tipo di parametro	Definizione	Valori possibili	Commenti
record	{list}	Record da salvare	N/D	N/D

save_timestamp

save_timestamp(datetime_format=False, timezone=False, new_timestamp=1683034181430)

Salva il timestamp.

Parametri

Nome del parametro	Tipo di parametro	Definizione	Valori possibili	Commenti
datetime_format	{boolean}	N/D	True per il formato data/ora, False per Unix	Il valore predefinito è False (facoltativo)
fuso orario	Parametro non più supportato
new_timestamp	{long}	Timestamp da salvare nel contesto	N/D	Il timestamp corrisponde per impostazione predefinita al timestamp Unix della chiamata al metodo

send_mail

send_mail(subject, message, recipients, attachment_file_name, attachment_content)

Invia un'email (allegati consentiti).

Parametri

Nome del parametro	Tipo di parametro	Definizione	Valori possibili	Commenti
subject	{string}	Oggetto email	N/D	N/D
messaggio	{string}	Messaggio email	N/D	N/D
attachment_file_name	{string}	Nome file allegato	N/D	N/D
destinatari	{[{string}]}	Elenco dei destinatari	N/D	N/D

set_job_context_property

set_job_context_property(identifier, property_key, property_value)

Imposta la proprietà del contesto del job con ambito utilizzando l'identificatore univoco di un job.

Parametri

Nome del parametro	Tipo di parametro	Definizione	Valori possibili	Commenti
identificatore	{string}	Identificatore del contesto	N/D	N/D
property_key	{string}	La chiave della proprietà di contesto del job	N/D	N/D
property_value	{string}	Il valore della proprietà di contesto del job	N/D	N/D

set_scoped_job_context_property

set_scoped_job_context_property(property_key, property_value)

Imposta la proprietà del contesto del job con ambito utilizzando l'identificatore univoco di un job.

Parametri

Nome del parametro	Tipo di parametro	Definizione	Valori possibili	Commenti
property_key	{string}	La chiave della proprietà di contesto del job	N/D	N/D
property_value	{string}	Il valore della proprietà di contesto del job	N/D	N/D