Class: DatadogAPIClient::V2::ServiceDefinitionAPI

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of ServiceDefinitionAPI.



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

def api_client
  @api_client
end

Instance Method Details

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

Create or update service definition.

See Also:



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

def create_or_update_service_definitions(body, opts = {})
  data, _status_code, _headers = create_or_update_service_definitions_with_http_info(body, opts)
  data
end

#create_or_update_service_definitions_with_http_info(body, opts = {}) ⇒ Array<(ServiceDefinitionCreateResponse, Integer, Hash)>

Create or update service definition.

Create or update service definition in the Datadog Service Catalog.

Parameters:

Returns:



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
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/datadog_api_client/v2/api/service_definition_api.rb', line 41

def create_or_update_service_definitions_with_http_info(body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ServiceDefinitionAPI.create_or_update_service_definitions ...'
  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 ServiceDefinitionAPI.create_or_update_service_definitions"
  end
  # resource path
  local_var_path = '/api/v2/services/definitions'

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

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

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

#delete_service_definition(service_name, opts = {}) ⇒ Object

Delete a single service definition.

See Also:



96
97
98
99
 
# File 'lib/datadog_api_client/v2/api/service_definition_api.rb', line 96

def delete_service_definition(service_name, opts = {})
  delete_service_definition_with_http_info(service_name, opts)
  nil
end

#delete_service_definition_with_http_info(service_name, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete a single service definition.

Delete a single service definition in the Datadog Service Catalog.

Parameters:

  • service_name (String) —

    The name of the service.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/datadog_api_client/v2/api/service_definition_api.rb', line 108

def delete_service_definition_with_http_info(service_name, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ServiceDefinitionAPI.delete_service_definition ...'
  end
  # verify the required parameter 'service_name' is set
  if @api_client.config.client_side_validation && service_name.nil?
    fail ArgumentError, "Missing the required parameter 'service_name' when calling ServiceDefinitionAPI.delete_service_definition"
  end
  # resource path
  local_var_path = '/api/v2/services/definitions/{service_name}'.sub('{service_name}', CGI.escape(service_name.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(['*/*'])

  # 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] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :delete_service_definition,
    :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::Delete, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ServiceDefinitionAPI#delete_service_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_service_definition(service_name, opts = {}) ⇒ Object

Get a single service definition.

See Also:



161
162
163
164
 
# File 'lib/datadog_api_client/v2/api/service_definition_api.rb', line 161

def get_service_definition(service_name, opts = {})
  data, _status_code, _headers = get_service_definition_with_http_info(service_name, opts)
  data
end

#get_service_definition_with_http_info(service_name, opts = {}) ⇒ Array<(ServiceDefinitionGetResponse, Integer, Hash)>

Get a single service definition.

Get a single service definition from the Datadog Service Catalog.

Parameters:

  • service_name (String) —

    The name of the service.

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

    the optional parameters

Options Hash (opts):

Returns:



174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/datadog_api_client/v2/api/service_definition_api.rb', line 174

def get_service_definition_with_http_info(service_name, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ServiceDefinitionAPI.get_service_definition ...'
  end
  # verify the required parameter 'service_name' is set
  if @api_client.config.client_side_validation && service_name.nil?
    fail ArgumentError, "Missing the required parameter 'service_name' when calling ServiceDefinitionAPI.get_service_definition"
  end
  allowable_values = ['v1', 'v2', 'v2.1', 'v2.2']
  if @api_client.config.client_side_validation && opts[:'schema_version'] && !allowable_values.include?(opts[:'schema_version'])
    fail ArgumentError, "invalid value for \"schema_version\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/api/v2/services/definitions/{service_name}'.sub('{service_name}', CGI.escape(service_name.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'schema_version'] = opts[:'schema_version'] if !opts[:'schema_version'].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] || 'ServiceDefinitionGetResponse'

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

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

#list_service_definitions(opts = {}) ⇒ Object

Get all service definitions.

See Also:



232
233
234
235
 
# File 'lib/datadog_api_client/v2/api/service_definition_api.rb', line 232

def list_service_definitions(opts = {})
  data, _status_code, _headers = list_service_definitions_with_http_info(opts)
  data
end

#list_service_definitions_with_http_info(opts = {}) ⇒ Array<(ServiceDefinitionsListResponse, Integer, Hash)>

Get all service definitions.

Get a list of all service definitions from the Datadog Service Catalog.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Size for a given page. The maximum allowed value is 100.

  • :page_number (Integer) —

    Specific page number to return.

  • :schema_version (ServiceDefinitionSchemaVersions) —

    The schema version desired in the response.

Returns:



246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
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
 
# File 'lib/datadog_api_client/v2/api/service_definition_api.rb', line 246

def list_service_definitions_with_http_info(opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ServiceDefinitionAPI.list_service_definitions ...'
  end
  allowable_values = ['v1', 'v2', 'v2.1', 'v2.2']
  if @api_client.config.client_side_validation && opts[:'schema_version'] && !allowable_values.include?(opts[:'schema_version'])
    fail ArgumentError, "invalid value for \"schema_version\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/api/v2/services/definitions'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'page[number]'] = opts[:'page_number'] if !opts[:'page_number'].nil?
  query_params[:'schema_version'] = opts[:'schema_version'] if !opts[:'schema_version'].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] || 'ServiceDefinitionsListResponse'

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

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

#list_service_definitions_with_pagination(opts = {}) {|ServiceDefinitionData| ... } ⇒ Object

Get all service definitions.

Provide a paginated version of #list_service_definitions, returning all items.

To use it you need to use a block: list_service_definitions_with_pagination { |item| p item }

Yields:



306
307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'lib/datadog_api_client/v2/api/service_definition_api.rb', line 306

def list_service_definitions_with_pagination(opts = {})
    api_version = "V2"
    page_size = @api_client.get_attribute_from_path(opts, "page_size", 10)
    @api_client.set_attribute_from_path(api_version, opts, "page_size", Integer, page_size)
    @api_client.set_attribute_from_path(api_version, opts, "page_number", Integer, 0)
    while true do
        response = list_service_definitions(opts)
        @api_client.get_attribute_from_path(response, "data").each { |item| yield(item) }
        if @api_client.get_attribute_from_path(response, "data").length < page_size
          break
        end
        @api_client.set_attribute_from_path(api_version, opts, "page_number", Integer, @api_client.get_attribute_from_path(opts, "page_number", 0) + 1)
    end
end