Class: InfluxDB2::API::LabelsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/influxdb2/apis/generated/api/labels_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ LabelsApi

Returns a new instance of LabelsApi.



18
19
20
 
# File 'lib/influxdb2/apis/generated/api/labels_api.rb', line 18

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



16
17
18
 
# File 'lib/influxdb2/apis/generated/api/labels_api.rb', line 16

def api_client
  @api_client
end

Instance Method Details

#delete_labels_id(label_id, opts = {}) ⇒ nil

Delete a label

Parameters:

  • label_id (String) —

    The ID of the label to delete.

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

    the optional parameters

Options Hash (opts):

  • :zap_trace_span (String) —

    OpenTracing span context

Returns:

  • (nil) 


26
27
28
29
 
# File 'lib/influxdb2/apis/generated/api/labels_api.rb', line 26

def delete_labels_id(label_id, opts = {})
  delete_labels_id_with_http_info(label_id, opts)
  nil
end

#delete_labels_id_with_http_info(label_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete a label

Parameters:

  • label_id (String) —

    The ID of the label to delete.

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

    the optional parameters

Options Hash (opts):

  • :zap_trace_span (String) —

    OpenTracing span context

Returns:

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

    nil, response status code and response headers



36
37
38
39
40
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
 
# File 'lib/influxdb2/apis/generated/api/labels_api.rb', line 36

