Class: Azure::Logic::Mgmt::V2016_06_01::WorkflowRuns

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2016-06-01/generated/azure_mgmt_logic/workflow_runs.rb

Overview

REST API for Azure Logic Apps.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ WorkflowRuns

Creates and initializes a new instance of the WorkflowRuns class.

Parameters:

  • client —

    service class for accessing basic functionality.



17
18
19
 
# File 'lib/2016-06-01/generated/azure_mgmt_logic/workflow_runs.rb', line 17

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ LogicManagementClient (readonly)

Returns reference to the LogicManagementClient.

Returns:



22
23
24
 
# File 'lib/2016-06-01/generated/azure_mgmt_logic/workflow_runs.rb', line 22

def client
  @client
end

Instance Method Details

#cancel(resource_group_name, workflow_name, run_name, custom_headers: nil) ⇒ Object

Cancels a workflow run.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • workflow_name (String) —

    The workflow name.

  • run_name (String) —

    The workflow run name.

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that



231
232
233
234
 
# File 'lib/2016-06-01/generated/azure_mgmt_logic/workflow_runs.rb', line 231

def cancel(resource_group_name, workflow_name, run_name, custom_headers:nil)
  response = cancel_async(resource_group_name, workflow_name, run_name, custom_headers:custom_headers).value!
  nil
end

#cancel_async(resource_group_name, workflow_name, run_name, custom_headers: nil) ⇒ Concurrent::Promise

Cancels a workflow run.

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • workflow_name (String) —

    The workflow name.

  • run_name (String) —

    The workflow run name.

  • A (Hash{String => String}) —

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
 
# File 'lib/2016-06-01/generated/azure_mgmt_logic/workflow_runs.rb', line 262

