CcpResponseConfigResponse

data class CcpResponseConfigResponse(val compressionAlgo: String? = null, val convertChildPropertiesToArray: Boolean? = null, val csvDelimiter: String? = null, val csvEscape: String? = null, val eventsJsonPaths: List<String>, val format: String? = null, val hasCsvBoundary: Boolean? = null, val hasCsvHeader: Boolean? = null, val isGzipCompressed: Boolean? = null, val successStatusJsonPath: String? = null, val successStatusValue: String? = null)

A custom response configuration for a rule.

Constructors

Link copied to clipboard
constructor(compressionAlgo: String? = null, convertChildPropertiesToArray: Boolean? = null, csvDelimiter: String? = null, csvEscape: String? = null, eventsJsonPaths: List<String>, format: String? = null, hasCsvBoundary: Boolean? = null, hasCsvHeader: Boolean? = null, isGzipCompressed: Boolean? = null, successStatusJsonPath: String? = null, successStatusValue: String? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val compressionAlgo: String? = null

The compression algorithm. For Example: 'gzip', 'multi-gzip', 'deflate'.

Link copied to clipboard

The value indicating whether the response isn't an array of events / logs. By setting this flag to true it means the remote server will response with an object which each property has as a value an array of events / logs.

Link copied to clipboard
val csvDelimiter: String? = null

The csv delimiter, in case the response format is CSV.

Link copied to clipboard
val csvEscape: String? = null

The character used to escape characters in CSV.

Link copied to clipboard

The json paths, '$' char is the json root.

Link copied to clipboard
val format: String? = null

The response format. possible values are json,csv,xml

Link copied to clipboard
val hasCsvBoundary: Boolean? = null

The value indicating whether the response has CSV boundary in case the response in CSV format.

Link copied to clipboard
val hasCsvHeader: Boolean? = null

The value indicating whether the response has headers in case the response in CSV format.

Link copied to clipboard

The value indicating whether the remote server support Gzip and we should expect Gzip response.

Link copied to clipboard

The value where the status message/code should appear in the response.

Link copied to clipboard

The status value.