Class: DatadogAPIClient::V2::BitsAIAPI

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of BitsAIAPI.



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

def api_client
  @api_client
end

Instance Method Details

#get_investigation(id, opts = {}) ⇒ Object

Get a Bits AI investigation.

See Also:



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

def get_investigation(id, opts = {})
  data, _status_code, _headers = get_investigation_with_http_info(id, opts)
  data
end

#get_investigation_with_http_info(id, opts = {}) ⇒ Array<(GetInvestigationResponse, Integer, Hash)>

Get a Bits AI investigation.

Get a specific Bits AI investigation by ID.

Parameters:

  • id (String) —

    The ID of the investigation.

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

    the optional parameters

Returns:

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

    GetInvestigationResponse data, response status code and response headers



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

def get_investigation_with_http_info(id, opts = {})

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

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

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

#list_investigations(opts = {}) ⇒ Object

List Bits AI investigations.

See Also:



94
95
96
97
 
# File 'lib/datadog_api_client/v2/api/bits_ai_api.rb', line 94

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

#list_investigations_with_http_info(opts = {}) ⇒ Array<(ListInvestigationsResponse, Integer, Hash)>

List Bits AI investigations.

List all Bits AI investigations for the organization.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_offset (Integer) —

    Offset for pagination.

  • :page_limit (Integer) —

    Maximum number of investigations to return.

  • :filter_monitor_id (Integer) —

    Filter investigations by monitor ID.

Returns:

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

    ListInvestigationsResponse data, 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
157
158
 
# File 'lib/datadog_api_client/v2/api/bits_ai_api.rb', line 108

def list_investigations_with_http_info(opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BitsAIAPI.list_investigations ...'
  end
  if @api_client.config.client_side_validation && !opts[:'page_limit'].nil? && opts[:'page_limit'] > 100
    fail ArgumentError, 'invalid value for "opts[:"page_limit"]" when calling BitsAIAPI.list_investigations, must be smaller than or equal to 100.'
  end
  # resource path
  local_var_path = '/api/v2/bits-ai/investigations'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page[offset]'] = opts[:'page_offset'] if !opts[:'page_offset'].nil?
  query_params[:'page[limit]'] = opts[:'page_limit'] if !opts[:'page_limit'].nil?
  query_params[:'filter[monitor_id]'] = opts[:'filter_monitor_id'] if !opts[:'filter_monitor_id'].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] || 'ListInvestigationsResponse'

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

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

#list_investigations_with_pagination(opts = {}) {|ListInvestigationsResponseData| ... } ⇒ Object

List Bits AI investigations.

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

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

Yields:



167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/datadog_api_client/v2/api/bits_ai_api.rb', line 167

def list_investigations_with_pagination(opts = {})
    api_version = "V2"
    page_size = @api_client.get_attribute_from_path(opts, "page_limit", 25)
    @api_client.set_attribute_from_path(api_version, opts, "page_limit", Integer, page_size)
    while true do
        response = list_investigations(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_offset", Integer, @api_client.get_attribute_from_path(opts, "page_offset", 0) + page_size)
    end
end

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

Trigger a Bits AI investigation.

See Also:



184
185
186
187
 
# File 'lib/datadog_api_client/v2/api/bits_ai_api.rb', line 184

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

#trigger_investigation_with_http_info(body, opts = {}) ⇒ Array<(TriggerInvestigationResponse, Integer, Hash)>

Trigger a Bits AI investigation.

Trigger a Bits AI investigation from a monitor alert or a general investigation. This endpoint requires the bits_investigations_write permission. When the trigger type is monitor_alert_trigger, the monitors_read permission is also required.

Parameters:

Returns:



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
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/datadog_api_client/v2/api/bits_ai_api.rb', line 198

def trigger_investigation_with_http_info(body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BitsAIAPI.trigger_investigation ...'
  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 BitsAIAPI.trigger_investigation"
  end
  # resource path
  local_var_path = '/api/v2/bits-ai/investigations'

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

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

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