Class: Fastly::LoggingSplunkApi

Inherits:
Object
  • Object
show all
Defined in:
lib/fastly/api/logging_splunk_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ LoggingSplunkApi

Returns a new instance of LoggingSplunkApi.



17
18
19
 
# File 'lib/fastly/api/logging_splunk_api.rb', line 17

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



15
16
17
 
# File 'lib/fastly/api/logging_splunk_api.rb', line 15

def api_client
  @api_client
end

Instance Method Details

#create_log_splunk(opts = {}) ⇒ LoggingSplunkResponse

Create a Splunk log endpoint Create a Splunk logging object for a particular service and version.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :version_id (Integer) —

    Integer identifying a service version. (required)

  • :name (String) —

    The name for the real-time logging configuration.

  • :placement (String) —

    Where in the generated VCL the logging call should be placed. If not set, endpoints with `format_version` of 2 are placed in `vcl_log` and those with `format_version` of 1 are placed in `vcl_deliver`.

  • :response_condition (String) —

    The name of an existing condition in the configured endpoint, or leave blank to always execute.

  • :format (String) —

    A Fastly [log format string](docs.fastly.com/en/guides/custom-log-formats). (default to ‘%h %l %u %t "%r" %>s %b’)

  • :format_version (Integer) —

    The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in `vcl_log` if `format_version` is set to `2` and in `vcl_deliver` if `format_version` is set to `1`. (default to FORMAT_VERSION::v2)

  • :tls_ca_cert (String) —

    A secure certificate to authenticate a server with. Must be in PEM format. (default to ‘null’)

  • :tls_client_cert (String) —

    The client certificate used to make authenticated requests. Must be in PEM format. (default to ‘null’)

  • :tls_client_key (String) —

    The client private key used to make authenticated requests. Must be in PEM format. (default to ‘null’)

  • :tls_hostname (String) —

    The hostname to verify the server's certificate. This should be one of the Subject Alternative Name (SAN) fields for the certificate. Common Names (CN) are not supported. (default to ‘null’)

  • :request_max_entries (Integer) —

    The maximum number of logs sent in one request. Defaults `0` for unbounded. (default to 0)

  • :request_max_bytes (Integer) —

    The maximum number of bytes sent in one request. Defaults `0` for unbounded. (default to 0)

  • :url (String) —

    The URL to post logs to.

  • :token (String) —

    A Splunk token for use in posting logs over HTTP to your collector.

  • :use_tls (LoggingUseTlsString) — default: default to '0'

Returns:



39
40
41
42
 
# File 'lib/fastly/api/logging_splunk_api.rb', line 39

def create_log_splunk(opts = {})
  data, _status_code, _headers = create_log_splunk_with_http_info(opts)
  data
end

#create_log_splunk_with_http_info(opts = {}) ⇒ Array<(LoggingSplunkResponse, Integer, Hash)>

Create a Splunk log endpoint Create a Splunk logging object for a particular service and version.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :version_id (Integer) —

    Integer identifying a service version. (required)

  • :name (String) —

    The name for the real-time logging configuration.

  • :placement (String) —

    Where in the generated VCL the logging call should be placed. If not set, endpoints with &#x60;format_version&#x60; of 2 are placed in &#x60;vcl_log&#x60; and those with &#x60;format_version&#x60; of 1 are placed in &#x60;vcl_deliver&#x60;.

  • :response_condition (String) —

    The name of an existing condition in the configured endpoint, or leave blank to always execute.

  • :format (String) —

    A Fastly [log format string](docs.fastly.com/en/guides/custom-log-formats). (default to ‘%h %l %u %t "%r" %&gt;s %b’)

  • :format_version (Integer) —

    The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in &#x60;vcl_log&#x60; if &#x60;format_version&#x60; is set to &#x60;2&#x60; and in &#x60;vcl_deliver&#x60; if &#x60;format_version&#x60; is set to &#x60;1&#x60;. (default to FORMAT_VERSION::v2)

  • :tls_ca_cert (String) —

    A secure certificate to authenticate a server with. Must be in PEM format. (default to ‘null’)

  • :tls_client_cert (String) —

    The client certificate used to make authenticated requests. Must be in PEM format. (default to ‘null’)

  • :tls_client_key (String) —

    The client private key used to make authenticated requests. Must be in PEM format. (default to ‘null’)

  • :tls_hostname (String) —

    The hostname to verify the server&#39;s certificate. This should be one of the Subject Alternative Name (SAN) fields for the certificate. Common Names (CN) are not supported. (default to ‘null’)

  • :request_max_entries (Integer) —

    The maximum number of logs sent in one request. Defaults &#x60;0&#x60; for unbounded. (default to 0)

  • :request_max_bytes (Integer) —

    The maximum number of bytes sent in one request. Defaults &#x60;0&#x60; for unbounded. (default to 0)

  • :url (String) —

    The URL to post logs to.

  • :token (String) —

    A Splunk token for use in posting logs over HTTP to your collector.

  • :use_tls (LoggingUseTlsString) — default: default to '0'

