Class: Azure::MixedReality::Mgmt::V2020_05_01::MixedRealityClient

Inherits:
MsRestAzure::AzureServiceClient
  • Object
show all
Includes:
MsRestAzure, MsRestAzure::Serialization
Defined in:
lib/2020-05-01/generated/azure_mgmt_mixedreality/mixed_reality_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, base_url = nil, options = nil) ⇒ MixedRealityClient

Creates initializes a new instance of the MixedRealityClient class.

Parameters:

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

    credentials to authorize HTTP requests made by the service client.

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

    the base URI of the service.

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

    filters to be applied to the HTTP requests.



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/2020-05-01/generated/azure_mgmt_mixedreality/mixed_reality_client.rb', line 51

def initialize(credentials = nil, base_url = nil, options = nil)
  super(credentials, options)
  @base_url = base_url || 'https://management.azure.com'

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

  @operations = Operations.new(self)
  @spatial_anchors_accounts = SpatialAnchorsAccounts.new(self)
  @api_version = '2020-05-01'
  @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 The preferred language for the response.

Returns:

  • (String) —

    The preferred language for the response.



28
29
30
 
# File 'lib/2020-05-01/generated/azure_mgmt_mixedreality/mixed_reality_client.rb', line 28

def accept_language
  @accept_language
end

#api_version ⇒ String (readonly)

Returns The API version to be used with the HTTP request.

Returns:

  • (String) —

    The API version to be used with the HTTP request.



21
22
23
 
# File 'lib/2020-05-01/generated/azure_mgmt_mixedreality/mixed_reality_client.rb', line 21

def api_version
  @api_version
end

#base_url ⇒ String

Returns the base URI of the service.

Returns:

  • (String) —

    the base URI of the service.



15
16
17
 
# File 'lib/2020-05-01/generated/azure_mgmt_mixedreality/mixed_reality_client.rb', line 15

def base_url
  @base_url
end

#credentials ⇒ 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/2020-05-01/generated/azure_mgmt_mixedreality/mixed_reality_client.rb', line 18

def credentials
  @credentials
end

#generate_client_request_id ⇒ Boolean

generated. When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

Returns:

  • (Boolean) —

    Whether a unique x-ms-client-request-id should be



37
38
39
 
# File 'lib/2020-05-01/generated/azure_mgmt_mixedreality/mixed_reality_client.rb', line 37

def generate_client_request_id
  @generate_client_request_id
end

#long_running_operation_retry_timeout ⇒ Integer

Operations. Default value is 30.

Returns:

  • (Integer) —

    The retry timeout in seconds for Long Running



32
33
34
 
# File 'lib/2020-05-01/generated/azure_mgmt_mixedreality/mixed_reality_client.rb', line 32

def long_running_operation_retry_timeout
  @long_running_operation_retry_timeout
end

#operations ⇒ Operations (readonly)

Returns operations.

Returns:



40
41
42
 
# File 'lib/2020-05-01/generated/azure_mgmt_mixedreality/mixed_reality_client.rb', line 40

def operations
  @operations
end

#spatial_anchors_accounts ⇒ SpatialAnchorsAccounts (readonly)

Returns spatial_anchors_accounts.

Returns:



43
44
45
 
# File 'lib/2020-05-01/generated/azure_mgmt_mixedreality/mixed_reality_client.rb', line 43

def spatial_anchors_accounts
  @spatial_anchors_accounts
end

#subscription_id ⇒ String

string (e.g. 00000000-0000-0000-0000-000000000000)

Returns:

  • (String) —

    The Azure subscription ID. This is a GUID-formatted



25
26
27
 
# File 'lib/2020-05-01/generated/azure_mgmt_mixedreality/mixed_reality_client.rb', line 25

def subscription_id
  @subscription_id
end

Instance Method Details

#check_name_availability_local(location, check_name_availability, custom_headers: nil) ⇒ CheckNameAvailabilityResponse

Check Name Availability for local uniqueness

Availability Request. will be added to the HTTP request.

Parameters:

  • location (String) —

    The location in which uniqueness will be verified.

  • check_name_availability (CheckNameAvailabilityRequest) —

    Check Name

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

    A hash of custom headers that

Returns:

  • (CheckNameAvailabilityResponse) —

    operation results.



136
137
138
139
 
# File 'lib/2020-05-01/generated/azure_mgmt_mixedreality/mixed_reality_client.rb', line 136

def check_name_availability_local(location, check_name_availability, custom_headers:nil)
  response = check_name_availability_local_async(location, check_name_availability, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#check_name_availability_local_async(location, check_name_availability, custom_headers: nil) ⇒ Concurrent::Promise

Check Name Availability for local uniqueness

Availability Request. to the HTTP request.

Parameters:

  • location (String) —

    The location in which uniqueness will be verified.

  • check_name_availability (CheckNameAvailabilityRequest) —

    Check Name

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/2020-05-01/generated/azure_mgmt_mixedreality/mixed_reality_client.rb', line 167

def check_name_availability_local_async(location, check_name_availability, custom_headers:nil)
  fail ArgumentError, 'subscription_id is nil' if subscription_id.nil?
  fail ArgumentError, 'location is nil' if location.nil?
  fail ArgumentError, "'location' should satisfy the constraint - 'MaxLength': '90'" if !location.nil? && location.length > 90
  fail ArgumentError, "'location' should satisfy the constraint - 'MinLength': '1'" if !location.nil? && location.length < 1
  fail ArgumentError, "'location' should satisfy the constraint - 'Pattern': '^[-\w\._\(\)]+$'" if !location.nil? && location.match(Regexp.new('^^[-\w\._\(\)]+$$')).nil?
  fail ArgumentError, 'check_name_availability is nil' if check_name_availability.nil?
  fail ArgumentError, 'api_version is nil' if 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'] = accept_language unless accept_language.nil?

  # Serialize Request
  request_mapper = Azure::MixedReality::Mgmt::V2020_05_01::Models::CheckNameAvailabilityRequest.mapper()
  request_content = self.serialize(request_mapper,  check_name_availability)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/providers/Microsoft.MixedReality/locations/{location}/checkNameAvailability'

  request_url = @base_url || self.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => subscription_id,'location' => location},
      query_params: {'api-version' => api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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 MsRestAzure::AzureOperationError.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::MixedReality::Mgmt::V2020_05_01::Models::CheckNameAvailabilityResponse.mapper()
        result.body = self.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

#check_name_availability_local_with_http_info(location, check_name_availability, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Check Name Availability for local uniqueness

Availability Request. will be added to the HTTP request.

Parameters:

  • location (String) —

    The location in which uniqueness will be verified.

  • check_name_availability (CheckNameAvailabilityRequest) —

    Check Name

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



152
153
154
 
# File 'lib/2020-05-01/generated/azure_mgmt_mixedreality/mixed_reality_client.rb', line 152

def check_name_availability_local_with_http_info(location, check_name_availability, custom_headers:nil)
  check_name_availability_local_async(location, check_name_availability, custom_headers:custom_headers).value!
end

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



83
84
85
86
 
# File 'lib/2020-05-01/generated/azure_mgmt_mixedreality/mixed_reality_client.rb', line 83

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.



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/2020-05-01/generated/azure_mgmt_mixedreality/mixed_reality_client.rb', line 108

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.



95
96
97
98
99
 
# File 'lib/2020-05-01/generated/azure_mgmt_mixedreality/mixed_reality_client.rb', line 95

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