Class: Azure::DataShare::Mgmt::V2019_11_01::ConsumerInvitations

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2019-11-01/generated/azure_mgmt_datashare/consumer_invitations.rb

Overview

Creates a Microsoft.DataShare management client.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ ConsumerInvitations

Creates and initializes a new instance of the ConsumerInvitations class.

Parameters:

  • client —

    service class for accessing basic functionality.



17
18
19
 
# File 'lib/2019-11-01/generated/azure_mgmt_datashare/consumer_invitations.rb', line 17

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ DataShareManagementClient (readonly)

Returns reference to the DataShareManagementClient.

Returns:



22
23
24
 
# File 'lib/2019-11-01/generated/azure_mgmt_datashare/consumer_invitations.rb', line 22

def client
  @client
end

Instance Method Details

#get(location, invitation_id, custom_headers: nil) ⇒ ConsumerInvitation

Gets the invitation identified by invitationId

Get an invitation

will be added to the HTTP request.

Parameters:

  • location (String) —

    Location of the invitation

  • invitation_id (String) —

    An invitation id

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

    A hash of custom headers that

Returns:

  • (ConsumerInvitation) —

    operation results.



142
143
144
145
 
# File 'lib/2019-11-01/generated/azure_mgmt_datashare/consumer_invitations.rb', line 142

