Class: Azure::CognitiveServices::ContentModerator::V1_0::ContentModeratorClient

Inherits:
MsRestAzure::AzureServiceClient
  • Object
show all
Includes:
MsRestAzure, MsRestAzure::Serialization
Defined in:
lib/1.0/generated/azure_cognitiveservices_contentmoderator/content_moderator_client.rb

Overview

A service client - single point of access to the REST API.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(credentials = nil, options = nil) ⇒ ContentModeratorClient

Creates initializes a new instance of the ContentModeratorClient class.

Parameters:

  • credentials (MsRest::ServiceClientCredentials) (defaults to: nil) —

    credentials to authorize HTTP requests made by the service client.

  • options (Array) (defaults to: nil) —

    filters to be applied to the HTTP requests.



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/1.0/generated/azure_cognitiveservices_contentmoderator/content_moderator_client.rb', line 78

def initialize(credentials = nil, options = nil)
  super(credentials, options)
  @base_url = 'https://{baseUrl}/'

  fail ArgumentError, 'invalid type of credentials input parameter' unless credentials.is_a?(MsRest::ServiceClientCredentials) unless credentials.nil?
  @credentials = credentials

  @image_moderation = ImageModeration.new(self)
  @text_moderation = TextModeration.new(self)
  @list_management_image_lists = ListManagementImageLists.new(self)
  @list_management_term_lists = ListManagementTermLists.new(self)
  @list_management_image = ListManagementImage.new(self)
  @list_management_term = ListManagementTerm.new(self)
  @reviews = Reviews.new(self)
  @accept_language = 'en-US'
  @long_running_operation_retry_timeout = 30
  @generate_client_request_id = true
  add_telemetry
end

Instance Attribute Details

#accept_language ⇒ String

Returns Gets or sets the preferred language for the response.

Returns:

  • (String) —

    Gets or sets the preferred language for the response.



42
43
44
 
# File 'lib/1.0/generated/azure_cognitiveservices_contentmoderator/content_moderator_client.rb', line 42

def accept_language
  @accept_language
end

#base_url ⇒ AzureRegionBaseUrl

Moderator endpoints. Possible values include: ‘westus.api.cognitive.microsoft.com’, ‘westus2.api.cognitive.microsoft.com’, ‘eastus.api.cognitive.microsoft.com’, ‘eastus2.api.cognitive.microsoft.com’, ‘westcentralus.api.cognitive.microsoft.com’, ‘southcentralus.api.cognitive.microsoft.com’, ‘westeurope.api.cognitive.microsoft.com’, ‘northeurope.api.cognitive.microsoft.com’, ‘southeastasia.api.cognitive.microsoft.com’, ‘eastasia.api.cognitive.microsoft.com’, ‘australiaeast.api.cognitive.microsoft.com’, ‘brazilsouth.api.cognitive.microsoft.com’, ‘contentmoderatortest.azure-api.net’

Returns:

  • (AzureRegionBaseUrl) —

    Supported Azure regions for Content



15
16
17
 
# File 'lib/1.0/generated/azure_cognitiveservices_contentmoderator/content_moderator_client.rb', line 15

def base_url
  @base_url
end

#credentials ⇒ Object

subscription.

Returns:

  • Subscription credentials which uniquely identify client



39
40
41
 
# File 'lib/1.0/generated/azure_cognitiveservices_contentmoderator/content_moderator_client.rb', line 39

def credentials
  @credentials
end

#credentials1 ⇒ Object (readonly)

Returns Credentials needed for the client to connect to Azure.

Returns:

  • Credentials needed for the client to connect to Azure.



18
19
20
 
# File 'lib/1.0/generated/azure_cognitiveservices_contentmoderator/content_moderator_client.rb', line 18

def credentials1
  @credentials1
end

#generate_client_request_id ⇒ Boolean

is generated and included in each request. Default is true.

Returns:

  • (Boolean) —

    When set to true a unique x-ms-client-request-id value



50
51
52
 
# File 'lib/1.0/generated/azure_cognitiveservices_contentmoderator/content_moderator_client.rb', line 50

def generate_client_request_id
  @generate_client_request_id
end

#image_moderation ⇒ ImageModeration (readonly)

Returns image_moderation.

Returns:



53
54
55
 
# File 'lib/1.0/generated/azure_cognitiveservices_contentmoderator/content_moderator_client.rb', line 53

def image_moderation
  @image_moderation
end

#list_management_image ⇒ ListManagementImage (readonly)

Returns list_management_image.

Returns:



65
66
67
 
