Class: SmplkitGeneratedClient::Jobs::JobHttpConfiguration

Inherits:
ApiModelBase
  • Object
show all
Defined in:
lib/smplkit/_generated/jobs/lib/smplkit_jobs_client/models/job_http_configuration.rb

Overview

HTTP request a job performs when it fires. Extends the shared forwarder configuration with the two fields a scheduled job needs beyond a forwarder.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ JobHttpConfiguration

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/smplkit/_generated/jobs/lib/smplkit_jobs_client/models/job_http_configuration.rb', line 113

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `SmplkitGeneratedClient::Jobs::JobHttpConfiguration` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `SmplkitGeneratedClient::Jobs::JobHttpConfiguration`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'method')
    self.method = attributes[:'method']
  else
    self.method = 'POST'
  end

  if attributes.key?(:'url')
    self.url = attributes[:'url']
  else
    self.url = nil
  end

  if attributes.key?(:'headers')
    if (value = attributes[:'headers']).is_a?(Array)
      self.headers = value
    end
  end

  if attributes.key?(:'success_status')
    self.success_status = attributes[:'success_status']
  else
    self.success_status = '2xx'
  end

  if attributes.key?(:'tls_verify')
    self.tls_verify = attributes[:'tls_verify']
  else
    self.tls_verify = true
  end

  if attributes.key?(:'ca_cert')
    self.ca_cert = attributes[:'ca_cert']
  end

  if attributes.key?(:'body')
    self.body = attributes[:'body']
  end

  if attributes.key?(:'timeout')
    self.timeout = attributes[:'timeout']
  else
    self.timeout = 30
  end
end

Instance Attribute Details

#body ⇒ Object

Request body sent on each run. When omitted, an empty body is sent (suitable for a connectivity ping). Sent verbatim — pair with a matching ‘Content-Type` header. Limit 1 MiB.



38
39
40
 
# File 'lib/smplkit/_generated/jobs/lib/smplkit_jobs_client/models/job_http_configuration.rb', line 38

def body
  @body
end

#ca_cert ⇒ Object

Optional PEM-encoded certificate (or bundle) used to verify the destination server’s TLS certificate, in addition to the system trust store. Use this to pin a private or self-signed CA (e.g. Splunk’s default ‘SplunkCommonCA`) without disabling verification entirely via `tls_verify`. Must contain one or more `—–BEGIN CERTIFICATE—–` blocks. Ignored when `tls_verify` is `false`.



35
36
37
 
# File 'lib/smplkit/_generated/jobs/lib/smplkit_jobs_client/models/job_http_configuration.rb', line 35

def ca_cert
  @ca_cert
end

#headers ⇒ Object

HTTP headers attached to each request.



26
27
28
 
# File 'lib/smplkit/_generated/jobs/lib/smplkit_jobs_client/models/job_http_configuration.rb', line 26

def headers
  @headers
end

#method ⇒ Object

HTTP method used when delivering the request.



20
21
22
 
# File 'lib/smplkit/_generated/jobs/lib/smplkit_jobs_client/models/job_http_configuration.rb', line 20

def method
  @method
end

#success_status ⇒ Object