def get(location, invitation_id, custom_headers:nil)
  response = get_async(location, invitation_id, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#get_async(location, invitation_id, custom_headers: nil) ⇒ Concurrent::Promise

Gets the invitation identified by invitationId

Get an invitation

to the HTTP request.

Parameters:

  • location (String) —

    Location of the invitation

  • invitation_id (String) —

    An invitation id

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
 
# File 'lib/2019-11-01/generated/azure_mgmt_datashare/consumer_invitations.rb', line 175

def get_async(location, invitation_id, custom_headers:nil)
  fail ArgumentError, 'location is nil' if location.nil?
  fail ArgumentError, 'invitation_id is nil' if invitation_id.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 = 'providers/Microsoft.DataShare/locations/{location}/consumerInvitations/{invitationId}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'location' => location,'invitationId' => invitation_id},
      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
      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::DataShare::Mgmt::V2019_11_01::Models::ConsumerInvitation.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(location, invitation_id, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets the invitation identified by invitationId

Get an invitation

will be added to the HTTP request.

Parameters:

  • location (String) —

    Location of the invitation

  • invitation_id (String) —

    An invitation id

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



159
160
161
 
# File 'lib/2019-11-01/generated/azure_mgmt_datashare/consumer_invitations.rb', line 159

def get_with_http_info(location, invitation_id, custom_headers:nil)
  get_async(location, invitation_id, custom_headers:custom_headers).value!
end

#list_invitations(skip_token: nil, custom_headers: nil) ⇒ Array<ConsumerInvitation>

List the invitations

Lists invitations

will be added to the HTTP request.

Parameters:

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

    The continuation token

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

    A hash of custom headers that

Returns:

  • (Array<ConsumerInvitation>) —

    operation results.



240
241
242
243
 
# File 'lib/2019-11-01/generated/azure_mgmt_datashare/consumer_invitations.rb', line 240

def list_invitations(skip_token:nil, custom_headers:nil)
  first_page = list_invitations_as_lazy(skip_token:skip_token, custom_headers:custom_headers)
  first_page.get_all_items
end

#list_invitations_as_lazy(skip_token: nil, custom_headers: nil) ⇒ ConsumerInvitationList

List the invitations

Lists invitations

will be added to the HTTP request.

response.

Parameters:

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

    The continuation token

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

    A hash of custom headers that

Returns:

  • (ConsumerInvitationList) —

    which provide lazy access to pages of the



430
431
432
433
434
435
436
437
438
439
 
# File 'lib/2019-11-01/generated/azure_mgmt_datashare/consumer_invitations.rb', line 430

def list_invitations_as_lazy(skip_token:nil, custom_headers:nil)
  response = list_invitations_async(skip_token:skip_token, custom_headers:custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_page_link|
      list_invitations_next_async(next_page_link, custom_headers:custom_headers)
    end
    page
  end
end

#list_invitations_async(skip_token: nil, custom_headers: nil) ⇒ Concurrent::Promise

List the invitations

Lists invitations

to the HTTP request.

Parameters:

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

    The continuation token

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
308
309
310
311
312
313
314
315
316
317
318
319
320
 
# File 'lib/2019-11-01/generated/azure_mgmt_datashare/consumer_invitations.rb', line 271

def list_invitations_async(skip_token:nil, custom_headers: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 = 'providers/Microsoft.DataShare/ListInvitations'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      query_params: {'api-version' => @client.api_version,'$skipToken' => skip_token},
      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::DataShare::Mgmt::V2019_11_01::Models::ConsumerInvitationList.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_invitations_next(next_page_link, custom_headers: nil) ⇒ ConsumerInvitationList

List the invitations

Lists invitations

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:

  • (ConsumerInvitationList) —

    operation results.



334
335
336
337
 
# File 'lib/2019-11-01/generated/azure_mgmt_datashare/consumer_invitations.rb', line 334

def list_invitations_next(next_page_link, custom_headers:nil)
  response = list_invitations_next_async(next_page_link, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#list_invitations_next_async(next_page_link, custom_headers: nil) ⇒ Concurrent::Promise

List the invitations

Lists invitations

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.



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
406
407
408
409
410
411
412
413
414
415
416
 
# File 'lib/2019-11-01/generated/azure_mgmt_datashare/consumer_invitations.rb', line 367

def list_invitations_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::DataShare::Mgmt::V2019_11_01::Models::ConsumerInvitationList.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_invitations_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

List the invitations

Lists invitations

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.



351
352
353
 
# File 'lib/2019-11-01/generated/azure_mgmt_datashare/consumer_invitations.rb', line 351

def list_invitations_next_with_http_info(next_page_link, custom_headers:nil)
  list_invitations_next_async(next_page_link, custom_headers:custom_headers).value!
end

#list_invitations_with_http_info(skip_token: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

List the invitations

Lists invitations

will be added to the HTTP request.

Parameters:

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

    The continuation token

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



256
257
258
 
# File 'lib/2019-11-01/generated/azure_mgmt_datashare/consumer_invitations.rb', line 256

def list_invitations_with_http_info(skip_token:nil, custom_headers:nil)
  list_invitations_async(skip_token:skip_token, custom_headers:custom_headers).value!
end

#reject_invitation(location, invitation, custom_headers: nil) ⇒ ConsumerInvitation

Rejects the invitation identified by invitationId

Reject an invitation

will be added to the HTTP request.

Parameters:

  • location (String) —

    Location of the invitation

  • invitation (ConsumerInvitation) —

    An invitation payload

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

    A hash of custom headers that

Returns:

  • (ConsumerInvitation) —

    operation results.



36
37
38
39
 
# File 'lib/2019-11-01/generated/azure_mgmt_datashare/consumer_invitations.rb', line 36

def reject_invitation(location, invitation, custom_headers:nil)
  response = reject_invitation_async(location, invitation, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#reject_invitation_async(location, invitation, custom_headers: nil) ⇒ Concurrent::Promise

Rejects the invitation identified by invitationId

Reject an invitation

to the HTTP request.

Parameters:

  • location (String) —

    Location of the invitation

  • invitation (ConsumerInvitation) —

    An invitation payload

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



69
70
71
72
73
74
75
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
127
128
 
# File 'lib/2019-11-01/generated/azure_mgmt_datashare/consumer_invitations.rb', line 69

def reject_invitation_async(location, invitation, custom_headers:nil)
  fail ArgumentError, 'location is nil' if location.nil?
  fail ArgumentError, 'invitation is nil' if invitation.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::DataShare::Mgmt::V2019_11_01::Models::ConsumerInvitation.mapper()
  request_content = @client.serialize(request_mapper,  invitation)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'providers/Microsoft.DataShare/locations/{location}/RejectInvitation'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'location' => location},
      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(: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?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::DataShare::Mgmt::V2019_11_01::Models::ConsumerInvitation.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

#reject_invitation_with_http_info(location, invitation, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Rejects the invitation identified by invitationId

Reject an invitation

will be added to the HTTP request.

Parameters:

  • location (String) —

    Location of the invitation

  • invitation (ConsumerInvitation) —

    An invitation payload

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



53
54
55
 
# File 'lib/2019-11-01/generated/azure_mgmt_datashare/consumer_invitations.rb', line 53

def reject_invitation_with_http_info(location, invitation, custom_headers:nil)
  reject_invitation_async(location, invitation, custom_headers:custom_headers).value!
end