Class: DatadogAPIClient::V2::ActionConnectionAPI

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of ActionConnectionAPI.



22
23
24
 
# File 'lib/datadog_api_client/v2/api/action_connection_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/action_connection_api.rb', line 20

def api_client
  @api_client
end

Instance Method Details

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

Create a new Action Connection.

See Also:



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

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

#create_action_connection_with_http_info(body, opts = {}) ⇒ Array<(CreateActionConnectionResponse, Integer, Hash)>

Create a new Action Connection.

Create a new Action Connection

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/action_connection_api.rb', line 41

def create_action_connection_with_http_info(body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ActionConnectionAPI.create_action_connection ...'
  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 ActionConnectionAPI.create_action_connection"
  end
  # resource path
  local_var_path = '/api/v2/actions/connections'

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

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

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

#delete_action_connection(connection_id, opts = {}) ⇒ Object

Delete an existing Action Connection.

See Also:



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

def delete_action_connection(connection_id, opts = {})
  delete_action_connection_with_http_info(connection_id, opts)
  nil
end

#delete_action_connection_with_http_info(connection_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete an existing Action Connection.

Delete an existing Action Connection

Parameters:

  • connection_id (String) —

    The ID of the action connection

  • 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/action_connection_api.rb', line 108

def delete_action_connection_with_http_info(connection_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ActionConnectionAPI.delete_action_connection ...'
  end
  # verify the required parameter 'connection_id' is set
  if @api_client.config.client_side_validation && connection_id.nil?
    fail ArgumentError, "Missing the required parameter 'connection_id' when calling ActionConnectionAPI.delete_action_connection"
  end
  # resource path
  local_var_path = '/api/v2/actions/connections/{connection_id}'.sub('{connection_id}', CGI.escape(connection_id.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_action_connection,
    :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: ActionConnectionAPI#delete_action_connection\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_action_connection(connection_id, opts = {}) ⇒ Object

Get an existing Action Connection.

See Also:



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

def get_action_connection(connection_id, opts = {})
  data, _status_code, _headers = get_action_connection_with_http_info(connection_id, opts)
  data
end

#get_action_connection_with_http_info(connection_id, opts = {}) ⇒ Array<(GetActionConnectionResponse, Integer, Hash)>

Get an existing Action Connection.

Get an existing Action Connection

Parameters:

  • connection_id (String) —

    The ID of the action connection

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

    the optional parameters

Returns:

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

    GetActionConnectionResponse data, response status code and response headers



173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/datadog_api_client/v2/api/action_connection_api.rb', line 173

def get_action_connection_with_http_info(connection_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ActionConnectionAPI.get_action_connection ...'
  end
  # verify the required parameter 'connection_id' is set
  if @api_client.config.client_side_validation && connection_id.nil?
    fail ArgumentError, "Missing the required parameter 'connection_id' when calling ActionConnectionAPI.get_action_connection"
  end
  # resource path
  local_var_path = '/api/v2/actions/connections/{connection_id}'.sub('{connection_id}', CGI.escape(connection_id.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'])

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

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

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

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

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

#update_action_connection(connection_id, body, opts = {}) ⇒ Object

Update an existing Action Connection.

See Also:



226
227
228
229
 
# File 'lib/datadog_api_client/v2/api/action_connection_api.rb', line 226

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

#update_action_connection_with_http_info(connection_id, body, opts = {}) ⇒ Array<(UpdateActionConnectionResponse, Integer, Hash)>

Update an existing Action Connection.

Update an existing Action Connection

Parameters:

  • connection_id (String) —

    The ID of the action connection

  • body (UpdateActionConnectionRequest) —

    Update an existing Action Connection request body

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

    the optional parameters

Returns:



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

def update_action_connection_with_http_info(connection_id, body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ActionConnectionAPI.update_action_connection ...'
  end
  # verify the required parameter 'connection_id' is set
  if @api_client.config.client_side_validation && connection_id.nil?
    fail ArgumentError, "Missing the required parameter 'connection_id' when calling ActionConnectionAPI.update_action_connection"
  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 ActionConnectionAPI.update_action_connection"
  end
  # resource path
  local_var_path = '/api/v2/actions/connections/{connection_id}'.sub('{connection_id}', CGI.escape(connection_id.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] || 'UpdateActionConnectionResponse'

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

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