Class: OCI::LimitsIncrease::LimitsIncreaseClient

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/limits_increase/limits_increase_client.rb

Overview

Use the Limits Increase API to work with limit increase requests. For more information, see Working with Limit Increase Requests.

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) ⇒ LimitsIncreaseClient

Creates a new LimitsIncreaseClient. 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



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/oci/limits_increase/limits_increase_client.rb', line 57

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 + '/20251101'
  else
    region ||= config.region
    region ||= signer.region if signer.respond_to?(:region)
    self.region = region
  end
  logger.info "LimitsIncreaseClient endpoint set to '#{@endpoint}'." if logger
end

Instance Attribute Details

#api_client ⇒ OCI::ApiClient (readonly)

Client used to make HTTP requests.

Returns:



17
18
19
 
# File 'lib/oci/limits_increase/limits_increase_client.rb', line 17

def api_client
  @api_client
end

#endpoint ⇒ String (readonly)

Fully qualified endpoint URL

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/limits_increase/limits_increase_client.rb', line 21

def endpoint
  @endpoint
end

#region ⇒ String

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

Returns:

  • (String) 


31
32
33
 
# File 'lib/oci/limits_increase/limits_increase_client.rb', line 31

def region
  @region
end

#retry_config ⇒ OCI::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

Returns:



27
28
29
 
# File 'lib/oci/limits_increase/limits_increase_client.rb', line 27

def retry_config
  @retry_config
end

Instance Method Details

#cancel_limits_increase_item_request(limits_increase_item_request_id, opts = {}) ⇒ Response

Note:

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

Withdraws the specified item from the limit increase request. For more information, see Withdrawing an Item from a Limit Increase Request.

Parameters:

  • limits_increase_item_request_id (String) —

    The OCID of the limit increase request.

  • 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

  • :opc_request_id (String) —

    Override request id for request tracking purposes.

  • :if_match (String) —

    This value (etag) should be passed when you want to ensure that no-one else has changed the value while you're making an update. To get the current etag, make a GET call and read the current etag header. If GET returns 404, and you still want to ensure that noone else has executed a SET operation, pass the following header instead: if-none-match: *

  • :opc_retry_token (String) —

    Idempotency token to make sure that a second create operation won't fail if the first one succeeded. This can be any random string.

Returns:



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
163
 
# File 'lib/oci/limits_increase/limits_increase_client.rb', line 124

