Built-in Types

WebhookRetries

Webhook retry configuration.

Bases

dataclass

FieldTypeDescription
max_retriesintMaximum number of retries. Default is 3.
max_retry_delayintMaximum delay between retries in milliseconds. Default is 15000.

WebhookSecret

Webhook secret.

Bases

dataclass

FieldTypeDescription
contentsstrBase64-decoded string of a secret key. If this is not provided, one will automatically be generated.

WebhookSpec

📘

Note: The specified endpoint must be HTTPS, and it must be a fully qualified domain name that resolves to an IPv4 address in public space.

Webhook configuration.

Bases

dataclass

FieldTypeDescription
endpointstrWebhook endpoint URL. The endpoint must be HTTPS, and it must be a fully qualified domain name that resolves to an IPv4 address in public space.

JobOptions

Batch job configuration.

Bases

dataclass

FieldTypeDescription
dataset_idstrThe dataset ID.
webhook_idstrThe webhook ID.
artifact_idOptional[str]The ID of the artifact to deploy. Use this field for spinning up new temporary deployments to run batch jobs. If this field is specified, the deployment_id field can be left blank.
deployment_idOptional[str]The ID of an existing deployment in your Nexus project. If this field is specified, the artifact_id and deployment_metadata fields can be left blank.
deployment_metadataOptional[DeploymentMetadata]The deployment configuration when spinning up new temporary deployments to run batch jobs. To be used in conjunction with artifact_id.
start_at_timeOptional[int]Start time of the batch job in milliseconds.
stop_at_timeOptional[int]Stop time of the batch job in milliseconds.

LogsFilter

Filter options for batch job logs.

Bases

dataclass

FieldTypeDescription
before_timeOptional[str]Filter logs before the specified timestamp in milliseconds.
after_timeOptional[str]Filter logs after the specified timestamp in milliseconds.
min_levelOptional[str]Filter logs with a minimum level, e.g. Info or Error. Defaults to Info.
max_entriesOptional[int]Maximum number of log entries to return.