Class: Azure::Logic::Mgmt::V2016_06_01::WorkflowVersions

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

Overview

REST API for Azure Logic Apps.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ WorkflowVersions

Creates and initializes a new instance of the WorkflowVersions class.

Parameters:

  • client —

    service class for accessing basic functionality.



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

def client
  @client
end

Instance Method Details

#get(resource_group_name, workflow_name, version_id, custom_headers: nil) ⇒ WorkflowVersion

Gets a workflow version.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • workflow_name (String) —

    The workflow name.

  • version_id (String) —

    The workflow versionId.

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

    A hash of custom headers that

Returns:

  • (WorkflowVersion) —

    operation results.



130
131
132
133
 
# File 'lib/2016-06-01/generated/azure_mgmt_logic/workflow_versions.rb', line 130

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

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

Gets a workflow version.

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • workflow_name (String) —

    The workflow name.

  • version_id (String) —

    The workflow versionId.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



161
162
163
164
165
166
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
 
# File 'lib/2016-06-01/generated/azure_mgmt_logic/workflow_versions.rb', line 161

def get_async(resource_group_name, workflow_name, version_id, 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, 'version_id is nil' if version_id.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}/versions/{versionId}'

  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,'versionId' => version_id},
      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::WorkflowVersion.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, version_id, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets a workflow version.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • workflow_name (String) —

    The workflow name.

  • version_id (String) —

    The workflow versionId.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



146
147
148
 
# File 'lib/2016-06-01/generated/azure_mgmt_logic/workflow_versions.rb', line 146

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

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

Gets a list of workflow versions.

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.

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

    A hash of custom headers that

Returns:

  • (Array<WorkflowVersion>) —

    operation results.



35
36
37
38
 
# File 'lib/2016-06-01/generated/azure_mgmt_logic/workflow_versions.rb', line 35

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

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

Gets a list of workflow versions.

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.

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

    A hash of custom headers that

Returns:

  • (WorkflowVersionListResult) —

    which provide lazy access to pages of the



425
426
427
428
429
430
431
432
433
434
 
# File 'lib/2016-06-01/generated/azure_mgmt_logic/workflow_versions.rb', line 425

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

Gets a list of workflow versions.

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.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/2016-06-01/generated/azure_mgmt_logic/workflow_versions.rb', line 66

def list_async(resource_group_name, workflow_name, top: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}/versions'

  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},
      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::WorkflowVersionListResult.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_callback_url(resource_group_name, workflow_name, version_id, trigger_name, parameters: nil, custom_headers: nil) ⇒ WorkflowTriggerCallbackUrl

Get the callback url for a trigger of a workflow version.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • workflow_name (String) —

    The workflow name.

  • version_id (String) —

    The workflow versionId.

  • trigger_name (String) —

    The workflow trigger name.

  • parameters (GetCallbackUrlParameters) (defaults to: nil) —

    The callback URL parameters.

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

    A hash of custom headers that

Returns:

  • (WorkflowTriggerCallbackUrl) —

    operation results.



228
229
230
231
 
# File 'lib/2016-06-01/generated/azure_mgmt_logic/workflow_versions.rb', line 228

def list_callback_url(resource_group_name, workflow_name, version_id, trigger_name, parameters:nil, custom_headers:nil)
  response = list_callback_url_async(resource_group_name, workflow_name, version_id, trigger_name, parameters:parameters, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#list_callback_url_async(resource_group_name, workflow_name, version_id, trigger_name, parameters: nil, custom_headers: nil) ⇒ Concurrent::Promise

Get the callback url for a trigger of a workflow version.

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • workflow_name (String) —

    The workflow name.

  • version_id (String) —

    The workflow versionId.

  • trigger_name (String) —

    The workflow trigger name.

  • parameters (GetCallbackUrlParameters) (defaults to: nil) —

    The callback URL parameters.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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

def list_callback_url_async(resource_group_name, workflow_name, version_id, trigger_name, parameters: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, 'version_id is nil' if version_id.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?

  # Serialize Request
  request_mapper = Azure::Logic::Mgmt::V2016_06_01::Models::GetCallbackUrlParameters.mapper()
  request_content = @client.serialize(request_mapper,  parameters)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/versions/{versionId}/triggers/{triggerName}/listCallbackUrl'

  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,'versionId' => version_id,'triggerName' => trigger_name},
      query_params: {'api-version' => @client.api_version},
      body: request_content,
      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?
    # 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::WorkflowTriggerCallbackUrl.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_callback_url_with_http_info(resource_group_name, workflow_name, version_id, trigger_name, parameters: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Get the callback url for a trigger of a workflow version.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • workflow_name (String) —

    The workflow name.

  • version_id (String) —

    The workflow versionId.

  • trigger_name (String) —

    The workflow trigger name.

  • parameters (GetCallbackUrlParameters) (defaults to: nil) —

    The callback URL parameters.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



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

def list_callback_url_with_http_info(resource_group_name, workflow_name, version_id, trigger_name, parameters:nil, custom_headers:nil)
  list_callback_url_async(resource_group_name, workflow_name, version_id, trigger_name, parameters:parameters, custom_headers:custom_headers).value!
end

#list_next(next_page_link, custom_headers: nil) ⇒ WorkflowVersionListResult

Gets a list of workflow versions.

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:

  • (WorkflowVersionListResult) —

    operation results.



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

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

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.



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

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::WorkflowVersionListResult.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 versions.

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.



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

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

Gets a list of workflow versions.

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.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



51
52
53
 
# File 'lib/2016-06-01/generated/azure_mgmt_logic/workflow_versions.rb', line 51

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