Class: Azure::CognitiveServices::ContentModerator::V1_0::ListManagementImage

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/1.0/generated/azure_cognitiveservices_contentmoderator/list_management_image.rb

Overview

You use the API to scan your content as it is generated. Content Moderator then processes your content and sends the results along with relevant information either back to your systems or to the built-in review tool. You can use this information to take decisions e.g. take it down, send to human judge, etc.

When using the API, images need to have a minimum of 128 pixels and a maximum file size of 4MB. Text can be at most 1024 characters long. If the content passed to the text API or the image API exceeds the size limits, the API will return an error code that informs about the issue.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ ListManagementImage

Creates and initializes a new instance of the ListManagementImage class.

Parameters:

  • client —

    service class for accessing basic functionality.



27
28
29
 
# File 'lib/1.0/generated/azure_cognitiveservices_contentmoderator/list_management_image.rb', line 27

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ ContentModeratorClient (readonly)

Returns reference to the ContentModeratorClient.

Returns:



32
33
34
 
# File 'lib/1.0/generated/azure_cognitiveservices_contentmoderator/list_management_image.rb', line 32

def client
  @client
end

Instance Method Details

#add_image(list_id, tag: nil, label: nil, custom_headers: nil) ⇒ Image

Add an image to the list with list Id equal to list Id passed.

will be added to the HTTP request.

Parameters:

  • list_id (String) —

    List Id of the image list.

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

    Tag for the image.

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

    The image label.

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

    A hash of custom headers that

Returns:

  • (Image) —

    operation results.



45
46
47
48
 
# File 'lib/1.0/generated/azure_cognitiveservices_contentmoderator/list_management_image.rb', line 45

def add_image(list_id, tag:nil, label:nil, custom_headers:nil)
  response = add_image_async(list_id, tag:tag, label:label, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#add_image_async(list_id, tag: nil, label: nil, custom_headers: nil) ⇒ Concurrent::Promise

Add an image to the list with list Id equal to list Id passed.

to the HTTP request.

Parameters:

  • list_id (String) —

    List Id of the image list.

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

    Tag for the image.

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

    The image label.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/1.0/generated/azure_cognitiveservices_contentmoderator/list_management_image.rb', line 76

def add_image_async(list_id, tag:nil, label:nil, custom_headers:nil)
  fail ArgumentError, '@client.endpoint is nil' if @client.endpoint.nil?
  fail ArgumentError, 'list_id is nil' if list_id.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 = 'contentmoderator/lists/v1.0/imagelists/{listId}/images'

  request_url = @base_url || @client.base_url
request_url = request_url.gsub('{Endpoint}', @client.endpoint)

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'listId' => list_id},
      query_params: {'tag' => tag,'label' => label},
      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?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::CognitiveServices::ContentModerator::V1_0::Models::Image.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

#add_image_file_input(list_id, image_stream, tag: nil, label: nil, custom_headers: nil) ⇒ Image

Add an image to the list with list Id equal to list Id passed.

will be added to the HTTP request.

Parameters:

  • list_id (String) —

    List Id of the image list.

  • image_stream —

    The image file.

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

    Tag for the image.

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

    The image label.

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

    A hash of custom headers that

Returns:

  • (Image) —

    operation results.



529
530
531
532
 
# File 'lib/1.0/generated/azure_cognitiveservices_contentmoderator/list_management_image.rb', line 529

