Class: Azure::MediaServices::Mgmt::V2018_07_01::Jobs

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2018-07-01/generated/azure_mgmt_media_services/jobs.rb

Overview

Jobs

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Jobs

Creates and initializes a new instance of the Jobs class.

Parameters:

  • client —

    service class for accessing basic functionality.



17
18
19
 
# File 'lib/2018-07-01/generated/azure_mgmt_media_services/jobs.rb', line 17

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ AzureMediaServices (readonly)

Returns reference to the AzureMediaServices.

Returns:



22
23
24
 
# File 'lib/2018-07-01/generated/azure_mgmt_media_services/jobs.rb', line 22

def client
  @client
end

Instance Method Details

#cancel_job(resource_group_name, account_name, transform_name, job_name, custom_headers: nil) ⇒ Object

Cancel Job

Cancel a Job.

Azure subscription. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group within the

  • account_name (String) —

    The Media Services account name.

  • transform_name (String) —

    The Transform name.

  • job_name (String) —

    The Job name.

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

    A hash of custom headers that



615
616
617
618
 
# File 'lib/2018-07-01/generated/azure_mgmt_media_services/jobs.rb', line 615

def cancel_job(resource_group_name, , transform_name, job_name, custom_headers:nil)
  response = cancel_job_async(resource_group_name, , transform_name, job_name, custom_headers:custom_headers).value!
  nil
end

#cancel_job_async(resource_group_name, account_name, transform_name, job_name, custom_headers: nil) ⇒ Concurrent::Promise

Cancel Job

Cancel a Job.

Azure subscription. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group within the

  • account_name (String) —

    The Media Services account name.

  • transform_name (String) —

    The Transform name.

  • job_name (String) —

    The Job name.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
 
# File 'lib/2018-07-01/generated/azure_mgmt_media_services/jobs.rb', line 654

