Class: Azure::ApiManagement::Mgmt::V2017_03_01::ApiIssueComment
- Inherits:
-
Object
- Object
- Azure::ApiManagement::Mgmt::V2017_03_01::ApiIssueComment
- Includes:
- MsRestAzure
- Defined in:
- lib/2017-03-01/generated/azure_mgmt_api_management/api_issue_comment.rb
Overview
ApiManagement Client
Instance Attribute Summary collapse
-
#client ⇒ ApiManagementClient
readonly
Reference to the ApiManagementClient.
Instance Method Summary collapse
-
#create_or_update(resource_group_name, service_name, api_id, issue_id, comment_id, parameters, if_match: nil, custom_headers: nil) ⇒ IssueCommentContract
Creates a new Comment for the Issue in an API or updates an existing one.
-
#create_or_update_async(resource_group_name, service_name, api_id, issue_id, comment_id, parameters, if_match: nil, custom_headers: nil) ⇒ Concurrent::Promise
Creates a new Comment for the Issue in an API or updates an existing one.
-
#create_or_update_with_http_info(resource_group_name, service_name, api_id, issue_id, comment_id, parameters, if_match: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Creates a new Comment for the Issue in an API or updates an existing one.
-
#delete(resource_group_name, service_name, api_id, issue_id, comment_id, if_match, custom_headers: nil) ⇒ Object
Deletes the specified comment from an Issue.
-
#delete_async(resource_group_name, service_name, api_id, issue_id, comment_id, if_match, custom_headers: nil) ⇒ Concurrent::Promise
Deletes the specified comment from an Issue.
-
#delete_with_http_info(resource_group_name, service_name, api_id, issue_id, comment_id, if_match, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Deletes the specified comment from an Issue.
-
#get(resource_group_name, service_name, api_id, issue_id, comment_id, custom_headers: nil) ⇒ IssueCommentContract
Gets the details of the issue Comment for an API specified by its identifier.
-
#get_async(resource_group_name, service_name, api_id, issue_id, comment_id, custom_headers: nil) ⇒ Concurrent::Promise
Gets the details of the issue Comment for an API specified by its identifier.
-
#get_with_http_info(resource_group_name, service_name, api_id, issue_id, comment_id, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Gets the details of the issue Comment for an API specified by its identifier.
-
#initialize(client) ⇒ ApiIssueComment
constructor
Creates and initializes a new instance of the ApiIssueComment class.
Constructor Details
#initialize(client) ⇒ ApiIssueComment
Creates and initializes a new instance of the ApiIssueComment class.
17 18 19 |
# File 'lib/2017-03-01/generated/azure_mgmt_api_management/api_issue_comment.rb', line 17 def initialize(client) @client = client end |
Instance Attribute Details
#client ⇒ ApiManagementClient (readonly)
Returns reference to the ApiManagementClient.
22 23 24 |
# File 'lib/2017-03-01/generated/azure_mgmt_api_management/api_issue_comment.rb', line 22 def client @client end |
Instance Method Details
#create_or_update(resource_group_name, service_name, api_id, issue_id, comment_id, parameters, if_match: nil, custom_headers: nil) ⇒ IssueCommentContract
Creates a new Comment for the Issue in an API or updates an existing one.
Management service instance. Management service instance. in the current Issue. current entity state from the header response of the GET request or it should be * for unconditional update. will be added to the HTTP request.
171 172 173 174 |
# File 'lib/2017-03-01/generated/azure_mgmt_api_management/api_issue_comment.rb', line 171 def create_or_update(resource_group_name, service_name, api_id, issue_id, comment_id, parameters, if_match:nil, custom_headers:nil) response = create_or_update_async(resource_group_name, service_name, api_id, issue_id, comment_id, parameters, if_match:if_match, custom_headers:custom_headers).value! response.body unless response.nil? end |
#create_or_update_async(resource_group_name, service_name, api_id, issue_id, comment_id, parameters, if_match: nil, custom_headers: nil) ⇒ Concurrent::Promise
Creates a new Comment for the Issue in an API or updates an existing one.
Management service instance. Management service instance. in the current Issue. current entity state from the header response of the GET request or it should be * for unconditional update. to the HTTP request.
220 221 222 223 224 225 226 227 228 229 230 231 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 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 |
# File 'lib/2017-03-01/generated/azure_mgmt_api_management/api_issue_comment.rb', line 220 def create_or_update_async(resource_group_name, service_name, api_id, issue_id, comment_id, parameters, if_match: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, 'issue_id is nil' if issue_id.nil? fail ArgumentError, "'issue_id' should satisfy the constraint - 'MaxLength': '256'" if !issue_id.nil? && issue_id.length > 256 fail ArgumentError, "'issue_id' should satisfy the constraint - 'MinLength': '1'" if !issue_id.nil? && issue_id.length < 1 fail ArgumentError, "'issue_id' should satisfy the constraint - 'Pattern': '^[^*#&+:<>?]+$'" if !issue_id.nil? && issue_id.match(Regexp.new('^^[^*#&+:<>?]+$$')).nil? fail ArgumentError, 'comment_id is nil' if comment_id.nil? fail ArgumentError, "'comment_id' should satisfy the constraint - 'MaxLength': '256'" if !comment_id.nil? && comment_id.length > 256 fail ArgumentError, "'comment_id' should satisfy the constraint - 'MinLength': '1'" if !comment_id.nil? && comment_id.length < 1 fail ArgumentError, "'comment_id' should satisfy the constraint - 'Pattern': '^[^*#&+:<>?]+$'" if !comment_id.nil? && comment_id.match(Regexp.new('^^[^*#&+:<>?]+$$')).nil? fail ArgumentError, 'parameters is nil' if parameters.nil? 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['If-Match'] = if_match unless if_match.nil? request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil? # Serialize Request request_mapper = Azure::ApiManagement::Mgmt::V2017_03_01::Models::IssueCommentContract.mapper() request_content = @client.serialize(request_mapper, parameters) request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/issues/{issueId}/comments/{commentId}' request_url = @base_url || @client.base_url = { middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]], path_params: {'resourceGroupName' => resource_group_name,'serviceName' => service_name,'apiId' => api_id,'issueId' => issue_id,'commentId' => comment_id,'subscriptionId' => @client.subscription_id}, query_params: {'api-version' => @client.api_version}, body: request_content, headers: request_headers.merge(custom_headers || {}), base_url: request_url } promise = @client.make_request_async(:put, path_template, ) promise = promise.then do |result| http_response = result.response status_code = http_response.status response_content = http_response.body unless status_code == 201 || 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 == 201 begin parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content) result_mapper = Azure::ApiManagement::Mgmt::V2017_03_01::Models::IssueCommentContract.mapper() result.body = @client.deserialize(result_mapper, parsed_response) rescue Exception => e fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e., e.backtrace, result) end end # Deserialize Response if status_code == 200 begin parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content) result_mapper = Azure::ApiManagement::Mgmt::V2017_03_01::Models::IssueCommentContract.mapper() result.body = @client.deserialize(result_mapper, parsed_response) rescue Exception => e fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e., e.backtrace, result) end end result end promise.execute end |
#create_or_update_with_http_info(resource_group_name, service_name, api_id, issue_id, comment_id, parameters, if_match: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Creates a new Comment for the Issue in an API or updates an existing one.
Management service instance. Management service instance. in the current Issue. current entity state from the header response of the GET request or it should be * for unconditional update. will be added to the HTTP request.
196 197 198 |
# File 'lib/2017-03-01/generated/azure_mgmt_api_management/api_issue_comment.rb', line 196 def create_or_update_with_http_info(resource_group_name, service_name, api_id, issue_id, comment_id, parameters, if_match:nil, custom_headers:nil) create_or_update_async(resource_group_name, service_name, api_id, issue_id, comment_id, parameters, if_match:if_match, custom_headers:custom_headers).value! end |
#delete(resource_group_name, service_name, api_id, issue_id, comment_id, if_match, custom_headers: nil) ⇒ Object
Deletes the specified comment from an Issue.
Management service instance. Management service instance. in the current Issue. current entity state from the header response of the GET request or it should be * for unconditional update. will be added to the HTTP request.
327 328 329 330 |
# File 'lib/2017-03-01/generated/azure_mgmt_api_management/api_issue_comment.rb', line 327 def delete(resource_group_name, service_name, api_id, issue_id, comment_id, if_match, custom_headers:nil) response = delete_async(resource_group_name, service_name, api_id, issue_id, comment_id, if_match, custom_headers:custom_headers).value! nil end |
#delete_async(resource_group_name, service_name, api_id, issue_id, comment_id, if_match, custom_headers: nil) ⇒ Concurrent::Promise
Deletes the specified comment from an Issue.
Management service instance. Management service instance. in the current Issue. current entity state from the header response of the GET request or it should be * for unconditional update. to the HTTP request.
374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 |
# File 'lib/2017-03-01/generated/azure_mgmt_api_management/api_issue_comment.rb', line 374 def delete_async(resource_group_name, service_name, api_id, issue_id, comment_id, if_match, 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, 'issue_id is nil' if issue_id.nil? fail ArgumentError, "'issue_id' should satisfy the constraint - 'MaxLength': '256'" if !issue_id.nil? && issue_id.length > 256 fail ArgumentError, "'issue_id' should satisfy the constraint - 'MinLength': '1'" if !issue_id.nil? && issue_id.length < 1 fail ArgumentError, "'issue_id' should satisfy the constraint - 'Pattern': '^[^*#&+:<>?]+$'" if !issue_id.nil? && issue_id.match(Regexp.new('^^[^*#&+:<>?]+$$')).nil? fail ArgumentError, 'comment_id is nil' if comment_id.nil? fail ArgumentError, "'comment_id' should satisfy the constraint - 'MaxLength': '256'" if !comment_id.nil? && comment_id.length > 256 fail ArgumentError, "'comment_id' should satisfy the constraint - 'MinLength': '1'" if !comment_id.nil? && comment_id.length < 1 fail ArgumentError, "'comment_id' should satisfy the constraint - 'Pattern': '^[^*#&+:<>?]+$'" if !comment_id.nil? && comment_id.match(Regexp.new('^^[^*#&+:<>?]+$$')).nil? fail ArgumentError, 'if_match is nil' if if_match.nil? 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['If-Match'] = if_match unless if_match.nil? 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}/issues/{issueId}/comments/{commentId}' request_url = @base_url || @client.base_url = { middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]], path_params: {'resourceGroupName' => resource_group_name,'serviceName' => service_name,'apiId' => api_id,'issueId' => issue_id,'commentId' => comment_id,'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(:delete, path_template, ) promise = promise.then do |result| http_response = result.response status_code = http_response.status response_content = http_response.body unless 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, service_name, api_id, issue_id, comment_id, if_match, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Deletes the specified comment from an Issue.
Management service instance. Management service instance. in the current Issue. current entity state from the header response of the GET request or it should be * for unconditional update. will be added to the HTTP request.
351 352 353 |
# File 'lib/2017-03-01/generated/azure_mgmt_api_management/api_issue_comment.rb', line 351 def delete_with_http_info(resource_group_name, service_name, api_id, issue_id, comment_id, if_match, custom_headers:nil) delete_async(resource_group_name, service_name, api_id, issue_id, comment_id, if_match, custom_headers:custom_headers).value! end |
#get(resource_group_name, service_name, api_id, issue_id, comment_id, custom_headers: nil) ⇒ IssueCommentContract
Gets the details of the issue Comment for an API specified by its identifier.
Management service instance. Management service instance. in the current Issue. will be added to the HTTP request.
40 41 42 43 |
# File 'lib/2017-03-01/generated/azure_mgmt_api_management/api_issue_comment.rb', line 40 def get(resource_group_name, service_name, api_id, issue_id, comment_id, custom_headers:nil) response = get_async(resource_group_name, service_name, api_id, issue_id, comment_id, custom_headers:custom_headers).value! response.body unless response.nil? end |
#get_async(resource_group_name, service_name, api_id, issue_id, comment_id, custom_headers: nil) ⇒ Concurrent::Promise
Gets the details of the issue Comment for an API specified by its identifier.
Management service instance. Management service instance. in the current Issue. to the HTTP request.
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 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 |
# File 'lib/2017-03-01/generated/azure_mgmt_api_management/api_issue_comment.rb', line 81 def get_async(resource_group_name, service_name, api_id, issue_id, comment_id, 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, 'issue_id is nil' if issue_id.nil? fail ArgumentError, "'issue_id' should satisfy the constraint - 'MaxLength': '256'" if !issue_id.nil? && issue_id.length > 256 fail ArgumentError, "'issue_id' should satisfy the constraint - 'MinLength': '1'" if !issue_id.nil? && issue_id.length < 1 fail ArgumentError, "'issue_id' should satisfy the constraint - 'Pattern': '^[^*#&+:<>?]+$'" if !issue_id.nil? && issue_id.match(Regexp.new('^^[^*#&+:<>?]+$$')).nil? fail ArgumentError, 'comment_id is nil' if comment_id.nil? fail ArgumentError, "'comment_id' should satisfy the constraint - 'MaxLength': '256'" if !comment_id.nil? && comment_id.length > 256 fail ArgumentError, "'comment_id' should satisfy the constraint - 'MinLength': '1'" if !comment_id.nil? && comment_id.length < 1 fail ArgumentError, "'comment_id' should satisfy the constraint - 'Pattern': '^[^*#&+:<>?]+$'" if !comment_id.nil? && comment_id.match(Regexp.new('^^[^*#&+:<>?]+$$')).nil? 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}/issues/{issueId}/comments/{commentId}' request_url = @base_url || @client.base_url = { middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]], path_params: {'resourceGroupName' => resource_group_name,'serviceName' => service_name,'apiId' => api_id,'issueId' => issue_id,'commentId' => comment_id,'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, ) 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::ApiManagement::Mgmt::V2017_03_01::Models::IssueCommentContract.mapper() result.body = @client.deserialize(result_mapper, parsed_response) rescue Exception => e fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e., e.backtrace, result) end end result end promise.execute end |
#get_with_http_info(resource_group_name, service_name, api_id, issue_id, comment_id, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Gets the details of the issue Comment for an API specified by its identifier.
Management service instance. Management service instance. in the current Issue. will be added to the HTTP request.
61 62 63 |
# File 'lib/2017-03-01/generated/azure_mgmt_api_management/api_issue_comment.rb', line 61 def get_with_http_info(resource_group_name, service_name, api_id, issue_id, comment_id, custom_headers:nil) get_async(resource_group_name, service_name, api_id, issue_id, comment_id, custom_headers:custom_headers).value! end |