Class: OCI::Limits::LimitsClient

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/limits/limits_client.rb

Overview

APIs that interact with the resource limits of a specific resource type

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ LimitsClient

Creates a new LimitsClient. Notes: If a config is not specified, then the global OCI.config will be used.

This client is not thread-safe

Either a region or an endpoint must be specified. If an endpoint is specified, it will be used instead of the region. A region may be specified in the config or via or the region parameter. If specified in both, then the region parameter will be used.

Parameters:

  • config (Config) (defaults to: nil)

    A Config object.

  • region (String) (defaults to: nil)

    A region used to determine the service endpoint. This will usually correspond to a value in Regions::REGION_ENUM, but may be an arbitrary string.

  • endpoint (String) (defaults to: nil)

    The fully qualified endpoint URL

  • signer (OCI::BaseSigner) (defaults to: nil)

    A signer implementation which can be used by this client. If this is not provided then a signer will be constructed via the provided config. One use case of this parameter is instance principals authentication, so that the instance principals signer can be provided to the client

  • proxy_settings (OCI::ApiClientProxySettings) (defaults to: nil)

    If your environment requires you to use a proxy server for outgoing HTTP requests the details for the proxy can be provided in this parameter

  • retry_config (OCI::Retry::RetryConfig) (defaults to: nil)

    The retry configuration for this service client. This represents the default retry configuration to apply across all operations. This can be overridden on a per-operation basis. The default retry configuration value is nil, which means that an operation will not perform any retries



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
# File 'lib/oci/limits/limits_client.rb', line 53

def initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil)
  # If the signer is an InstancePrincipalsSecurityTokenSigner or SecurityTokenSigner and no config was supplied (they are self-sufficient signers)
  # then create a dummy config to pass to the ApiClient constructor. If customers wish to create a client which uses instance principals
  # and has config (either populated programmatically or loaded from a file), they must construct that config themselves and then
  # pass it to this constructor.
  #
  # If there is no signer (or the signer is not an instance principals signer) and no config was supplied, this is not valid
  # so try and load the config from the default file.
  config = OCI::Config.validate_and_build_config_with_signer(config, signer)

  signer = OCI::Signer.config_file_auth_builder(config) if signer.nil?

  @api_client = OCI::ApiClient.new(config, signer, proxy_settings: proxy_settings)
  @retry_config = retry_config

  if endpoint
    @endpoint = endpoint + '/'
  else
    region ||= config.region
    region ||= signer.region if signer.respond_to?(:region)
    self.region = region
  end
  logger.info "LimitsClient endpoint set to '#{@endpoint}'." if logger
end

Instance Attribute Details

#api_clientOCI::ApiClient (readonly)

Client used to make HTTP requests.

Returns:



13
14
15
# File 'lib/oci/limits/limits_client.rb', line 13

def api_client
  @api_client
end

#endpointString (readonly)

Fully qualified endpoint URL

Returns:

  • (String)


17
18
19
# File 'lib/oci/limits/limits_client.rb', line 17

def endpoint
  @endpoint
end

#regionString

The region, which will usually correspond to a value in Regions::REGION_ENUM.

Returns:

  • (String)


27
28
29
# File 'lib/oci/limits/limits_client.rb', line 27

def region
  @region
end

#retry_configOCI::Retry::RetryConfig (readonly)

The default retry configuration to apply to all operations in this service client. This can be overridden on a per-operation basis. The default retry configuration value is nil, which means that an operation will not perform any retries



23
24
25
# File 'lib/oci/limits/limits_client.rb', line 23

def retry_config
  @retry_config
end

Instance Method Details

#get_resource_availability(service_name, limit_name, compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_resource_availability API.

For a given compartmentId, resource limit name, and scope, returns the following: - the number of available resources associated with the given limit - the usage in the selected compartment for the given limit Note: not all resource limits support this API. If the value is not available, the API will return 404.

Parameters:

  • service_name (String)

    The service name of the target quota.

  • limit_name (String)

    The limit name for which to fetch the data.

  • compartment_id (String)

    The OCID of the compartment for which data is being fetched.

  • opts (Hash) (defaults to: {})

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig)

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :availability_domain (String)

    This field is mandatory if the scopeType of the target resource limit is AD. Otherwise, this field should be omitted. If the above requirements are not met, the API will return a 400 - InvalidParameter response.

  • :opc_request_id (String)

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:



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
152
153
154
155
156
157
158
159
160
161
162
# File 'lib/oci/limits/limits_client.rb', line 121

def get_resource_availability(service_name, limit_name, compartment_id, opts = {})
  logger.debug 'Calling operation LimitsClient#get_resource_availability.' if logger

  raise "Missing the required parameter 'service_name' when calling get_resource_availability." if service_name.nil?
  raise "Missing the required parameter 'limit_name' when calling get_resource_availability." if limit_name.nil?
  raise "Missing the required parameter 'compartment_id' when calling get_resource_availability." if compartment_id.nil?
  raise "Parameter value for 'service_name' must not be blank" if OCI::Internal::Util.blank_string?(service_name)
  raise "Parameter value for 'limit_name' must not be blank" if OCI::Internal::Util.blank_string?(limit_name)

  path = '/20190729/services/{serviceName}/limits/{limitName}/resourceAvailability'.sub('{serviceName}', service_name.to_s).sub('{limitName}', limit_name.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:availabilityDomain] = opts[:availability_domain] if opts[:availability_domain]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'LimitsClient#get_resource_availability') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Limits::Models::ResourceAvailability'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_limit_definitions(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_limit_definitions API.