def add_image_file_input(list_id, image_stream, tag:nil, label:nil, custom_headers:nil)
  response = add_image_file_input_async(list_id, image_stream, tag:tag, label:label, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#add_image_file_input_async(list_id, image_stream, tag: nil, label: nil, custom_headers: nil) ⇒ Concurrent::Promise

Add an image to the list with list Id equal to list Id passed.

to the HTTP request.

Parameters:

  • list_id (String) —

    List Id of the image list.

  • image_stream —

    The image file.

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

    Tag for the image.

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

    The image label.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
 
# File 'lib/1.0/generated/azure_cognitiveservices_contentmoderator/list_management_image.rb', line 562

def add_image_file_input_async(list_id, image_stream, tag:nil, label:nil, custom_headers:nil)
  fail ArgumentError, '@client.endpoint is nil' if @client.endpoint.nil?
  fail ArgumentError, 'list_id is nil' if list_id.nil?
  fail ArgumentError, 'image_stream is nil' if image_stream.nil?


  request_headers = {}
  request_headers['Content-Type'] = 'image/gif'

  # 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 = {
    client_side_validation: true,
    required: true,
    serialized_name: 'ImageStream',
    type: {
      name: 'Stream'
    }
  }
  request_content = @client.serialize(request_mapper,  image_stream)

  path_template = 'contentmoderator/lists/v1.0/imagelists/{listId}/images'

  request_url = @base_url || @client.base_url
request_url = request_url.gsub('{Endpoint}', @client.endpoint)

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'listId' => list_id},
      query_params: {'tag' => tag,'label' => label},
      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 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?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::CognitiveServices::ContentModerator::V1_0::Models::Image.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

#add_image_file_input_with_http_info(list_id, image_stream, tag: nil, label: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Add an image to the list with list Id equal to list Id passed.

will be added to the HTTP request.

Parameters:

  • list_id (String) —

    List Id of the image list.

  • image_stream —

    The image file.

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

    Tag for the image.

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

    The image label.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



546
547
548
 
# File 'lib/1.0/generated/azure_cognitiveservices_contentmoderator/list_management_image.rb', line 546

def add_image_file_input_with_http_info(list_id, image_stream, tag:nil, label:nil, custom_headers:nil)
  add_image_file_input_async(list_id, image_stream, tag:tag, label:label, custom_headers:custom_headers).value!
end

#add_image_url_input(list_id, content_type, image_url, tag: nil, label: nil, custom_headers: nil) ⇒ Image

Add an image to the list with list Id equal to list Id passed.

will be added to the HTTP request.

Parameters:

  • list_id (String) —

    List Id of the image list.

  • content_type (String) —

    The content type.

  • image_url (ImageUrl) —

    The image url.

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

    Tag for the image.

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

    The image label.

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

    A hash of custom headers that

Returns:

  • (Image) —

    operation results.



420
421
422
423
 
# File 'lib/1.0/generated/azure_cognitiveservices_contentmoderator/list_management_image.rb', line 420

def add_image_url_input(list_id, content_type, image_url, tag:nil, label:nil, custom_headers:nil)
  response = add_image_url_input_async(list_id, content_type, image_url, tag:tag, label:label, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#add_image_url_input_async(list_id, content_type, image_url, tag: nil, label: nil, custom_headers: nil) ⇒ Concurrent::Promise

Add an image to the list with list Id equal to list Id passed.

to the HTTP request.

Parameters:

  • list_id (String) —

    List Id of the image list.

  • content_type (String) —

    The content type.

  • image_url (ImageUrl) —

    The image url.

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

    Tag for the image.

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

    The image label.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
 
# File 'lib/1.0/generated/azure_cognitiveservices_contentmoderator/list_management_image.rb', line 455

def add_image_url_input_async(list_id, content_type, image_url, tag:nil, label:nil, custom_headers:nil)
  fail ArgumentError, '@client.endpoint is nil' if @client.endpoint.nil?
  fail ArgumentError, 'list_id is nil' if list_id.nil?
  fail ArgumentError, 'content_type is nil' if content_type.nil?
  fail ArgumentError, 'image_url is nil' if image_url.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['Content-Type'] = content_type unless content_type.nil?
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?

  # Serialize Request
  request_mapper = Azure::CognitiveServices::ContentModerator::V1_0::Models::ImageUrl.mapper()
  request_content = @client.serialize(request_mapper,  image_url)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'contentmoderator/lists/v1.0/imagelists/{listId}/images'

  request_url = @base_url || @client.base_url
request_url = request_url.gsub('{Endpoint}', @client.endpoint)

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'listId' => list_id},
      query_params: {'tag' => tag,'label' => label},
      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 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?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::CognitiveServices::ContentModerator::V1_0::Models::Image.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

