Class: Azure::ApiManagement::Mgmt::V2018_06_01_preview::OperationOperations

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

Overview

ApiManagement Client

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ OperationOperations

Creates and initializes a new instance of the OperationOperations class.



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

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ ApiManagementClient (readonly) 



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

def client
  @client
end

Instance Method Details

#list_by_tags(resource_group_name, service_name, api_id, filter: nil, top: nil, skip: nil, include_not_tagged_operations: nil, custom_headers: nil) ⇒ Array<TagResourceContract>

Lists a collection of operations associated with tags.

API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. functions | |————-|————————|———————————–|

|name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith| |displayName | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith| |apiName | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith| |description | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith| |method | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith| |urlTemplate | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith|

will be added to the HTTP request.



56
57
58
59
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_api_management/operation_operations.rb', line 56

def list_by_tags(resource_group_name, service_name, api_id, filter:nil, top:nil, skip:nil, include_not_tagged_operations:nil, custom_headers:nil)
  first_page = list_by_tags_as_lazy(resource_group_name, service_name, api_id, filter:filter, top:top, skip:skip, include_not_tagged_operations:include_not_tagged_operations, custom_headers:custom_headers)
  first_page.get_all_items
end

#list_by_tags_as_lazy(resource_group_name, service_name, api_id, filter: nil, top: nil, skip: nil, include_not_tagged_operations: nil, custom_headers: nil) ⇒ TagResourceCollection

Lists a collection of operations associated with tags.

API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. functions | |————-|————————|———————————–|

|name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith| |displayName | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith| |apiName | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith| |description | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith| |method | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith| |urlTemplate | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith|

will be added to the HTTP request.

response.



316
317
318
319
320
321
322
323
324
325
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_api_management/operation_operations.rb', line 316

def list_by_tags_as_lazy(resource_group_name, service_name, api_id, filter:nil, top:nil, skip:nil, include_not_tagged_operations:nil, custom_headers:nil)
  response = list_by_tags_async(resource_group_name, service_name, api_id, filter:filter, top:top, skip:skip, include_not_tagged_operations:include_not_tagged_operations, custom_headers:custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_page_link|
      list_by_tags_next_async(next_page_link, custom_headers:custom_headers)
    end
    page
  end
end

#list_by_tags_async(resource_group_name, service_name, api_id, filter: nil, top: nil, skip: nil, include_not_tagged_operations: nil, custom_headers: nil) ⇒ Concurrent::Promise

Lists a collection of operations associated with tags.

API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. functions | |————-|————————|———————————–|

|name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith| |displayName | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith| |apiName | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith| |description | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith| |method | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith| |urlTemplate | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith|

to the HTTP request.



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
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_api_management/operation_operations.rb', line 129

def list_by_tags_async(resource_group_name, service_name, api_id, filter:nil, top:nil, skip:nil, include_not_tagged_operations:nil, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'service_name is nil' if service_name.nil?
  fail ArgumentError, "'service_name' should satisfy the constraint - 'MaxLength': '50'" if !service_name.nil? && service_name.length > 50
  fail ArgumentError, "'service_name' should satisfy the constraint - 'MinLength': '1'" if !service_name.nil? && service_name.length < 1
  fail ArgumentError, "'service_name' should satisfy the constraint - 'Pattern': '^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$'" if !service_name.nil? && service_name.match(Regexp.new('^^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$$')).nil?
  fail ArgumentError, 'api_id is nil' if api_id.nil?
  fail ArgumentError, "'api_id' should satisfy the constraint - 'MaxLength': '256'" if !api_id.nil? && api_id.length > 256
  fail ArgumentError, "'api_id' should satisfy the constraint - 'MinLength': '1'" if !api_id.nil? && api_id.length < 1
  fail ArgumentError, "'api_id' should satisfy the constraint - 'Pattern': '^[^*#&+:<>?]+$'" if !api_id.nil? && api_id.match(Regexp.new('^^[^*#&+:<>?]+$$')).nil?
  fail ArgumentError, "'top' should satisfy the constraint - 'InclusiveMinimum': '1'" if !top.nil? && top < 1
  fail ArgumentError, "'skip' should satisfy the constraint - 'InclusiveMinimum': '0'" if !skip.nil? && skip < 0
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.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.ApiManagement/service/{serviceName}/apis/{apiId}/operationsByTags'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'serviceName' => service_name,'apiId' => api_id,'subscriptionId' => @client.subscription_id},
      query_params: {'$filter' => filter,'$top' => top,'$skip' => skip,'includeNotTaggedOperations' => include_not_tagged_operations,'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::ApiManagement::Mgmt::V2018_06_01_preview::Models::TagResourceCollection.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_tags_next(next_page_link, custom_headers: nil) ⇒ TagResourceCollection

Lists a collection of operations associated with tags.

to List operation. will be added to the HTTP request.



203
204
205
206
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_api_management/operation_operations.rb', line 203

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

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

Lists a collection of operations associated with tags.

to List operation. to the HTTP request.



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
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_api_management/operation_operations.rb', line 232

def list_by_tags_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::ApiManagement::Mgmt::V2018_06_01_preview::Models::TagResourceCollection.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_tags_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists a collection of operations associated with tags.

to List operation. will be added to the HTTP request.



218
219
220
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_api_management/operation_operations.rb', line 218

def list_by_tags_next_with_http_info(next_page_link, custom_headers:nil)
  list_by_tags_next_async(next_page_link, custom_headers:custom_headers).value!
end

#list_by_tags_with_http_info(resource_group_name, service_name, api_id, filter: nil, top: nil, skip: nil, include_not_tagged_operations: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists a collection of operations associated with tags.

API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. functions | |————-|————————|———————————–|

|name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith| |displayName | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith| |apiName | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith| |description | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith| |method | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith| |urlTemplate | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith|

will be added to the HTTP request.



93
94
95
 
# File 'lib/2018-06-01-preview/generated/azure_mgmt_api_management/operation_operations.rb', line 93

def list_by_tags_with_http_info(resource_group_name, service_name, api_id, filter:nil, top:nil, skip:nil, include_not_tagged_operations:nil, custom_headers:nil)
  list_by_tags_async(resource_group_name, service_name, api_id, filter:filter, top:top, skip:skip, include_not_tagged_operations:include_not_tagged_operations, custom_headers:custom_headers).value!
end