class Azure::CognitiveServices::Face::V1_0::FaceClient

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

Attributes

accept_language[RW]

@return [String] The preferred language for the response.

base_url[R]

@return [String] the base URI of the service.

credentials[RW]

@return Subscription credentials which uniquely identify client subscription.

credentials1[R]

@return Credentials needed for the client to connect to Azure.

endpoint[RW]

@return [String] Supported Cognitive Services endpoints (protocol and hostname, for example: westus.api.cognitive.microsoft.com).

face[R]

@return [Face] face

face_list_operations[R]

@return [FaceListOperations] face_list_operations

generate_client_request_id[RW]

@return [Boolean] Whether a unique x-ms-client-request-id should be generated. When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

large_face_list_operations[R]

@return [LargeFaceListOperations] large_face_list_operations

large_person_group_operations[R]

@return [LargePersonGroupOperations] large_person_group_operations

large_person_group_person[R]

@return [LargePersonGroupPerson] large_person_group_person

long_running_operation_retry_timeout[RW]

@return [Integer] The retry timeout in seconds for Long Running Operations. Default value is 30.

person_group_operations[R]

@return [PersonGroupOperations] person_group_operations

person_group_person[R]

@return [PersonGroupPerson] person_group_person

snapshot_operations[R]

@return [SnapshotOperations] snapshot_operations

Public Class Methods

new(credentials = nil, options = nil) click to toggle source

Creates initializes a new instance of the FaceClient class. @param credentials [MsRest::ServiceClientCredentials] credentials to authorize HTTP requests made by the service client. @param options [Array] filters to be applied to the HTTP requests.

Calls superclass method
# File lib/1.0/generated/azure_cognitiveservices_face/face_client.rb, line 69
def initialize(credentials = nil, options = nil)
  super(credentials, options)
  @base_url = '{Endpoint}/face/v1.0'

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

  @face = Face.new(self)
  @person_group_person = PersonGroupPerson.new(self)
  @person_group_operations = PersonGroupOperations.new(self)
  @face_list_operations = FaceListOperations.new(self)
  @large_person_group_person = LargePersonGroupPerson.new(self)
  @large_person_group_operations = LargePersonGroupOperations.new(self)
  @large_face_list_operations = LargeFaceListOperations.new(self)
  @snapshot_operations = SnapshotOperations.new(self)
  @accept_language = 'en-US'
  @long_running_operation_retry_timeout = 30
  @generate_client_request_id = true
  add_telemetry
end

Public Instance Methods

make_request(method, path, options = {}) click to toggle source

Makes a request and returns the body of the response. @param method [Symbol] with any of the following values :get, :put, :post, :patch, :delete. @param path [String] the path, relative to {base_url}. @param options [Hash{String=>String}] specifying any request options like :body. @return [Hash{String=>String}] containing 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)
# File lib/1.0/generated/azure_cognitiveservices_face/face_client.rb, line 106
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 = {}) click to toggle source

Makes a request asynchronously. @param method [Symbol] with any of the following values :get, :put, :post, :patch, :delete. @param path [String] the path, relative to {base_url}. @param options [Hash{String=>String}] specifying any request options like :body. @return [Concurrent::Promise] Promise object which holds the HTTP response.

Calls superclass method
# File lib/1.0/generated/azure_cognitiveservices_face/face_client.rb, line 131
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 = {}) click to toggle source

Makes a request and returns the operation response. @param method [Symbol] with any of the following values :get, :put, :post, :patch, :delete. @param path [String] the path, relative to {base_url}. @param options [Hash{String=>String}] specifying any request options like :body. @return [MsRestAzure::AzureOperationResponse] Operation response containing the request, response and status.

# File lib/1.0/generated/azure_cognitiveservices_face/face_client.rb, line 118
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

Private Instance Methods

add_telemetry() click to toggle source

Adds telemetry information.

# File lib/1.0/generated/azure_cognitiveservices_face/face_client.rb, line 153
def add_telemetry
    sdk_information = 'azure_cognitiveservices_face'
    sdk_information = "#{sdk_information}/0.19.1"
    add_user_agent_information(sdk_information)
end