#add_image_url_input_with_http_info(list_id, content_type, image_url, tag: nil, label: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Add an image to the list with list Id equal to list Id passed.

will be added to the HTTP request.

Parameters:

  • list_id (String) —

    List Id of the image list.

  • content_type (String) —

    The content type.

  • image_url (ImageUrl) —

    The image url.

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

    Tag for the image.

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

    The image label.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



438
439
440
 
# File 'lib/1.0/generated/azure_cognitiveservices_contentmoderator/list_management_image.rb', line 438

def add_image_url_input_with_http_info(list_id, content_type, image_url, tag:nil, label:nil, custom_headers:nil)
  add_image_url_input_async(list_id, content_type, image_url, tag:tag, label:label, custom_headers:custom_headers).value!
end

#add_image_with_http_info(list_id, tag: nil, label: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Add an image to the list with list Id equal to list Id passed.

will be added to the HTTP request.

Parameters:

  • list_id (String) —

    List Id of the image list.

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

    Tag for the image.

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

    The image label.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



61
62
63
 
# File 'lib/1.0/generated/azure_cognitiveservices_contentmoderator/list_management_image.rb', line 61

def add_image_with_http_info(list_id, tag:nil, label:nil, custom_headers:nil)
  add_image_async(list_id, tag:tag, label:label, custom_headers:custom_headers).value!
end

#delete_all_images(list_id, custom_headers: nil) ⇒ String

Deletes all images from the list with list Id equal to list Id passed.

will be added to the HTTP request.

Parameters:

  • list_id (String) —

    List Id of the image list.

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

    A hash of custom headers that

Returns:

  • (String) —

    operation results.



137
138
139
140
 
# File 'lib/1.0/generated/azure_cognitiveservices_contentmoderator/list_management_image.rb', line 137

def delete_all_images(list_id, custom_headers:nil)
  response = delete_all_images_async(list_id, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#delete_all_images_async(list_id, custom_headers: nil) ⇒ Concurrent::Promise

Deletes all images from the list with list Id equal to list Id passed.

to the HTTP request.

Parameters:

  • list_id (String) —

    List Id of the image list.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
214
215
216
217
218
219
220
 
# File 'lib/1.0/generated/azure_cognitiveservices_contentmoderator/list_management_image.rb', line 164

def delete_all_images_async(list_id, custom_headers:nil)
  fail ArgumentError, '@client.endpoint is nil' if @client.endpoint.nil?
  fail ArgumentError, 'list_id is nil' if list_id.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 = 'contentmoderator/lists/v1.0/imagelists/{listId}/images'

  request_url = @base_url || @client.base_url
request_url = request_url.gsub('{Endpoint}', @client.endpoint)

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'listId' => list_id},
      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
      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?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = {
          client_side_validation: true,
          required: false,
          serialized_name: 'parsed_response',
          type: {
            name: 'String'
          }
        }
        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

#delete_all_images_with_http_info(list_id, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Deletes all images from the list with list Id equal to list Id passed.

will be added to the HTTP request.

Parameters:

  • list_id (String) —

    List Id of the image list.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



151
152
153
 
# File 'lib/1.0/generated/azure_cognitiveservices_contentmoderator/list_management_image.rb', line 151

def delete_all_images_with_http_info(list_id, custom_headers:nil)
  delete_all_images_async(list_id, custom_headers:custom_headers).value!
end

#delete_image(list_id, image_id, custom_headers: nil) ⇒ String

Deletes an image from the list with list Id and image Id passed.

will be added to the HTTP request.

Parameters:

  • list_id (String) —

    List Id of the image list.

  • image_id (String) —

    Id of the image.

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

    A hash of custom headers that