HTTP response status that indicates success. Either a specific status code (e.g. ‘200`, `204`) or a status class (`1xx`, `2xx`, `3xx`, `4xx`, `5xx`).



29
30
31
 
# File 'lib/smplkit/_generated/jobs/lib/smplkit_jobs_client/models/job_http_configuration.rb', line 29

def success_status
  @success_status
end

#timeout ⇒ Object

Per-run timeout in seconds. A run that does not complete within this many seconds fails with reason ‘TIMEOUT`. Bounded by your plan’s maximum timeout.



41
42
43
 
# File 'lib/smplkit/_generated/jobs/lib/smplkit_jobs_client/models/job_http_configuration.rb', line 41

def timeout
  @timeout
end

#tls_verify ⇒ Object

Whether to verify the destination server’s TLS certificate against trusted certificate authorities. Defaults to ‘true` and should be left on for any production destination. Set to `false` only for development or short-lived testing against a destination that presents an untrusted certificate (e.g. a Splunk Cloud trial stack on `:8088` serving its default self-signed certificate). When `false`, deliveries proceed without certificate verification — they are vulnerable to man-in-the-middle attacks. For long-lived self-signed setups, pin the issuing CA via `ca_cert` instead of disabling verification entirely.



32
33
34
 
# File 'lib/smplkit/_generated/jobs/lib/smplkit_jobs_client/models/job_http_configuration.rb', line 32

def tls_verify
  @tls_verify
end

#url ⇒ Object

Destination URL. Must be an absolute ‘http://` or `https://` URL with a hostname (e.g. `siem.example.com/in`).



23
24
25
 
# File 'lib/smplkit/_generated/jobs/lib/smplkit_jobs_client/models/job_http_configuration.rb', line 23

def url
  @url
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



80
81
82
 
# File 'lib/smplkit/_generated/jobs/lib/smplkit_jobs_client/models/job_http_configuration.rb', line 80

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



85
86
87
 
# File 'lib/smplkit/_generated/jobs/lib/smplkit_jobs_client/models/job_http_configuration.rb', line 85

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/smplkit/_generated/jobs/lib/smplkit_jobs_client/models/job_http_configuration.rb', line 66

def self.attribute_map
  {
    :'method' => :'method',
    :'url' => :'url',
    :'headers' => :'headers',
    :'success_status' => :'success_status',
    :'tls_verify' => :'tls_verify',
    :'ca_cert' => :'ca_cert',
    :'body' => :'body',
    :'timeout' => :'timeout'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
 
# File 'lib/smplkit/_generated/jobs/lib/smplkit_jobs_client/models/job_http_configuration.rb', line 330

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



104
105
106
107
108
109
 
# File 'lib/smplkit/_generated/jobs/lib/smplkit_jobs_client/models/job_http_configuration.rb', line 104

def self.openapi_nullable
  Set.new([
    :'ca_cert',
    :'body',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/smplkit/_generated/jobs/lib/smplkit_jobs_client/models/job_http_configuration.rb', line 90

def self.openapi_types
  {
    :'method' => :'String',
    :'url' => :'String',
    :'headers' => :'Array<HttpHeader>',
    :'success_status' => :'String',
    :'tls_verify' => :'Boolean',
    :'ca_cert' => :'String',
    :'body' => :'String',
    :'timeout' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/smplkit/_generated/jobs/lib/smplkit_jobs_client/models/job_http_configuration.rb', line 302

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      method == o.method &&
      url == o.url &&
      headers == o.headers &&
      success_status == o.success_status &&
      tls_verify == o.tls_verify &&
      ca_cert == o.ca_cert &&
      body == o.body &&
      timeout == o.timeout
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


317
318
319
 
# File 'lib/smplkit/_generated/jobs/lib/smplkit_jobs_client/models/job_http_configuration.rb', line 317

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



323
324
325
 
# File 'lib/smplkit/_generated/jobs/lib/smplkit_jobs_client/models/job_http_configuration.rb', line 323

def hash
  [method, url, headers, success_status, tls_verify, ca_cert, body, timeout].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/smplkit/_generated/jobs/lib/smplkit_jobs_client/models/job_http_configuration.rb', line 174

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @url.nil?
    invalid_properties.push('invalid value for "url", url cannot be nil.')
  end

  if @url.to_s.length > 2048
    invalid_properties.push('invalid value for "url", the character length must be smaller than or equal to 2048.')
  end

  if @url.to_s.length < 1
    invalid_properties.push('invalid value for "url", the character length must be greater than or equal to 1.')
  end

  if !@success_status.nil? && @success_status.to_s.length > 3
    invalid_properties.push('invalid value for "success_status", the character length must be smaller than or equal to 3.')
  end

  if !@ca_cert.nil? && @ca_cert.to_s.length > 65536
    invalid_properties.push('invalid value for "ca_cert", the character length must be smaller than or equal to 65536.')
  end

  if !@body.nil? && @body.to_s.length > 1048576
    invalid_properties.push('invalid value for "body", the character length must be smaller than or equal to 1048576.')
  end

  if !@timeout.nil? && @timeout < 1
    invalid_properties.push('invalid value for "timeout", must be greater than or equal to 1.')
  end

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



352
353
354
355
356
357
358
359
360
361
362
363
364
 
# File 'lib/smplkit/_generated/jobs/lib/smplkit_jobs_client/models/job_http_configuration.rb', line 352

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/smplkit/_generated/jobs/lib/smplkit_jobs_client/models/job_http_configuration.rb', line 210

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  method_validator = EnumAttributeValidator.new('String', ["GET", "POST", "PUT", "PATCH", "DELETE"])
  return false unless method_validator.valid?(@method)
  return false if @url.nil?
  return false if @url.to_s.length > 2048
  return false if @url.to_s.length < 1
  return false if !@success_status.nil? && @success_status.to_s.length > 3
  return false if !@ca_cert.nil? && @ca_cert.to_s.length > 65536
  return false if !@body.nil? && @body.to_s.length > 1048576
  return false if !@timeout.nil? && @timeout < 1
  true
end