def cancel_limits_increase_item_request(limits_increase_item_request_id, opts = {})
  logger.debug 'Calling operation LimitsIncreaseClient#cancel_limits_increase_item_request.' if logger

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

  path = '/limitsIncreaseItemRequests/{limitsIncreaseItemRequestId}/actions/cancel'.sub('{limitsIncreaseItemRequestId}', limits_increase_item_request_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # 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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'LimitsIncreaseClient#cancel_limits_increase_item_request') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::LimitsIncrease::Models::LimitsIncreaseItemRequest'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#cancel_limits_increase_request(limits_increase_request_id, opts = {}) ⇒ Response

Note:

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

Withdraws the specified limit increase request. For more information, see Withdrawing a Limit Increase Request.

Parameters:

  • limits_increase_request_id (String) —

    The OCID of the limit increase request.

  • 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

  • :opc_request_id (String) —

    Override request id for request tracking purposes.

  • :if_match (String) —

    This value (etag) should be passed when you want to ensure that no-one else has changed the value while you're making an update. To get the current etag, make a GET call and read the current etag header. If GET returns 404, and you still want to ensure that noone else has executed a SET operation, pass the following header instead: if-none-match: *

  • :opc_retry_token (String) —

    Idempotency token to make sure that a second create operation won't fail if the first one succeeded. This can be any random string.

Returns:



192
193
194
195
196
197
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
 
# File 'lib/oci/limits_increase/limits_increase_client.rb', line 192

def cancel_limits_increase_request(limits_increase_request_id, opts = {})
  logger.debug 'Calling operation LimitsIncreaseClient#cancel_limits_increase_request.' if logger

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

  path = '/limitsIncreaseRequests/{limitsIncreaseRequestId}/actions/cancel'.sub('{limitsIncreaseRequestId}', limits_increase_request_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # 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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'LimitsIncreaseClient#cancel_limits_increase_request') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::LimitsIncrease::Models::LimitsIncreaseRequest'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_limits_increase_request(create_limits_increase_request_details, opts = {}) ⇒ Response

Note:

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

Creates a limit increase request in the specified compartment. For more information, see Creating a Limit Increase Request.

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

  • :opc_retry_token (String) —

    Idempotency token to make sure that a second create operation won't fail if the first one succeeded. This can be any random string.

  • :opc_request_id (String) —

    Override request id for request tracking purposes.

Returns:



255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/oci/limits_increase/limits_increase_client.rb', line 255

def create_limits_increase_request(create_limits_increase_request_details, opts = {})
  logger.debug 'Calling operation LimitsIncreaseClient#create_limits_increase_request.' if logger

  raise "Missing the required parameter 'create_limits_increase_request_details' when calling create_limits_increase_request." if create_limits_increase_request_details.nil?

  path = '/limitsIncreaseRequests'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_limits_increase_request_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'LimitsIncreaseClient#create_limits_increase_request') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::LimitsIncrease::Models::LimitsIncreaseRequest'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_limits_increase_request(limits_increase_request_id, opts = {}) ⇒ Response

Note:

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

Deletes the specified limit increase request. For more information, see Deleting a Limit Increase Request.

Parameters:

  • limits_increase_request_id (String) —

    The OCID of the limit increase request.

  • 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

  • :opc_request_id (String) —

    Override request id for request tracking purposes.

  • :if_match (String) —

    This value (etag) should be passed when you want to ensure that no-one else has changed the value while you're making an update. To get the current etag, make a GET call and read the current etag header. If GET returns 404, and you still want to ensure that noone else has executed a SET operation, pass the following header instead: if-none-match: *

Returns:

  • (Response) —

    A Response object with data of type nil



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
344
345
346
347
348
349
350
351
352
353
354
 
# File 'lib/oci/limits_increase/limits_increase_client.rb', line 318

def delete_limits_increase_request(limits_increase_request_id, opts = {})
  logger.debug 'Calling operation LimitsIncreaseClient#delete_limits_increase_request.' if logger

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

  path = '/limitsIncreaseRequests/{limitsIncreaseRequestId}'.sub('{limitsIncreaseRequestId}', limits_increase_request_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # 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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'LimitsIncreaseClient#delete_limits_increase_request') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_limits_increase_item_request(limits_increase_item_request_id, opts = {}) ⇒ Response

Note:

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

Gets the specified item from the limit increase request. For more information, see Getting Details for a Limit Increase Request.

Parameters:

  • limits_increase_item_request_id (String) —

    The OCID of the limit increase request.

  • 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

  • :opc_request_id (String) —

    Override request id for request tracking purposes.

Returns:



375
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
 
# File 'lib/oci/limits_increase/limits_increase_client.rb', line 375

def get_limits_increase_item_request(limits_increase_item_request_id, opts = {})
  logger.debug 'Calling operation LimitsIncreaseClient#get_limits_increase_item_request.' if logger

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

  path = '/limitsIncreaseItemRequests/{limitsIncreaseItemRequestId}'.sub('{limitsIncreaseItemRequestId}', limits_increase_item_request_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # 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: 'LimitsIncreaseClient#get_limits_increase_item_request') 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::LimitsIncrease::Models::LimitsIncreaseItemRequest'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_limits_increase_request(limits_increase_request_id, opts = {}) ⇒ Response

Note:

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

Gets the specified limit increase request. For more information, see Getting Details for a Limit Increase Request.

Parameters:

  • limits_increase_request_id (String) —

    The OCID of the limit increase request.

  • 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

  • :opc_request_id (String) —

    Override request id for request tracking purposes.

Returns:



432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
 
# File 'lib/oci/limits_increase/limits_increase_client.rb', line 432

def get_limits_increase_request(limits_increase_request_id, opts = {})
  logger.debug 'Calling operation LimitsIncreaseClient#get_limits_increase_request.' if logger

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

  path = '/limitsIncreaseRequests/{limitsIncreaseRequestId}'.sub('{limitsIncreaseRequestId}', limits_increase_request_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # 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: 'LimitsIncreaseClient#get_limits_increase_request') 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::LimitsIncrease::Models::LimitsIncreaseRequest'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Lists items in the specified limit increase request. For more information, see Getting Details for a Limit Increase Request.

Allowed values are: timeCreated

Parameters:

  • compartment_id (String) —

    The OCID of the parent compartment. Note: The tenancy is 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 (String) —

    Name of service that owns the limit.

  • :lifecycle_state (String) —

    Lifecycle state of the limit increase request.

  • :limits_increase_request_id (String) —

    The OCID of the limit increase request.

  • :sort_order (String) —

    The sort order to use, either 'asc' or 'desc'. By default, it is ascending.

    Allowed values are: ASC, DESC

  • :sort_by (String) —

    The field to sort by. You can specify only one sort order. The default order for timeCreated is descending. (default to timeCreated)

  • :limit (Integer) —

    Maximum number of items returned in a page. (default to 100)

  • :page (String) —

    The next page token.

  • :opc_request_id (String) —

    Override request id for request tracking purposes.

Returns:



505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
 
# File 'lib/oci/limits_increase/limits_increase_client.rb', line 505

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

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

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

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

  path = '/limitsIncreaseItemRequests'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:service] = opts[:service] if opts[:service]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:limitsIncreaseRequestId] = opts[:limits_increase_request_id] if opts[:limits_increase_request_id]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  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: 'LimitsIncreaseClient#list_limits_increase_item_requests') 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::LimitsIncrease::Models::LimitsIncreaseItemRequestCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Gets the fields for the specified service and limit name. Service name is required if limit name is provided. If limit name is not provided, returns all questions for the specified service. If service name is not provided, returns all available questions. For more information, see Creating a Limit Increase Request.

Allowed values are: serviceName, limitName

Parameters:

  • compartment_id (String) —

    The OCID of the parent compartment. Note: The tenancy is 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 name of the service.

  • :limit_name (String) —

    The name of the limit.

  • :opc_request_id (String) —

    Override request id for request tracking purposes.

  • :sort_order (String) —

    The sort order to use, either 'asc' or 'desc'. By default, it is ascending.

    Allowed values are: ASC, DESC

  • :sort_by (String) —

    The field to sort by. Both fields will sort alphabetically (default to serviceName)

  • :limit (Integer) —

    Maximum number of items returned in a page. (default to 100)

  • :page (String) —

    The next page token.

Returns:



594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
 
# File 'lib/oci/limits_increase/limits_increase_client.rb', line 594

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

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

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

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

  path = '/limitsIncreaseQuestionnaires'
  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[:limitName] = opts[:limit_name] if opts[:limit_name]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  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: 'LimitsIncreaseClient#list_limits_increase_questions') 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::LimitsIncrease::Models::LimitsIncreaseQuestionCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Lists limit increase requests in the specified compartment. For more information, see Listing Limit Increase Requests.

