Class: Azure::Hdinsight::Mgmt::V2018_06_01_preview::ScriptActions

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2018-06-01-preview/generated/azure_mgmt_hdinsight/script_actions.rb

Overview

HDInsight Management Client

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ ScriptActions

Creates and initializes a new instance of the ScriptActions class.

Parameters:

  • client

    service class for accessing basic functionality.



17
18
19
# File 'lib/2018-06-01-preview/generated/azure_mgmt_hdinsight/script_actions.rb', line 17

def initialize(client)
  @client = client
end

Instance Attribute Details

#clientHDInsightManagementClient (readonly)

Returns reference to the HDInsightManagementClient.

Returns:



22
23
24
# File 'lib/2018-06-01-preview/generated/azure_mgmt_hdinsight/script_actions.rb', line 22

def client
  @client
end

Instance Method Details

#delete(resource_group_name, cluster_name, script_name, custom_headers: nil) ⇒ Object

Deletes a specified persisted script action of the cluster.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • cluster_name (String)

    The name of the cluster.

  • script_name (String)

    The name of the script.

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

    A hash of custom headers that



34
35
36
37
# File 'lib/2018-06-01-preview/generated/azure_mgmt_hdinsight/script_actions.rb', line 34

def delete(resource_group_name, cluster_name, script_name, custom_headers:nil)
  response = delete_async(resource_group_name, cluster_name, script_name, custom_headers:custom_headers).value!
  nil
end

#delete_async(resource_group_name, cluster_name, script_name, custom_headers: nil) ⇒ Concurrent::Promise

Deletes a specified persisted script action of the cluster.

to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • cluster_name (String)

    The name of the cluster.

  • script_name (String)

    The name of the script.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



65
66
67
68
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
# File 'lib/2018-06-01-preview/generated/azure_mgmt_hdinsight/script_actions.rb', line 65

def delete_async(resource_group_name, cluster_name, script_name, custom_headers: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, 'cluster_name is nil' if cluster_name.nil?
  fail ArgumentError, 'script_name is nil' if script_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.HDInsight/clusters/{clusterName}/scriptActions/{scriptName}'

  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,'clusterName' => cluster_name,'scriptName' => script_name},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:delete, 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 || status_code == 204
      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?

    result
  end

  promise.execute
end

#delete_with_http_info(resource_group_name, cluster_name, script_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Deletes a specified persisted script action of the cluster.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • cluster_name (String)

    The name of the cluster.

  • script_name (String)

    The name of the script.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



50
51
52
# File 'lib/2018-06-01-preview/generated/azure_mgmt_hdinsight/script_actions.rb', line 50

def delete_with_http_info(resource_group_name, cluster_name, script_name, custom_headers:nil)
  delete_async(resource_group_name, cluster_name, script_name, custom_headers:custom_headers).value!
end

#get_execution_detail(resource_group_name, cluster_name, script_execution_id, custom_headers: nil) ⇒ RuntimeScriptActionDetail

Gets the script execution detail for the given script execution ID.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • cluster_name (String)

    The name of the cluster.

  • script_execution_id (String)

    The script execution Id

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

    A hash of custom headers that

Returns:

  • (RuntimeScriptActionDetail)

    operation results.



216
217
218
219
# File 'lib/2018-06-01-preview/generated/azure_mgmt_hdinsight/script_actions.rb', line 216

