Class: Azure::Cosmosdb::Mgmt::V2020_03_01::CollectionPartition

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2020-03-01/generated/azure_mgmt_cosmosdb/collection_partition.rb

Overview

Azure Cosmos DB Database Service Resource Provider REST API

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ CollectionPartition

Creates and initializes a new instance of the CollectionPartition class.

Parameters:

  • client —

    service class for accessing basic functionality.



17
18
19
 
# File 'lib/2020-03-01/generated/azure_mgmt_cosmosdb/collection_partition.rb', line 17

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ CosmosDBManagementClient (readonly)

Returns reference to the CosmosDBManagementClient.

Returns:



22
23
24
 
# File 'lib/2020-03-01/generated/azure_mgmt_cosmosdb/collection_partition.rb', line 22

def client
  @client
end

Instance Method Details

#list_metrics(resource_group_name, account_name, database_rid, collection_rid, filter, custom_headers: nil) ⇒ PartitionMetricListResult

Retrieves the metrics determined by the given filter for the given collection, split by partition.

is case insensitive. metrics to return. The parameters that can be filtered are name.value (name of the metric, can have an or of multiple names), startTime, endTime, and timeGrain. The supported operator is eq. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group. The name

  • account_name (String) —

    Cosmos DB database account name.

  • database_rid (String) —

    Cosmos DB database rid.

  • collection_rid (String) —

    Cosmos DB collection rid.

  • filter (String) —

    An OData filter expression that describes a subset of

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

    A hash of custom headers that

Returns:

  • (PartitionMetricListResult) —

    operation results.



42
43
44
45
 
# File 'lib/2020-03-01/generated/azure_mgmt_cosmosdb/collection_partition.rb', line 42

