Class: Fastly::LoggingBigqueryApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ LoggingBigqueryApi

Returns a new instance of LoggingBigqueryApi.



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

def api_client
  @api_client
end

Instance Method Details

#create_log_bigquery(opts = {}) ⇒ LoggingBigqueryResponse

Create a BigQuery log endpoint Create a BigQuery 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 of the BigQuery logging object. Used as a primary key for API access.

  • :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). Must produce JSON that matches the schema of your BigQuery table.

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

  • :user (String) —

    Your Google Cloud Platform service account email address. The `client_email` field in your service account authentication JSON. Not required if `account_name` is specified.

  • :secret_key (String) —

    Your Google Cloud Platform account secret key. The `private_key` field in your service account authentication JSON. Not required if `account_name` is specified.

  • :account_name (String) —

    The name of the Google Cloud Platform service account associated with the target log collection service. Not required if `user` and `secret_key` are provided.

  • :dataset (String) —

    Your BigQuery dataset.

  • :table (String) —

    Your BigQuery table.

  • :template_suffix (String) —

    BigQuery table name suffix template. Optional.

  • :project_id (String) —

    Your Google Cloud Platform project ID. Required

Returns:



37
38
39
40
 
# File 'lib/fastly/api/logging_bigquery_api.rb', line 37

def create_log_bigquery(opts = {})
  data, _status_code, _headers = create_log_bigquery_with_http_info(opts)
  data
end

#create_log_bigquery_with_http_info(opts = {}) ⇒ Array<(LoggingBigqueryResponse, Integer, Hash)>

Create a BigQuery log endpoint Create a BigQuery 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 of the BigQuery logging object. Used as a primary key for API access.

  • :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). Must produce JSON that matches the schema of your BigQuery table.

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

  • :user (String) —

    Your Google Cloud Platform service account email address. The &#x60;client_email&#x60; field in your service account authentication JSON. Not required if &#x60;account_name&#x60; is specified.

  • :secret_key (String) —

    Your Google Cloud Platform account secret key. The &#x60;private_key&#x60; field in your service account authentication JSON. Not required if &#x60;account_name&#x60; is specified.

  • :account_name (String) —

    The name of the Google Cloud Platform service account associated with the target log collection service. Not required if &#x60;user&#x60; and &#x60;secret_key&#x60; are provided.

  • :dataset (String) —

    Your BigQuery dataset.

  • :table (String) —

    Your BigQuery table.

  • :template_suffix (String) —

    BigQuery table name suffix template. Optional.

  • :project_id (String) —

    Your Google Cloud Platform project ID. Required

Returns:

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

    LoggingBigqueryResponse data, response status code and response headers



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
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/fastly/api/logging_bigquery_api.rb', line 59

def create_log_bigquery_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LoggingBigqueryApi.create_log_bigquery ...'
  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 LoggingBigqueryApi.create_log_bigquery"
  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 LoggingBigqueryApi.create_log_bigquery"
  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/bigquery'.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['user'] = opts[:'user'] if !opts[:'user'].nil?
  form_params['secret_key'] = opts[:'secret_key'] if !opts[:'secret_key'].nil?
  form_params['account_name'] = opts[:'account_name'] if !opts[:'account_name'].nil?
  form_params['dataset'] = opts[:'dataset'] if !opts[:'dataset'].nil?
  form_params['table'] = opts[:'table'] if !opts[:'table'].nil?
  form_params['template_suffix'] = opts[:'template_suffix'] if !opts[:'template_suffix'].nil?
  form_params['project_id'] = opts[:'project_id'] if !opts[:'project_id'].nil?

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

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

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

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

#delete_log_bigquery(opts = {}) ⇒ InlineResponse200

Delete a BigQuery log endpoint Delete a BigQuery 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_bigquery_name (String) —

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

Returns:



145
146
147
148
 
# File 'lib/fastly/api/logging_bigquery_api.rb', line 145

def delete_log_bigquery(opts = {})
  data, _status_code, _headers = delete_log_bigquery_with_http_info(opts)
  data
end

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

Delete a BigQuery log endpoint Delete a BigQuery 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_bigquery_name (String) —

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

Returns:

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

    InlineResponse200 data, response status code and response headers



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
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/fastly/api/logging_bigquery_api.rb', line 156

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

#get_log_bigquery(opts = {}) ⇒ LoggingBigqueryResponse

Get a BigQuery log endpoint Get the details for a BigQuery 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_bigquery_name (String) —

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

Returns:



222
223
224
225
 
# File 'lib/fastly/api/logging_bigquery_api.rb', line 222

def get_log_bigquery(opts = {})
  data, _status_code, _headers = get_log_bigquery_with_http_info(opts)
  data
end

#get_log_bigquery_with_http_info(opts = {}) ⇒ Array<(LoggingBigqueryResponse, Integer, Hash)>

Get a BigQuery log endpoint Get the details for a BigQuery 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_bigquery_name (String) —

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

Returns:

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

    LoggingBigqueryResponse data, response status code and response headers



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
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/fastly/api/logging_bigquery_api.rb', line 233

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

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

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

#list_log_bigquery(opts = {}) ⇒ Array<LoggingBigqueryResponse>

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



298
299
300
301
 
