Class: Azure::ARM::CustomerInsights::CustomerInsightsManagementClient

Inherits:
MsRestAzure::AzureServiceClient
  • Object
show all
Includes:
MsRestAzure, MsRestAzure::Serialization
Defined in:
lib/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.



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

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

  @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 Gets or sets the preferred language for the response.

Returns:

  • (String) —

    Gets or sets the preferred language for the response.



29
30
31
 
# File 'lib/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/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:



55
56
57
 
# File 'lib/generated/azure_mgmt_customer_insights/customer_insights_management_client.rb', line 55

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/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:



61
62
63
 
# File 'lib/generated/azure_mgmt_customer_insights/customer_insights_management_client.rb', line 61

def connector_mappings
  @connector_mappings
end

#connectors ⇒ Connectors (readonly)

Returns connectors.

Returns:



58
59
60
 
# File 'lib/generated/azure_mgmt_customer_insights/customer_insights_management_client.rb', line 58

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/generated/azure_mgmt_customer_insights/customer_insights_management_client.rb', line 18

def credentials
  @credentials
end

#generate_client_request_id ⇒ Boolean

is generated and included in each request. Default is true.

Returns:

  • (Boolean) —

    When set to true a unique x-ms-client-request-id value



37
38
39
 
# File 'lib/generated/azure_mgmt_customer_insights/customer_insights_management_client.rb', line 37

def generate_client_request_id
  @generate_client_request_id
end

#hubs ⇒ Hubs (readonly)

Returns hubs.

Returns:



40
41
42
 
# File 'lib/generated/azure_mgmt_customer_insights/customer_insights_management_client.rb', line 40

def hubs
  @hubs
end

#images ⇒ Images (readonly)

Returns images.

Returns:



82
83
84
 
# File 'lib/generated/azure_mgmt_customer_insights/customer_insights_management_client.rb', line 82

def images
  @images
end

#interactions ⇒ Interactions (readonly)

Returns interactions.

Returns:



46
47
48
 
# File 'lib/generated/azure_mgmt_customer_insights/customer_insights_management_client.rb', line 46

def interactions
  @interactions
end

#kpi ⇒ Kpi (readonly)

Returns kpi.

Returns:

  • (Kpi) —

    kpi



64
65
66
 
# File 'lib/generated/azure_mgmt_customer_insights/customer_insights_management_client.rb', line 64

def kpi
  @kpi
end

#links ⇒ Links (readonly)

Returns links.

Returns:



73
74
75
 
# File 'lib/generated/azure_mgmt_customer_insights/customer_insights_management_client.rb', line 73

def links
  @links
end

#long_running_operation_retry_timeout ⇒ Integer

Running Operations. Default value is 30.

Returns:

  • (Integer) —

    Gets or sets the retry timeout in seconds for Long



33
34
35
 
# File 'lib/generated/azure_mgmt_customer_insights/customer_insights_management_client.rb', line 33

def long_running_operation_retry_timeout
  @long_running_operation_retry_timeout
end

#predictions ⇒ Predictions (readonly)

Returns predictions.

Returns:



85
86
87
 
# File 'lib/generated/azure_mgmt_customer_insights/customer_insights_management_client.rb', line 85

def predictions
  @predictions
end

#profiles ⇒ Profiles (readonly)

Returns profiles.

Returns:



43
44
45
 
# File 'lib/generated/azure_mgmt_customer_insights/customer_insights_management_client.rb', line 43

def profiles
  @profiles
end

#relationship_links ⇒ RelationshipLinks (readonly)

Returns relationship_links.

Returns:



52
53
54
 
# File 'lib/generated/azure_mgmt_customer_insights/customer_insights_management_client.rb', line 52

def relationship_links
  @relationship_links
end

#relationships ⇒ Relationships (readonly)

Returns relationships.

Returns:



49
50
51
 
# File 'lib/generated/azure_mgmt_customer_insights/customer_insights_management_client.rb', line 49

def relationships
  @relationships
end

#role_assignments ⇒ RoleAssignments (readonly)

Returns role_assignments.

Returns:



79
80
81
 
# File 'lib/generated/azure_mgmt_customer_insights/customer_insights_management_client.rb', line 79

def role_assignments
  @role_assignments
end

#roles ⇒ Roles (readonly)

Returns roles.

Returns:



76
77
78
 
# File 'lib/generated/azure_mgmt_customer_insights/customer_insights_management_client.rb', line 76

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/generated/azure_mgmt_customer_insights/customer_insights_management_client.rb', line 23

def subscription_id
  @subscription_id
end

#views ⇒ Views (readonly)

Returns views.

Returns:



70
71
72
 
# File 'lib/generated/azure_mgmt_customer_insights/customer_insights_management_client.rb', line 70

def views
  @views
end

#widget_types ⇒ WidgetTypes (readonly)

Returns widget_types.

Returns:



67
68
69
 
# File 'lib/generated/azure_mgmt_customer_insights/customer_insights_management_client.rb', line 67

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.



139
140
141
142
 
# File 'lib/generated/azure_mgmt_customer_insights/customer_insights_management_client.rb', line 139

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.



164
165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/generated/azure_mgmt_customer_insights/customer_insights_management_client.rb', line 164

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

  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.



151
152
153
154
155
 
# File 'lib/generated/azure_mgmt_customer_insights/customer_insights_management_client.rb', line 151

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