Class: Fastly::LoggingKinesisApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ LoggingKinesisApi

Returns a new instance of LoggingKinesisApi.



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

def api_client
  @api_client
end

Instance Method Details

#create_log_kinesis(opts = {}) ⇒ LoggingKinesisResponse

Create an Amazon Kinesis log endpoint Create an Amazon Kinesis Data Streams 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 (LoggingPlacement)
  • :format_version (LoggingFormatVersion) — default: default to 2
  • :format (String) —

    A Fastly [log format string](docs.fastly.com/en/guides/custom-log-formats). Must produce valid JSON that Kinesis can ingest. (default to ‘"timestamp":"%{begin:%Y-%m-%dT%H:%M:%St","time_elapsed":"%Fastly::LoggingKinesisApi.timetime.elapsedtime.elapsed.usecV","is_tls":"%\"true\", \"false\")V","client_ip":"%Fastly::LoggingKinesisApi.reqreq.httpreq.http.Fastly-Client-IPV","geo_city":"%Fastly::LoggingKinesisApi.clientclient.geoclient.geo.cityV","geo_country_code":"%Fastly::LoggingKinesisApi.clientclient.geoclient.geo.country_codeV","request":"%Fastly::LoggingKinesisApi.reqreq.requestV","host":"%Fastly::LoggingKinesisApi.reqreq.httpreq.http.Fastly-Orig-HostV","url":"%Fastly::LoggingKinesisApi.jsonjson.escape(reqjson.escape(req.url)V","request_referer":"%Fastly::LoggingKinesisApi.jsonjson.escape(reqjson.escape(req.httpjson.escape(req.http.Referer)V","request_user_agent":"%Fastly::LoggingKinesisApi.jsonjson.escape(reqjson.escape(req.httpjson.escape(req.http.User-Agent)V","request_accept_language":"%Fastly::LoggingKinesisApi.jsonjson.escape(reqjson.escape(req.httpjson.escape(req.http.Accept-Language)V","request_accept_charset":"%Fastly::LoggingKinesisApi.jsonjson.escape(reqjson.escape(req.httpjson.escape(req.http.Accept-Charset)V","cache_status":"%{regsub(fastly_info.state, \"^(HIT-(SYNTH)|(HITPASS|HIT|MISS|PASS|ERROR|PIPE)).*\", \"\\2\\3\") }V"}’)

  • :topic (String) —

    The Amazon Kinesis stream to send logs to. Required.

  • :region (AwsRegion)
  • :secret_key (String) —

    The secret key associated with the target Amazon Kinesis stream. Not required if `iam_role` is specified.

  • :access_key (String) —

    The access key associated with the target Amazon Kinesis stream. Not required if `iam_role` is specified.

  • :iam_role (String) —

    The ARN for an IAM role granting Fastly access to the target Amazon Kinesis stream. Not required if `access_key` and `secret_key` are provided.

Returns:



34
35
36
37
 
# File 'lib/fastly/api/logging_kinesis_api.rb', line 34

def create_log_kinesis(opts = {})
  data, _status_code, _headers = create_log_kinesis_with_http_info(opts)
  data
end

#create_log_kinesis_with_http_info(opts = {}) ⇒ Array<(LoggingKinesisResponse, Integer, Hash)>

Create an Amazon Kinesis log endpoint Create an Amazon Kinesis Data Streams 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 (LoggingPlacement)
  • :format_version (LoggingFormatVersion) — default: default to 2
  • :format (String) —

    A Fastly [log format string](docs.fastly.com/en/guides/custom-log-formats). Must produce valid JSON that Kinesis can ingest. (default to ‘"timestamp":"%{begin:%Y-%m-%dT%H:%M:%St","time_elapsed":"%Fastly::LoggingKinesisApi.timetime.elapsedtime.elapsed.usecV","is_tls":"%\"true\", \"false\")V","client_ip":"%Fastly::LoggingKinesisApi.reqreq.httpreq.http.Fastly-Client-IPV","geo_city":"%Fastly::LoggingKinesisApi.clientclient.geoclient.geo.cityV","geo_country_code":"%Fastly::LoggingKinesisApi.clientclient.geoclient.geo.country_codeV","request":"%Fastly::LoggingKinesisApi.reqreq.requestV","host":"%Fastly::LoggingKinesisApi.reqreq.httpreq.http.Fastly-Orig-HostV","url":"%Fastly::LoggingKinesisApi.jsonjson.escape(reqjson.escape(req.url)V","request_referer":"%Fastly::LoggingKinesisApi.jsonjson.escape(reqjson.escape(req.httpjson.escape(req.http.Referer)V","request_user_agent":"%Fastly::LoggingKinesisApi.jsonjson.escape(reqjson.escape(req.httpjson.escape(req.http.User-Agent)V","request_accept_language":"%Fastly::LoggingKinesisApi.jsonjson.escape(reqjson.escape(req.httpjson.escape(req.http.Accept-Language)V","request_accept_charset":"%Fastly::LoggingKinesisApi.jsonjson.escape(reqjson.escape(req.httpjson.escape(req.http.Accept-Charset)V","cache_status":"%{regsub(fastly_info.state, \"^(HIT-(SYNTH)|(HITPASS|HIT|MISS|PASS|ERROR|PIPE)).*\", \"\\2\\3\") }V"}’)

  • :topic (String) —

    The Amazon Kinesis stream to send logs to. Required.

  • :region (AwsRegion)
  • :secret_key (String) —

    The secret key associated with the target Amazon Kinesis stream. Not required if &#x60;iam_role&#x60; is specified.

  • :access_key (String) —

    The access key associated with the target Amazon Kinesis stream. Not required if &#x60;iam_role&#x60; is specified.

  • :iam_role (String) —

    The ARN for an IAM role granting Fastly access to the target Amazon Kinesis stream. Not required if &#x60;access_key&#x60; and &#x60;secret_key&#x60; are provided.

