Class: Fastly::LoggingKafkaApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ LoggingKafkaApi

Returns a new instance of LoggingKafkaApi.



17
18
19
 
# File 'lib/fastly/api/logging_kafka_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_kafka_api.rb', line 15

def api_client
  @api_client
end

Instance Method Details

#create_log_kafka(opts = {}) ⇒ LoggingKafkaResponsePost

Create a Kafka log endpoint Create a Kafka logging endpoint 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](www.fastly.com/documentation/guides/integrations/streaming-logs/custom-log-formats/). (default to ‘%h %l %u %t "%r" %>s %b’)

  • :log_processing_region (String) —

    The geographic region where the logs will be processed before streaming. Valid values are `us`, `eu`, and `none` for global. (default to ‘none’)

  • :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’)

  • :topic (String) —

    The Kafka topic to send logs to. Required.

  • :brokers (String) —

    A comma-separated list of IP addresses or hostnames of Kafka brokers. Required.

  • :compression_codec (String) —

    The codec used for compression of your logs.

  • :required_acks (Integer) —

    The number of acknowledgements a leader must receive before a write is considered successful. (default to 1)

  • :request_max_bytes (Integer) —

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

  • :parse_log_keyvals (Boolean) —

    Enables parsing of key=value tuples from the beginning of a logline, turning them into [record headers](cwiki.apache.org/confluence/display/KAFKA/KIP-82+-+Add+Record+Headers).

  • :auth_method (String) —

    SASL authentication method.

  • :user (String) —

    SASL user.

  • :password (String) —

    SASL password.

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

Returns:



45
46
47
48
 
# File 'lib/fastly/api/logging_kafka_api.rb', line 45

def create_log_kafka(opts = {})
  data, _status_code, _headers = create_log_kafka_with_http_info(opts)
  data
end

#create_log_kafka_with_http_info(opts = {}) ⇒ Array<(LoggingKafkaResponsePost, Integer, Hash)>

Create a Kafka log endpoint Create a Kafka logging endpoint 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](www.fastly.com/documentation/guides/integrations/streaming-logs/custom-log-formats/). (default to ‘%h %l %u %t "%r" %&gt;s %b’)

  • :log_processing_region (String) —

    The geographic region where the logs will be processed before streaming. Valid values are &#x60;us&#x60;, &#x60;eu&#x60;, and &#x60;none&#x60; for global. (default to ‘none’)

  • :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’)

  • :topic (String) —

    The Kafka topic to send logs to. Required.

  • :brokers (String) —

    A comma-separated list of IP addresses or hostnames of Kafka brokers. Required.

  • :compression_codec (String) —

    The codec used for compression of your logs.

  • :required_acks (Integer) —

    The number of acknowledgements a leader must receive before a write is considered successful. (default to 1)

  • :request_max_bytes (Integer) —

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

  • :parse_log_keyvals (Boolean) —

    Enables parsing of key&#x3D;value tuples from the beginning of a logline, turning them into [record headers](cwiki.apache.org/confluence/display/KAFKA/KIP-82+-+Add+Record+Headers).

  • :auth_method (String) —

    SASL authentication method.

  • :user (String) —

    SASL user.

  • :password (String) —

    SASL password.

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

Returns:

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

    LoggingKafkaResponsePost data, response status code and response headers



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
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
171
172
173
174
175
176
177
 
# File 'lib/fastly/api/logging_kafka_api.rb', line 75