# File 'lib/1.0/generated/azure_cognitiveservices_contentmoderator/content_moderator_client.rb', line 65

def list_management_image
  @list_management_image
end

#list_management_image_lists ⇒ ListManagementImageLists (readonly)

Returns list_management_image_lists.

Returns:



59
60
61
 
# File 'lib/1.0/generated/azure_cognitiveservices_contentmoderator/content_moderator_client.rb', line 59

def list_management_image_lists
  @list_management_image_lists
end

#list_management_term ⇒ ListManagementTerm (readonly)

Returns list_management_term.

Returns:



68
69
70
 
# File 'lib/1.0/generated/azure_cognitiveservices_contentmoderator/content_moderator_client.rb', line 68

def list_management_term
  @list_management_term
end

#list_management_term_lists ⇒ ListManagementTermLists (readonly)

Returns list_management_term_lists.

Returns:



62
63
64
 
# File 'lib/1.0/generated/azure_cognitiveservices_contentmoderator/content_moderator_client.rb', line 62

def list_management_term_lists
  @list_management_term_lists
end

#long_running_operation_retry_timeout ⇒ Integer

Running Operations. Default value is 30.

Returns:

  • (Integer) —

    Gets or sets the retry timeout in seconds for Long



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

def long_running_operation_retry_timeout
  @long_running_operation_retry_timeout
end

#reviews ⇒ Reviews (readonly)

Returns reviews.

Returns:



71
72
73
 
# File 'lib/1.0/generated/azure_cognitiveservices_contentmoderator/content_moderator_client.rb', line 71

def reviews
  @reviews
end

#text_moderation ⇒ TextModeration (readonly)

Returns text_moderation.

Returns:



56
57
58
 
# File 'lib/1.0/generated/azure_cognitiveservices_contentmoderator/content_moderator_client.rb', line 56

def text_moderation
  @text_moderation
end

Instance Method Details

#make_request(method, path, options = {}) ⇒ Hash{String=>String}

Makes a request and returns the body of the response. Example:

request_content = "{'location':'westus','tags':{'tag1':'val1','tag2':'val2'}}"
path = "/path"
options = {
  body: request_content,
  query_params: {'api-version' => '2016-02-01'}
}
result = @client.make_request(:put, path, options)

Parameters:

  • method (Symbol) —

    with any of the following values :get, :put, :post, :patch, :delete.

  • path (String) —

    the path, relative to #base_url.

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

    specifying any request options like :body.

Returns:

  • (Hash{String=>String}) —

    containing the body of the response.



114
115
116
117
 
# File 'lib/1.0/generated/azure_cognitiveservices_contentmoderator/content_moderator_client.rb', line 114

def make_request(method, path, options = {})
  result = make_request_with_http_info(method, path, options)
  result.body unless result.nil?
end

#make_request_async(method, path, options = {}) ⇒ Concurrent::Promise

Makes a request asynchronously.

Parameters:

  • method (Symbol) —

    with any of the following values :get, :put, :post, :patch, :delete.

  • path (String) —

    the path, relative to #base_url.

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

    specifying any request options like :body.

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/1.0/generated/azure_cognitiveservices_contentmoderator/content_moderator_client.rb', line 139

def make_request_async(method, path, options = {})
  fail ArgumentError, 'method is nil' if method.nil?
  fail ArgumentError, 'path is nil' if path.nil?

  request_url = options[:base_url] || @base_url
  if(!options[:headers].nil? && !options[:headers]['Content-Type'].nil?)
    @request_headers['Content-Type'] = options[:headers]['Content-Type']
  end

  request_headers = @request_headers
  request_headers.merge!({'accept-language' => @accept_language}) unless @accept_language.nil?
  options.merge!({headers: request_headers.merge(options[:headers] || {})})
  options.merge!({credentials: @credentials}) unless @credentials.nil?

  super(request_url, method, path, options)
end

#make_request_with_http_info(method, path, options = {}) ⇒ MsRestAzure::AzureOperationResponse

Makes a request and returns the operation response.

Parameters:

  • method (Symbol) —

    with any of the following values :get, :put, :post, :patch, :delete.

  • path (String) —

    the path, relative to #base_url.

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

    specifying any request options like :body.

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    Operation response containing the request, response and status.



126
127
128
129
130
 
# File 'lib/1.0/generated/azure_cognitiveservices_contentmoderator/content_moderator_client.rb', line 126

def make_request_with_http_info(method, path, options = {})
  result = make_request_async(method, path, options).value!
  result.body = result.response.body.to_s.empty? ? nil : JSON.load(result.response.body)
  result
end