Class: Azure::SQL::Mgmt::V2017_03_01_preview::JobStepExecutions

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2017-03-01-preview/generated/azure_mgmt_sql/job_step_executions.rb

Overview

The Azure SQL Database management API provides a RESTful set of web services that interact with Azure SQL Database services to manage your databases. The API enables you to create, retrieve, update, and delete databases.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ JobStepExecutions

Creates and initializes a new instance of the JobStepExecutions class.

Parameters:

  • client —

    service class for accessing basic functionality.



20
21
22
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/job_step_executions.rb', line 20

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ SqlManagementClient (readonly)

Returns reference to the SqlManagementClient.

Returns:



25
26
27
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/job_step_executions.rb', line 25

def client
  @client
end

Instance Method Details

#get(resource_group_name, server_name, job_agent_name, job_name, job_execution_id, step_name, custom_headers: nil) ⇒ JobExecution

Gets a step execution of a job execution.

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • server_name (String) —

    The name of the server.

  • job_agent_name (String) —

    The name of the job agent.

  • job_name (String) —

    The name of the job to get.

  • job_execution_id —

    The unique id of the job execution

  • step_name (String) —

    The name of the step.

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

    A hash of custom headers that

Returns:

  • (JobExecution) —

    operation results.



191
192
193
194
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/job_step_executions.rb', line 191

