Class: DatadogAPIClient::V2::GovernanceInsightsAPI

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of GovernanceInsightsAPI.



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

def api_client
  @api_client
end

Instance Method Details

#list_governance_insights(opts = {}) ⇒ Object

List governance insights.

See Also:



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

def list_governance_insights(opts = {})
  data, _status_code, _headers = list_governance_insights_with_http_info(opts)
  data
end

#list_governance_insights_with_http_info(opts = {}) ⇒ Array<(GovernanceInsightsResponse, Integer, Hash)>

List governance insights.

Retrieve the list of governance insights available to the organization. By default, only insight metadata is returned; pass withValues=true to also compute and include each insight's current and previous values. Insights can be filtered by product.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :with_values (Boolean) —

    Whether to compute and include the current and previous value of each insight. Defaults to false, in which case only insight metadata is returned.

  • :org_uuid (String) —

    The UUID of the organization to compute insights for. Defaults to the organization of the authenticated user. Used to retrieve insights for a child organization from a parent organization.

  • :filter_product (Array<String>) —

    Restrict the results to insights belonging to the given products. May be repeated to filter by multiple products. Matching is case-insensitive.

Returns:

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

    GovernanceInsightsResponse data, response status code and response headers



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
96
97
98
99
 
# File 'lib/datadog_api_client/v2/api/governance_insights_api.rb', line 45

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GovernanceInsightsAPI.list_governance_insights ...'
  end
  # resource path
  local_var_path = '/api/v2/governance/insights'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'withValues'] = opts[:'with_values'] if !opts[:'with_values'].nil?
  query_params[:'orgUuid'] = opts[:'org_uuid'] if !opts[:'org_uuid'].nil?
  query_params[:'filter[product]'] = @api_client.build_collection_param(opts[:'filter_product'], :multi) if !opts[:'filter_product'].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] || 'GovernanceInsightsResponse'

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

  new_options = opts.merge(
    :operation => :list_governance_insights,
    :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"
  )
  new_options[:query_string_normalizer] = HTTParty::Request::NON_RAILS_QUERY_STRING_NORMALIZER

  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: GovernanceInsightsAPI#list_governance_insights\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end