Includes a list of resource limits that are currently supported. If the 'areQuotasSupported' property is true, you can create quota policies on top of this limit at the compartment level.

Allowed values are: name, description Allowed values are: ASC, DESC

Parameters:

  • compartment_id (String)

    The OCID of the parent compartment (remember that the tenancy is simply the root compartment).

  • opts (Hash) (defaults to: {})

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig)

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :service_name (String)

    The target service name.

  • :name (String)

    Optional field, filter for a specific resource limit.

  • :sort_by (String)

    The field to sort by. (default to name)

  • :sort_order (String)

    The sort order to use, either 'asc' or 'desc'. By default it will be ascending. (default to ASC)

  • :limit (Integer)

    The maximum number of items to return in a paginated "List" call. (default to 100)

  • :page (String)

    The value of the opc-next-page response header from the previous "List" call.

  • :opc_request_id (String)

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
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
# File 'lib/oci/limits/limits_client.rb', line 198

def list_limit_definitions(compartment_id, opts = {})
  logger.debug 'Calling operation LimitsClient#list_limit_definitions.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_limit_definitions." if compartment_id.nil?

  if opts[:sort_by] && !%w[name description].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of name, description.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  path = '/20190729/limitDefinitions'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:serviceName] = opts[:service_name] if opts[:service_name]
  query_params[:name] = opts[:name] if opts[:name]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'LimitsClient#list_limit_definitions') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::Limits::Models::LimitDefinitionSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_limit_values(compartment_id, service_name, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_limit_values API.

Includes a full list of resource limits belonging to a given service.

Allowed values are: name Allowed values are: ASC, DESC

Parameters:

  • compartment_id (String)

    The OCID of the parent compartment (remember that the tenancy is simply the root compartment).

  • service_name (String)

    The target service name

  • opts (Hash) (defaults to: {})

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig)

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :scope_type (String)

    Filter entries by scope type. Allowed values are: GLOBAL, REGION, AD

  • :availability_domain (String)

    Filter entries by availability domain. This implies that only AD-specific values will be returned.

  • :name (String)

    Optional field, can be used to see a specific resource limit value.

  • :sort_by (String)

    The field to sort by. We will be implicitly sorting by availabilityDomain, as a second level field, if available. (default to name)

  • :sort_order (String)

    The sort order to use, either 'asc' or 'desc'. By default it will be ascending. (default to ASC)

  • :limit (Integer)

    The maximum number of items to return in a paginated "List" call. (default to 100)

  • :page (String)

    The value of the opc-next-page response header from the previous "List" call.

  • :opc_request_id (String)

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:



286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
# File 'lib/oci/limits/limits_client.rb', line 286

def list_limit_values(compartment_id, service_name, opts = {})
  logger.debug 'Calling operation LimitsClient#list_limit_values.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_limit_values." if compartment_id.nil?
  raise "Missing the required parameter 'service_name' when calling list_limit_values." if service_name.nil?

  if opts[:scope_type] && !%w[GLOBAL REGION AD].include?(opts[:scope_type])
    raise 'Invalid value for "scope_type", must be one of GLOBAL, REGION, AD.'
  end

  if opts[:sort_by] && !%w[name].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of name.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  path = '/20190729/limitValues'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:serviceName] = service_name
  query_params[:scopeType] = opts[:scope_type] if opts[:scope_type]
  query_params[:availabilityDomain] = opts[:availability_domain] if opts[:availability_domain]
  query_params[:name] = opts[:name] if opts[:name]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'LimitsClient#list_limit_values') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::Limits::Models::LimitValueSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_services(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_services API.

Returns the list of supported services. This will include the programmatic service name, along with the friendly service name.

Allowed values are: name, description Allowed values are: ASC, DESC

Parameters:

  • compartment_id (String)

    The OCID of the parent compartment (remember that the tenancy is simply the root compartment).

  • opts (Hash) (defaults to: {})

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig)

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :sort_by (String)

    The field to sort by. (default to name)

  • :sort_order (String)

    The sort order to use, either 'asc' or 'desc'. By default it will be ascending. (default to ASC)

  • :limit (Integer)

    The maximum number of items to return in a paginated "List" call. (default to 100)

  • :page (String)

    The value of the opc-next-page response header from the previous "List" call.

  • :opc_request_id (String)

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:



376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
# File 'lib/oci/limits/limits_client.rb', line 376

def list_services(compartment_id, opts = {})
  logger.debug 'Calling operation LimitsClient#list_services.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_services." if compartment_id.nil?

  if opts[:sort_by] && !%w[name description].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of name, description.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  path = '/20190729/services'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'LimitsClient#list_services') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::Limits::Models::ServiceSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#loggerLogger

Returns The logger for this client. May be nil.

Returns:

  • (Logger)

    The logger for this client. May be nil.



92
93
94
# File 'lib/oci/limits/limits_client.rb', line 92

def logger
  @api_client.config.logger
end