def list_metrics(resource_group_name, , database_rid, collection_rid, filter, custom_headers:nil)
  response = list_metrics_async(resource_group_name, , database_rid, collection_rid, filter, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#list_metrics_async(resource_group_name, account_name, database_rid, collection_rid, filter, custom_headers: nil) ⇒ Concurrent::Promise

Retrieves the metrics determined by the given filter for the given collection, split by partition.

is case insensitive. metrics to return. The parameters that can be filtered are name.value (name of the metric, can have an or of multiple names), startTime, endTime, and timeGrain. The supported operator is eq. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group. The name

  • account_name (String) —

    Cosmos DB database account name.

  • database_rid (String) —

    Cosmos DB database rid.

  • collection_rid (String) —

    Cosmos DB collection rid.

  • filter (String) —

    An OData filter expression that describes a subset of

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/2020-03-01/generated/azure_mgmt_cosmosdb/collection_partition.rb', line 87

def list_metrics_async(resource_group_name, , database_rid, collection_rid, filter, custom_headers:nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, "'@client.subscription_id' should satisfy the constraint - 'MinLength': '1'" if !@client.subscription_id.nil? && @client.subscription_id.length < 1
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MaxLength': '90'" if !resource_group_name.nil? && resource_group_name.length > 90
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MinLength': '1'" if !resource_group_name.nil? && resource_group_name.length < 1
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'Pattern': '^[-\w\._\(\)]+$'" if !resource_group_name.nil? && resource_group_name.match(Regexp.new('^^[-\w\._\(\)]+$$')).nil?
  fail ArgumentError, 'account_name is nil' if .nil?
  fail ArgumentError, "'account_name' should satisfy the constraint - 'MaxLength': '50'" if !.nil? && .length > 50
  fail ArgumentError, "'account_name' should satisfy the constraint - 'MinLength': '3'" if !.nil? && .length < 3
  fail ArgumentError, "'account_name' should satisfy the constraint - 'Pattern': '^[a-z0-9]+(-[a-z0-9]+)*'" if !.nil? && .match(Regexp.new('^^[a-z0-9]+(-[a-z0-9]+)*$')).nil?
  fail ArgumentError, 'database_rid is nil' if database_rid.nil?
  fail ArgumentError, 'collection_rid is nil' if collection_rid.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, "'@client.api_version' should satisfy the constraint - 'MinLength': '1'" if !@client.api_version.nil? && @client.api_version.length < 1
  fail ArgumentError, 'filter is nil' if filter.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.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/collections/{collectionRid}/partitions/metrics'

  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,'accountName' => ,'databaseRid' => database_rid,'collectionRid' => collection_rid},
      query_params: {'api-version' => @client.api_version,'$filter' => filter},
      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::Cosmosdb::Mgmt::V2020_03_01::Models::PartitionMetricListResult.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

#list_metrics_with_http_info(resource_group_name, account_name, database_rid, collection_rid, filter, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Retrieves the metrics determined by the given filter for the given collection, split by partition.

is case insensitive. metrics to return. The parameters that can be filtered are name.value (name of the metric, can have an or of multiple names), startTime, endTime, and timeGrain. The supported operator is eq. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group. The name

  • account_name (String) —

    Cosmos DB database account name.

  • database_rid (String) —

    Cosmos DB database rid.

  • collection_rid (String) —

    Cosmos DB collection rid.

  • filter (String) —

    An OData filter expression that describes a subset of

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



65
66
67
 
# File 'lib/2020-03-01/generated/azure_mgmt_cosmosdb/collection_partition.rb', line 65

def list_metrics_with_http_info(resource_group_name, , database_rid, collection_rid, filter, custom_headers:nil)
  list_metrics_async(resource_group_name, , database_rid, collection_rid, filter, custom_headers:custom_headers).value!
end

#list_usages(resource_group_name, account_name, database_rid, collection_rid, filter: nil, custom_headers: nil) ⇒ PartitionUsagesResult

Retrieves the usages (most recent storage data) for the given collection, split by partition.

is case insensitive. usages to return. The supported parameter is name.value (name of the metric, can have an or of multiple names). will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group. The name

  • account_name (String) —

    Cosmos DB database account name.

  • database_rid (String) —

    Cosmos DB database rid.

  • collection_rid (String) —

    Cosmos DB collection rid.

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

    An OData filter expression that describes a subset of

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

    A hash of custom headers that

Returns:

  • (PartitionUsagesResult) —

    operation results.



170
171
172
173
 
# File 'lib/2020-03-01/generated/azure_mgmt_cosmosdb/collection_partition.rb', line 170

def list_usages(resource_group_name, , database_rid, collection_rid, filter:nil, custom_headers:nil)
  response = list_usages_async(resource_group_name, , database_rid, collection_rid, filter:filter, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#list_usages_async(resource_group_name, account_name, database_rid, collection_rid, filter: nil, custom_headers: nil) ⇒ Concurrent::Promise

Retrieves the usages (most recent storage data) for the given collection, split by partition.

is case insensitive. usages to return. The supported parameter is name.value (name of the metric, can have an or of multiple names). to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group. The name

  • account_name (String) —

    Cosmos DB database account name.

  • database_rid (String) —

    Cosmos DB database rid.

  • collection_rid (String) —

    Cosmos DB collection rid.

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

    An OData filter expression that describes a subset of

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/2020-03-01/generated/azure_mgmt_cosmosdb/collection_partition.rb', line 213

def list_usages_async(resource_group_name, , database_rid, collection_rid, filter:nil, custom_headers:nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, "'@client.subscription_id' should satisfy the constraint - 'MinLength': '1'" if !@client.subscription_id.nil? && @client.subscription_id.length < 1
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MaxLength': '90'" if !resource_group_name.nil? && resource_group_name.length > 90
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MinLength': '1'" if !resource_group_name.nil? && resource_group_name.length < 1
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'Pattern': '^[-\w\._\(\)]+$'" if !resource_group_name.nil? && resource_group_name.match(Regexp.new('^^[-\w\._\(\)]+$$')).nil?
  fail ArgumentError, 'account_name is nil' if .nil?
  fail ArgumentError, "'account_name' should satisfy the constraint - 'MaxLength': '50'" if !.nil? && .length > 50
  fail ArgumentError, "'account_name' should satisfy the constraint - 'MinLength': '3'" if !.nil? && .length < 3
  fail ArgumentError, "'account_name' should satisfy the constraint - 'Pattern': '^[a-z0-9]+(-[a-z0-9]+)*'" if !.nil? && .match(Regexp.new('^^[a-z0-9]+(-[a-z0-9]+)*$')).nil?
  fail ArgumentError, 'database_rid is nil' if database_rid.nil?
  fail ArgumentError, 'collection_rid is nil' if collection_rid.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, "'@client.api_version' should satisfy the constraint - 'MinLength': '1'" if !@client.api_version.nil? && @client.api_version.length < 1


  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.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/collections/{collectionRid}/partitions/usages'

  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,'accountName' => ,'databaseRid' => database_rid,'collectionRid' => collection_rid},
      query_params: {'api-version' => @client.api_version,'$filter' => filter},
      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::Cosmosdb::Mgmt::V2020_03_01::Models::PartitionUsagesResult.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

#list_usages_with_http_info(resource_group_name, account_name, database_rid, collection_rid, filter: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Retrieves the usages (most recent storage data) for the given collection, split by partition.

is case insensitive. usages to return. The supported parameter is name.value (name of the metric, can have an or of multiple names). will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group. The name

  • account_name (String) —

    Cosmos DB database account name.

  • database_rid (String) —

    Cosmos DB database rid.

  • collection_rid (String) —

    Cosmos DB collection rid.

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

    An OData filter expression that describes a subset of

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



192
193
194
 
# File 'lib/2020-03-01/generated/azure_mgmt_cosmosdb/collection_partition.rb', line 192

def list_usages_with_http_info(resource_group_name, , database_rid, collection_rid, filter:nil, custom_headers:nil)
  list_usages_async(resource_group_name, , database_rid, collection_rid, filter:filter, custom_headers:custom_headers).value!
end