def delete_labels_id_with_http_info(label_id, opts = {})
  # verify the required parameter 'label_id' is set
  if @api_client.config.client_side_validation && label_id.nil?
    fail ArgumentError, "Missing the required parameter 'label_id' when calling LabelsApi.delete_labels_id"
  end
  # resource path
  local_var_path = '/labels/{labelID}'.sub('{' + 'labelID' + '}', CGI.escape(label_id.to_s))

  # 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'])
  header_params[:'Zap-Trace-Span'] = opts[:'zap_trace_span'] if !opts[:'zap_trace_span'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['header']

  new_options = opts.merge(
    :operation => :"LabelsApi.delete_labels_id",
    :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(:DELETE, local_var_path, new_options)
  return data, status_code, headers
end

#get_labels(opts = {}) ⇒ LabelsResponse

List all labels

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :zap_trace_span (String) —

    OpenTracing span context

  • :org_id (String) —

    The organization ID.

Returns:



84
85
86
87
 
# File 'lib/influxdb2/apis/generated/api/labels_api.rb', line 84

def get_labels(opts = {})
  data, _status_code, _headers = get_labels_with_http_info(opts)
  data
end

#get_labels_id(label_id, opts = {}) ⇒ LabelResponse

Retrieve a label

Parameters:

  • label_id (String) —

    The ID of the label to update.

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

    the optional parameters

Options Hash (opts):

  • :zap_trace_span (String) —

    OpenTracing span context

Returns:



139
140
141
142
 
# File 'lib/influxdb2/apis/generated/api/labels_api.rb', line 139

def get_labels_id(label_id, opts = {})
  data, _status_code, _headers = get_labels_id_with_http_info(label_id, opts)
  data
end

#get_labels_id_with_http_info(label_id, opts = {}) ⇒ Array<(LabelResponse, Integer, Hash)>

Retrieve a label

Parameters:

  • label_id (String) —

    The ID of the label to update.

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

    the optional parameters

Options Hash (opts):

  • :zap_trace_span (String) —

    OpenTracing span context

Returns:

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

    LabelResponse data, response status code and response headers



149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/influxdb2/apis/generated/api/labels_api.rb', line 149

def get_labels_id_with_http_info(label_id, opts = {})
  # verify the required parameter 'label_id' is set
  if @api_client.config.client_side_validation && label_id.nil?
    fail ArgumentError, "Missing the required parameter 'label_id' when calling LabelsApi.get_labels_id"
  end
  # resource path
  local_var_path = '/labels/{labelID}'.sub('{' + 'labelID' + '}', CGI.escape(label_id.to_s))

  # 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'])
  header_params[:'Zap-Trace-Span'] = opts[:'zap_trace_span'] if !opts[:'zap_trace_span'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'LabelResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['header']

  new_options = opts.merge(
    :operation => :"LabelsApi.get_labels_id",
    :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)
  return data, status_code, headers
end

#get_labels_with_http_info(opts = {}) ⇒ Array<(LabelsResponse, Integer, Hash)>

List all labels

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :zap_trace_span (String) —

    OpenTracing span context

  • :org_id (String) —

    The organization ID.

Returns:

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

    LabelsResponse data, response status code and response headers



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/influxdb2/apis/generated/api/labels_api.rb', line 94

def get_labels_with_http_info(opts = {})
  # resource path
  local_var_path = '/labels'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'orgID'] = opts[:'org_id'] if !opts[:'org_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'Zap-Trace-Span'] = opts[:'zap_trace_span'] if !opts[:'zap_trace_span'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'LabelsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['header']

  new_options = opts.merge(
    :operation => :"LabelsApi.get_labels",
    :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)
  return data, status_code, headers
end

#patch_labels_id(label_id, label_update, opts = {}) ⇒ LabelResponse

Update a label

Parameters:

  • label_id (String) —

    The ID of the label to update.

  • label_update (LabelUpdate) —

    A label update.

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

    the optional parameters

Options Hash (opts):

  • :zap_trace_span (String) —

    OpenTracing span context

Returns:



198
199
200
201
 
# File 'lib/influxdb2/apis/generated/api/labels_api.rb', line 198

def patch_labels_id(label_id, label_update, opts = {})
  data, _status_code, _headers = patch_labels_id_with_http_info(label_id, label_update, opts)
  data
end

#patch_labels_id_with_http_info(label_id, label_update, opts = {}) ⇒ Array<(LabelResponse, Integer, Hash)>

Update a label

Parameters:

  • label_id (String) —

    The ID of the label to update.

  • label_update (LabelUpdate) —

    A label update.

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

    the optional parameters

Options Hash (opts):

  • :zap_trace_span (String) —

    OpenTracing span context

Returns:

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

    LabelResponse data, response status code and response headers



209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/influxdb2/apis/generated/api/labels_api.rb', line 209

def patch_labels_id_with_http_info(label_id, label_update, opts = {})
  # verify the required parameter 'label_id' is set
  if @api_client.config.client_side_validation && label_id.nil?
    fail ArgumentError, "Missing the required parameter 'label_id' when calling LabelsApi.patch_labels_id"
  end
  # verify the required parameter 'label_update' is set
  if @api_client.config.client_side_validation && label_update.nil?
    fail ArgumentError, "Missing the required parameter 'label_update' when calling LabelsApi.patch_labels_id"
  end
  # resource path
  local_var_path = '/labels/{labelID}'.sub('{' + 'labelID' + '}', CGI.escape(label_id.to_s))

  # 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'])
  header_params[:'Zap-Trace-Span'] = opts[:'zap_trace_span'] if !opts[:'zap_trace_span'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(label_update)

  # return_type
  return_type = opts[:debug_return_type] || 'LabelResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['header']

  new_options = opts.merge(
    :operation => :"LabelsApi.patch_labels_id",
    :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(:PATCH, local_var_path, new_options)
  return data, status_code, headers
end

#post_labels(label_create_request, opts = {}) ⇒ LabelResponse

Create a label

Parameters:

  • label_create_request (LabelCreateRequest) —

    The label to create.

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

    the optional parameters

Returns:



262
263
264
265
 
# File 'lib/influxdb2/apis/generated/api/labels_api.rb', line 262

def post_labels(label_create_request, opts = {})
  data, _status_code, _headers = post_labels_with_http_info(label_create_request, opts)
  data
end

#post_labels_with_http_info(label_create_request, opts = {}) ⇒ Array<(LabelResponse, Integer, Hash)>

Create a label

Parameters:

  • label_create_request (LabelCreateRequest) —

    The label to create.

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

    the optional parameters

Returns:

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

    LabelResponse data, response status code and response headers



271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/influxdb2/apis/generated/api/labels_api.rb', line 271

def post_labels_with_http_info(label_create_request, opts = {})
  # verify the required parameter 'label_create_request' is set
  if @api_client.config.client_side_validation && label_create_request.nil?
    fail ArgumentError, "Missing the required parameter 'label_create_request' when calling LabelsApi.post_labels"
  end
  # resource path
  local_var_path = '/labels'

  # 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(label_create_request)

  # return_type
  return_type = opts[:debug_return_type] || 'LabelResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['header']

  new_options = opts.merge(
    :operation => :"LabelsApi.post_labels",
    :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(:POST, local_var_path, new_options)
  return data, status_code, headers
end