Class: Azure::Logic::Mgmt::V2016_06_01::WorkflowTriggerHistories

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

Overview

REST API for Azure Logic Apps.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ WorkflowTriggerHistories

Creates and initializes a new instance of the WorkflowTriggerHistories class.

Parameters:

  • client —

    service class for accessing basic functionality.



17
18
19
 
# File 'lib/2016-06-01/generated/azure_mgmt_logic/workflow_trigger_histories.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_trigger_histories.rb', line 22

def client
  @client
end

Instance Method Details

#get(resource_group_name, workflow_name, trigger_name, history_name, custom_headers: nil) ⇒ WorkflowTriggerHistory

Gets a workflow trigger history.

to the run name for triggers that resulted in a run. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • workflow_name (String) —

    The workflow name.

  • trigger_name (String) —

    The workflow trigger name.

  • history_name (String) —

    The workflow trigger history name. Corresponds

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

    A hash of custom headers that

Returns:

  • (WorkflowTriggerHistory) —

    operation results.



142
143
144
145
 
# File 'lib/2016-06-01/generated/azure_mgmt_logic/workflow_trigger_histories.rb', line 142

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

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

Gets a workflow trigger history.

to the run name for triggers that resulted in a run. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • workflow_name (String) —

    The workflow name.

  • trigger_name (String) —

    The workflow trigger name.

  • history_name (String) —

    The workflow trigger history name. Corresponds

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
228
229
230
 
# File 'lib/2016-06-01/generated/azure_mgmt_logic/workflow_trigger_histories.rb', line 177

def get_async(resource_group_name, workflow_name, trigger_name, history_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, 'trigger_name is nil' if trigger_name.nil?
  fail ArgumentError, 'history_name is nil' if history_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}/triggers/{triggerName}/histories/{historyName}'

  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,'triggerName' => trigger_name,'historyName' => history_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::WorkflowTriggerHistory.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, trigger_name, history_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets a workflow trigger history.

to the run name for triggers that resulted in a run. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • workflow_name (String) —

    The workflow name.

  • trigger_name (String) —

    The workflow trigger name.

  • history_name (String) —

    The workflow trigger history name. Corresponds

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



160
161
162
 
# File 'lib/2016-06-01/generated/azure_mgmt_logic/workflow_trigger_histories.rb', line 160

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

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

Gets a list of workflow trigger histories.

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.

  • trigger_name (String) —

    The workflow trigger 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<WorkflowTriggerHistory>) —

    operation results.



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

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

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

Gets a list of workflow trigger histories.

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

of the response.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • workflow_name (String) —

    The workflow name.

  • trigger_name (String) —

    The workflow trigger 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:

  • (WorkflowTriggerHistoryListResult) —

    which provide lazy access to pages



427
428
429
430
431
432
433
434
435
436
 
# File 'lib/2016-06-01/generated/azure_mgmt_logic/workflow_trigger_histories.rb', line 427

def list_as_lazy(resource_group_name, workflow_name, trigger_name, top:nil, filter:nil, custom_headers:nil)
  response = list_async(resource_group_name, workflow_name, trigger_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, trigger_name, top: nil, filter: nil, custom_headers: nil) ⇒ Concurrent::Promise

Gets a list of workflow trigger histories.

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.

  • trigger_name (String) —

    The workflow trigger 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.



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
124
125
126
127
 
# File 'lib/2016-06-01/generated/azure_mgmt_logic/workflow_trigger_histories.rb', line 75

def list_async(resource_group_name, workflow_name, trigger_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, 'trigger_name is nil' if trigger_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}/triggers/{triggerName}/histories'

  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,'triggerName' => trigger_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::WorkflowTriggerHistoryListResult.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) ⇒ WorkflowTriggerHistoryListResult

Gets a list of workflow trigger histories.

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:

  • (WorkflowTriggerHistoryListResult) —

    operation results.



334
335
336
337
 
# File 'lib/2016-06-01/generated/azure_mgmt_logic/workflow_trigger_histories.rb', line 334

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 trigger histories.

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.



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
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
 
# File 'lib/2016-06-01/generated/azure_mgmt_logic/workflow_trigger_histories.rb', line 363

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::WorkflowTriggerHistoryListResult.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 trigger histories.

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.



349
350
351
 
# File 'lib/2016-06-01/generated/azure_mgmt_logic/workflow_trigger_histories.rb', line 349

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, trigger_name, top: nil, filter: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets a list of workflow trigger histories.

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.

  • trigger_name (String) —

    The workflow trigger 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.



57
58
59
 
# File 'lib/2016-06-01/generated/azure_mgmt_logic/workflow_trigger_histories.rb', line 57

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

#resubmit(resource_group_name, workflow_name, trigger_name, history_name, custom_headers: nil) ⇒ Object

Resubmits a workflow run based on the trigger history.

to the run name for triggers that resulted in a run. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • workflow_name (String) —

    The workflow name.

  • trigger_name (String) —

    The workflow trigger name.

  • history_name (String) —

    The workflow trigger history name. Corresponds

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

    A hash of custom headers that



244
245
246
247
 
# File 'lib/2016-06-01/generated/azure_mgmt_logic/workflow_trigger_histories.rb', line 244

def resubmit(resource_group_name, workflow_name, trigger_name, history_name, custom_headers:nil)
  response = resubmit_async(resource_group_name, workflow_name, trigger_name, history_name, custom_headers:custom_headers).value!
  nil
end

#resubmit_async(resource_group_name, workflow_name, trigger_name, history_name, custom_headers: nil) ⇒ Concurrent::Promise

Resubmits a workflow run based on the trigger history.

to the run name for triggers that resulted in a run. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • workflow_name (String) —

    The workflow name.

  • trigger_name (String) —

    The workflow trigger name.

  • history_name (String) —

    The workflow trigger history name. Corresponds

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
317
318
319
320
321
322
 
# File 'lib/2016-06-01/generated/azure_mgmt_logic/workflow_trigger_histories.rb', line 279

def resubmit_async(resource_group_name, workflow_name, trigger_name, history_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, 'trigger_name is nil' if trigger_name.nil?
  fail ArgumentError, 'history_name is nil' if history_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}/triggers/{triggerName}/histories/{historyName}/resubmit'

  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,'triggerName' => trigger_name,'historyName' => history_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 == 202
      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

#resubmit_with_http_info(resource_group_name, workflow_name, trigger_name, history_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Resubmits a workflow run based on the trigger history.

to the run name for triggers that resulted in a run. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • workflow_name (String) —

    The workflow name.

  • trigger_name (String) —

    The workflow trigger name.

  • history_name (String) —

    The workflow trigger history name. Corresponds

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



262
263
264
 
# File 'lib/2016-06-01/generated/azure_mgmt_logic/workflow_trigger_histories.rb', line 262

def resubmit_with_http_info(resource_group_name, workflow_name, trigger_name, history_name, custom_headers:nil)
  resubmit_async(resource_group_name, workflow_name, trigger_name, history_name, custom_headers:custom_headers).value!
end