def create_log_kafka_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LoggingKafkaApi.create_log_kafka ...'
  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 LoggingKafkaApi.create_log_kafka"
  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 LoggingKafkaApi.create_log_kafka"
  end
  allowable_values = ["none", "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 = ["none", "eu", "us"]
  if @api_client.config.client_side_validation && opts[:'log_processing_region'] && !allowable_values.include?(opts[:'log_processing_region'])
    fail ArgumentError, "invalid value for \"log_processing_region\", 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
  allowable_values = ["gzip", "snappy", "lz4", "null"]
  if @api_client.config.client_side_validation && opts[:'compression_codec'] && !allowable_values.include?(opts[:'compression_codec'])
    fail ArgumentError, "invalid value for \"compression_codec\", must be one of #{allowable_values}"
  end
  allowable_values = [1, 0, -1]
  if @api_client.config.client_side_validation && opts[:'required_acks'] && !allowable_values.include?(opts[:'required_acks'])
    fail ArgumentError, "invalid value for \"required_acks\", must be one of #{allowable_values}"
  end
  allowable_values = ["plain", "scram-sha-256", "scram-sha-512"]
  if @api_client.config.client_side_validation && opts[:'auth_method'] && !allowable_values.include?(opts[:'auth_method'])
    fail ArgumentError, "invalid value for \"auth_method\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/service/{service_id}/version/{version_id}/logging/kafka'.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['log_processing_region'] = opts[:'log_processing_region'] if !opts[:'log_processing_region'].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['topic'] = opts[:'topic'] if !opts[:'topic'].nil?
  form_params['brokers'] = opts[:'brokers'] if !opts[:'brokers'].nil?
  form_params['compression_codec'] = opts[:'compression_codec'] if !opts[:'compression_codec'].nil?
  form_params['required_acks'] = opts[:'required_acks'] if !opts[:'required_acks'].nil?
  form_params['request_max_bytes'] = opts[:'request_max_bytes'] if !opts[:'request_max_bytes'].nil?
  form_params['parse_log_keyvals'] = opts[:'parse_log_keyvals'] if !opts[:'parse_log_keyvals'].nil?
  form_params['auth_method'] = opts[:'auth_method'] if !opts[:'auth_method'].nil?
  form_params['user'] = opts[:'user'] if !opts[:'user'].nil?
  form_params['password'] = opts[:'password'] if !opts[:'password'].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] || 'LoggingKafkaResponsePost'

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

  new_options = opts.merge(
    :operation => :"LoggingKafkaApi.create_log_kafka",
    :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: LoggingKafkaApi#create_log_kafka\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_log_kafka(opts = {}) ⇒ InlineResponse200

Delete the Kafka log endpoint Delete the Kafka logging endpoint 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_kafka_name (String) —

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

Returns:



185
186
187
188
 
# File 'lib/fastly/api/logging_kafka_api.rb', line 185

def delete_log_kafka(opts = {})
  data, _status_code, _headers = delete_log_kafka_with_http_info(opts)
  data
end

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

Delete the Kafka log endpoint Delete the Kafka logging endpoint 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_kafka_name (String) —

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

Returns:

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

    InlineResponse200 data, response status code and response headers



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
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/fastly/api/logging_kafka_api.rb', line 196

def delete_log_kafka_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LoggingKafkaApi.delete_log_kafka ...'
  end
  # unbox the parameters from the hash
  service_id = opts[:'service_id']
  version_id = opts[:'version_id']
  logging_kafka_name = opts[:'logging_kafka_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 LoggingKafkaApi.delete_log_kafka"
  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 LoggingKafkaApi.delete_log_kafka"
  end
  # verify the required parameter 'logging_kafka_name' is set
  if @api_client.config.client_side_validation && logging_kafka_name.nil?
    fail ArgumentError, "Missing the required parameter 'logging_kafka_name' when calling LoggingKafkaApi.delete_log_kafka"
  end
  # resource path
  local_var_path = '/service/{service_id}/version/{version_id}/logging/kafka/{logging_kafka_name}'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_id.to_s)).sub('{' + 'logging_kafka_name' + '}', CGI.escape(logging_kafka_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 => :"LoggingKafkaApi.delete_log_kafka",
    :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: LoggingKafkaApi#delete_log_kafka\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_log_kafka(opts = {}) ⇒ LoggingKafkaResponse

Get a Kafka log endpoint Get the Kafka logging endpoint 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_kafka_name (String) —

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

Returns:



262
263
264
265
 
# File 'lib/fastly/api/logging_kafka_api.rb', line 262

def get_log_kafka(opts = {})
  data, _status_code, _headers = get_log_kafka_with_http_info(opts)
  data
end

#get_log_kafka_with_http_info(opts = {}) ⇒ Array<(LoggingKafkaResponse, Integer, Hash)>

Get a Kafka log endpoint Get the Kafka logging endpoint 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_kafka_name (String) —

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

Returns:

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

    LoggingKafkaResponse data, response status code and response headers



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
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
 
# File 'lib/fastly/api/logging_kafka_api.rb', line 273

def get_log_kafka_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LoggingKafkaApi.get_log_kafka ...'
  end
  # unbox the parameters from the hash
  service_id = opts[:'service_id']
  version_id = opts[:'version_id']
  logging_kafka_name = opts[:'logging_kafka_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 LoggingKafkaApi.get_log_kafka"
  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 LoggingKafkaApi.get_log_kafka"
  end
  # verify the required parameter 'logging_kafka_name' is set
  if @api_client.config.client_side_validation && logging_kafka_name.nil?
    fail ArgumentError, "Missing the required parameter 'logging_kafka_name' when calling LoggingKafkaApi.get_log_kafka"
  end
  # resource path
  local_var_path = '/service/{service_id}/version/{version_id}/logging/kafka/{logging_kafka_name}'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_id.to_s)).sub('{' + 'logging_kafka_name' + '}', CGI.escape(logging_kafka_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] || 'LoggingKafkaResponse'

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

  new_options = opts.merge(
    :operation => :"LoggingKafkaApi.get_log_kafka",
    :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: LoggingKafkaApi#get_log_kafka\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_log_kafka(opts = {}) ⇒ Array<LoggingKafkaResponse>

List Kafka log endpoints List all of the Kafka logging endpoints 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:



338
339
340
341
 
# File 'lib/fastly/api/logging_kafka_api.rb', line 338

def list_log_kafka(opts = {})
  data, _status_code, _headers = list_log_kafka_with_http_info(opts)
  data
end

#list_log_kafka_with_http_info(opts = {}) ⇒ Array<(Array<LoggingKafkaResponse>, Integer, Hash)>

List Kafka log endpoints List all of the Kafka logging endpoints 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<LoggingKafkaResponse>, Integer, Hash)>) —

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



348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
 
# File 'lib/fastly/api/logging_kafka_api.rb', line 348

def list_log_kafka_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LoggingKafkaApi.list_log_kafka ...'
  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 LoggingKafkaApi.list_log_kafka"
  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 LoggingKafkaApi.list_log_kafka"
  end
  # resource path
  local_var_path = '/service/{service_id}/version/{version_id}/logging/kafka'.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<LoggingKafkaResponse>'

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

  new_options = opts.merge(
    :operation => :"LoggingKafkaApi.list_log_kafka",
    :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: LoggingKafkaApi#list_log_kafka\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_log_kafka(opts = {}) ⇒ LoggingKafkaResponse

Update the Kafka log endpoint Update the Kafka logging endpoint 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_kafka_name (String) —

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

Returns:



409
410
411
412
 
# File 'lib/fastly/api/logging_kafka_api.rb', line 409

def update_log_kafka(opts = {})
  data, _status_code, _headers = update_log_kafka_with_http_info(opts)
  data
end

#update_log_kafka_with_http_info(opts = {}) ⇒ Array<(LoggingKafkaResponse, Integer, Hash)>

Update the Kafka log endpoint Update the Kafka logging endpoint 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_kafka_name (String) —

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

Returns:

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

    LoggingKafkaResponse data, response status code and response headers



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
 
# File 'lib/fastly/api/logging_kafka_api.rb', line 420

def update_log_kafka_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LoggingKafkaApi.update_log_kafka ...'
  end
  # unbox the parameters from the hash
  service_id = opts[:'service_id']
  version_id = opts[:'version_id']
  logging_kafka_name = opts[:'logging_kafka_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 LoggingKafkaApi.update_log_kafka"
  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 LoggingKafkaApi.update_log_kafka"
  end
  # verify the required parameter 'logging_kafka_name' is set
  if @api_client.config.client_side_validation && logging_kafka_name.nil?
    fail ArgumentError, "Missing the required parameter 'logging_kafka_name' when calling LoggingKafkaApi.update_log_kafka"
  end
  # resource path
  local_var_path = '/service/{service_id}/version/{version_id}/logging/kafka/{logging_kafka_name}'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_id.to_s)).sub('{' + 'logging_kafka_name' + '}', CGI.escape(logging_kafka_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] || {}

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

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

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

  new_options = opts.merge(
    :operation => :"LoggingKafkaApi.update_log_kafka",
    :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: LoggingKafkaApi#update_log_kafka\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end