Class: Azure::DataBoxEdge::Mgmt::V2019_08_01::Jobs

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2019-08-01/generated/azure_mgmt_databoxedge/jobs.rb

Overview

Jobs

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Jobs

Creates and initializes a new instance of the Jobs class.

Parameters:

  • client —

    service class for accessing basic functionality.


17
18
19
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/jobs.rb', line 17

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ DataBoxEdgeManagementClient (readonly)

Returns reference to the DataBoxEdgeManagementClient.

Returns:


22
23
24
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/jobs.rb', line 22

def client
  @client
end

Instance Method Details

#get(device_name, name, resource_group_name, custom_headers: nil) ⇒ Job

Gets the details of a specified job on a Data Box Edge/Data Box Gateway device.

will be added to the HTTP request.

Parameters:

  • device_name (String) —

    The device name.

  • name (String) —

    The job name.

  • resource_group_name (String) —

    The resource group name.

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

    A hash of custom headers that

Returns:

  • (Job) —

    operation results.


36
37
38
39
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/jobs.rb', line 36

def get(device_name, name, resource_group_name, custom_headers:nil)
  response = get_async(device_name, name, resource_group_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#get_async(device_name, name, resource_group_name, custom_headers: nil) ⇒ Concurrent::Promise

Gets the details of a specified job on a Data Box Edge/Data Box Gateway device.

to the HTTP request.

Parameters:

  • device_name (String) —

    The device name.

  • name (String) —

    The job name.

  • resource_group_name (String) —

    The resource group name.

  • 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
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/jobs.rb', line 69

def get_async(device_name, name, resource_group_name, custom_headers:nil)
  fail ArgumentError, 'device_name is nil' if device_name.nil?
  fail ArgumentError, 'name is nil' if name.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.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.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/jobs/{name}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'deviceName' => device_name,'name' => name,'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_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::DataBoxEdge::Mgmt::V2019_08_01::Models::Job.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(device_name, name, resource_group_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets the details of a specified job on a Data Box Edge/Data Box Gateway device.

will be added to the HTTP request.

Parameters:

  • device_name (String) —

    The device name.

  • name (String) —

    The job name.

  • resource_group_name (String) —

    The resource group name.

  • 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-08-01/generated/azure_mgmt_databoxedge/jobs.rb', line 53

def get_with_http_info(device_name, name, resource_group_name, custom_headers:nil)
  get_async(device_name, name, resource_group_name, custom_headers:custom_headers).value!
end