Class: DatadogAPIClient::V2::CIVisibilityTestsAPI

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of CIVisibilityTestsAPI.



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

def api_client
  @api_client
end

Instance Method Details

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

Aggregate tests events.

See Also:



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

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

#aggregate_ci_app_test_events_with_http_info(body, opts = {}) ⇒ Array<(CIAppTestsAnalyticsAggregateResponse, Integer, Hash)>

Aggregate tests events.

The API endpoint to aggregate CI Visibility test events into buckets of computed metrics and timeseries.

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

def aggregate_ci_app_test_events_with_http_info(body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CIVisibilityTestsAPI.aggregate_ci_app_test_events ...'
  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 CIVisibilityTestsAPI.aggregate_ci_app_test_events"
  end
  # resource path
  local_var_path = '/api/v2/ci/tests/analytics/aggregate'

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

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

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

#list_ci_app_test_events(opts = {}) ⇒ Object

Get a list of tests events.

See Also:



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

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

#list_ci_app_test_events_with_http_info(opts = {}) ⇒ Array<(CIAppTestEventsResponse, Integer, Hash)>

Get a list of tests events.

List endpoint returns CI Visibility test events that match a search query. Results are paginated similarly to logs.

Use this endpoint to see your latest test events.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter_query (String) —

    Search query following log syntax.

  • :filter_from (Time) —

    Minimum timestamp for requested events.

  • :filter_to (Time) —

    Maximum timestamp for requested events.

  • :sort (CIAppSort) —

    Order of events in results.

  • :page_cursor (String) —

    List following results with a cursor provided in the previous query.

  • :page_limit (Integer) —

    Maximum number of events in the response.

Returns:

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

    CIAppTestEventsResponse data, response status code and response headers



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
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/datadog_api_client/v2/api/ci_visibility_tests_api.rb', line 116

def list_ci_app_test_events_with_http_info(opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CIVisibilityTestsAPI.list_ci_app_test_events ...'
  end
  allowable_values = ['timestamp', '-timestamp']
  if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
    fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
  end
  if @api_client.config.client_side_validation && !opts[:'page_limit'].nil? && opts[:'page_limit'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_limit"]" when calling CIVisibilityTestsAPI.list_ci_app_test_events, must be smaller than or equal to 1000.'
  end
  # resource path
  local_var_path = '/api/v2/ci/tests/events'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'filter[query]'] = opts[:'filter_query'] if !opts[:'filter_query'].nil?
  query_params[:'filter[from]'] = opts[:'filter_from'] if !opts[:'filter_from'].nil?
  query_params[:'filter[to]'] = opts[:'filter_to'] if !opts[:'filter_to'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
  query_params[:'page[limit]'] = opts[:'page_limit'] if !opts[:'page_limit'].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] || 'CIAppTestEventsResponse'

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

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

#list_ci_app_test_events_with_pagination(opts = {}) {|CIAppTestEvent| ... } ⇒ Object

Get a list of tests events.

Provide a paginated version of #list_ci_app_test_events, returning all items.

To use it you need to use a block: list_ci_app_test_events_with_pagination { |item| p item }

Yields:



182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/datadog_api_client/v2/api/ci_visibility_tests_api.rb', line 182

def list_ci_app_test_events_with_pagination(opts = {})
    api_version = "V2"
    page_size = @api_client.get_attribute_from_path(opts, "page_limit", 10)
    @api_client.set_attribute_from_path(api_version, opts, "page_limit", Integer, page_size)
    while true do
        response = list_ci_app_test_events(opts)
        @api_client.get_attribute_from_path(response, "data").each { |item| yield(item) }
        if @api_client.get_attribute_from_path(response, "data").length < page_size
          break
        end
        @api_client.set_attribute_from_path(api_version, opts, "page_cursor", String, @api_client.get_attribute_from_path(response, "meta.page.after"))
    end
end

#search_ci_app_test_events(opts = {}) ⇒ Object

Search tests events.

See Also:



199
200
201
202
 
# File 'lib/datadog_api_client/v2/api/ci_visibility_tests_api.rb', line 199

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

#search_ci_app_test_events_with_http_info(opts = {}) ⇒ Array<(CIAppTestEventsResponse, Integer, Hash)>

Search tests events.

List endpoint returns CI Visibility test events that match a search query. Results are paginated similarly to logs.

Use this endpoint to build complex events filtering and search.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    CIAppTestEventsResponse data, response status code and response headers



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

def search_ci_app_test_events_with_http_info(opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CIVisibilityTestsAPI.search_ci_app_test_events ...'
  end
  # resource path
  local_var_path = '/api/v2/ci/tests/events/search'

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

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

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

#search_ci_app_test_events_with_pagination(opts = {}) {|CIAppTestEvent| ... } ⇒ Object

Search tests events.

Provide a paginated version of #search_ci_app_test_events, returning all items.

To use it you need to use a block: search_ci_app_test_events_with_pagination { |item| p item }

Yields:



269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/datadog_api_client/v2/api/ci_visibility_tests_api.rb', line 269

def search_ci_app_test_events_with_pagination(opts = {})
    api_version = "V2"
    page_size = @api_client.get_attribute_from_path(opts, "body.page.limit", 10)
    @api_client.set_attribute_from_path(api_version, opts, "body.page.limit", CIAppTestEventsRequest, page_size)
    while true do
        response = search_ci_app_test_events(opts)
        @api_client.get_attribute_from_path(response, "data").each { |item| yield(item) }
        if @api_client.get_attribute_from_path(response, "data").length < page_size
          break
        end
        @api_client.set_attribute_from_path(api_version, opts, "body.page.cursor", CIAppTestEventsRequest, @api_client.get_attribute_from_path(response, "meta.page.after"))
    end
end