Class: DatadogAPIClient::V1::SnapshotsAPI

Inherits:
Object
  • Object
show all
Defined in:
lib/datadog_api_client/v1/api/snapshots_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of SnapshotsAPI.

[View source]

22
23
24
 
# File 'lib/datadog_api_client/v1/api/snapshots_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/v1/api/snapshots_api.rb', line 20

def api_client
  @api_client
end

Instance Method Details

#get_graph_snapshot(start, _end, opts = {}) ⇒ Object

Take graph snapshots.

See Also:

[View source]

29
30
31
32
 
# File 'lib/datadog_api_client/v1/api/snapshots_api.rb', line 29

def get_graph_snapshot(start, _end, opts = {})
  data, _status_code, _headers = get_graph_snapshot_with_http_info(start, _end, opts)
  data
end

#get_graph_snapshot_with_http_info(start, _end, opts = {}) ⇒ Array<(GraphSnapshot, Integer, Hash)>

Take graph snapshots.

Take graph snapshots. Note: When a snapshot is created, there is some delay before it is available.

Parameters:

  • start (Integer) —

    The POSIX timestamp of the start of the query in seconds.

  • _end (Integer) —

    The POSIX timestamp of the end of the query in seconds.

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

    the optional parameters

Options Hash (opts):

  • :metric_query (String) —

    The metric query.

  • :event_query (String) —

    A query that adds event bands to the graph.

  • :graph_def (String) —

    A JSON document defining the graph. graph_def can be used instead of metric_query. The JSON document uses the grammar defined here and should be formatted to a single line then URL encoded.

  • :title (String) —

    A title for the graph. If no title is specified, the graph does not have a title.

  • :height (Integer) —

    The height of the graph. If no height is specified, the graph's original height is used.

  • :width (Integer) —

    The width of the graph. If no width is specified, the graph's original width is used.

Returns:

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

    GraphSnapshot data, response status code and response headers

[View source]

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
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/datadog_api_client/v1/api/snapshots_api.rb', line 49

def get_graph_snapshot_with_http_info(start, _end, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SnapshotsAPI.get_graph_snapshot ...'
  end
  # verify the required parameter 'start' is set
  if @api_client.config.client_side_validation && start.nil?
    fail ArgumentError, "Missing the required parameter 'start' when calling SnapshotsAPI.get_graph_snapshot"
  end
  # verify the required parameter '_end' is set
  if @api_client.config.client_side_validation && _end.nil?
    fail ArgumentError, "Missing the required parameter '_end' when calling SnapshotsAPI.get_graph_snapshot"
  end
  # resource path
  local_var_path = '/api/v1/graph/snapshot'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'start'] = start
  query_params[:'end'] = _end
  query_params[:'metric_query'] = opts[:'metric_query'] if !opts[:'metric_query'].nil?
  query_params[:'event_query'] = opts[:'event_query'] if !opts[:'event_query'].nil?
  query_params[:'graph_def'] = opts[:'graph_def'] if !opts[:'graph_def'].nil?
  query_params[:'title'] = opts[:'title'] if !opts[:'title'].nil?
  query_params[:'height'] = opts[:'height'] if !opts[:'height'].nil?
  query_params[:'width'] = opts[:'width'] if !opts[:'width'].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] || 'GraphSnapshot'

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

  new_options = opts.merge(
    :operation => :get_graph_snapshot,
    :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 => "V1"
  )

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