def get_execution_detail(resource_group_name, cluster_name, script_execution_id, custom_headers:nil)
  response = get_execution_detail_async(resource_group_name, cluster_name, script_execution_id, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#get_execution_detail_async(resource_group_name, cluster_name, script_execution_id, custom_headers: nil) ⇒ Concurrent::Promise

Gets the script execution detail for the given script execution ID.

to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • cluster_name (String)

    The name of the cluster.

  • script_execution_id (String)

    The script execution Id

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



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
290
291
292
293
294
295
296
297
298
299
300
301
# File 'lib/2018-06-01-preview/generated/azure_mgmt_hdinsight/script_actions.rb', line 247

def get_execution_detail_async(resource_group_name, cluster_name, script_execution_id, custom_headers: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, 'cluster_name is nil' if cluster_name.nil?
  fail ArgumentError, 'script_execution_id is nil' if script_execution_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.HDInsight/clusters/{clusterName}/scriptExecutionHistory/{scriptExecutionId}'

  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,'clusterName' => cluster_name,'scriptExecutionId' => script_execution_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::Hdinsight::Mgmt::V2018_06_01_preview::Models::RuntimeScriptActionDetail.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_execution_detail_with_http_info(resource_group_name, cluster_name, script_execution_id, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets the script execution detail for the given script execution ID.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • cluster_name (String)

    The name of the cluster.

  • script_execution_id (String)

    The script execution Id

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



232
233
234
# File 'lib/2018-06-01-preview/generated/azure_mgmt_hdinsight/script_actions.rb', line 232

def get_execution_detail_with_http_info(resource_group_name, cluster_name, script_execution_id, custom_headers:nil)
  get_execution_detail_async(resource_group_name, cluster_name, script_execution_id, custom_headers:custom_headers).value!
end

#list_by_cluster(resource_group_name, cluster_name, custom_headers: nil) ⇒ Array<RuntimeScriptActionDetail>

Lists all the persisted script actions for the specified cluster.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • cluster_name (String)

    The name of the cluster.

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

    A hash of custom headers that

Returns:

  • (Array<RuntimeScriptActionDetail>)

    operation results.



121
122
123
124
# File 'lib/2018-06-01-preview/generated/azure_mgmt_hdinsight/script_actions.rb', line 121

def list_by_cluster(resource_group_name, cluster_name, custom_headers:nil)
  first_page = list_by_cluster_as_lazy(resource_group_name, cluster_name, custom_headers:custom_headers)
  first_page.get_all_items
end

#list_by_cluster_as_lazy(resource_group_name, cluster_name, custom_headers: nil) ⇒ ScriptActionsList

Lists all the persisted script actions for the specified cluster.

will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • cluster_name (String)

    The name of the cluster.

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

    A hash of custom headers that

Returns:

  • (ScriptActionsList)

    which provide lazy access to pages of the



404
405
406
407
408
409
410
411
412
413
# File 'lib/2018-06-01-preview/generated/azure_mgmt_hdinsight/script_actions.rb', line 404

def list_by_cluster_as_lazy(resource_group_name, cluster_name, custom_headers:nil)
  response = list_by_cluster_async(resource_group_name, cluster_name, custom_headers:custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_page_link|
      list_by_cluster_next_async(next_page_link, custom_headers:custom_headers)
    end
    page
  end
end

#list_by_cluster_async(resource_group_name, cluster_name, custom_headers: nil) ⇒ Concurrent::Promise

Lists all the persisted script actions for the specified cluster.

to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • cluster_name (String)

    The name of the cluster.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
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
# File 'lib/2018-06-01-preview/generated/azure_mgmt_hdinsight/script_actions.rb', line 150

def list_by_cluster_async(resource_group_name, cluster_name, custom_headers: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, 'cluster_name is nil' if cluster_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.HDInsight/clusters/{clusterName}/scriptActions'

  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,'clusterName' => cluster_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 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::Hdinsight::Mgmt::V2018_06_01_preview::Models::ScriptActionsList.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_cluster_next(next_page_link, custom_headers: nil) ⇒ ScriptActionsList

Lists all the persisted script actions for the specified cluster.

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:

  • (ScriptActionsList)

    operation results.



313
314
315
316
# File 'lib/2018-06-01-preview/generated/azure_mgmt_hdinsight/script_actions.rb', line 313

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

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

Lists all the persisted script actions for the specified cluster.

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.



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
380
381
382
383
384
385
386
387
388
389
390
391
# File 'lib/2018-06-01-preview/generated/azure_mgmt_hdinsight/script_actions.rb', line 342

def list_by_cluster_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::Hdinsight::Mgmt::V2018_06_01_preview::Models::ScriptActionsList.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_cluster_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists all the persisted script actions for the specified cluster.

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.



328
329
330
# File 'lib/2018-06-01-preview/generated/azure_mgmt_hdinsight/script_actions.rb', line 328

def list_by_cluster_next_with_http_info(next_page_link, custom_headers:nil)
  list_by_cluster_next_async(next_page_link, custom_headers:custom_headers).value!
end

#list_by_cluster_with_http_info(resource_group_name, cluster_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists all the persisted script actions for the specified cluster.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group.

  • cluster_name (String)

    The name of the cluster.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



136
137
138
# File 'lib/2018-06-01-preview/generated/azure_mgmt_hdinsight/script_actions.rb', line 136

def list_by_cluster_with_http_info(resource_group_name, cluster_name, custom_headers:nil)
  list_by_cluster_async(resource_group_name, cluster_name, custom_headers:custom_headers).value!
end