Allowed values are: timeCreated, displayName

Parameters:

  • compartment_id (String) —

    The OCID of the parent compartment. Note: The tenancy is 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

  • :lifecycle_state (String) —

    Lifecycle state of the limit increase request.

  • :display_name (String) —

    A filter to return only the resources that match the entire display name specified.

  • :sort_order (String) —

    The sort order to use, either 'asc' or 'desc'. By default, it is ascending.

    Allowed values are: ASC, DESC

  • :sort_by (String) —

    The field to sort by. You can specify only one sort order. The default order for timeCreated is descending. The default order for displayName is ascending. (default to timeCreated)

  • :limit (Integer) —

    Maximum number of items returned in a page. (default to 100)

  • :page (String) —

    The next page token.

  • :opc_request_id (String) —

    Override request id for request tracking purposes.

Returns:



678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
 
# File 'lib/oci/limits_increase/limits_increase_client.rb', line 678

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

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

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

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

  path = '/limitsIncreaseRequests'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  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: 'LimitsIncreaseClient#list_limits_increase_requests') 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::LimitsIncrease::Models::LimitsIncreaseRequestCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#logger ⇒ Logger

Returns The logger for this client. May be nil.

Returns:

  • (Logger) —

    The logger for this client. May be nil.



96
97
98
 