Returns:

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

    LoggingKinesisResponse data, response status code and response headers



53
54
55
56
57
58
59
60
61
62
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
 
# File 'lib/fastly/api/logging_kinesis_api.rb', line 53

def create_log_kinesis_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LoggingKinesisApi.create_log_kinesis ...'
  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 LoggingKinesisApi.create_log_kinesis"
  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 LoggingKinesisApi.create_log_kinesis"
  end
  # resource path
  local_var_path = '/service/{service_id}/version/{version_id}/logging/kinesis'.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['format_version'] = opts[:'format_version'] if !opts[:'format_version'].nil?
  form_params['format'] = opts[:'format'] if !opts[:'format'].nil?
  form_params['topic'] = opts[:'topic'] if !opts[:'topic'].nil?
  form_params['region'] = opts[:'region'] if !opts[:'region'].nil?
  form_params['secret_key'] = opts[:'secret_key'] if !opts[:'secret_key'].nil?
  form_params['access_key'] = opts[:'access_key'] if !opts[:'access_key'].nil?
  form_params['iam_role'] = opts[:'iam_role'] if !opts[:'iam_role'].nil?

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

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

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

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

#delete_log_kinesis(opts = {}) ⇒ InlineResponse200

Delete the Amazon Kinesis log endpoint Delete an Amazon Kinesis Data Streams 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_kinesis_name (String) —

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

Returns:



128
129
130
131
 
# File 'lib/fastly/api/logging_kinesis_api.rb', line 128

def delete_log_kinesis(opts = {})
  data, _status_code, _headers = delete_log_kinesis_with_http_info(opts)
  data
end

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

Delete the Amazon Kinesis log endpoint Delete an Amazon Kinesis Data Streams 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_kinesis_name (String) —

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

Returns:

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

    InlineResponse200 data, response status code and response headers



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
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/fastly/api/logging_kinesis_api.rb', line 139

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

#get_log_kinesis(opts = {}) ⇒ LoggingKinesisResponse

Get an Amazon Kinesis log endpoint Get the details for an Amazon Kinesis Data Streams 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_kinesis_name (String) —

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

Returns:



205
206
207
208
 
# File 'lib/fastly/api/logging_kinesis_api.rb', line 205

def get_log_kinesis(opts = {})
  data, _status_code, _headers = get_log_kinesis_with_http_info(opts)
  data
end

#get_log_kinesis_with_http_info(opts = {}) ⇒ Array<(LoggingKinesisResponse, Integer, Hash)>

Get an Amazon Kinesis log endpoint Get the details for an Amazon Kinesis Data Streams 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_kinesis_name (String) —

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

Returns:

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

    LoggingKinesisResponse data, response status code and response headers



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
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/fastly/api/logging_kinesis_api.rb', line 216

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

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

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

#list_log_kinesis(opts = {}) ⇒ Array<LoggingKinesisResponse>

List Amazon Kinesis log endpoints List all of the Amazon Kinesis Data Streams 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:



281
282
283
284
 
# File 'lib/fastly/api/logging_kinesis_api.rb', line 281

def list_log_kinesis(opts = {})
  data, _status_code, _headers = list_log_kinesis_with_http_info(opts)
  data
end

#list_log_kinesis_with_http_info(opts = {}) ⇒ Array<(Array<LoggingKinesisResponse>, Integer, Hash)>

List Amazon Kinesis log endpoints List all of the Amazon Kinesis Data Streams 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<LoggingKinesisResponse>, Integer, Hash)>) —

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



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
332
333
334
335
336
337
338
339
340
341
342
343
344
 
# File 'lib/fastly/api/logging_kinesis_api.rb', line 291

def list_log_kinesis_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LoggingKinesisApi.list_log_kinesis ...'
  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 LoggingKinesisApi.list_log_kinesis"
  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 LoggingKinesisApi.list_log_kinesis"
  end
  # resource path
  local_var_path = '/service/{service_id}/version/{version_id}/logging/kinesis'.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<LoggingKinesisResponse>'

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

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