def cancel_async(resource_group_name, workflow_name, run_name, custom_headers:nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'workflow_name is nil' if workflow_name.nil?
  fail ArgumentError, 'run_name is nil' if run_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs/{runName}/cancel'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'workflowName' => workflow_name,'runName' => run_name},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:post, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      error_model = JSON.load(response_content)
      fail MsRestAzure::AzureOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?

    result
  end

  promise.execute
end

#cancel_with_http_info(resource_group_name, workflow_name, run_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Cancels a workflow run.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • workflow_name (String) —

    The workflow name.

  • run_name (String) —

    The workflow run name.

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



247
248
249
 
# File 'lib/2016-06-01/generated/azure_mgmt_logic/workflow_runs.rb', line 247

def cancel_with_http_info(resource_group_name, workflow_name, run_name, custom_headers:nil)
  cancel_async(resource_group_name, workflow_name, run_name, custom_headers:custom_headers).value!
end

#get(resource_group_name, workflow_name, run_name, custom_headers: nil) ⇒ WorkflowRun

Gets a workflow run.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • workflow_name (String) —

    The workflow name.

  • run_name (String) —

    The workflow run name.

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (WorkflowRun) —

    operation results.



136
137
138
139
 
# File 'lib/2016-06-01/generated/azure_mgmt_logic/workflow_runs.rb', line 136

def get(resource_group_name, workflow_name, run_name, custom_headers:nil)
  response = get_async(resource_group_name, workflow_name, run_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#get_async(resource_group_name, workflow_name, run_name, custom_headers: nil) ⇒ Concurrent::Promise

Gets a workflow run.

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • workflow_name (String) —

    The workflow name.

  • run_name (String) —

    The workflow run name.

  • A (Hash{String => String}) —

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



167
168
169
170
171
172
173
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
 
# File 'lib/2016-06-01/generated/azure_mgmt_logic/workflow_runs.rb', line 167

def get_async(resource_group_name, workflow_name, run_name, custom_headers:nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'workflow_name is nil' if workflow_name.nil?
  fail ArgumentError, 'run_name is nil' if run_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs/{runName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'workflowName' => workflow_name,'runName' => run_name},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:get, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      error_model = JSON.load(response_content)
      fail MsRestAzure::AzureOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Logic::Mgmt::V2016_06_01::Models::WorkflowRun.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#get_with_http_info(resource_group_name, workflow_name, run_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets a workflow run.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • workflow_name (String) —

    The workflow name.

  • run_name (String) —

    The workflow run name.

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



152
153
154
 
# File 'lib/2016-06-01/generated/azure_mgmt_logic/workflow_runs.rb', line 152

def get_with_http_info(resource_group_name, workflow_name, run_name, custom_headers:nil)
  get_async(resource_group_name, workflow_name, run_name, custom_headers:custom_headers).value!
end

#list(resource_group_name, workflow_name, top: nil, filter: nil, custom_headers: nil) ⇒ Array<WorkflowRun>

Gets a list of workflow runs.

filters include: Status, StartTime, and ClientTrackingId. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • workflow_name (String) —

    The workflow name.

  • top (Integer) (defaults to: nil) —

    The number of items to be included in the result.

  • filter (String) (defaults to: nil) —

    The filter to apply on the operation. Options for

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (Array<WorkflowRun>) —

    operation results.



37
38
39
40
 
# File 'lib/2016-06-01/generated/azure_mgmt_logic/workflow_runs.rb', line 37

def list(resource_group_name, workflow_name, top:nil, filter:nil, custom_headers:nil)
  first_page = list_as_lazy(resource_group_name, workflow_name, top:top, filter:filter, custom_headers:custom_headers)
  first_page.get_all_items
end

#list_as_lazy(resource_group_name, workflow_name, top: nil, filter: nil, custom_headers: nil) ⇒ WorkflowRunListResult

Gets a list of workflow runs.

filters include: Status, StartTime, and ClientTrackingId. will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • workflow_name (String) —

    The workflow name.

  • top (Integer) (defaults to: nil) —

    The number of items to be included in the result.

  • filter (String) (defaults to: nil) —

    The filter to apply on the operation. Options for

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (WorkflowRunListResult) —

    which provide lazy access to pages of the



408
409
410
411
412
413
414
415
416
417
 
# File 'lib/2016-06-01/generated/azure_mgmt_logic/workflow_runs.rb', line 408

def list_as_lazy(resource_group_name, workflow_name, top:nil, filter:nil, custom_headers:nil)
  response = list_async(resource_group_name, workflow_name, top:top, filter:filter, custom_headers:custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_page_link|
      list_next_async(next_page_link, custom_headers:custom_headers)
    end
    page
  end
end

#list_async(resource_group_name, workflow_name, top: nil, filter: nil, custom_headers: nil) ⇒ Concurrent::Promise

Gets a list of workflow runs.

filters include: Status, StartTime, and ClientTrackingId. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • workflow_name (String) —

    The workflow name.

  • top (Integer) (defaults to: nil) —

    The number of items to be included in the result.

  • filter (String) (defaults to: nil) —

    The filter to apply on the operation. Options for

  • A (Hash{String => String}) —

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/2016-06-01/generated/azure_mgmt_logic/workflow_runs.rb', line 72

def list_async(resource_group_name, workflow_name, top:nil, filter:nil, custom_headers:nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'workflow_name is nil' if workflow_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'workflowName' => workflow_name},
      query_params: {'api-version' => @client.api_version,'$top' => top,'$filter' => filter},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:get, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      error_model = JSON.load(response_content)
      fail MsRestAzure::AzureOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Logic::Mgmt::V2016_06_01::Models::WorkflowRunListResult.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#list_next(next_page_link, custom_headers: nil) ⇒ WorkflowRunListResult

Gets a list of workflow runs.

to List operation. will be added to the HTTP request.

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful call

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (WorkflowRunListResult) —

    operation results.



316
317
318
319
 
# File 'lib/2016-06-01/generated/azure_mgmt_logic/workflow_runs.rb', line 316

def list_next(next_page_link, custom_headers:nil)
  response = list_next_async(next_page_link, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#list_next_async(next_page_link, custom_headers: nil) ⇒ Concurrent::Promise

Gets a list of workflow runs.

to List operation. to the HTTP request.

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful call

  • A (Hash{String => String}) —

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
 
# File 'lib/2016-06-01/generated/azure_mgmt_logic/workflow_runs.rb', line 345

def list_next_async(next_page_link, custom_headers:nil)
  fail ArgumentError, 'next_page_link is nil' if next_page_link.nil?


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = '{nextLink}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      skip_encoding_path_params: {'nextLink' => next_page_link},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:get, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      error_model = JSON.load(response_content)
      fail MsRestAzure::AzureOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Logic::Mgmt::V2016_06_01::Models::WorkflowRunListResult.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#list_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets a list of workflow runs.

to List operation. will be added to the HTTP request.

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful call

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



331
332
333
 
# File 'lib/2016-06-01/generated/azure_mgmt_logic/workflow_runs.rb', line 331

def list_next_with_http_info(next_page_link, custom_headers:nil)
  list_next_async(next_page_link, custom_headers:custom_headers).value!
end

#list_with_http_info(resource_group_name, workflow_name, top: nil, filter: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets a list of workflow runs.

filters include: Status, StartTime, and ClientTrackingId. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • workflow_name (String) —

    The workflow name.

  • top (Integer) (defaults to: nil) —

    The number of items to be included in the result.

  • filter (String) (defaults to: nil) —

    The filter to apply on the operation. Options for

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



55
56
57
 
# File 'lib/2016-06-01/generated/azure_mgmt_logic/workflow_runs.rb', line 55

def list_with_http_info(resource_group_name, workflow_name, top:nil, filter:nil, custom_headers:nil)
  list_async(resource_group_name, workflow_name, top:top, filter:filter, custom_headers:custom_headers).value!
end