# File 'lib/oci/limits_increase/limits_increase_client.rb', line 96

def logger
  @api_client.config.logger
end

#patch_limits_increase_request(patch_limits_increase_request_details, limits_increase_request_id, opts = {}) ⇒ Response

Note:

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

Adds one or more comments to the specified limit increase request. For more information, see Adding Comments to a Limit Increase Request.

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

  • :opc_request_id (String) —

    Override request id for request tracking purposes.

  • :if_match (String) —

    This value (etag) should be passed when you want to ensure that no-one else has changed the value while you're making an update. To get the current etag, make a GET call and read the current etag header. If GET returns 404, and you still want to ensure that noone else has executed a SET operation, pass the following header instead: if-none-match: *

Returns:



755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
 
# File 'lib/oci/limits_increase/limits_increase_client.rb', line 755

def patch_limits_increase_request(patch_limits_increase_request_details, limits_increase_request_id, opts = {})
  logger.debug 'Calling operation LimitsIncreaseClient#patch_limits_increase_request.' if logger

  raise "Missing the required parameter 'patch_limits_increase_request_details' when calling patch_limits_increase_request." if patch_limits_increase_request_details.nil?
  raise "Missing the required parameter 'limits_increase_request_id' when calling patch_limits_increase_request." if limits_increase_request_id.nil?
  raise "Parameter value for 'limits_increase_request_id' must not be blank" if OCI::Internal::Util.blank_string?(limits_increase_request_id)

  path = '/limitsIncreaseRequests/{limitsIncreaseRequestId}'.sub('{limitsIncreaseRequestId}', limits_increase_request_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # 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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(patch_limits_increase_request_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'LimitsIncreaseClient#patch_limits_increase_request') do
    @api_client.call_api(
      :PATCH,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::LimitsIncrease::Models::LimitsIncreaseRequest'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_limits_increase_request(update_limits_increase_request_details, limits_increase_request_id, opts = {}) ⇒ Response

Note:

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

Updates the limit increase request. For more information, see Updating a Limit Increase Request.

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

  • :opc_request_id (String) —

    Override request id for request tracking purposes.

  • :if_match (String) —

    This value (etag) should be passed when you want to ensure that no-one else has changed the value while you're making an update. To get the current etag, make a GET call and read the current etag header. If GET returns 404, and you still want to ensure that noone else has executed a SET operation, pass the following header instead: if-none-match: *

Returns:



820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
 
# File 'lib/oci/limits_increase/limits_increase_client.rb', line 820

def update_limits_increase_request(update_limits_increase_request_details, limits_increase_request_id, opts = {})
  logger.debug 'Calling operation LimitsIncreaseClient#update_limits_increase_request.' if logger

  raise "Missing the required parameter 'update_limits_increase_request_details' when calling update_limits_increase_request." if update_limits_increase_request_details.nil?
  raise "Missing the required parameter 'limits_increase_request_id' when calling update_limits_increase_request." if limits_increase_request_id.nil?
  raise "Parameter value for 'limits_increase_request_id' must not be blank" if OCI::Internal::Util.blank_string?(limits_increase_request_id)

  path = '/limitsIncreaseRequests/{limitsIncreaseRequestId}'.sub('{limitsIncreaseRequestId}', limits_increase_request_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # 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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_limits_increase_request_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'LimitsIncreaseClient#update_limits_increase_request') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::LimitsIncrease::Models::LimitsIncreaseRequest'
    )
  end
  # rubocop:enable Metrics/BlockLength
end