Class: Azure::CustomerInsights::Mgmt::V2017_04_26::CustomerInsightsManagementClient

Inherits:
MsRestAzure::AzureServiceClient
  • Object
show all
Includes:
MsRestAzure, MsRestAzure::Serialization
Defined in:
lib/2017-04-26/generated/azure_mgmt_customer_insights/customer_insights_management_client.rb

Overview

A service client - single point of access to the REST API.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(credentials = nil, base_url = nil, options = nil) ⇒ CustomerInsightsManagementClient

Creates initializes a new instance of the CustomerInsightsManagementClient class.

Parameters:

  • credentials (MsRest::ServiceClientCredentials) (defaults to: nil) —

    credentials to authorize HTTP requests made by the service client.

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

    the base URI of the service.

  • options (Array) (defaults to: nil) —

    filters to be applied to the HTTP requests.



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
 
# File 'lib/2017-04-26/generated/azure_mgmt_customer_insights/customer_insights_management_client.rb', line 97

def initialize(credentials = nil, base_url = nil, options = nil)
  super(credentials, options)
  @base_url = base_url || 'https://management.azure.com'

  fail ArgumentError, 'invalid type of credentials input parameter' unless credentials.is_a?(MsRest::ServiceClientCredentials) unless credentials.nil?
  @credentials = credentials

  @operations = Operations.new(self)
  @hubs = Hubs.new(self)
  @profiles = Profiles.new(self)
  @interactions = Interactions.new(self)
  @relationships = Relationships.new(self)
  @relationship_links = RelationshipLinks.new(self)
  @authorization_policies = AuthorizationPolicies.new(self)
  @connectors = Connectors.new(self)
  @connector_mappings = ConnectorMappings.new(self)
  @kpi = Kpi.new(self)
  @widget_types = WidgetTypes.new(self)
  @views = Views.new(self)
  @links = Links.new(self)
  @roles = Roles.new(self)
  @role_assignments = RoleAssignments.new(self)
  @images = Images.new(self)
  @predictions = Predictions.new(self)
  @api_version = '2017-04-26'
  @accept_language = 'en-US'
  @long_running_operation_retry_timeout = 30
  @generate_client_request_id = true
  add_telemetry
end

Instance Attribute Details

#accept_language ⇒ String

Returns The preferred language for the response.

Returns:

  • (String) —

    The preferred language for the response.



29
30
31
 
# File 'lib/2017-04-26/generated/azure_mgmt_customer_insights/customer_insights_management_client.rb', line 29

def accept_language
  @accept_language
end

#api_version ⇒ String (readonly)

Returns Client Api Version.

Returns:

  • (String) —

    Client Api Version.



26
27
28
 
# File 'lib/2017-04-26/generated/azure_mgmt_customer_insights/customer_insights_management_client.rb', line 26

def api_version
  @api_version
end

#authorization_policies ⇒ AuthorizationPolicies (readonly)

Returns authorization_policies.

Returns:



59
60
61
 
# File 'lib/2017-04-26/generated/azure_mgmt_customer_insights/customer_insights_management_client.rb', line 59

def authorization_policies
  @authorization_policies
end

#base_url ⇒ String

Returns the base URI of the service.

Returns:

  • (String) —

    the base URI of the service.



15
16
17
 
# File 'lib/2017-04-26/generated/azure_mgmt_customer_insights/customer_insights_management_client.rb', line 15

def base_url
  @base_url
end

#connector_mappings ⇒ ConnectorMappings (readonly)

Returns connector_mappings.

Returns:



65
66
67
 
# File 'lib/2017-04-26/generated/azure_mgmt_customer_insights/customer_insights_management_client.rb', line 65

def connector_mappings
  @connector_mappings
end

#connectors ⇒ Connectors (readonly)

Returns connectors.

Returns:



62
63
64
 
# File 'lib/2017-04-26/generated/azure_mgmt_customer_insights/customer_insights_management_client.rb', line 62