Returns:

  • (Array<(LoggingSplunkResponse, Integer, Hash)>) —

    LoggingSplunkResponse data, response status code and response headers



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
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
 
# File 'lib/fastly/api/logging_splunk_api.rb', line 63

def create_log_splunk_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LoggingSplunkApi.create_log_splunk ...'
  end
  # unbox the parameters from the hash
  service_id = opts[:'service_id']
  version_id = opts[:'version_id']
  # verify the required parameter 'service_id' is set
  if @api_client.config.client_side_validation && service_id.nil?
    fail ArgumentError, "Missing the required parameter 'service_id' when calling LoggingSplunkApi.create_log_splunk"
  end
  # verify the required parameter 'version_id' is set
  if @api_client.config.client_side_validation && version_id.nil?
    fail ArgumentError, "Missing the required parameter 'version_id' when calling LoggingSplunkApi.create_log_splunk"
  end
  allowable_values = ["none", "waf_debug", "null"]
  if @api_client.config.client_side_validation && opts[:'placement'] && !allowable_values.include?(opts[:'placement'])
    fail ArgumentError, "invalid value for \"placement\", must be one of #{allowable_values}"
  end
  allowable_values = [1, 2]
  if @api_client.config.client_side_validation && opts[:'format_version'] && !allowable_values.include?(opts[:'format_version'])
    fail ArgumentError, "invalid value for \"format_version\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/service/{service_id}/version/{version_id}/logging/splunk'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['name'] = opts[:'name'] if !opts[:'name'].nil?
  form_params['placement'] = opts[:'placement'] if !opts[:'placement'].nil?
  form_params['response_condition'] = opts[:'response_condition'] if !opts[:'response_condition'].nil?
  form_params['format'] = opts[:'format'] if !opts[:'format'].nil?
  form_params['format_version'] = opts[:'format_version'] if !opts[:'format_version'].nil?
  form_params['tls_ca_cert'] = opts[:'tls_ca_cert'] if !opts[:'tls_ca_cert'].nil?
  form_params['tls_client_cert'] = opts[:'tls_client_cert'] if !opts[:'tls_client_cert'].nil?
  form_params['tls_client_key'] = opts[:'tls_client_key'] if !opts[:'tls_client_key'].nil?
  form_params['tls_hostname'] = opts[:'tls_hostname'] if !opts[:'tls_hostname'].nil?
  form_params['request_max_entries'] = opts[:'request_max_entries'] if !opts[:'request_max_entries'].nil?
  form_params['request_max_bytes'] = opts[:'request_max_bytes'] if !opts[:'request_max_bytes'].nil?
  form_params['url'] = opts[:'url'] if !opts[:'url'].nil?
  form_params['token'] = opts[:'token'] if !opts[:'token'].nil?
  form_params['use_tls'] = opts[:'use_tls'] if !opts[:'use_tls'].nil?

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'LoggingSplunkResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['token']

  new_options = opts.merge(
    :operation => :"LoggingSplunkApi.create_log_splunk",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LoggingSplunkApi#create_log_splunk\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_log_splunk(opts = {}) ⇒ InlineResponse200

Delete a Splunk log endpoint Delete the Splunk logging object for a particular service and version.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :version_id (Integer) —

    Integer identifying a service version. (required)

  • :logging_splunk_name (String) —

    The name for the real-time logging configuration. (required)

Returns:



151
152
153
154
 
# File 'lib/fastly/api/logging_splunk_api.rb', line 151

def delete_log_splunk(opts = {})
  data, _status_code, _headers = delete_log_splunk_with_http_info(opts)
  data
end

#delete_log_splunk_with_http_info(opts = {}) ⇒ Array<(InlineResponse200, Integer, Hash)>

Delete a Splunk log endpoint Delete the Splunk logging object for a particular service and version.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :version_id (Integer) —

    Integer identifying a service version. (required)

  • :logging_splunk_name (String) —

    The name for the real-time logging configuration. (required)

Returns:

  • (Array<(InlineResponse200, Integer, Hash)>) —

    InlineResponse200 data, response status code and response headers



162
163
164
165
166
167
168
169
170
171
172
173
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
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/fastly/api/logging_splunk_api.rb', line 162

def delete_log_splunk_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LoggingSplunkApi.delete_log_splunk ...'
  end
  # unbox the parameters from the hash
  service_id = opts[:'service_id']
  version_id = opts[:'version_id']
  logging_splunk_name = opts[:'logging_splunk_name']
  # verify the required parameter 'service_id' is set
  if @api_client.config.client_side_validation && service_id.nil?
    fail ArgumentError, "Missing the required parameter 'service_id' when calling LoggingSplunkApi.delete_log_splunk"
  end
  # verify the required parameter 'version_id' is set
  if @api_client.config.client_side_validation && version_id.nil?
    fail ArgumentError, "Missing the required parameter 'version_id' when calling LoggingSplunkApi.delete_log_splunk"
  end
  # verify the required parameter 'logging_splunk_name' is set
  if @api_client.config.client_side_validation && logging_splunk_name.nil?
    fail ArgumentError, "Missing the required parameter 'logging_splunk_name' when calling LoggingSplunkApi.delete_log_splunk"
  end
  # resource path
  local_var_path = '/service/{service_id}/version/{version_id}/logging/splunk/{logging_splunk_name}'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_id.to_s)).sub('{' + 'logging_splunk_name' + '}', CGI.escape(logging_splunk_name.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'InlineResponse200'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['token']

  new_options = opts.merge(
    :operation => :"LoggingSplunkApi.delete_log_splunk",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LoggingSplunkApi#delete_log_splunk\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_log_splunk(opts = {}) ⇒ LoggingSplunkResponse

Get a Splunk log endpoint Get the details for a Splunk logging object for a particular service and version.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :version_id (Integer) —

    Integer identifying a service version. (required)

  • :logging_splunk_name (String) —

    The name for the real-time logging configuration. (required)

Returns:



228
229
230
231
 
# File 'lib/fastly/api/logging_splunk_api.rb', line 228

def get_log_splunk(opts = {})
  data, _status_code, _headers = get_log_splunk_with_http_info(opts)
  data
end

#get_log_splunk_with_http_info(opts = {}) ⇒ Array<(LoggingSplunkResponse, Integer, Hash)>

Get a Splunk log endpoint Get the details for a Splunk logging object for a particular service and version.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :version_id (Integer) —

    Integer identifying a service version. (required)

  • :logging_splunk_name (String) —

    The name for the real-time logging configuration. (required)

Returns:

  • (Array<(LoggingSplunkResponse, Integer, Hash)>) —

    LoggingSplunkResponse data, response status code and response headers



239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/fastly/api/logging_splunk_api.rb', line 239

def get_log_splunk_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LoggingSplunkApi.get_log_splunk ...'
  end
  # unbox the parameters from the hash
  service_id = opts[:'service_id']
  version_id = opts[:'version_id']
  logging_splunk_name = opts[:'logging_splunk_name']
  # verify the required parameter 'service_id' is set
  if @api_client.config.client_side_validation && service_id.nil?
    fail ArgumentError, "Missing the required parameter 'service_id' when calling LoggingSplunkApi.get_log_splunk"
  end
  # verify the required parameter 'version_id' is set
  if @api_client.config.client_side_validation && version_id.nil?
    fail ArgumentError, "Missing the required parameter 'version_id' when calling LoggingSplunkApi.get_log_splunk"
  end
  # verify the required parameter 'logging_splunk_name' is set
  if @api_client.config.client_side_validation && logging_splunk_name.nil?
    fail ArgumentError, "Missing the required parameter 'logging_splunk_name' when calling LoggingSplunkApi.get_log_splunk"
  end
  # resource path
  local_var_path = '/service/{service_id}/version/{version_id}/logging/splunk/{logging_splunk_name}'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_id.to_s)).sub('{' + 'logging_splunk_name' + '}', CGI.escape(logging_splunk_name.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'LoggingSplunkResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['token']

  new_options = opts.merge(
    :operation => :"LoggingSplunkApi.get_log_splunk",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LoggingSplunkApi#get_log_splunk\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_log_splunk(opts = {}) ⇒ Array<LoggingSplunkResponse>

List Splunk log endpoints List all of the Splunk logging objects for a particular service and version.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :version_id (Integer) —

    Integer identifying a service version. (required)

Returns:



304
305
306
307
 
# File 'lib/fastly/api/logging_splunk_api.rb', line 304

def list_log_splunk(opts = {})
  data, _status_code, _headers = list_log_splunk_with_http_info(opts)
  data
end

#list_log_splunk_with_http_info(opts = {}) ⇒ Array<(Array<LoggingSplunkResponse>, Integer, Hash)>

List Splunk log endpoints List all of the Splunk logging objects for a particular service and version.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :version_id (Integer) —

    Integer identifying a service version. (required)

Returns:

  • (Array<(Array<LoggingSplunkResponse>, Integer, Hash)>) —

    Array<LoggingSplunkResponse> data, response status code and response headers



314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
 
# File 'lib/fastly/api/logging_splunk_api.rb', line 314

def list_log_splunk_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LoggingSplunkApi.list_log_splunk ...'
  end
  # unbox the parameters from the hash
  service_id = opts[:'service_id']
  version_id = opts[:'version_id']
  # verify the required parameter 'service_id' is set
  if @api_client.config.client_side_validation && service_id.nil?
    fail ArgumentError, "Missing the required parameter 'service_id' when calling LoggingSplunkApi.list_log_splunk"
  end
  # verify the required parameter 'version_id' is set
  if @api_client.config.client_side_validation && version_id.nil?
    fail ArgumentError, "Missing the required parameter 'version_id' when calling LoggingSplunkApi.list_log_splunk"
  end
  # resource path
  local_var_path = '/service/{service_id}/version/{version_id}/logging/splunk'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Array<LoggingSplunkResponse>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['token']

  new_options = opts.merge(
    :operation => :"LoggingSplunkApi.list_log_splunk",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LoggingSplunkApi#list_log_splunk\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_log_splunk(opts = {}) ⇒ LoggingSplunkResponse

Update a Splunk log endpoint Update the Splunk logging object for a particular service and version.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :version_id (Integer) —

    Integer identifying a service version. (required)

  • :logging_splunk_name (String) —

    The name for the real-time logging configuration. (required)

  • :name (String) —

    The name for the real-time logging configuration.

  • :placement (String) —

    Where in the generated VCL the logging call should be placed. If not set, endpoints with &#x60;format_version&#x60; of 2 are placed in &#x60;vcl_log&#x60; and those with &#x60;format_version&#x60; of 1 are placed in &#x60;vcl_deliver&#x60;.

  • :response_condition (String) —

    The name of an existing condition in the configured endpoint, or leave blank to always execute.

  • :format (String) —

    A Fastly [log format string](docs.fastly.com/en/guides/custom-log-formats). (default to ‘%h %l %u %t "%r" %&gt;s %b’)

  • :format_version (Integer) —

    The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in &#x60;vcl_log&#x60; if &#x60;format_version&#x60; is set to &#x60;2&#x60; and in &#x60;vcl_deliver&#x60; if &#x60;format_version&#x60; is set to &#x60;1&#x60;. (default to FORMAT_VERSION::v2)

  • :tls_ca_cert (String) —

    A secure certificate to authenticate a server with. Must be in PEM format. (default to ‘null’)

  • :tls_client_cert (String) —

    The client certificate used to make authenticated requests. Must be in PEM format. (default to ‘null’)

  • :tls_client_key (String) —

    The client private key used to make authenticated requests. Must be in PEM format. (default to ‘null’)

  • :tls_hostname (String) —

    The hostname to verify the server&#39;s certificate. This should be one of the Subject Alternative Name (SAN) fields for the certificate. Common Names (CN) are not supported. (default to ‘null’)

  • :request_max_entries (Integer) —

    The maximum number of logs sent in one request. Defaults &#x60;0&#x60; for unbounded. (default to 0)

  • :request_max_bytes (Integer) —

    The maximum number of bytes sent in one request. Defaults &#x60;0&#x60; for unbounded. (default to 0)

  • :url (String) —

    The URL to post logs to.

  • :token (String) —

    A Splunk token for use in posting logs over HTTP to your collector.

  • :use_tls (LoggingUseTlsString) — default: default to '0'

Returns:



389
390
391
392
 
# File 'lib/fastly/api/logging_splunk_api.rb', line 389

def update_log_splunk(opts = {})
  data, _status_code, _headers = update_log_splunk_with_http_info(opts)
  data
end

#update_log_splunk_with_http_info(opts = {}) ⇒ Array<(LoggingSplunkResponse, Integer, Hash)>

Update a Splunk log endpoint Update the Splunk logging object for a particular service and version.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :version_id (Integer) —

    Integer identifying a service version. (required)

  • :logging_splunk_name (String) —

    The name for the real-time logging configuration. (required)

  • :name (String) —

    The name for the real-time logging configuration.

  • :placement (String) —

    Where in the generated VCL the logging call should be placed. If not set, endpoints with &#x60;format_version&#x60; of 2 are placed in &#x60;vcl_log&#x60; and those with &#x60;format_version&#x60; of 1 are placed in &#x60;vcl_deliver&#x60;.

  • :response_condition (String) —

    The name of an existing condition in the configured endpoint, or leave blank to always execute.

  • :format (String) —

    A Fastly [log format string](docs.fastly.com/en/guides/custom-log-formats). (default to ‘%h %l %u %t "%r" %&gt;s %b’)

  • :format_version (Integer) —

    The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in &#x60;vcl_log&#x60; if &#x60;format_version&#x60; is set to &#x60;2&#x60; and in &#x60;vcl_deliver&#x60; if &#x60;format_version&#x60; is set to &#x60;1&#x60;. (default to FORMAT_VERSION::v2)

  • :tls_ca_cert (String) —

    A secure certificate to authenticate a server with. Must be in PEM format. (default to ‘null’)

  • :tls_client_cert (String) —

    The client certificate used to make authenticated requests. Must be in PEM format. (default to ‘null’)

  • :tls_client_key (String) —

    The client private key used to make authenticated requests. Must be in PEM format. (default to ‘null’)

  • :tls_hostname (String) —

    The hostname to verify the server&#39;s certificate. This should be one of the Subject Alternative Name (SAN) fields for the certificate. Common Names (CN) are not supported. (default to ‘null’)

  • :request_max_entries (Integer) —

    The maximum number of logs sent in one request. Defaults &#x60;0&#x60; for unbounded. (default to 0)

  • :request_max_bytes (Integer) —

    The maximum number of bytes sent in one request. Defaults &#x60;0&#x60; for unbounded. (default to 0)

  • :url (String) —

    The URL to post logs to.

  • :token (String) —

    A Splunk token for use in posting logs over HTTP to your collector.

  • :use_tls (LoggingUseTlsString) — default: default to '0'

Returns:

  • (Array<(LoggingSplunkResponse, Integer, Hash)>) —

    LoggingSplunkResponse data, response status code and response headers



414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
 
# File 'lib/fastly/api/logging_splunk_api.rb', line 414

def update_log_splunk_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LoggingSplunkApi.update_log_splunk ...'
  end
  # unbox the parameters from the hash
  service_id = opts[:'service_id']
  version_id = opts[:'version_id']
  logging_splunk_name = opts[:'logging_splunk_name']
  # verify the required parameter 'service_id' is set
  if @api_client.config.client_side_validation && service_id.nil?
    fail ArgumentError, "Missing the required parameter 'service_id' when calling LoggingSplunkApi.update_log_splunk"
  end
  # verify the required parameter 'version_id' is set
  if @api_client.config.client_side_validation && version_id.nil?
    fail ArgumentError, "Missing the required parameter 'version_id' when calling LoggingSplunkApi.update_log_splunk"
  end
  # verify the required parameter 'logging_splunk_name' is set
  if @api_client.config.client_side_validation && logging_splunk_name.nil?
    fail ArgumentError, "Missing the required parameter 'logging_splunk_name' when calling LoggingSplunkApi.update_log_splunk"
  end
  allowable_values = ["none", "waf_debug", "null"]
  if @api_client.config.client_side_validation && opts[:'placement'] && !allowable_values.include?(opts[:'placement'])
    fail ArgumentError, "invalid value for \"placement\", must be one of #{allowable_values}"
  end
  allowable_values = [1, 2]
  if @api_client.config.client_side_validation && opts[:'format_version'] && !allowable_values.include?(opts[:'format_version'])
    fail ArgumentError, "invalid value for \"format_version\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/service/{service_id}/version/{version_id}/logging/splunk/{logging_splunk_name}'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_id.to_s)).sub('{' + 'logging_splunk_name' + '}', CGI.escape(logging_splunk_name.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['name'] = opts[:'name'] if !opts[:'name'].nil?
  form_params['placement'] = opts[:'placement'] if !opts[:'placement'].nil?
  form_params['response_condition'] = opts[:'response_condition'] if !opts[:'response_condition'].nil?
  form_params['format'] = opts[:'format'] if !opts[:'format'].nil?
  form_params['format_version'] = opts[:'format_version'] if !opts[:'format_version'].nil?
  form_params['tls_ca_cert'] = opts[:'tls_ca_cert'] if !opts[:'tls_ca_cert'].nil?
  form_params['tls_client_cert'] = opts[:'tls_client_cert'] if !opts[:'tls_client_cert'].nil?
  form_params['tls_client_key'] = opts[:'tls_client_key'] if !opts[:'tls_client_key'].nil?
  form_params['tls_hostname'] = opts[:'tls_hostname'] if !opts[:'tls_hostname'].nil?
  form_params['request_max_entries'] = opts[:'request_max_entries'] if !opts[:'request_max_entries'].nil?
  form_params['request_max_bytes'] = opts[:'request_max_bytes'] if !opts[:'request_max_bytes'].nil?
  form_params['url'] = opts[:'url'] if !opts[:'url'].nil?
  form_params['token'] = opts[:'token'] if !opts[:'token'].nil?
  form_params['use_tls'] = opts[:'use_tls'] if !opts[:'use_tls'].nil?

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'LoggingSplunkResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['token']

  new_options = opts.merge(
    :operation => :"LoggingSplunkApi.update_log_splunk",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LoggingSplunkApi#update_log_splunk\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end