Class: DatadogAPIClient::V2::FleetAutomationAPI

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of FleetAutomationAPI.



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

def api_client
  @api_client
end

Instance Method Details

#cancel_fleet_deployment(deployment_id, opts = {}) ⇒ Object

Cancel a deployment.

See Also:



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

def cancel_fleet_deployment(deployment_id, opts = {})
  cancel_fleet_deployment_with_http_info(deployment_id, opts)
  nil
end

#cancel_fleet_deployment_with_http_info(deployment_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Cancel a deployment.

Cancel this deployment and stop all associated operations. If a workflow is currently running for this deployment, it is canceled immediately. Changes already applied to hosts are not rolled back.

Parameters:

  • deployment_id (String) —

    The unique identifier of the deployment to cancel.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
92
93
94
95
96
97
 
# File 'lib/datadog_api_client/v2/api/fleet_automation_api.rb', line 43

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FleetAutomationAPI.cancel_fleet_deployment ...'
  end
  # verify the required parameter 'deployment_id' is set
  if @api_client.config.client_side_validation && deployment_id.nil?
    fail ArgumentError, "Missing the required parameter 'deployment_id' when calling FleetAutomationAPI.cancel_fleet_deployment"
  end
  # resource path
  local_var_path = '/api/unstable/fleet/deployments/{deployment_id}/cancel'.sub('{deployment_id}', CGI.escape(deployment_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(['*/*'])

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

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

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

Create a deployment.

See Also:



102
103
104
105
 
# File 'lib/datadog_api_client/v2/api/fleet_automation_api.rb', line 102

def create_fleet_deployment_configure(body, opts = {})
  data, _status_code, _headers = create_fleet_deployment_configure_with_http_info(body, opts)
  data
end

#create_fleet_deployment_configure_with_http_info(body, opts = {}) ⇒ Array<(FleetDeploymentResponse, Integer, Hash)>

Create a deployment.

Create a new deployment to apply configuration changes to a fleet of hosts matching the specified filter query.

Parameters:

Returns:

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

    FleetDeploymentResponse data, response status code and response headers



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
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/datadog_api_client/v2/api/fleet_automation_api.rb', line 115

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FleetAutomationAPI.create_fleet_deployment_configure ...'
  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 FleetAutomationAPI.create_fleet_deployment_configure"
  end
  # resource path
  local_var_path = '/api/unstable/fleet/deployments/configure'

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

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

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

#get_fleet_deployment(deployment_id, opts = {}) ⇒ Object

Get a deployment by ID.

See Also:



176
177
178
179
 
# File 'lib/datadog_api_client/v2/api/fleet_automation_api.rb', line 176

def get_fleet_deployment(deployment_id, opts = {})
  data, _status_code, _headers = get_fleet_deployment_with_http_info(deployment_id, opts)
  data
end

#get_fleet_deployment_with_http_info(deployment_id, opts = {}) ⇒ Array<(FleetDeploymentResponse, Integer, Hash)>

Get a deployment by ID.

Retrieve the details of a specific deployment using its unique identifier.

Parameters:

  • deployment_id (String) —

    The unique identifier of the deployment to retrieve.

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

    the optional parameters

Returns:

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

    FleetDeploymentResponse data, response status code and response headers



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
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/datadog_api_client/v2/api/fleet_automation_api.rb', line 188

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FleetAutomationAPI.get_fleet_deployment ...'
  end
  # verify the required parameter 'deployment_id' is set
  if @api_client.config.client_side_validation && deployment_id.nil?
    fail ArgumentError, "Missing the required parameter 'deployment_id' when calling FleetAutomationAPI.get_fleet_deployment"
  end
  # resource path
  local_var_path = '/api/unstable/fleet/deployments/{deployment_id}'.sub('{deployment_id}', CGI.escape(deployment_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] || 'FleetDeploymentResponse'

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

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

#list_fleet_deployments(opts = {}) ⇒ Object

List all deployments.

See Also:



247
248
249
250
 
# File 'lib/datadog_api_client/v2/api/fleet_automation_api.rb', line 247

def list_fleet_deployments(opts = {})
  data, _status_code, _headers = list_fleet_deployments_with_http_info(opts)
  data
end

#list_fleet_deployments_with_http_info(opts = {}) ⇒ Array<(FleetDeploymentsResponse, Integer, Hash)>

List all deployments.

Retrieve a list of all deployments for fleet automation. Use the page_size and page_offset parameters to paginate results.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Number of deployments to return per page. Maximum value is 100.

  • :page_offset (Integer) —

    Index of the first deployment to return. Use this with page_size to paginate through results.

Returns:

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

    FleetDeploymentsResponse data, response status code and response headers



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
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/datadog_api_client/v2/api/fleet_automation_api.rb', line 261

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FleetAutomationAPI.list_fleet_deployments ...'
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling FleetAutomationAPI.list_fleet_deployments, must be smaller than or equal to 100.'
  end
  # resource path
  local_var_path = '/api/unstable/fleet/deployments'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'page_offset'] = opts[:'page_offset'] if !opts[:'page_offset'].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] || 'FleetDeploymentsResponse'

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

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