Class: DatadogAPIClient::V2::ErrorTrackingAPI

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of ErrorTrackingAPI.



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

def api_client
  @api_client
end

Instance Method Details

#get_issue(issue_id, opts = {}) ⇒ Object

Get the details of an error tracking issue.

See Also:



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

def get_issue(issue_id, opts = {})
  data, _status_code, _headers = get_issue_with_http_info(issue_id, opts)
  data
end

#get_issue_with_http_info(issue_id, opts = {}) ⇒ Array<(IssueResponse, Integer, Hash)>

Get the details of an error tracking issue.

Retrieve the full details for a specific error tracking issue, including attributes and relationships.

Parameters:

  • issue_id (String) —

    The identifier of the issue.

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

    the optional parameters

Options Hash (opts):

Returns:

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

    IssueResponse data, response status code and response headers



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/error_tracking_api.rb', line 42

def get_issue_with_http_info(issue_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ErrorTrackingAPI.get_issue ...'
  end
  # verify the required parameter 'issue_id' is set
  if @api_client.config.client_side_validation && issue_id.nil?
    fail ArgumentError, "Missing the required parameter 'issue_id' when calling ErrorTrackingAPI.get_issue"
  end
  # resource path
  local_var_path = '/api/v2/error-tracking/issues/{issue_id}'.sub('{issue_id}', CGI.escape(issue_id.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?

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

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

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

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

Search error tracking issues.

See Also:



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

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

#search_issues_with_http_info(body, opts = {}) ⇒ Array<(IssuesSearchResponse, Integer, Hash)>

Search error tracking issues.

Search issues endpoint allows you to programmatically search for issues within your organization. This endpoint returns a list of issues that match a given search query, following the event search syntax. The search results are limited to a maximum of 100 issues per request.

Parameters:

  • body (IssuesSearchRequest) —

    Search issues request payload.

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

    the optional parameters

Options Hash (opts):

Returns:

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

    IssuesSearchResponse data, response status code and response headers



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

def search_issues_with_http_info(body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ErrorTrackingAPI.search_issues ...'
  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 ErrorTrackingAPI.search_issues"
  end
  # resource path
  local_var_path = '/api/v2/error-tracking/issues/search'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil?

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

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

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

#update_issue_assignee(issue_id, body, opts = {}) ⇒ Object

Update the assignee of an issue.

See Also:



165
166
167
168
 
# File 'lib/datadog_api_client/v2/api/error_tracking_api.rb', line 165

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

#update_issue_assignee_with_http_info(issue_id, body, opts = {}) ⇒ Array<(IssueResponse, Integer, Hash)>

Update the assignee of an issue.

Update the assignee of an issue by issue_id.

Parameters:

  • issue_id (String) —

    The identifier of the issue.

  • body (IssueUpdateAssigneeRequest) —

    Update issue assignee request payload.

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

    the optional parameters

Returns:

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

    IssueResponse data, response status code and response headers



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
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/datadog_api_client/v2/api/error_tracking_api.rb', line 178

def update_issue_assignee_with_http_info(issue_id, body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ErrorTrackingAPI.update_issue_assignee ...'
  end
  # verify the required parameter 'issue_id' is set
  if @api_client.config.client_side_validation && issue_id.nil?
    fail ArgumentError, "Missing the required parameter 'issue_id' when calling ErrorTrackingAPI.update_issue_assignee"
  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 ErrorTrackingAPI.update_issue_assignee"
  end
  # resource path
  local_var_path = '/api/v2/error-tracking/issues/{issue_id}/assignee'.sub('{issue_id}', CGI.escape(issue_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] || 'IssueResponse'

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

  new_options = opts.merge(
    :operation => :update_issue_assignee,
    :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::Put, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ErrorTrackingAPI#update_issue_assignee\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_issue_state(issue_id, body, opts = {}) ⇒ Object

Update the state of an issue.

See Also:



237
238
239
240
 
# File 'lib/datadog_api_client/v2/api/error_tracking_api.rb', line 237

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

#update_issue_state_with_http_info(issue_id, body, opts = {}) ⇒ Array<(IssueResponse, Integer, Hash)>

Update the state of an issue.

Update the state of an issue by issue_id. Use this endpoint to move an issue between states such as OPEN, RESOLVED, or IGNORED.

Parameters:

  • issue_id (String) —

    The identifier of the issue.

  • body (IssueUpdateStateRequest) —

    Update issue state request payload.

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

    the optional parameters

Returns:

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

    IssueResponse data, response status code and response headers



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
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/datadog_api_client/v2/api/error_tracking_api.rb', line 250

def update_issue_state_with_http_info(issue_id, body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ErrorTrackingAPI.update_issue_state ...'
  end
  # verify the required parameter 'issue_id' is set
  if @api_client.config.client_side_validation && issue_id.nil?
    fail ArgumentError, "Missing the required parameter 'issue_id' when calling ErrorTrackingAPI.update_issue_state"
  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 ErrorTrackingAPI.update_issue_state"
  end
  # resource path
  local_var_path = '/api/v2/error-tracking/issues/{issue_id}/state'.sub('{issue_id}', CGI.escape(issue_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] || 'IssueResponse'

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

  new_options = opts.merge(
    :operation => :update_issue_state,
    :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::Put, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ErrorTrackingAPI#update_issue_state\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end