Class: Azure::DataFactory::Mgmt::V2017_09_01_preview::ActivityRuns

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2017-09-01-preview/generated/azure_mgmt_data_factory/activity_runs.rb

Overview

The Azure Data Factory V2 management API provides a RESTful set of web services that interact with Azure Data Factory V2 services.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ ActivityRuns

Creates and initializes a new instance of the ActivityRuns class.

Parameters:

  • client —

    service class for accessing basic functionality.



18
19
20
 
# File 'lib/2017-09-01-preview/generated/azure_mgmt_data_factory/activity_runs.rb', line 18

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ DataFactoryManagementClient (readonly)

Returns reference to the DataFactoryManagementClient.

Returns:



23
24
25
 
# File 'lib/2017-09-01-preview/generated/azure_mgmt_data_factory/activity_runs.rb', line 23

def client
  @client
end

Instance Method Details

#list_by_pipeline_run(resource_group_name, factory_name, run_id, start_time, end_time, status: nil, activity_name: nil, linked_service_name: nil, custom_headers: nil) ⇒ Array<ActivityRun>

List activity runs based on input filter conditions.

format. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • factory_name (String) —

    The factory name.

  • run_id (String) —

    The pipeline run identifier.

  • start_time (DateTime) —

    The start time of activity runs in ISO8601

  • end_time (DateTime) —

    The end time of activity runs in ISO8601 format.

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

    The status of the pipeline run.

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

    The name of the activity.

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

    The linked service name.

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

    A hash of custom headers that

Returns:

  • (Array<ActivityRun>) —

    operation results.



42
43
44
45
 
# File 'lib/2017-09-01-preview/generated/azure_mgmt_data_factory/activity_runs.rb', line 42

def list_by_pipeline_run(resource_group_name, factory_name, run_id, start_time, end_time, status:nil, activity_name:nil, linked_service_name:nil, custom_headers:nil)
  first_page = list_by_pipeline_run_as_lazy(resource_group_name, factory_name, run_id, start_time, end_time, status:status, activity_name:activity_name, linked_service_name:linked_service_name, custom_headers:custom_headers)
  first_page.get_all_items
end

#list_by_pipeline_run_as_lazy(resource_group_name, factory_name, run_id, start_time, end_time, status: nil, activity_name: nil, linked_service_name: nil, custom_headers: nil) ⇒ ActivityRunsListResponse

List activity runs based on input filter conditions.

format. will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • factory_name (String) —

    The factory name.

  • run_id (String) —

    The pipeline run identifier.

  • start_time (DateTime) —

    The start time of activity runs in ISO8601

  • end_time (DateTime) —

    The end time of activity runs in ISO8601 format.

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

    The status of the pipeline run.

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

    The name of the activity.

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

    The linked service name.

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

    A hash of custom headers that

Returns:

  • (ActivityRunsListResponse) —

    which provide lazy access to pages of the



260
261
262
263
264
265
266
267
268
269
 
# File 'lib/2017-09-01-preview/generated/azure_mgmt_data_factory/activity_runs.rb', line 260

