Class: Azure::Cosmosdb::Mgmt::V2015_04_08::CosmosDB

Inherits:
MsRestAzure::AzureServiceClient
  • Object
show all
Includes:
MsRestAzure, MsRestAzure::Serialization
Defined in:
lib/2015-04-08/generated/azure_mgmt_cosmosdb/cosmos_db.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) ⇒ CosmosDB

Creates initializes a new instance of the CosmosDB class.



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
 
# File 'lib/2015-04-08/generated/azure_mgmt_cosmosdb/cosmos_db.rb', line 84

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

  @database_accounts = DatabaseAccounts.new(self)
  @operations = Operations.new(self)
  @database = Database.new(self)
  @collection = Collection.new(self)
  @collection_region = CollectionRegion.new(self)
   = DatabaseAccountRegion.new(self)
  @percentile_source_target = PercentileSourceTarget.new(self)
  @percentile_target = PercentileTarget.new(self)
  @percentile = Percentile.new(self)
  @collection_partition_region = CollectionPartitionRegion.new(self)
  @collection_partition = CollectionPartition.new(self)
  @partition_key_range_id = PartitionKeyRangeId.new(self)
  @partition_key_range_id_region = PartitionKeyRangeIdRegion.new(self)
  @api_version = '2015-04-08'
  @accept_language = 'en-US'
  @long_running_operation_retry_timeout = 30
  @generate_client_request_id = true
  add_telemetry
end

Instance Attribute Details

#accept_language ⇒ String 



28
29
30
 
# File 'lib/2015-04-08/generated/azure_mgmt_cosmosdb/cosmos_db.rb', line 28

def accept_language
  @accept_language
end

#api_version ⇒ String (readonly)

The current version is 2015-04-08.



25
26
27
 
# File 'lib/2015-04-08/generated/azure_mgmt_cosmosdb/cosmos_db.rb', line 25

def api_version
  @api_version
end

#base_url ⇒ String 



15
16
17
 
# File 'lib/2015-04-08/generated/azure_mgmt_cosmosdb/cosmos_db.rb', line 15

def base_url
  @base_url
end

#collection ⇒ Collection (readonly) 



49
50
51
 
# File 'lib/2015-04-08/generated/azure_mgmt_cosmosdb/cosmos_db.rb', line 49

def collection
  @collection
end

#collection_partition ⇒ CollectionPartition (readonly) 



70
71
72
 
# File 'lib/2015-04-08/generated/azure_mgmt_cosmosdb/cosmos_db.rb', line 70

def collection_partition
  @collection_partition
end

#collection_partition_region ⇒ CollectionPartitionRegion (readonly) 



67
68
69
 
# File 'lib/2015-04-08/generated/azure_mgmt_cosmosdb/cosmos_db.rb', line 67

def collection_partition_region
  @collection_partition_region
end

#collection_region ⇒ CollectionRegion (readonly) 



52
53
54
 
# File 'lib/2015-04-08/generated/azure_mgmt_cosmosdb/cosmos_db.rb', line 52

def collection_region
  @collection_region
end

#credentials ⇒ Object (readonly) 



18
19
20
 
# File 'lib/2015-04-08/generated/azure_mgmt_cosmosdb/cosmos_db.rb', line 18

def credentials
  @credentials
end

#database ⇒ Database (readonly) 



46
47
48
 
# File 'lib/2015-04-08/generated/azure_mgmt_cosmosdb/cosmos_db.rb', line 46

def database
  @database
end

#database_account_region ⇒ DatabaseAccountRegion (readonly) 



55
56
57
 
# File 'lib/2015-04-08/generated/azure_mgmt_cosmosdb/cosmos_db.rb', line 55

def 
  
end

#database_accounts ⇒ DatabaseAccounts (readonly) 



40
41
42
 
# File 'lib/2015-04-08/generated/azure_mgmt_cosmosdb/cosmos_db.rb', line 40

def database_accounts
  @database_accounts
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.



37
38
39
 
# File 'lib/2015-04-08/generated/azure_mgmt_cosmosdb/cosmos_db.rb', line 37

def generate_client_request_id
  @generate_client_request_id
end

#long_running_operation_retry_timeout ⇒ Integer

Operations. Default value is 30.



32
33
34
 
# File 'lib/2015-04-08/generated/azure_mgmt_cosmosdb/cosmos_db.rb', line 32

def long_running_operation_retry_timeout
  @long_running_operation_retry_timeout
end

#operations ⇒ Operations (readonly) 



43
44
45
 
# File 'lib/2015-04-08/generated/azure_mgmt_cosmosdb/cosmos_db.rb', line 43

def operations
  @operations
end

#partition_key_range_id ⇒ PartitionKeyRangeId (readonly) 



73
74
75
 
# File 'lib/2015-04-08/generated/azure_mgmt_cosmosdb/cosmos_db.rb', line 73

def partition_key_range_id
  @partition_key_range_id
end

#partition_key_range_id_region ⇒ PartitionKeyRangeIdRegion (readonly) 



76
77
78
 
# File 'lib/2015-04-08/generated/azure_mgmt_cosmosdb/cosmos_db.rb', line 76

def partition_key_range_id_region
  @partition_key_range_id_region
end

#percentile ⇒ Percentile (readonly) 



64
65
66
 
# File 'lib/2015-04-08/generated/azure_mgmt_cosmosdb/cosmos_db.rb', line 64

def percentile
  @percentile
end

#percentile_source_target ⇒ PercentileSourceTarget (readonly) 



58
59
60
 
# File 'lib/2015-04-08/generated/azure_mgmt_cosmosdb/cosmos_db.rb', line 58

def percentile_source_target
  @percentile_source_target
end

#percentile_target ⇒ PercentileTarget (readonly) 



61
62
63
 
# File 'lib/2015-04-08/generated/azure_mgmt_cosmosdb/cosmos_db.rb', line 61

def percentile_target
  @percentile_target
end

#subscription_id ⇒ String 



21
22
23
 
# File 'lib/2015-04-08/generated/azure_mgmt_cosmosdb/cosmos_db.rb', line 21

def subscription_id
  @subscription_id
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)



127
128
129
130
 
# File 'lib/2015-04-08/generated/azure_mgmt_cosmosdb/cosmos_db.rb', line 127

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.



152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/2015-04-08/generated/azure_mgmt_cosmosdb/cosmos_db.rb', line 152

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.



139
140
141
142
143
 
# File 'lib/2015-04-08/generated/azure_mgmt_cosmosdb/cosmos_db.rb', line 139

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