Class: DatadogAPIClient::V2::DataObservabilityAPI

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of DataObservabilityAPI.



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

def api_client
  @api_client
end

Instance Method Details

#get_data_observability_monitor_run_status(run_id, opts = {}) ⇒ Object

Get data observability monitor run status.

See Also:



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

def get_data_observability_monitor_run_status(run_id, opts = {})
  data, _status_code, _headers = get_data_observability_monitor_run_status_with_http_info(run_id, opts)
  data
end

#get_data_observability_monitor_run_status_with_http_info(run_id, opts = {}) ⇒ Array<(GetDataObservabilityMonitorRunStatusResponse, Integer, Hash)>

Get data observability monitor run status.

Retrieves the current status of a data observability monitor run. Poll this endpoint after triggering a run to determine when evaluation is complete.

Parameters:

  • run_id (String) —

    The ID of the monitor run to retrieve status for.

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

    the optional 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
92
93
94
95
 
# File 'lib/datadog_api_client/v2/api/data_observability_api.rb', line 41

def get_data_observability_monitor_run_status_with_http_info(run_id, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.get_data_observability_monitor_run_status".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.get_data_observability_monitor_run_status")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.get_data_observability_monitor_run_status"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DataObservabilityAPI.get_data_observability_monitor_run_status ...'
  end
  # verify the required parameter 'run_id' is set
  if @api_client.config.client_side_validation && run_id.nil?
    fail ArgumentError, "Missing the required parameter 'run_id' when calling DataObservabilityAPI.get_data_observability_monitor_run_status"
  end
  # resource path
  local_var_path = '/api/v2/data-observability/monitors/runs/{run_id}/status'.sub('{run_id}', CGI.escape(run_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] || 'GetDataObservabilityMonitorRunStatusResponse'

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

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

#run_data_observability_monitor(monitor_id, opts = {}) ⇒ Object

Run a data observability monitor.

See Also:



100
101
102
103
 
# File 'lib/datadog_api_client/v2/api/data_observability_api.rb', line 100

def run_data_observability_monitor(monitor_id, opts = {})
  data, _status_code, _headers = run_data_observability_monitor_with_http_info(monitor_id, opts)
  data
end

#run_data_observability_monitor_with_http_info(monitor_id, opts = {}) ⇒ Array<(RunDataObservabilityMonitorResponse, Integer, Hash)>

Run a data observability monitor.

Manually triggers a run for a data observability monitor. Only monitors that are not scheduled (manually-runnable) can be triggered this way.

Parameters:

  • monitor_id (Integer) —

    The ID of the data observability monitor to run.

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

    the optional parameters

Returns:



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
161
162
163
164
165
166
 
# File 'lib/datadog_api_client/v2/api/data_observability_api.rb', line 112

def run_data_observability_monitor_with_http_info(monitor_id, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.run_data_observability_monitor".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.run_data_observability_monitor")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.run_data_observability_monitor"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DataObservabilityAPI.run_data_observability_monitor ...'
  end
  # verify the required parameter 'monitor_id' is set
  if @api_client.config.client_side_validation && monitor_id.nil?
    fail ArgumentError, "Missing the required parameter 'monitor_id' when calling DataObservabilityAPI.run_data_observability_monitor"
  end
  # resource path
  local_var_path = '/api/v2/data-observability/monitors/{monitor_id}/run'.sub('{monitor_id}', CGI.escape(monitor_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] || 'RunDataObservabilityMonitorResponse'

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

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