Class: Azure::Synapse::Mgmt::V2019_06_01_preview::SqlPoolTables

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2019-06-01-preview/generated/azure_mgmt_synapse/sql_pool_tables.rb

Overview

Azure Synapse Analytics Management Client

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ SqlPoolTables

Creates and initializes a new instance of the SqlPoolTables class.

Parameters:

  • client —

    service class for accessing basic functionality.



17
18
19
 
# File 'lib/2019-06-01-preview/generated/azure_mgmt_synapse/sql_pool_tables.rb', line 17

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ SynapseManagementClient (readonly)

Returns reference to the SynapseManagementClient.

Returns:



22
23
24
 
# File 'lib/2019-06-01-preview/generated/azure_mgmt_synapse/sql_pool_tables.rb', line 22

def client
  @client
end

Instance Method Details

#get(resource_group_name, workspace_name, sql_pool_name, schema_name, table_name, custom_headers: nil) ⇒ SqlPoolTable

Get Sql pool table

is case insensitive. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group. The name

  • workspace_name (String) —

    The name of the workspace

  • sql_pool_name (String) —

    SQL pool name

  • schema_name (String) —

    The name of the schema.

  • table_name (String) —

    The name of the table.

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

    A hash of custom headers that

Returns:

  • (SqlPoolTable) —

    operation results.



160
161
162
163
 
# File 'lib/2019-06-01-preview/generated/azure_mgmt_synapse/sql_pool_tables.rb', line 160