Returns:

  • (String) —

    operation results.



319
320
321
322
 
# File 'lib/1.0/generated/azure_cognitiveservices_contentmoderator/list_management_image.rb', line 319

def delete_image(list_id, image_id, custom_headers:nil)
  response = delete_image_async(list_id, image_id, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#delete_image_async(list_id, image_id, custom_headers: nil) ⇒ Concurrent::Promise

Deletes an image from the list with list Id and image Id passed.

to the HTTP request.

Parameters:

  • list_id (String) —

    List Id of the image list.

  • image_id (String) —

    Id of the image.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
 
# File 'lib/1.0/generated/azure_cognitiveservices_contentmoderator/list_management_image.rb', line 348

def delete_image_async(list_id, image_id, custom_headers:nil)
  fail ArgumentError, '@client.endpoint is nil' if @client.endpoint.nil?
  fail ArgumentError, 'list_id is nil' if list_id.nil?
  fail ArgumentError, 'image_id is nil' if image_id.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 = 'contentmoderator/lists/v1.0/imagelists/{listId}/images/{ImageId}'

  request_url = @base_url || @client.base_url
request_url = request_url.gsub('{Endpoint}', @client.endpoint)

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'listId' => list_id,'ImageId' => image_id},
      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
      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?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = {
          client_side_validation: true,
          required: false,
          serialized_name: 'parsed_response',
          type: {
            name: 'String'
          }
        }
        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

#delete_image_with_http_info(list_id, image_id, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Deletes an image from the list with list Id and image Id passed.

will be added to the HTTP request.

Parameters:

  • list_id (String) —

    List Id of the image list.

  • image_id (String) —

    Id of the image.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



334
335
336
 
# File 'lib/1.0/generated/azure_cognitiveservices_contentmoderator/list_management_image.rb', line 334

def delete_image_with_http_info(list_id, image_id, custom_headers:nil)
  delete_image_async(list_id, image_id, custom_headers:custom_headers).value!
end

#get_all_image_ids(list_id, custom_headers: nil) ⇒ ImageIds

Gets all image Ids from the list with list Id equal to list Id passed.

will be added to the HTTP request.

Parameters:

  • list_id (String) —

    List Id of the image list.

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

    A hash of custom headers that

Returns:

  • (ImageIds) —

    operation results.



231
232
233
234
 
# File 'lib/1.0/generated/azure_cognitiveservices_contentmoderator/list_management_image.rb', line 231

def get_all_image_ids(list_id, custom_headers:nil)
  response = get_all_image_ids_async(list_id, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#get_all_image_ids_async(list_id, custom_headers: nil) ⇒ Concurrent::Promise

Gets all image Ids from the list with list Id equal to list Id passed.

to the HTTP request.

Parameters:

  • list_id (String) —

    List Id of the image list.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/1.0/generated/azure_cognitiveservices_contentmoderator/list_management_image.rb', line 258

def get_all_image_ids_async(list_id, custom_headers:nil)
  fail ArgumentError, '@client.endpoint is nil' if @client.endpoint.nil?
  fail ArgumentError, 'list_id is nil' if list_id.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 = 'contentmoderator/lists/v1.0/imagelists/{listId}/images'

  request_url = @base_url || @client.base_url
request_url = request_url.gsub('{Endpoint}', @client.endpoint)

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'listId' => list_id},
      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?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::CognitiveServices::ContentModerator::V1_0::Models::ImageIds.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_all_image_ids_with_http_info(list_id, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets all image Ids from the list with list Id equal to list Id passed.

will be added to the HTTP request.

Parameters:

  • list_id (String) —

    List Id of the image list.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



245
246
247
 
# File 'lib/1.0/generated/azure_cognitiveservices_contentmoderator/list_management_image.rb', line 245

def get_all_image_ids_with_http_info(list_id, custom_headers:nil)
  get_all_image_ids_async(list_id, custom_headers:custom_headers).value!
end