def cancel_job_async(resource_group_name, , transform_name, job_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, 'account_name is nil' if .nil?
  fail ArgumentError, 'transform_name is nil' if transform_name.nil?
  fail ArgumentError, 'job_name is nil' if job_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.Media/mediaServices/{accountName}/transforms/{transformName}/jobs/{jobName}/cancelJob'

  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,'accountName' => ,'transformName' => transform_name,'jobName' => job_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 MsRest::HttpOperationError.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.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?

    result
  end

  promise.execute
end

#cancel_job_with_http_info(resource_group_name, account_name, transform_name, job_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Cancel Job

Cancel a Job.

Azure subscription. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group within the

  • account_name (String) —

    The Media Services account name.

  • transform_name (String) —

    The Transform name.

  • job_name (String) —

    The Job name.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



635
636
637
 
# File 'lib/2018-07-01/generated/azure_mgmt_media_services/jobs.rb', line 635

def cancel_job_with_http_info(resource_group_name, , transform_name, job_name, custom_headers:nil)
  cancel_job_async(resource_group_name, , transform_name, job_name, custom_headers:custom_headers).value!
end

#create(resource_group_name, account_name, transform_name, job_name, parameters, custom_headers: nil) ⇒ Job

Create Job

Creates a Job.

Azure subscription. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group within the

  • account_name (String) —

    The Media Services account name.

  • transform_name (String) —

    The Transform name.

  • job_name (String) —

    The Job name.

  • parameters (Job) —

    The request parameters

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

    A hash of custom headers that

Returns:

  • (Job) —

    operation results.



267
268
269
270
 
# File 'lib/2018-07-01/generated/azure_mgmt_media_services/jobs.rb', line 267

def create(resource_group_name, , transform_name, job_name, parameters, custom_headers:nil)
  response = create_async(resource_group_name, , transform_name, job_name, parameters, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#create_async(resource_group_name, account_name, transform_name, job_name, parameters, custom_headers: nil) ⇒ Concurrent::Promise

Create Job

Creates a Job.

Azure subscription. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group within the

  • account_name (String) —

    The Media Services account name.

  • transform_name (String) —

    The Transform name.

  • job_name (String) —

    The Job name.

  • parameters (Job) —

    The request parameters

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
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
 
# File 'lib/2018-07-01/generated/azure_mgmt_media_services/jobs.rb', line 308

def create_async(resource_group_name, , transform_name, job_name, parameters, 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, 'account_name is nil' if .nil?
  fail ArgumentError, 'transform_name is nil' if transform_name.nil?
  fail ArgumentError, 'job_name is nil' if job_name.nil?
  fail ArgumentError, 'parameters is nil' if parameters.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::MediaServices::Mgmt::V2018_07_01::Models::Job.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.Media/mediaServices/{accountName}/transforms/{transformName}/jobs/{jobName}'

  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,'accountName' => ,'transformName' => transform_name,'jobName' => job_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(:put, 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 == 201
      error_model = JSON.load(response_content)
      fail MsRest::HttpOperationError.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.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 201
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::MediaServices::Mgmt::V2018_07_01::Models::Job.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

#create_with_http_info(resource_group_name, account_name, transform_name, job_name, parameters, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Create Job

Creates a Job.

Azure subscription. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group within the

  • account_name (String) —

    The Media Services account name.

  • transform_name (String) —

    The Transform name.

  • job_name (String) —

    The Job name.

  • parameters (Job) —

    The request parameters

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



288
289
290
 
# File 'lib/2018-07-01/generated/azure_mgmt_media_services/jobs.rb', line 288

def create_with_http_info(resource_group_name, , transform_name, job_name, parameters, custom_headers:nil)
  create_async(resource_group_name, , transform_name, job_name, parameters, custom_headers:custom_headers).value!
end

#delete(resource_group_name, account_name, transform_name, job_name, custom_headers: nil) ⇒ Object

Delete Job

Deletes a Job.

Azure subscription. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group within the

  • account_name (String) —

    The Media Services account name.

  • transform_name (String) —

    The Transform name.

  • job_name (String) —

    The Job name.

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

    A hash of custom headers that



387
388
389
390
 
# File 'lib/2018-07-01/generated/azure_mgmt_media_services/jobs.rb', line 387

def delete(resource_group_name, , transform_name, job_name, custom_headers:nil)
  response = delete_async(resource_group_name, , transform_name, job_name, custom_headers:custom_headers).value!
  nil
end

#delete_async(resource_group_name, account_name, transform_name, job_name, custom_headers: nil) ⇒ Concurrent::Promise

Delete Job

Deletes a Job.

Azure subscription. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group within the

  • account_name (String) —

    The Media Services account name.

  • transform_name (String) —

    The Transform name.

  • job_name (String) —

    The Job name.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
 
# File 'lib/2018-07-01/generated/azure_mgmt_media_services/jobs.rb', line 426

def delete_async(resource_group_name, , transform_name, job_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, 'account_name is nil' if .nil?
  fail ArgumentError, 'transform_name is nil' if transform_name.nil?
  fail ArgumentError, 'job_name is nil' if job_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.Media/mediaServices/{accountName}/transforms/{transformName}/jobs/{jobName}'

  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,'accountName' => ,'transformName' => transform_name,'jobName' => job_name},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:delete, 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 || status_code == 204
      error_model = JSON.load(response_content)
      fail MsRest::HttpOperationError.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.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?

    result
  end

  promise.execute
end

#delete_with_http_info(resource_group_name, account_name, transform_name, job_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Delete Job

Deletes a Job.

Azure subscription. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group within the

  • account_name (String) —

    The Media Services account name.

  • transform_name (String) —

    The Transform name.

  • job_name (String) —

    The Job name.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



407
408
409
 
# File 'lib/2018-07-01/generated/azure_mgmt_media_services/jobs.rb', line 407

def delete_with_http_info(resource_group_name, , transform_name, job_name, custom_headers:nil)
  delete_async(resource_group_name, , transform_name, job_name, custom_headers:custom_headers).value!
end

#get(resource_group_name, account_name, transform_name, job_name, custom_headers: nil) ⇒ Job

Get Job

Gets a Job.

Azure subscription. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group within the

  • account_name (String) —

    The Media Services account name.

  • transform_name (String) —

    The Transform name.

  • job_name (String) —

    The Job name.

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

    A hash of custom headers that

Returns:

  • (Job) —

    operation results.



155
156
157
158
 
# File 'lib/2018-07-01/generated/azure_mgmt_media_services/jobs.rb', line 155

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

#get_async(resource_group_name, account_name, transform_name, job_name, custom_headers: nil) ⇒ Concurrent::Promise

Get Job

Gets a Job.

Azure subscription. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group within the

  • account_name (String) —

    The Media Services account name.

  • transform_name (String) —

    The Transform name.

  • job_name (String) —

    The Job name.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
243
244
245
246
247
248
249
 
# File 'lib/2018-07-01/generated/azure_mgmt_media_services/jobs.rb', line 194

def get_async(resource_group_name, , transform_name, job_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, 'account_name is nil' if .nil?
  fail ArgumentError, 'transform_name is nil' if transform_name.nil?
  fail ArgumentError, 'job_name is nil' if job_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.Media/mediaServices/{accountName}/transforms/{transformName}/jobs/{jobName}'

  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,'accountName' => ,'transformName' => transform_name,'jobName' => job_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 || status_code == 404
      error_model = JSON.load(response_content)
      fail MsRest::HttpOperationError.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.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-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::MediaServices::Mgmt::V2018_07_01::Models::Job.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, account_name, transform_name, job_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Get Job

Gets a Job.

Azure subscription. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group within the

  • account_name (String) —

    The Media Services account name.

  • transform_name (String) —

    The Transform name.

  • job_name (String) —

    The Job name.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



175
176
177
 
# File 'lib/2018-07-01/generated/azure_mgmt_media_services/jobs.rb', line 175

def get_with_http_info(resource_group_name, , transform_name, job_name, custom_headers:nil)
  get_async(resource_group_name, , transform_name, job_name, custom_headers:custom_headers).value!
end

#list(resource_group_name, account_name, transform_name, filter: nil, orderby: nil, custom_headers: nil) ⇒ Array<Job>

List Jobs

Lists all of the Jobs for the Transform.

Azure subscription. should be ordered. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group within the

  • account_name (String) —

    The Media Services account name.

  • transform_name (String) —

    The Transform name.

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

    Restricts the set of items returned.

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

    Specifies the key by which the result collection

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

    A hash of custom headers that

Returns:

  • (Array<Job>) —

    operation results.



41
42
43
44
 
# File 'lib/2018-07-01/generated/azure_mgmt_media_services/jobs.rb', line 41

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

#list_as_lazy(resource_group_name, account_name, transform_name, filter: nil, orderby: nil, custom_headers: nil) ⇒ JobCollection

List Jobs

Lists all of the Jobs for the Transform.

Azure subscription. should be ordered. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group within the

  • account_name (String) —

    The Media Services account name.

  • transform_name (String) —

    The Transform name.

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

    Restricts the set of items returned.

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

    Specifies the key by which the result collection

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

    A hash of custom headers that

Returns:

  • (JobCollection) —

    which provide lazy access to pages of the response.



814
815
816
817
818
819
820
821
822
823
 
# File 'lib/2018-07-01/generated/azure_mgmt_media_services/jobs.rb', line 814

def list_as_lazy(resource_group_name, , transform_name, filter:nil, orderby:nil, custom_headers:nil)
  response = list_async(resource_group_name, , transform_name, filter:filter, orderby:orderby, 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, account_name, transform_name, filter: nil, orderby: nil, custom_headers: nil) ⇒ Concurrent::Promise

List Jobs

Lists all of the Jobs for the Transform.

Azure subscription. should be ordered. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group within the

  • account_name (String) —

    The Media Services account name.

  • transform_name (String) —

    The Transform name.

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

    Restricts the set of items returned.

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

    Specifies the key by which the result collection

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/2018-07-01/generated/azure_mgmt_media_services/jobs.rb', line 84

def list_async(resource_group_name, , transform_name, filter:nil, orderby: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, 'account_name is nil' if .nil?
  fail ArgumentError, 'transform_name is nil' if transform_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.Media/mediaServices/{accountName}/transforms/{transformName}/jobs'

  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,'accountName' => ,'transformName' => transform_name},
      query_params: {'api-version' => @client.api_version,'$filter' => filter,'$orderby' => orderby},
      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 MsRest::HttpOperationError.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.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-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::MediaServices::Mgmt::V2018_07_01::Models::JobCollection.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) ⇒ JobCollection

List Jobs

Lists all of the Jobs for the Transform.

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:

  • (JobCollection) —

    operation results.



713
714
715
716
 
# File 'lib/2018-07-01/generated/azure_mgmt_media_services/jobs.rb', line 713

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

List Jobs

Lists all of the Jobs for the Transform.

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.



746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
 
# File 'lib/2018-07-01/generated/azure_mgmt_media_services/jobs.rb', line 746

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 MsRest::HttpOperationError.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.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-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::MediaServices::Mgmt::V2018_07_01::Models::JobCollection.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

List Jobs

Lists all of the Jobs for the Transform.

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.



730
731
732
 
# File 'lib/2018-07-01/generated/azure_mgmt_media_services/jobs.rb', line 730

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

List Jobs

Lists all of the Jobs for the Transform.

Azure subscription. should be ordered. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group within the

  • account_name (String) —

    The Media Services account name.

  • transform_name (String) —

    The Transform name.

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

    Restricts the set of items returned.

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

    Specifies the key by which the result collection

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



63
64
65
 
# File 'lib/2018-07-01/generated/azure_mgmt_media_services/jobs.rb', line 63

def list_with_http_info(resource_group_name, , transform_name, filter:nil, orderby:nil, custom_headers:nil)
  list_async(resource_group_name, , transform_name, filter:filter, orderby:orderby, custom_headers:custom_headers).value!
end

#update(resource_group_name, account_name, transform_name, job_name, parameters, custom_headers: nil) ⇒ Job

Update Job

Update is only supported for description and priority. Updating Priority will take effect when the Job state is Queued or Scheduled and depending on the timing the priority update may be ignored.

Azure subscription. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group within the

  • account_name (String) —

    The Media Services account name.

  • transform_name (String) —

    The Transform name.

  • job_name (String) —

    The Job name.

  • parameters (Job) —

    The request parameters

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

    A hash of custom headers that

Returns:

  • (Job) —

    operation results.



491
492
493
494
 
# File 'lib/2018-07-01/generated/azure_mgmt_media_services/jobs.rb', line 491

def update(resource_group_name, , transform_name, job_name, parameters, custom_headers:nil)
  response = update_async(resource_group_name, , transform_name, job_name, parameters, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#update_async(resource_group_name, account_name, transform_name, job_name, parameters, custom_headers: nil) ⇒ Concurrent::Promise

Update Job

Update is only supported for description and priority. Updating Priority will take effect when the Job state is Queued or Scheduled and depending on the timing the priority update may be ignored.

Azure subscription. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group within the

  • account_name (String) —

    The Media Services account name.

  • transform_name (String) —

    The Transform name.

  • job_name (String) —

    The Job name.

  • parameters (Job) —

    The request parameters

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
 
# File 'lib/2018-07-01/generated/azure_mgmt_media_services/jobs.rb', line 536

def update_async(resource_group_name, , transform_name, job_name, parameters, 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, 'account_name is nil' if .nil?
  fail ArgumentError, 'transform_name is nil' if transform_name.nil?
  fail ArgumentError, 'job_name is nil' if job_name.nil?
  fail ArgumentError, 'parameters is nil' if parameters.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::MediaServices::Mgmt::V2018_07_01::Models::Job.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.Media/mediaServices/{accountName}/transforms/{transformName}/jobs/{jobName}'

  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,'accountName' => ,'transformName' => transform_name,'jobName' => job_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(:patch, 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 MsRest::HttpOperationError.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.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-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::MediaServices::Mgmt::V2018_07_01::Models::Job.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

#update_with_http_info(resource_group_name, account_name, transform_name, job_name, parameters, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Update Job

Update is only supported for description and priority. Updating Priority will take effect when the Job state is Queued or Scheduled and depending on the timing the priority update may be ignored.

Azure subscription. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group within the

  • account_name (String) —

    The Media Services account name.

  • transform_name (String) —

    The Transform name.

  • job_name (String) —

    The Job name.

  • parameters (Job) —

    The request parameters

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



514
515
516
 
# File 'lib/2018-07-01/generated/azure_mgmt_media_services/jobs.rb', line 514

def update_with_http_info(resource_group_name, , transform_name, job_name, parameters, custom_headers:nil)
  update_async(resource_group_name, , transform_name, job_name, parameters, custom_headers:custom_headers).value!
end