Class: DatadogAPIClient::V2::ProcessesAPI

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = APIClient.default) ⇒ ProcessesAPI 



22
23
24
 
# File 'lib/datadog_api_client/v2/api/processes_api.rb', line 22

def initialize(api_client = 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/processes_api.rb', line 20

def api_client
  @api_client
end

Instance Method Details

#list_processes(opts = {}) ⇒ ProcessSummariesResponse

Get all processes Get all processes for your organization.

Options Hash (opts):

  • :search (String) —

    String to search processes by.

  • :tags (String) —

    Comma-separated list of tags to filter processes by.

  • :from (Integer) —

    Unix timestamp (number of seconds since epoch) of the start of the query window. If not provided, the start of the query window will be 15 minutes before the `to` timestamp. If neither `from` nor `to` are provided, the query window will be `[now - 15m, now]`.

  • :to (Integer) —

    Unix timestamp (number of seconds since epoch) of the end of the query window. If not provided, the end of the query window will be 15 minutes after the `from` timestamp. If neither `from` nor `to` are provided, the query window will be `[now - 15m, now]`.

  • :page_limit (Integer) —

    Maximum number of results returned. (default to 1000)

  • :page_cursor (String) —

    String to query the next page of results. This key is provided with each valid response from the API in `meta.page.after`.



35
36
37
38
 
# File 'lib/datadog_api_client/v2/api/processes_api.rb', line 35

def list_processes(opts = {})
  data, _status_code, _headers = list_processes_with_http_info(opts)
  data
end

#list_processes_with_http_info(opts = {}) ⇒ Array<(ProcessSummariesResponse, Integer, Hash)>

Get all processes Get all processes for your organization.

Options Hash (opts):

  • :search (String) —

    String to search processes by.

  • :tags (String) —

    Comma-separated list of tags to filter processes by.

  • :from (Integer) —

    Unix timestamp (number of seconds since epoch) of the start of the query window. If not provided, the start of the query window will be 15 minutes before the &#x60;to&#x60; timestamp. If neither &#x60;from&#x60; nor &#x60;to&#x60; are provided, the query window will be &#x60;[now - 15m, now]&#x60;.

  • :to (Integer) —

    Unix timestamp (number of seconds since epoch) of the end of the query window. If not provided, the end of the query window will be 15 minutes after the &#x60;from&#x60; timestamp. If neither &#x60;from&#x60; nor &#x60;to&#x60; are provided, the query window will be &#x60;[now - 15m, now]&#x60;.

  • :page_limit (Integer) —

    Maximum number of results returned.

  • :page_cursor (String) —

    String to query the next page of results. This key is provided with each valid response from the API in &#x60;meta.page.after&#x60;.



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
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/datadog_api_client/v2/api/processes_api.rb', line 50

def list_processes_with_http_info(opts = {})

  if @api_client.config.unstable_operations.has_key?(:list_processes)
    unstable_enabled = @api_client.config.unstable_operations[:list_processes]
    if unstable_enabled
      @api_client.config.logger.warn format("Using unstable operation '%s'", "list_processes")
    else
      raise APIError.new(message: format("Unstable operation '%s' is disabled", "list_processes"))
    end
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProcessesAPI.list_processes ...'
  end
  if @api_client.config.client_side_validation && !opts[:'page_limit'].nil? && opts[:'page_limit'] > 10000
    fail ArgumentError, 'invalid value for "opts[:"page_limit"]" when calling ProcessesAPI.list_processes, must be smaller than or equal to 10000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_limit'].nil? && opts[:'page_limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_limit"]" when calling ProcessesAPI.list_processes, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/api/v2/processes'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
  query_params[:'tags'] = opts[:'tags'] if !opts[:'tags'].nil?
  query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
  query_params[:'to'] = opts[:'to'] if !opts[:'to'].nil?
  query_params[:'page[limit]'] = opts[:'page_limit'] if !opts[:'page_limit'].nil?
  query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].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] || 'ProcessSummariesResponse'

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

  new_options = opts.merge(
    :operation => :list_processes,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProcessesAPI#list_processes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end