Class: DatadogAPIClient::V2::LogsArchiveSearchesAPI

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of LogsArchiveSearchesAPI.



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

def api_client
  @api_client
end

Instance Method Details

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

Create an Archive Search.

See Also:



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

def create_archive_search(body, opts = {})
  data, _status_code, _headers = create_archive_search_with_http_info(body, opts)
  data
end

#create_archive_search_with_http_info(body, opts = {}) ⇒ Array<(ArchiveSearchResponse, Integer, Hash)>

Create an Archive Search.

Start a search over the logs stored in an archive.

Without a rehydration object, the search only scans the archive and reports how much data matched. With one, the matched logs are also indexed into a retained historical view, which requires the logs_write_historical_view permission.

Parameters:

Returns:

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

    ArchiveSearchResponse 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
100
101
 
# File 'lib/datadog_api_client/v2/api/logs_archive_searches_api.rb', line 45

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LogsArchiveSearchesAPI.create_archive_search ...'
  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 LogsArchiveSearchesAPI.create_archive_search"
  end
  # resource path
  local_var_path = '/api/v2/logs/archive_searches'

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

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

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

#get_archive_search(archive_search_id, opts = {}) ⇒ Object

Get an Archive Search.

See Also:



106
107
108
109
 
# File 'lib/datadog_api_client/v2/api/logs_archive_searches_api.rb', line 106

def get_archive_search(archive_search_id, opts = {})
  data, _status_code, _headers = get_archive_search_with_http_info(archive_search_id, opts)
  data
end

#get_archive_search_with_http_info(archive_search_id, opts = {}) ⇒ Array<(ArchiveSearchResponse, Integer, Hash)>

Get an Archive Search.

Get a single Archive Search, including its status and the amount of archive data scanned when the search finishes.

Parameters:

  • archive_search_id (String) —

    Unique identifier of the Archive Search.

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

    the optional parameters

Returns:

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

    ArchiveSearchResponse data, response status code and response headers



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
167
168
169
170
171
172
 
# File 'lib/datadog_api_client/v2/api/logs_archive_searches_api.rb', line 118

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LogsArchiveSearchesAPI.get_archive_search ...'
  end
  # verify the required parameter 'archive_search_id' is set
  if @api_client.config.client_side_validation && archive_search_id.nil?
    fail ArgumentError, "Missing the required parameter 'archive_search_id' when calling LogsArchiveSearchesAPI.get_archive_search"
  end
  # resource path
  local_var_path = '/api/v2/logs/archive_searches/{archive_search_id}'.sub('{archive_search_id}', CGI.escape(archive_search_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] || 'ArchiveSearchResponse'

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

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