# File 'lib/fastly/api/logging_bigquery_api.rb', line 298

def list_log_bigquery(opts = {})
  data, _status_code, _headers = list_log_bigquery_with_http_info(opts)
  data
end

#list_log_bigquery_with_http_info(opts = {}) ⇒ Array<(Array<LoggingBigqueryResponse>, Integer, Hash)>

List BigQuery log endpoints List all of the BigQuery 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<LoggingBigqueryResponse>, Integer, Hash)>) —

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



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
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
 
# File 'lib/fastly/api/logging_bigquery_api.rb', line 308

def list_log_bigquery_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LoggingBigqueryApi.list_log_bigquery ...'
  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 LoggingBigqueryApi.list_log_bigquery"
  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 LoggingBigqueryApi.list_log_bigquery"
  end
  # resource path
  local_var_path = '/service/{service_id}/version/{version_id}/logging/bigquery'.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<LoggingBigqueryResponse>'

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

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

#update_log_bigquery(opts = {}) ⇒ LoggingBigqueryResponse

Update a BigQuery log endpoint Update a BigQuery 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_bigquery_name (String) —

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

  • :name (String) —

    The name of the BigQuery logging object. Used as a primary key for API access.

  • :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). Must produce JSON that matches the schema of your BigQuery table.

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

  • :user (String) —

    Your Google Cloud Platform service account email address. The &#x60;client_email&#x60; field in your service account authentication JSON. Not required if &#x60;account_name&#x60; is specified.

  • :secret_key (String) —

    Your Google Cloud Platform account secret key. The &#x60;private_key&#x60; field in your service account authentication JSON. Not required if &#x60;account_name&#x60; is specified.

  • :account_name (String) —

    The name of the Google Cloud Platform service account associated with the target log collection service. Not required if &#x60;user&#x60; and &#x60;secret_key&#x60; are provided.

  • :dataset (String) —

    Your BigQuery dataset.

  • :table (String) —

    Your BigQuery table.

  • :template_suffix (String) —

    BigQuery table name suffix template. Optional.

  • :project_id (String) —

    Your Google Cloud Platform project ID. Required

Returns:



381
382
383
384
 
# File 'lib/fastly/api/logging_bigquery_api.rb', line 381

def update_log_bigquery(opts = {})
  data, _status_code, _headers = update_log_bigquery_with_http_info(opts)
  data
end

#update_log_bigquery_with_http_info(opts = {}) ⇒ Array<(LoggingBigqueryResponse, Integer, Hash)>

Update a BigQuery log endpoint Update a BigQuery 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_bigquery_name (String) —

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

  • :name (String) —

    The name of the BigQuery logging object. Used as a primary key for API access.

  • :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). Must produce JSON that matches the schema of your BigQuery table.

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

  • :user (String) —

    Your Google Cloud Platform service account email address. The &#x60;client_email&#x60; field in your service account authentication JSON. Not required if &#x60;account_name&#x60; is specified.

  • :secret_key (String) —

    Your Google Cloud Platform account secret key. The &#x60;private_key&#x60; field in your service account authentication JSON. Not required if &#x60;account_name&#x60; is specified.

  • :account_name (String) —

    The name of the Google Cloud Platform service account associated with the target log collection service. Not required if &#x60;user&#x60; and &#x60;secret_key&#x60; are provided.

  • :dataset (String) —

    Your BigQuery dataset.

  • :table (String) —

    Your BigQuery table.

  • :template_suffix (String) —

    BigQuery table name suffix template. Optional.

  • :project_id (String) —

    Your Google Cloud Platform project ID. Required

Returns:

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

    LoggingBigqueryResponse data, response status code and response headers



404
405
406
407
408
409
410
411
412
413
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
 
# File 'lib/fastly/api/logging_bigquery_api.rb', line 404

def update_log_bigquery_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LoggingBigqueryApi.update_log_bigquery ...'
  end
  # unbox the parameters from the hash
  service_id = opts[:'service_id']
  version_id = opts[:'version_id']
  logging_bigquery_name = opts[:'logging_bigquery_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 LoggingBigqueryApi.update_log_bigquery"
  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 LoggingBigqueryApi.update_log_bigquery"
  end
  # verify the required parameter 'logging_bigquery_name' is set
  if @api_client.config.client_side_validation && logging_bigquery_name.nil?
    fail ArgumentError, "Missing the required parameter 'logging_bigquery_name' when calling LoggingBigqueryApi.update_log_bigquery"
  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/bigquery/{logging_bigquery_name}'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_id.to_s)).sub('{' + 'logging_bigquery_name' + '}', CGI.escape(logging_bigquery_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['user'] = opts[:'user'] if !opts[:'user'].nil?
  form_params['secret_key'] = opts[:'secret_key'] if !opts[:'secret_key'].nil?
  form_params['account_name'] = opts[:'account_name'] if !opts[:'account_name'].nil?
  form_params['dataset'] = opts[:'dataset'] if !opts[:'dataset'].nil?
  form_params['table'] = opts[:'table'] if !opts[:'table'].nil?
  form_params['template_suffix'] = opts[:'template_suffix'] if !opts[:'template_suffix'].nil?
  form_params['project_id'] = opts[:'project_id'] if !opts[:'project_id'].nil?

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

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

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

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