def get(resource_group_name, workspace_name, sql_pool_name, schema_name, table_name, custom_headers:nil)
  response = get_async(resource_group_name, workspace_name, sql_pool_name, schema_name, table_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#get_async(resource_group_name, workspace_name, sql_pool_name, schema_name, table_name, custom_headers: nil) ⇒ Concurrent::Promise

Get Sql pool table

is case insensitive. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group. The name

  • workspace_name (String) —

    The name of the workspace

  • sql_pool_name (String) —

    SQL pool name

  • schema_name (String) —

    The name of the schema.

  • table_name (String) —

    The name of the table.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/2019-06-01-preview/generated/azure_mgmt_synapse/sql_pool_tables.rb', line 197

def get_async(resource_group_name, workspace_name, sql_pool_name, schema_name, table_name, custom_headers:nil)
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, "'@client.api_version' should satisfy the constraint - 'MinLength': '1'" if !@client.api_version.nil? && @client.api_version.length < 1
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, "'@client.subscription_id' should satisfy the constraint - 'MinLength': '1'" if !@client.subscription_id.nil? && @client.subscription_id.length < 1
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MaxLength': '90'" if !resource_group_name.nil? && resource_group_name.length > 90
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MinLength': '1'" if !resource_group_name.nil? && resource_group_name.length < 1
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'Pattern': '^[-\w\._\(\)]+$'" if !resource_group_name.nil? && resource_group_name.match(Regexp.new('^^[-\w\._\(\)]+$$')).nil?
  fail ArgumentError, 'workspace_name is nil' if workspace_name.nil?
  fail ArgumentError, 'sql_pool_name is nil' if sql_pool_name.nil?
  fail ArgumentError, 'schema_name is nil' if schema_name.nil?
  fail ArgumentError, 'table_name is nil' if table_name.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 = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlPools/{sqlPoolName}/schemas/{schemaName}/tables/{tableName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'workspaceName' => workspace_name,'sqlPoolName' => sql_pool_name,'schemaName' => schema_name,'tableName' => table_name},
      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 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::Synapse::Mgmt::V2019_06_01_preview::Models::SqlPoolTable.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(resource_group_name, workspace_name, sql_pool_name, schema_name, table_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Get Sql pool table

is case insensitive. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group. The name

  • workspace_name (String) —

    The name of the workspace

  • sql_pool_name (String) —

    SQL pool name

  • schema_name (String) —

    The name of the schema.

  • table_name (String) —

    The name of the table.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



179
180
181
 
# File 'lib/2019-06-01-preview/generated/azure_mgmt_synapse/sql_pool_tables.rb', line 179

def get_with_http_info(resource_group_name, workspace_name, sql_pool_name, schema_name, table_name, custom_headers:nil)
  get_async(resource_group_name, workspace_name, sql_pool_name, schema_name, table_name, custom_headers:custom_headers).value!
end

#list_by_schema(resource_group_name, workspace_name, sql_pool_name, schema_name, filter: nil, custom_headers: nil) ⇒ Array<SqlPoolTable>

Gets tables of a given schema in a SQL pool

Gets tables of a given schema in a SQL pool.

is case insensitive. the collection. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group. The name

  • workspace_name (String) —

    The name of the workspace

  • sql_pool_name (String) —

    SQL pool name

  • schema_name (String) —

    The name of the schema.

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

    An OData filter expression that filters elements in

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

    A hash of custom headers that

Returns:

  • (Array<SqlPoolTable>) —

    operation results.



41
42
43
44
 
# File 'lib/2019-06-01-preview/generated/azure_mgmt_synapse/sql_pool_tables.rb', line 41

def list_by_schema(resource_group_name, workspace_name, sql_pool_name, schema_name, filter:nil, custom_headers:nil)
  first_page = list_by_schema_as_lazy(resource_group_name, workspace_name, sql_pool_name, schema_name, filter:filter, custom_headers:custom_headers)
  first_page.get_all_items
end

#list_by_schema_as_lazy(resource_group_name, workspace_name, sql_pool_name, schema_name, filter: nil, custom_headers: nil) ⇒ SqlPoolTableListResult

Gets tables of a given schema in a SQL pool

Gets tables of a given schema in a SQL pool.

is case insensitive. the collection. will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    The name of the resource group. The name

  • workspace_name (String) —

    The name of the workspace

  • sql_pool_name (String) —

    SQL pool name

  • schema_name (String) —

    The name of the schema.

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

    An OData filter expression that filters elements in

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

    A hash of custom headers that

Returns:

  • (SqlPoolTableListResult) —

    which provide lazy access to pages of the



374
375
376
377
378
379
380
381
382
383
 
# File 'lib/2019-06-01-preview/generated/azure_mgmt_synapse/sql_pool_tables.rb', line 374

def list_by_schema_as_lazy(resource_group_name, workspace_name, sql_pool_name, schema_name, filter:nil, custom_headers:nil)
  response = list_by_schema_async(resource_group_name, workspace_name, sql_pool_name, schema_name, filter:filter, custom_headers:custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_page_link|
      list_by_schema_next_async(next_page_link, custom_headers:custom_headers)
    end
    page
  end
end

#list_by_schema_async(resource_group_name, workspace_name, sql_pool_name, schema_name, filter: nil, custom_headers: nil) ⇒ Concurrent::Promise

Gets tables of a given schema in a SQL pool

Gets tables of a given schema in a SQL pool.

is case insensitive. the collection. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group. The name

  • workspace_name (String) —

    The name of the workspace

  • sql_pool_name (String) —

    SQL pool name

  • schema_name (String) —

    The name of the schema.

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

    An OData filter expression that filters elements in

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/2019-06-01-preview/generated/azure_mgmt_synapse/sql_pool_tables.rb', line 84

def list_by_schema_async(resource_group_name, workspace_name, sql_pool_name, schema_name, filter:nil, custom_headers:nil)
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, "'@client.api_version' should satisfy the constraint - 'MinLength': '1'" if !@client.api_version.nil? && @client.api_version.length < 1
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, "'@client.subscription_id' should satisfy the constraint - 'MinLength': '1'" if !@client.subscription_id.nil? && @client.subscription_id.length < 1
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MaxLength': '90'" if !resource_group_name.nil? && resource_group_name.length > 90
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MinLength': '1'" if !resource_group_name.nil? && resource_group_name.length < 1
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'Pattern': '^[-\w\._\(\)]+$'" if !resource_group_name.nil? && resource_group_name.match(Regexp.new('^^[-\w\._\(\)]+$$')).nil?
  fail ArgumentError, 'workspace_name is nil' if workspace_name.nil?
  fail ArgumentError, 'sql_pool_name is nil' if sql_pool_name.nil?
  fail ArgumentError, 'schema_name is nil' if schema_name.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 = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlPools/{sqlPoolName}/schemas/{schemaName}/tables'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'workspaceName' => workspace_name,'sqlPoolName' => sql_pool_name,'schemaName' => schema_name},
      query_params: {'api-version' => @client.api_version,'$filter' => filter},
      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 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::Synapse::Mgmt::V2019_06_01_preview::Models::SqlPoolTableListResult.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_by_schema_next(next_page_link, custom_headers: nil) ⇒ SqlPoolTableListResult

Gets tables of a given schema in a SQL pool

Gets tables of a given schema in a SQL pool.

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:

  • (SqlPoolTableListResult) —

    operation results.



272
273
274
275
 
# File 'lib/2019-06-01-preview/generated/azure_mgmt_synapse/sql_pool_tables.rb', line 272

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

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

Gets tables of a given schema in a SQL pool

Gets tables of a given schema in a SQL pool.

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.



305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
 
# File 'lib/2019-06-01-preview/generated/azure_mgmt_synapse/sql_pool_tables.rb', line 305

def list_by_schema_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 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::Synapse::Mgmt::V2019_06_01_preview::Models::SqlPoolTableListResult.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_by_schema_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets tables of a given schema in a SQL pool

Gets tables of a given schema in a SQL pool.

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.



289
290
291
 
# File 'lib/2019-06-01-preview/generated/azure_mgmt_synapse/sql_pool_tables.rb', line 289

def list_by_schema_next_with_http_info(next_page_link, custom_headers:nil)
  list_by_schema_next_async(next_page_link, custom_headers:custom_headers).value!
end

#list_by_schema_with_http_info(resource_group_name, workspace_name, sql_pool_name, schema_name, filter: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets tables of a given schema in a SQL pool

Gets tables of a given schema in a SQL pool.

is case insensitive. the collection. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group. The name

  • workspace_name (String) —

    The name of the workspace

  • sql_pool_name (String) —

    SQL pool name

  • schema_name (String) —

    The name of the schema.

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

    An OData filter expression that filters elements in

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



63
64
65
 
# File 'lib/2019-06-01-preview/generated/azure_mgmt_synapse/sql_pool_tables.rb', line 63

def list_by_schema_with_http_info(resource_group_name, workspace_name, sql_pool_name, schema_name, filter:nil, custom_headers:nil)
  list_by_schema_async(resource_group_name, workspace_name, sql_pool_name, schema_name, filter:filter, custom_headers:custom_headers).value!
end