Class: Azure::ApiManagement::Mgmt::V2017_03_01::ApiIssuComment

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2017-03-01/generated/azure_mgmt_api_management/api_issu_comment.rb

Overview

ApiManagement Client

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ ApiIssuComment

Creates and initializes a new instance of the ApiIssuComment class.

Parameters:

  • client —

    service class for accessing basic functionality.



17
18
19
 
# File 'lib/2017-03-01/generated/azure_mgmt_api_management/api_issu_comment.rb', line 17

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ ApiManagementClient (readonly)

Returns reference to the ApiManagementClient.

Returns:



22
23
24
 
# File 'lib/2017-03-01/generated/azure_mgmt_api_management/api_issu_comment.rb', line 22

def client
  @client
end

Instance Method Details

#head(resource_group_name, service_name, api_id, issue_id, comment_id, custom_headers: nil) ⇒ Object

Gets the entity state (Etag) version 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.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • service_name (String) —

    The name of the API Management service.

  • api_id (String) —

    API identifier. Must be unique in the current API

  • issue_id (String) —

    Issue identifier. Must be unique in the current API

  • comment_id (String) —

    Comment identifier within an Issue. Must be unique

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

    A hash of custom headers that



40
41
42
43
 
# File 'lib/2017-03-01/generated/azure_mgmt_api_management/api_issu_comment.rb', line 40

def head(resource_group_name, service_name, api_id, issue_id, comment_id, custom_headers:nil)
  response = head_async(resource_group_name, service_name, api_id, issue_id, comment_id, custom_headers:custom_headers).value!
  nil
end

#head_async(resource_group_name, service_name, api_id, issue_id, comment_id, custom_headers: nil) ⇒ Concurrent::Promise

Gets the entity state (Etag) version 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.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • service_name (String) —

    The name of the API Management service.

  • api_id (String) —

    API identifier. Must be unique in the current API

  • issue_id (String) —

    Issue identifier. Must be unique in the current API

  • comment_id (String) —

    Comment identifier within an Issue. Must be unique

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
 
# File 'lib/2017-03-01/generated/azure_mgmt_api_management/api_issu_comment.rb', line 83

def head_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

  options = {
      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(:head, 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?

    result
  end

  promise.execute
end

#head_with_http_info(resource_group_name, service_name, api_id, issue_id, comment_id, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets the entity state (Etag) version 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.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • service_name (String) —

    The name of the API Management service.

  • api_id (String) —

    API identifier. Must be unique in the current API

  • issue_id (String) —

    Issue identifier. Must be unique in the current API

  • comment_id (String) —

    Comment identifier within an Issue. Must be unique

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



62
63
64
 
# File 'lib/2017-03-01/generated/azure_mgmt_api_management/api_issu_comment.rb', line 62

def head_with_http_info(resource_group_name, service_name, api_id, issue_id, comment_id, custom_headers:nil)
  head_async(resource_group_name, service_name, api_id, issue_id, comment_id, custom_headers:custom_headers).value!
end