def list_by_pipeline_run_as_lazy(resource_group_name, factory_name, run_id, start_time, end_time, status:nil, activity_name:nil, linked_service_name:nil, custom_headers:nil)
  response = list_by_pipeline_run_async(resource_group_name, factory_name, run_id, start_time, end_time, status:status, activity_name:activity_name, linked_service_name:linked_service_name, custom_headers:custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_page_link|
      list_by_pipeline_run_next_async(next_page_link, custom_headers:custom_headers)
    end
    page
  end
end

#list_by_pipeline_run_async(resource_group_name, factory_name, run_id, start_time, end_time, status: nil, activity_name: nil, linked_service_name: nil, custom_headers: nil) ⇒ Concurrent::Promise

List activity runs based on input filter conditions.

format. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • factory_name (String) —

    The factory name.

  • run_id (String) —

    The pipeline run identifier.

  • start_time (DateTime) —

    The start time of activity runs in ISO8601

  • end_time (DateTime) —

    The end time of activity runs in ISO8601 format.

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

    The status of the pipeline run.

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

    The name of the activity.

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

    The linked service name.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
145
146
147
148
149
150
 
# File 'lib/2017-09-01-preview/generated/azure_mgmt_data_factory/activity_runs.rb', line 85

def list_by_pipeline_run_async(resource_group_name, factory_name, run_id, start_time, end_time, status:nil, activity_name:nil, linked_service_name:nil, 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, "'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, 'factory_name is nil' if factory_name.nil?
  fail ArgumentError, "'factory_name' should satisfy the constraint - 'MaxLength': '63'" if !factory_name.nil? && factory_name.length > 63
  fail ArgumentError, "'factory_name' should satisfy the constraint - 'MinLength': '3'" if !factory_name.nil? && factory_name.length < 3
  fail ArgumentError, "'factory_name' should satisfy the constraint - 'Pattern': '^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$'" if !factory_name.nil? && factory_name.match(Regexp.new('^^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$$')).nil?
  fail ArgumentError, 'run_id is nil' if run_id.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, 'start_time is nil' if start_time.nil?
  fail ArgumentError, 'end_time is nil' if end_time.nil?
  fail ArgumentError, "'linked_service_name' should satisfy the constraint - 'MaxLength': '260'" if !linked_service_name.nil? && linked_service_name.length > 260
  fail ArgumentError, "'linked_service_name' should satisfy the constraint - 'MinLength': '1'" if !linked_service_name.nil? && linked_service_name.length < 1
  fail ArgumentError, "'linked_service_name' should satisfy the constraint - 'Pattern': '^[A-Za-z0-9_][^<>*#.%&:\\+?/]*$'" if !linked_service_name.nil? && linked_service_name.match(Regexp.new('^^[A-Za-z0-9_][^<>*#.%&:\\+?/]*$$')).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.DataFactory/factories/{factoryName}/pipelineruns/{runId}/activityruns'

  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,'factoryName' => factory_name,'runId' => run_id},
      query_params: {'api-version' => @client.api_version,'startTime' => start_time,'endTime' => end_time,'status' => status,'activityName' => activity_name,'linkedServiceName' => linked_service_name},
      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::DataFactory::Mgmt::V2017_09_01_preview::Models::ActivityRunsListResponse.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_pipeline_run_next(next_page_link, custom_headers: nil) ⇒ ActivityRunsListResponse

List activity runs based on input filter conditions.

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:

  • (ActivityRunsListResponse) —

    operation results.



162
163
164
165
 
# File 'lib/2017-09-01-preview/generated/azure_mgmt_data_factory/activity_runs.rb', line 162

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

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

List activity runs based on input filter conditions.

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.



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
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/2017-09-01-preview/generated/azure_mgmt_data_factory/activity_runs.rb', line 191

def list_by_pipeline_run_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::DataFactory::Mgmt::V2017_09_01_preview::Models::ActivityRunsListResponse.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_pipeline_run_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

List activity runs based on input filter conditions.

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.



177
178
179
 
# File 'lib/2017-09-01-preview/generated/azure_mgmt_data_factory/activity_runs.rb', line 177

def list_by_pipeline_run_next_with_http_info(next_page_link, custom_headers:nil)
  list_by_pipeline_run_next_async(next_page_link, custom_headers:custom_headers).value!
end

#list_by_pipeline_run_with_http_info(resource_group_name, factory_name, run_id, start_time, end_time, status: nil, activity_name: nil, linked_service_name: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

List activity runs based on input filter conditions.

format. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • factory_name (String) —

    The factory name.

  • run_id (String) —

    The pipeline run identifier.

  • start_time (DateTime) —

    The start time of activity runs in ISO8601

  • end_time (DateTime) —

    The end time of activity runs in ISO8601 format.

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

    The status of the pipeline run.

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

    The name of the activity.

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

    The linked service name.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



64
65
66
 
# File 'lib/2017-09-01-preview/generated/azure_mgmt_data_factory/activity_runs.rb', line 64

def list_by_pipeline_run_with_http_info(resource_group_name, factory_name, run_id, start_time, end_time, status:nil, activity_name:nil, linked_service_name:nil, custom_headers:nil)
  list_by_pipeline_run_async(resource_group_name, factory_name, run_id, start_time, end_time, status:status, activity_name:activity_name, linked_service_name:linked_service_name, custom_headers:custom_headers).value!
end