Class: DatadogAPIClient::V2::WorkflowAutomationAPI

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of WorkflowAutomationAPI.



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

def api_client
  @api_client
end

Instance Method Details

#cancel_workflow_instance(workflow_id, instance_id, opts = {}) ⇒ Object

Cancel a workflow instance.

See Also:



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

def cancel_workflow_instance(workflow_id, instance_id, opts = {})
  data, _status_code, _headers = cancel_workflow_instance_with_http_info(workflow_id, instance_id, opts)
  data
end

#cancel_workflow_instance_with_http_info(workflow_id, instance_id, opts = {}) ⇒ Array<(WorklflowCancelInstanceResponse, Integer, Hash)>

Cancel a workflow instance.

Cancels a specific execution of a given workflow. This API requires an application key scoped with the workflows_run permission.

Parameters:

  • workflow_id (String) —

    The ID of the workflow.

  • instance_id (String) —

    The ID of the workflow instance.

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

    the optional parameters

Returns:



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
92
93
94
 
# File 'lib/datadog_api_client/v2/api/workflow_automation_api.rb', line 42

def cancel_workflow_instance_with_http_info(workflow_id, instance_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WorkflowAutomationAPI.cancel_workflow_instance ...'
  end
  # verify the required parameter 'workflow_id' is set
  if @api_client.config.client_side_validation && workflow_id.nil?
    fail ArgumentError, "Missing the required parameter 'workflow_id' when calling WorkflowAutomationAPI.cancel_workflow_instance"
  end
  # verify the required parameter 'instance_id' is set
  if @api_client.config.client_side_validation && instance_id.nil?
    fail ArgumentError, "Missing the required parameter 'instance_id' when calling WorkflowAutomationAPI.cancel_workflow_instance"
  end
  # resource path
  local_var_path = '/api/v2/workflows/{workflow_id}/instances/{instance_id}/cancel'.sub('{workflow_id}', CGI.escape(workflow_id.to_s).gsub('%2F', '/')).sub('{instance_id}', CGI.escape(instance_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] || 'WorklflowCancelInstanceResponse'

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

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

#create_workflow_instance(workflow_id, body, opts = {}) ⇒ Object

Execute a workflow.

See Also:



99
100
101
102
 
# File 'lib/datadog_api_client/v2/api/workflow_automation_api.rb', line 99

def create_workflow_instance(workflow_id, body, opts = {})
  data, _status_code, _headers = create_workflow_instance_with_http_info(workflow_id, body, opts)
  data
end

#create_workflow_instance_with_http_info(workflow_id, body, opts = {}) ⇒ Array<(WorkflowInstanceCreateResponse, Integer, Hash)>

Execute a workflow.

Execute the given workflow. This API requires an application key scoped with the workflows_run permission.

Parameters:

  • workflow_id (String) —

    The ID of the workflow.

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

    the optional parameters

Returns:



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
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/datadog_api_client/v2/api/workflow_automation_api.rb', line 112

def create_workflow_instance_with_http_info(workflow_id, body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WorkflowAutomationAPI.create_workflow_instance ...'
  end
  # verify the required parameter 'workflow_id' is set
  if @api_client.config.client_side_validation && workflow_id.nil?
    fail ArgumentError, "Missing the required parameter 'workflow_id' when calling WorkflowAutomationAPI.create_workflow_instance"
  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 WorkflowAutomationAPI.create_workflow_instance"
  end
  # resource path
  local_var_path = '/api/v2/workflows/{workflow_id}/instances'.sub('{workflow_id}', CGI.escape(workflow_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'])
  # 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] || 'WorkflowInstanceCreateResponse'

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

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

#get_workflow_instance(workflow_id, instance_id, opts = {}) ⇒ Object

Get a workflow instance.

See Also:



171
172
173
174
 
# File 'lib/datadog_api_client/v2/api/workflow_automation_api.rb', line 171

def get_workflow_instance(workflow_id, instance_id, opts = {})
  data, _status_code, _headers = get_workflow_instance_with_http_info(workflow_id, instance_id, opts)
  data
end

#get_workflow_instance_with_http_info(workflow_id, instance_id, opts = {}) ⇒ Array<(WorklflowGetInstanceResponse, Integer, Hash)>

Get a workflow instance.

Get a specific execution of a given workflow. This API requires an application key scoped with the workflows_read permission.

Parameters:

  • workflow_id (String) —

    The ID of the workflow.

  • instance_id (String) —

    The ID of the workflow instance.

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

    the optional parameters

Returns:



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
228
229
230
231
232
233
234
235
236
 
# File 'lib/datadog_api_client/v2/api/workflow_automation_api.rb', line 184

def get_workflow_instance_with_http_info(workflow_id, instance_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WorkflowAutomationAPI.get_workflow_instance ...'
  end
  # verify the required parameter 'workflow_id' is set
  if @api_client.config.client_side_validation && workflow_id.nil?
    fail ArgumentError, "Missing the required parameter 'workflow_id' when calling WorkflowAutomationAPI.get_workflow_instance"
  end
  # verify the required parameter 'instance_id' is set
  if @api_client.config.client_side_validation && instance_id.nil?
    fail ArgumentError, "Missing the required parameter 'instance_id' when calling WorkflowAutomationAPI.get_workflow_instance"
  end
  # resource path
  local_var_path = '/api/v2/workflows/{workflow_id}/instances/{instance_id}'.sub('{workflow_id}', CGI.escape(workflow_id.to_s).gsub('%2F', '/')).sub('{instance_id}', CGI.escape(instance_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] || 'WorklflowGetInstanceResponse'

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

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

#list_workflow_instances(workflow_id, opts = {}) ⇒ Object

List workflow instances.

See Also:



241
242
243
244
 
# File 'lib/datadog_api_client/v2/api/workflow_automation_api.rb', line 241

def list_workflow_instances(workflow_id, opts = {})
  data, _status_code, _headers = list_workflow_instances_with_http_info(workflow_id, opts)
  data
end

#list_workflow_instances_with_http_info(workflow_id, opts = {}) ⇒ Array<(WorkflowListInstancesResponse, Integer, Hash)>

List workflow instances.

List all instances of a given workflow. This API requires an application key scoped with the workflows_read permission.

Parameters:

  • workflow_id (String) —

    The ID of the workflow.

  • 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.

Returns:



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
298
299
300
301
302
303
304
305
 
# File 'lib/datadog_api_client/v2/api/workflow_automation_api.rb', line 255

def list_workflow_instances_with_http_info(workflow_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WorkflowAutomationAPI.list_workflow_instances ...'
  end
  # verify the required parameter 'workflow_id' is set
  if @api_client.config.client_side_validation && workflow_id.nil?
    fail ArgumentError, "Missing the required parameter 'workflow_id' when calling WorkflowAutomationAPI.list_workflow_instances"
  end
  # resource path
  local_var_path = '/api/v2/workflows/{workflow_id}/instances'.sub('{workflow_id}', CGI.escape(workflow_id.to_s).gsub('%2F', '/'))

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

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

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

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