Class: DatadogAPIClient::V2::GCPIntegrationAPI

Inherits:
Object
  • Object
show all
Defined in:
lib/datadog_api_client/v2/api/gcp_integration_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = DatadogAPIClient::APIClient.default) ⇒ GCPIntegrationAPI

Returns a new instance of GCPIntegrationAPI.



22
23
24
 
# File 'lib/datadog_api_client/v2/api/gcp_integration_api.rb', line 22

def initialize(api_client = DatadogAPIClient::APIClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



20
21
22
 
# File 'lib/datadog_api_client/v2/api/gcp_integration_api.rb', line 20

def api_client
  @api_client
end

Instance Method Details

#create_gcpsts_account(body, opts = {}) ⇒ Object

Create a new entry for your service account.

See Also:



29
30
31
32
 
# File 'lib/datadog_api_client/v2/api/gcp_integration_api.rb', line 29

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

#create_gcpsts_account_with_http_info(body, opts = {}) ⇒ Array<(GCPSTSServiceAccountResponse, Integer, Hash)>

Create a new entry for your service account.

Create a new entry within Datadog for your STS enabled service account.

Parameters:

Returns:



41
42
43
44
45
46
47
48
49
50
51
52
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
 
# File 'lib/datadog_api_client/v2/api/gcp_integration_api.rb', line 41

def (body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GCPIntegrationAPI.create_gcpsts_account ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling GCPIntegrationAPI.create_gcpsts_account"
  end
  # resource path
  local_var_path = '/api/v2/integration/gcp/accounts'

  # 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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

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

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :create_gcpsts_account,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

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

#delete_gcpsts_account(account_id, opts = {}) ⇒ Object

Delete an STS enabled GCP Account.

See Also:



96
97
98
99
 
# File 'lib/datadog_api_client/v2/api/gcp_integration_api.rb', line 96

def (, opts = {})
  (, opts)
  nil
end

#delete_gcpsts_account_with_http_info(account_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete an STS enabled GCP Account.

Delete an STS enabled GCP account from within Datadog.

Parameters:

  • account_id (String) —

    Your GCP STS enabled service account's unique ID.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
 
# File 'lib/datadog_api_client/v2/api/gcp_integration_api.rb', line 108

def (, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GCPIntegrationAPI.delete_gcpsts_account ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling GCPIntegrationAPI.delete_gcpsts_account"
  end
  # resource path
  local_var_path = '/api/v2/integration/gcp/accounts/{account_id}'.sub('{account_id}', CGI.escape(.to_s).gsub('%2F', '/'))

  # 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(['*/*'])

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

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

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :delete_gcpsts_account,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

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

#get_gcpsts_delegate(opts = {}) ⇒ Object

List delegate account.

See Also:



161
162
163
164
 
# File 'lib/datadog_api_client/v2/api/gcp_integration_api.rb', line 161

def get_gcpsts_delegate(opts = {})
  data, _status_code, _headers = get_gcpsts_delegate_with_http_info(opts)
  data
end

#get_gcpsts_delegate_with_http_info(opts = {}) ⇒ Array<(GCPSTSDelegateAccountResponse, Integer, Hash)>

List delegate account.

List your Datadog-GCP STS delegate account configured in your Datadog account.

Parameters:

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

    the optional parameters

Returns:



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
 
# File 'lib/datadog_api_client/v2/api/gcp_integration_api.rb', line 172

def get_gcpsts_delegate_with_http_info(opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GCPIntegrationAPI.get_gcpsts_delegate ...'
  end
  # resource path
  local_var_path = '/api/v2/integration/gcp/sts_delegate'

  # 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] || 'GCPSTSDelegateAccountResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :get_gcpsts_delegate,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

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

#list_gcpsts_accounts(opts = {}) ⇒ Object

List all GCP STS-enabled service accounts.

See Also:



221
222
223
224
 
# File 'lib/datadog_api_client/v2/api/gcp_integration_api.rb', line 221

def list_gcpsts_accounts(opts = {})
  data, _status_code, _headers = list_gcpsts_accounts_with_http_info(opts)
  data
end

#list_gcpsts_accounts_with_http_info(opts = {}) ⇒ Array<(GCPSTSServiceAccountsResponse, Integer, Hash)>

List all GCP STS-enabled service accounts.

List all GCP STS-enabled service accounts configured in your Datadog account.

Parameters:

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

    the optional parameters

Returns:



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
275
276
 
# File 'lib/datadog_api_client/v2/api/gcp_integration_api.rb', line 232

def list_gcpsts_accounts_with_http_info(opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GCPIntegrationAPI.list_gcpsts_accounts ...'
  end
  # resource path
  local_var_path = '/api/v2/integration/gcp/accounts'

  # 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] || 'GCPSTSServiceAccountsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :list_gcpsts_accounts,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

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

#make_gcpsts_delegate(opts = {}) ⇒ Object

Create a Datadog GCP principal.

See Also:



281
282
283
284
 
# File 'lib/datadog_api_client/v2/api/gcp_integration_api.rb', line 281

def make_gcpsts_delegate(opts = {})
  data, _status_code, _headers = make_gcpsts_delegate_with_http_info(opts)
  data
end

#make_gcpsts_delegate_with_http_info(opts = {}) ⇒ Array<(GCPSTSDelegateAccountResponse, Integer, Hash)>

Create a Datadog GCP principal.

Create a Datadog GCP principal.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (Object) —

    Create a delegate service account within Datadog.

Returns:



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
 
# File 'lib/datadog_api_client/v2/api/gcp_integration_api.rb', line 293

def make_gcpsts_delegate_with_http_info(opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GCPIntegrationAPI.make_gcpsts_delegate ...'
  end
  # resource path
  local_var_path = '/api/v2/integration/gcp/sts_delegate'

  # 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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'body'])

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

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :make_gcpsts_delegate,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

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

#update_gcpsts_account(account_id, body, opts = {}) ⇒ Object

Update STS Service Account.

See Also:



344
345
346
347
 
# File 'lib/datadog_api_client/v2/api/gcp_integration_api.rb', line 344

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

#update_gcpsts_account_with_http_info(account_id, body, opts = {}) ⇒ Array<(GCPSTSServiceAccountResponse, Integer, Hash)>

Update STS Service Account.

Update an STS enabled service account.

Parameters:

  • account_id (String) —

    Your GCP STS enabled service account's unique ID.

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

    the optional parameters

Returns:



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
402
403
404
405
406
407
408
409
410
411
 
# File 'lib/datadog_api_client/v2/api/gcp_integration_api.rb', line 357

def (, body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GCPIntegrationAPI.update_gcpsts_account ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling GCPIntegrationAPI.update_gcpsts_account"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling GCPIntegrationAPI.update_gcpsts_account"
  end
  # resource path
  local_var_path = '/api/v2/integration/gcp/accounts/{account_id}'.sub('{account_id}', CGI.escape(.to_s).gsub('%2F', '/'))

  # 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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

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

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :update_gcpsts_account,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

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