def connectors
  @connectors
end

#credentials ⇒ Object (readonly)

Returns Credentials needed for the client to connect to Azure.

Returns:

  • Credentials needed for the client to connect to Azure.



18
19
20
 
# File 'lib/2017-04-26/generated/azure_mgmt_customer_insights/customer_insights_management_client.rb', line 18

def credentials
  @credentials
end

#generate_client_request_id ⇒ Boolean

generated. When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

Returns:

  • (Boolean) —

    Whether a unique x-ms-client-request-id should be



38
39
40
 
# File 'lib/2017-04-26/generated/azure_mgmt_customer_insights/customer_insights_management_client.rb', line 38

def generate_client_request_id
  @generate_client_request_id
end

#hubs ⇒ Hubs (readonly)

Returns hubs.

Returns:



44
45
46
 
# File 'lib/2017-04-26/generated/azure_mgmt_customer_insights/customer_insights_management_client.rb', line 44

def hubs
  @hubs
end

#images ⇒ Images (readonly)

Returns images.

Returns:



86
87
88
 
# File 'lib/2017-04-26/generated/azure_mgmt_customer_insights/customer_insights_management_client.rb', line 86

def images
  @images
end

#interactions ⇒ Interactions (readonly)

Returns interactions.

Returns:



50
51
52
 
# File 'lib/2017-04-26/generated/azure_mgmt_customer_insights/customer_insights_management_client.rb', line 50

def interactions
  @interactions
end

#kpi ⇒ Kpi (readonly)

Returns kpi.

Returns:

  • (Kpi) —

    kpi



68
69
70
 
# File 'lib/2017-04-26/generated/azure_mgmt_customer_insights/customer_insights_management_client.rb', line 68

def kpi
  @kpi
end

#links ⇒ Links (readonly)

Returns links.

Returns:



77
78
79
 
# File 'lib/2017-04-26/generated/azure_mgmt_customer_insights/customer_insights_management_client.rb', line 77

def links
  @links
end

#long_running_operation_retry_timeout ⇒ Integer

Operations. Default value is 30.

Returns:

  • (Integer) —

    The retry timeout in seconds for Long Running



33
34
35
 
# File 'lib/2017-04-26/generated/azure_mgmt_customer_insights/customer_insights_management_client.rb', line 33

def long_running_operation_retry_timeout
  @long_running_operation_retry_timeout
end

#operations ⇒ Operations (readonly)

Returns operations.

Returns:



41
42
43
 
# File 'lib/2017-04-26/generated/azure_mgmt_customer_insights/customer_insights_management_client.rb', line 41

def operations
  @operations
end

#predictions ⇒ Predictions (readonly)

Returns predictions.

Returns:



89
90
91
 
# File 'lib/2017-04-26/generated/azure_mgmt_customer_insights/customer_insights_management_client.rb', line 89

def predictions
  @predictions
end

#profiles ⇒ Profiles (readonly)

Returns profiles.

Returns:



47
48
49
 
# File 'lib/2017-04-26/generated/azure_mgmt_customer_insights/customer_insights_management_client.rb', line 47

def profiles
  @profiles
end

#relationship_links ⇒ RelationshipLinks (readonly)

Returns relationship_links.

Returns:



56
57
58
 
# File 'lib/2017-04-26/generated/azure_mgmt_customer_insights/customer_insights_management_client.rb', line 56

def relationship_links
  @relationship_links
end

#relationships ⇒ Relationships (readonly)

Returns relationships.

Returns:



53
54
55
 
# File 'lib/2017-04-26/generated/azure_mgmt_customer_insights/customer_insights_management_client.rb', line 53

def relationships
  @relationships
end

#role_assignments ⇒ RoleAssignments (readonly)

Returns role_assignments.

Returns:



83
84
85
 
