GetLogpushJobResult

data class GetLogpushJobResult(val accountId: String? = null, val dataset: String, val destinationConf: String, val enabled: Boolean, val errorMessage: String, val frequency: String, val id: Int, val jobId: Int? = null, val kind: String, val lastComplete: String, val lastError: String, val logpullOptions: String, val maxUploadBytes: Int, val maxUploadIntervalSeconds: Int, val maxUploadRecords: Int, val name: String, val outputOptions: GetLogpushJobOutputOptions, val zoneId: String? = null)

A collection of values returned by getLogpushJob.

Constructors

Link copied to clipboard
constructor(accountId: String? = null, dataset: String, destinationConf: String, enabled: Boolean, errorMessage: String, frequency: String, id: Int, jobId: Int? = null, kind: String, lastComplete: String, lastError: String, logpullOptions: String, maxUploadBytes: Int, maxUploadIntervalSeconds: Int, maxUploadRecords: Int, name: String, outputOptions: GetLogpushJobOutputOptions, zoneId: String? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val accountId: String? = null

The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.

Link copied to clipboard

Name of the dataset. A list of supported datasets can be found on the Developer Docs.

Link copied to clipboard

Uniquely identifies a resource (such as an s3 bucket) where data will be pushed. Additional configuration parameters supported by the destination may be included.

Link copied to clipboard

Flag that indicates if the job is enabled.

Link copied to clipboard

If not null, the job is currently failing. Failures are usually repetitive (example: no permissions to write to destination bucket). Only the last failure is recorded. On successful execution of a job the errormessage and lasterror are set to null.

Link copied to clipboard

This field is deprecated. Please use max_upload_* parameters instead. The frequency at which Cloudflare sends batches of logs to your destination. Setting frequency to high sends your logs in larger quantities of smaller files. Setting frequency to low sends logs in smaller quantities of larger files. Available values: "high", "low".

Link copied to clipboard
val id: Int

Unique id of the job.

Link copied to clipboard
val jobId: Int? = null

Unique id of the job.

Link copied to clipboard

The kind parameter (optional) is used to differentiate between Logpush and Edge Log Delivery jobs. Currently, Edge Log Delivery is only supported for the http_requests dataset. Available values: "edge".

Link copied to clipboard

Records the last time for which logs have been successfully pushed. If the last successful push was for logs range 2018-07-23T10:00:00Z to 2018-07-23T10:01:00Z then the value of this field will be 2018-07-23T10:01:00Z. If the job has never run or has just been enabled and hasn't run yet then the field will be empty.

Link copied to clipboard

Records the last time the job failed. If not null, the job is currently failing. If null, the job has either never failed or has run successfully at least once since last failure. See also the error_message field.

Link copied to clipboard

This field is deprecated. Use output_options instead. Configuration string. It specifies things like requested fields and timestamp formats. If migrating from the logpull api, copy the url (full url or just the query string) of your call here, and logpush will keep on making this call for you, setting start and end times appropriately.

Link copied to clipboard

The maximum uncompressed file size of a batch of logs. This setting value must be between 5 MB and 1 GB, or 0 to disable it. Note that you cannot set a minimum file size; this means that log files may be much smaller than this batch size. This parameter is not available for jobs with edge as its kind.

Link copied to clipboard

The maximum interval in seconds for log batches. This setting must be between 30 and 300 seconds (5 minutes), or 0 to disable it. Note that you cannot specify a minimum interval for log batches; this means that log files may be sent in shorter intervals than this. This parameter is only used for jobs with edge as its kind.

Link copied to clipboard

The maximum number of log lines per batch. This setting must be between 1000 and 1,000,000 lines, or 0 to disable it. Note that you cannot specify a minimum number of log lines per batch; this means that log files may contain many fewer lines than this. This parameter is not available for jobs with edge as its kind.

Link copied to clipboard

Optional human readable job name. Not unique. Cloudflare suggests that you set this to a meaningful string, like the domain name, to make it easier to identify your job.

Link copied to clipboard

The structured replacement for logpull_options. When including this field, the logpull_option field will be ignored.

Link copied to clipboard
val zoneId: String? = null

The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.