def get(resource_group_name, server_name, job_agent_name, job_name, job_execution_id, step_name, custom_headers:nil)
  response = get_async(resource_group_name, server_name, job_agent_name, job_name, job_execution_id, step_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#get_async(resource_group_name, server_name, job_agent_name, job_name, job_execution_id, step_name, custom_headers: nil) ⇒ Concurrent::Promise

Gets a step execution of a job execution.

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • server_name (String) —

    The name of the server.

  • job_agent_name (String) —

    The name of the job agent.

  • job_name (String) —

    The name of the job to get.

  • job_execution_id —

    The unique id of the job execution

  • step_name (String) —

    The name of the step.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/job_step_executions.rb', line 232

def get_async(resource_group_name, server_name, job_agent_name, job_name, job_execution_id, step_name, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'server_name is nil' if server_name.nil?
  fail ArgumentError, 'job_agent_name is nil' if job_agent_name.nil?
  fail ArgumentError, 'job_name is nil' if job_name.nil?
  fail ArgumentError, 'job_execution_id is nil' if job_execution_id.nil?
  fail ArgumentError, 'step_name is nil' if step_name.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_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 = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}/executions/{jobExecutionId}/steps/{stepName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'serverName' => server_name,'jobAgentName' => job_agent_name,'jobName' => job_name,'jobExecutionId' => job_execution_id,'stepName' => step_name,'subscriptionId' => @client.subscription_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 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::SQL::Mgmt::V2017_03_01_preview::Models::JobExecution.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, server_name, job_agent_name, job_name, job_execution_id, step_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets a step execution of a job execution.

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • server_name (String) —

    The name of the server.

  • job_agent_name (String) —

    The name of the job agent.

  • job_name (String) —

    The name of the job to get.

  • job_execution_id —

    The unique id of the job execution

  • step_name (String) —

    The name of the step.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



212
213
214
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/job_step_executions.rb', line 212

def get_with_http_info(resource_group_name, server_name, job_agent_name, job_name, job_execution_id, step_name, custom_headers:nil)
  get_async(resource_group_name, server_name, job_agent_name, job_name, job_execution_id, step_name, custom_headers:custom_headers).value!
end

#list_by_job_execution(resource_group_name, server_name, job_agent_name, job_name, job_execution_id, create_time_min: nil, create_time_max: nil, end_time_min: nil, end_time_max: nil, is_active: nil, skip: nil, top: nil, custom_headers: nil) ⇒ Array<JobExecution>

Lists the step executions of a job execution.

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. at or after the specified time are included. before the specified time are included. or after the specified time are included. before the specified time are included. executions are included. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • server_name (String) —

    The name of the server.

  • job_agent_name (String) —

    The name of the job agent.

  • job_name (String) —

    The name of the job to get.

  • job_execution_id —

    The id of the job execution

  • create_time_min (DateTime) (defaults to: nil) —

    If specified, only job executions created

  • create_time_max (DateTime) (defaults to: nil) —

    If specified, only job executions created

  • end_time_min (DateTime) (defaults to: nil) —

    If specified, only job executions completed at

  • end_time_max (DateTime) (defaults to: nil) —

    If specified, only job executions completed

  • is_active (Boolean) (defaults to: nil) —

    If specified, only active or only completed job

  • skip (Integer) (defaults to: nil) —

    The number of elements in the collection to skip.

  • top (Integer) (defaults to: nil) —

    The number of elements to return from the collection.

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

    A hash of custom headers that

Returns:

  • (Array<JobExecution>) —

    operation results.



54
55
56
57
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/job_step_executions.rb', line 54

def list_by_job_execution(resource_group_name, server_name, job_agent_name, job_name, job_execution_id, create_time_min:nil, create_time_max:nil, end_time_min:nil, end_time_max:nil, is_active:nil, skip:nil, top:nil, custom_headers:nil)
  first_page = list_by_job_execution_as_lazy(resource_group_name, server_name, job_agent_name, job_name, job_execution_id, create_time_min:create_time_min, create_time_max:create_time_max, end_time_min:end_time_min, end_time_max:end_time_max, is_active:is_active, skip:skip, top:top, custom_headers:custom_headers)
  first_page.get_all_items
end

#list_by_job_execution_as_lazy(resource_group_name, server_name, job_agent_name, job_name, job_execution_id, create_time_min: nil, create_time_max: nil, end_time_min: nil, end_time_max: nil, is_active: nil, skip: nil, top: nil, custom_headers: nil) ⇒ JobExecutionListResult

Lists the step executions of a job execution.

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. at or after the specified time are included. before the specified time are included. or after the specified time are included. before the specified time are included. executions are included. will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • server_name (String) —

    The name of the server.

  • job_agent_name (String) —

    The name of the job agent.

  • job_name (String) —

    The name of the job to get.

  • job_execution_id —

    The id of the job execution

  • create_time_min (DateTime) (defaults to: nil) —

    If specified, only job executions created

  • create_time_max (DateTime) (defaults to: nil) —

    If specified, only job executions created

  • end_time_min (DateTime) (defaults to: nil) —

    If specified, only job executions completed at

  • end_time_max (DateTime) (defaults to: nil) —

    If specified, only job executions completed

  • is_active (Boolean) (defaults to: nil) —

    If specified, only active or only completed job

  • skip (Integer) (defaults to: nil) —

    The number of elements in the collection to skip.

  • top (Integer) (defaults to: nil) —

    The number of elements to return from the collection.

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

    A hash of custom headers that

Returns:

  • (JobExecutionListResult) —

    which provide lazy access to pages of the



409
410
411
412
413
414
415
416
417
418
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/job_step_executions.rb', line 409

def list_by_job_execution_as_lazy(resource_group_name, server_name, job_agent_name, job_name, job_execution_id, create_time_min:nil, create_time_max:nil, end_time_min:nil, end_time_max:nil, is_active:nil, skip:nil, top:nil, custom_headers:nil)
  response = list_by_job_execution_async(resource_group_name, server_name, job_agent_name, job_name, job_execution_id, create_time_min:create_time_min, create_time_max:create_time_max, end_time_min:end_time_min, end_time_max:end_time_max, is_active:is_active, skip:skip, top:top, custom_headers:custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_page_link|
      list_by_job_execution_next_async(next_page_link, custom_headers:custom_headers)
    end
    page
  end
end

#list_by_job_execution_async(resource_group_name, server_name, job_agent_name, job_name, job_execution_id, create_time_min: nil, create_time_max: nil, end_time_min: nil, end_time_max: nil, is_active: nil, skip: nil, top: nil, custom_headers: nil) ⇒ Concurrent::Promise

Lists the step executions of a job execution.

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. at or after the specified time are included. before the specified time are included. or after the specified time are included. before the specified time are included. executions are included. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • server_name (String) —

    The name of the server.

  • job_agent_name (String) —

    The name of the job agent.

  • job_name (String) —

    The name of the job to get.

  • job_execution_id —

    The id of the job execution

  • create_time_min (DateTime) (defaults to: nil) —

    If specified, only job executions created

  • create_time_max (DateTime) (defaults to: nil) —

    If specified, only job executions created

  • end_time_min (DateTime) (defaults to: nil) —

    If specified, only job executions completed at

  • end_time_max (DateTime) (defaults to: nil) —

    If specified, only job executions completed

  • is_active (Boolean) (defaults to: nil) —

    If specified, only active or only completed job

  • skip (Integer) (defaults to: nil) —

    The number of elements in the collection to skip.

  • top (Integer) (defaults to: nil) —

    The number of elements to return from the collection.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/job_step_executions.rb', line 117

def list_by_job_execution_async(resource_group_name, server_name, job_agent_name, job_name, job_execution_id, create_time_min:nil, create_time_max:nil, end_time_min:nil, end_time_max:nil, is_active:nil, skip:nil, top:nil, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'server_name is nil' if server_name.nil?
  fail ArgumentError, 'job_agent_name is nil' if job_agent_name.nil?
  fail ArgumentError, 'job_name is nil' if job_name.nil?
  fail ArgumentError, 'job_execution_id is nil' if job_execution_id.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_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 = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}/executions/{jobExecutionId}/steps'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'serverName' => server_name,'jobAgentName' => job_agent_name,'jobName' => job_name,'jobExecutionId' => job_execution_id,'subscriptionId' => @client.subscription_id},
      query_params: {'createTimeMin' => create_time_min,'createTimeMax' => create_time_max,'endTimeMin' => end_time_min,'endTimeMax' => end_time_max,'isActive' => is_active,'$skip' => skip,'$top' => top,'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::SQL::Mgmt::V2017_03_01_preview::Models::JobExecutionListResult.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_job_execution_next(next_page_link, custom_headers: nil) ⇒ JobExecutionListResult

Lists the step executions of a job execution.

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:

  • (JobExecutionListResult) —

    operation results.



301
302
303
304
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/job_step_executions.rb', line 301

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

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

Lists the step executions of a job execution.

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.



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
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/job_step_executions.rb', line 330

def list_by_job_execution_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::SQL::Mgmt::V2017_03_01_preview::Models::JobExecutionListResult.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_job_execution_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists the step executions of a job execution.

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.



316
317
318
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/job_step_executions.rb', line 316

def list_by_job_execution_next_with_http_info(next_page_link, custom_headers:nil)
  list_by_job_execution_next_async(next_page_link, custom_headers:custom_headers).value!
end

#list_by_job_execution_with_http_info(resource_group_name, server_name, job_agent_name, job_name, job_execution_id, create_time_min: nil, create_time_max: nil, end_time_min: nil, end_time_max: nil, is_active: nil, skip: nil, top: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists the step executions of a job execution.

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. at or after the specified time are included. before the specified time are included. or after the specified time are included. before the specified time are included. executions are included. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • server_name (String) —

    The name of the server.

  • job_agent_name (String) —

    The name of the job agent.

  • job_name (String) —

    The name of the job to get.

  • job_execution_id —

    The id of the job execution

  • create_time_min (DateTime) (defaults to: nil) —

    If specified, only job executions created

  • create_time_max (DateTime) (defaults to: nil) —

    If specified, only job executions created

  • end_time_min (DateTime) (defaults to: nil) —

    If specified, only job executions completed at

  • end_time_max (DateTime) (defaults to: nil) —

    If specified, only job executions completed

  • is_active (Boolean) (defaults to: nil) —

    If specified, only active or only completed job

  • skip (Integer) (defaults to: nil) —

    The number of elements in the collection to skip.

  • top (Integer) (defaults to: nil) —

    The number of elements to return from the collection.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



86
87
88
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/job_step_executions.rb', line 86

def list_by_job_execution_with_http_info(resource_group_name, server_name, job_agent_name, job_name, job_execution_id, create_time_min:nil, create_time_max:nil, end_time_min:nil, end_time_max:nil, is_active:nil, skip:nil, top:nil, custom_headers:nil)
  list_by_job_execution_async(resource_group_name, server_name, job_agent_name, job_name, job_execution_id, create_time_min:create_time_min, create_time_max:create_time_max, end_time_min:end_time_min, end_time_max:end_time_max, is_active:is_active, skip:skip, top:top, custom_headers:custom_headers).value!
end