# File 'lib/2017-04-26/generated/azure_mgmt_customer_insights/customer_insights_management_client.rb', line 83

def role_assignments
  @role_assignments
end

#roles ⇒ Roles (readonly)

Returns roles.

Returns:



80
81
82
 
# File 'lib/2017-04-26/generated/azure_mgmt_customer_insights/customer_insights_management_client.rb', line 80

def roles
  @roles
end

#subscription_id ⇒ String

Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Returns:

  • (String) —

    Gets subscription credentials which uniquely identify



23
24
25
 
# File 'lib/2017-04-26/generated/azure_mgmt_customer_insights/customer_insights_management_client.rb', line 23

def subscription_id
  @subscription_id
end

#views ⇒ Views (readonly)

Returns views.

Returns:



74
75
76
 
# File 'lib/2017-04-26/generated/azure_mgmt_customer_insights/customer_insights_management_client.rb', line 74

def views
  @views
end

#widget_types ⇒ WidgetTypes (readonly)

Returns widget_types.

Returns:



71
72
73
 
# File 'lib/2017-04-26/generated/azure_mgmt_customer_insights/customer_insights_management_client.rb', line 71

def widget_types
  @widget_types
end

Instance Method Details

#make_request(method, path, options = {}) ⇒ Hash{String=>String}

Makes a request and returns the body of the response. Example:

request_content = "{'location':'westus','tags':{'tag1':'val1','tag2':'val2'}}"
path = "/path"
options = {
  body: request_content,
  query_params: {'api-version' => '2016-02-01'}
}
result = @client.make_request(:put, path, options)

Parameters:

  • method (Symbol) —

    with any of the following values :get, :put, :post, :patch, :delete.

  • path (String) —

    the path, relative to #base_url.

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

    specifying any request options like :body.

Returns:

  • (Hash{String=>String}) —

    containing the body of the response.



144
145
146
147
 
# File 'lib/2017-04-26/generated/azure_mgmt_customer_insights/customer_insights_management_client.rb', line 144

def make_request(method, path, options = {})
  result = make_request_with_http_info(method, path, options)
  result.body unless result.nil?
end

#make_request_async(method, path, options = {}) ⇒ Concurrent::Promise

Makes a request asynchronously.

Parameters:

  • method (Symbol) —

    with any of the following values :get, :put, :post, :patch, :delete.

  • path (String) —

    the path, relative to #base_url.

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

    specifying any request options like :body.

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/2017-04-26/generated/azure_mgmt_customer_insights/customer_insights_management_client.rb', line 169

def make_request_async(method, path, options = {})
  fail ArgumentError, 'method is nil' if method.nil?
  fail ArgumentError, 'path is nil' if path.nil?

  request_url = options[:base_url] || @base_url
  if(!options[:headers].nil? && !options[:headers]['Content-Type'].nil?)
    @request_headers['Content-Type'] = options[:headers]['Content-Type']
  end

  request_headers = @request_headers
  request_headers.merge!({'accept-language' => @accept_language}) unless @accept_language.nil?
  options.merge!({headers: request_headers.merge(options[:headers] || {})})
  options.merge!({credentials: @credentials}) unless @credentials.nil?

  super(request_url, method, path, options)
end

#make_request_with_http_info(method, path, options = {}) ⇒ MsRestAzure::AzureOperationResponse

Makes a request and returns the operation response.

Parameters:

  • method (Symbol) —

    with any of the following values :get, :put, :post, :patch, :delete.

  • path (String) —

    the path, relative to #base_url.

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

    specifying any request options like :body.

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    Operation response containing the request, response and status.



156
157
158
159
160
 
# File 'lib/2017-04-26/generated/azure_mgmt_customer_insights/customer_insights_management_client.rb', line 156

def make_request_with_http_info(method, path, options = {})
  result = make_request_async(method, path, options).value!
  result.body = result.response.body.to_s.empty? ? nil : JSON.load(result.response.body)
  result
end