Class: Azure::MediaServices::Mgmt::V2018_06_01_preview::Jobs

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2018-06-01-preview/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-06-01-preview/generated/azure_mgmt_media_services/jobs.rb', line 17

def initialize(client)
  @client = client
end

Instance Attribute Details

#clientAzureMediaServices (readonly)

Returns reference to the AzureMediaServices.

Returns:



22
23
24
# File 'lib/2018-06-01-preview/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



499
500
501
502
# File 'lib/2018-06-01-preview/generated/azure_mgmt_media_services/jobs.rb', line 499

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.



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
# File 'lib/2018-06-01-preview/generated/azure_mgmt_media_services/jobs.rb', line 538

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.



519
520
521
# File 'lib/2018-06-01-preview/generated/azure_mgmt_media_services/jobs.rb', line 519

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.



279
280
281
282
# File 'lib/2018-06-01-preview/generated/azure_mgmt_media_services/jobs.rb', line 279

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.



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
372
373
374
375
376
377
378
379
380
381
382
383
# File 'lib/2018-06-01-preview/generated/azure_mgmt_media_services/jobs.rb', line 320

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_06_01_preview::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_06_01_preview::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.



300
301
302
# File 'lib/2018-06-01-preview/generated/azure_mgmt_media_services/jobs.rb', line 300

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



399
400
401
402
# File 'lib/2018-06-01-preview/generated/azure_mgmt_media_services/jobs.rb', line 399

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.



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
472
473
474
475
476
477
478
479
480
481
482
483
# File 'lib/2018-06-01-preview/generated/azure_mgmt_media_services/jobs.rb', line 438

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.



419
420
421
# File 'lib/2018-06-01-preview/generated/azure_mgmt_media_services/jobs.rb', line 419

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.



167
168
169
170
# File 'lib/2018-06-01-preview/generated/azure_mgmt_media_services/jobs.rb', line 167

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.



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
250
251
252
253
254
255
256
257
258
259
260
261
# File 'lib/2018-06-01-preview/generated/azure_mgmt_media_services/jobs.rb', line 206

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_06_01_preview::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.



187
188
189
# File 'lib/2018-06-01-preview/generated/azure_mgmt_media_services/jobs.rb', line 187

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, top: nil, skip: nil, custom_headers: nil) ⇒ Array<Job>

List Jobs

Lists all of the Jobs for the Transform.

Azure subscription. number of items returned from a collection. The service returns the number of available items up to but not greater than the specified value n. first n items of the queried collection from the result. The service returns items starting at position n+1. 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.

  • top (Integer) (defaults to: nil)

    Specifies a non-negative integer n that limits the

  • skip (Integer) (defaults to: nil)

    Specifies a non-negative integer n that excludes the

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

    A hash of custom headers that

Returns:

  • (Array<Job>)

    operation results.



45
46
47
48
# File 'lib/2018-06-01-preview/generated/azure_mgmt_media_services/jobs.rb', line 45

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

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

List Jobs

Lists all of the Jobs for the Transform.

Azure subscription. number of items returned from a collection. The service returns the number of available items up to but not greater than the specified value n. first n items of the queried collection from the result. The service returns items starting at position n+1. 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.

  • top (Integer) (defaults to: nil)

    Specifies a non-negative integer n that limits the

  • skip (Integer) (defaults to: nil)

    Specifies a non-negative integer n that excludes the

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



702
703
704
705
706
707
708
709
710
711
# File 'lib/2018-06-01-preview/generated/azure_mgmt_media_services/jobs.rb', line 702

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

List Jobs

Lists all of the Jobs for the Transform.

Azure subscription. number of items returned from a collection. The service returns the number of available items up to but not greater than the specified value n. first n items of the queried collection from the result. The service returns items starting at position n+1. 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.

  • top (Integer) (defaults to: nil)

    Specifies a non-negative integer n that limits the

  • skip (Integer) (defaults to: nil)

    Specifies a non-negative integer n that excludes the

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



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
139
140
141
142
143
144
145
146
147
148
149
150
# File 'lib/2018-06-01-preview/generated/azure_mgmt_media_services/jobs.rb', line 96

def list_async(resource_group_name, , transform_name, filter:nil, top:nil, skip: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,'$top' => top,'$skip' => skip},
      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_06_01_preview::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.



597
598
599
600
# File 'lib/2018-06-01-preview/generated/azure_mgmt_media_services/jobs.rb', line 597

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.



630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
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
# File 'lib/2018-06-01-preview/generated/azure_mgmt_media_services/jobs.rb', line 630

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_06_01_preview::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.



614
615
616
# File 'lib/2018-06-01-preview/generated/azure_mgmt_media_services/jobs.rb', line 614

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

List Jobs

Lists all of the Jobs for the Transform.

Azure subscription. number of items returned from a collection. The service returns the number of available items up to but not greater than the specified value n. first n items of the queried collection from the result. The service returns items starting at position n+1. 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.

  • top (Integer) (defaults to: nil)

    Specifies a non-negative integer n that limits the

  • skip (Integer) (defaults to: nil)

    Specifies a non-negative integer n that excludes the

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



71
72
73
# File 'lib/2018-06-01-preview/generated/azure_mgmt_media_services/jobs.rb', line 71

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