Class: Azure::TrafficManager::Mgmt::V2017_09_01_preview::HeatMap

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

Overview

HeatMap

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ HeatMap

Creates and initializes a new instance of the HeatMap class.

Parameters:

  • client —

    service class for accessing basic functionality.



17
18
19
 
# File 'lib/2017-09-01-preview/generated/azure_mgmt_traffic_manager/heat_map.rb', line 17

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ TrafficManagerManagementClient (readonly)

Returns reference to the TrafficManagerManagementClient.

Returns:



22
23
24
 
# File 'lib/2017-09-01-preview/generated/azure_mgmt_traffic_manager/heat_map.rb', line 22

def client
  @client
end

Instance Method Details

#get(resource_group_name, profile_name, top_left: nil, bot_right: nil, custom_headers: nil) ⇒ HeatMapModel

Gets latest heatmap for Traffic Manager profile.

the Traffic Manager endpoint. rectangular viewport to query for. the rectangular viewport to query for. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group containing

  • profile_name (String) —

    The name of the Traffic Manager profile.

  • top_left (Array<Float>) (defaults to: nil) —

    The top left latitude,longitude pair of the

  • bot_right (Array<Float>) (defaults to: nil) —

    The bottom right latitude,longitude pair of

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

    A hash of custom headers that

Returns:

  • (HeatMapModel) —

    operation results.



39
40
41
42
 
# File 'lib/2017-09-01-preview/generated/azure_mgmt_traffic_manager/heat_map.rb', line 39

def get(resource_group_name, profile_name, top_left:nil, bot_right:nil, custom_headers:nil)
  response = get_async(resource_group_name, profile_name, top_left:top_left, bot_right:bot_right, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#get_async(resource_group_name, profile_name, top_left: nil, bot_right: nil, custom_headers: nil) ⇒ Concurrent::Promise

Gets latest heatmap for Traffic Manager profile.

the Traffic Manager endpoint. rectangular viewport to query for. the rectangular viewport to query for. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group containing

  • profile_name (String) —

    The name of the Traffic Manager profile.

  • top_left (Array<Float>) (defaults to: nil) —

    The top left latitude,longitude pair of the

  • bot_right (Array<Float>) (defaults to: nil) —

    The bottom right latitude,longitude pair of

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
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
 
# File 'lib/2017-09-01-preview/generated/azure_mgmt_traffic_manager/heat_map.rb', line 78

def get_async(resource_group_name, profile_name, top_left:nil, bot_right: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, 'profile_name is nil' if profile_name.nil?
  heat_map_type = 'default'
  fail ArgumentError, "'top_left' should satisfy the constraint - 'MaxItems': '2'" if !top_left.nil? && top_left.length > 2
  fail ArgumentError, "'top_left' should satisfy the constraint - 'MinItems': '2'" if !top_left.nil? && top_left.length < 2
  fail ArgumentError, "'bot_right' should satisfy the constraint - 'MaxItems': '2'" if !bot_right.nil? && bot_right.length > 2
  fail ArgumentError, "'bot_right' should satisfy the constraint - 'MinItems': '2'" if !bot_right.nil? && bot_right.length < 2
  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.Network/trafficmanagerprofiles/{profileName}/heatMaps/{heatMapType}'

  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,'profileName' => profile_name,'heatMapType' => heat_map_type},
      query_params: {'topLeft' => top_left.nil? ? nil : top_left.join(','),'botRight' => bot_right.nil? ? nil : bot_right.join(','),'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::TrafficManager::Mgmt::V2017_09_01_preview::Models::HeatMapModel.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_with_http_info(resource_group_name, profile_name, top_left: nil, bot_right: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets latest heatmap for Traffic Manager profile.

the Traffic Manager endpoint. rectangular viewport to query for. the rectangular viewport to query for. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group containing

  • profile_name (String) —

    The name of the Traffic Manager profile.

  • top_left (Array<Float>) (defaults to: nil) —

    The top left latitude,longitude pair of the

  • bot_right (Array<Float>) (defaults to: nil) —

    The bottom right latitude,longitude pair of

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



59
60
61
 
# File 'lib/2017-09-01-preview/generated/azure_mgmt_traffic_manager/heat_map.rb', line 59

def get_with_http_info(resource_group_name, profile_name, top_left:nil, bot_right:nil, custom_headers:nil)
  get_async(resource_group_name, profile_name, top_left:top_left, bot_right:bot_right, custom_headers:custom_headers).value!
end