Class: OCI::CapacityManagement::DemandSignalClient

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/capacity_management/demand_signal_client.rb

Overview

OCI Control Center (OCC) Capacity Management enables you to manage capacity requests in realms where OCI Control Center Capacity Management is available. For more information, see OCI Control Center.

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

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



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

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

Instance Attribute Details

#api_client ⇒ OCI::ApiClient (readonly)

Client used to make HTTP requests.

Returns:



15
16
17
 
# File 'lib/oci/capacity_management/demand_signal_client.rb', line 15

def api_client
  @api_client
end

#endpoint ⇒ String (readonly)

Fully qualified endpoint URL

Returns:

  • (String) 


19
20
21
 
# File 'lib/oci/capacity_management/demand_signal_client.rb', line 19

def endpoint
  @endpoint
end

#region ⇒ String

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

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/capacity_management/demand_signal_client.rb', line 29

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:



25
26
27
 
# File 'lib/oci/capacity_management/demand_signal_client.rb', line 25

def retry_config
  @retry_config
end

Instance Method Details

#bulk_create_occm_demand_signal_item(bulk_create_occm_demand_signal_item_details, opts = {}) ⇒ Response

Note:

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

This API will help in bulk creation of demand signal items. This API is atomic i.e either all the demand signal item resources will be created or none will be created.

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) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :opc_request_id (String) —

    The client request ID for tracing. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Returns:

  • (Response) —

    A Response object with data of type nil



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
 
# File 'lib/oci/capacity_management/demand_signal_client.rb', line 121

def bulk_create_occm_demand_signal_item(bulk_create_occm_demand_signal_item_details, opts = {})
  logger.debug 'Calling operation DemandSignalClient#bulk_create_occm_demand_signal_item.' if logger

  raise "Missing the required parameter 'bulk_create_occm_demand_signal_item_details' when calling bulk_create_occm_demand_signal_item." if bulk_create_occm_demand_signal_item_details.nil?

  path = '/occmDemandSignalItems/actions/bulkCreateDemandSignalItems'
  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(bulk_create_occm_demand_signal_item_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DemandSignalClient#bulk_create_occm_demand_signal_item') 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
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_occm_demand_signal(create_occm_demand_signal_details, opts = {}) ⇒ Response

Note:

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

This is a post API to create occm demand signal.

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) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :opc_request_id (String) —

    The client request ID for tracing. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Returns:



185
186
187
188
189
190
191
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
 
# File 'lib/oci/capacity_management/demand_signal_client.rb', line 185

def create_occm_demand_signal(create_occm_demand_signal_details, opts = {})
  logger.debug 'Calling operation DemandSignalClient#create_occm_demand_signal.' if logger

  raise "Missing the required parameter 'create_occm_demand_signal_details' when calling create_occm_demand_signal." if create_occm_demand_signal_details.nil?

  path = '/occmDemandSignals'
  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_occm_demand_signal_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DemandSignalClient#create_occm_demand_signal') 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::CapacityManagement::Models::OccmDemandSignal'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_occm_demand_signal_item(create_occm_demand_signal_item_details, opts = {}) ⇒ Response

Note:

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

This API will create a demand signal item representing a resource request. This needs to be grouped under a demand signal.

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) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :opc_request_id (String) —

    The client request ID for tracing. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Returns:



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
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/oci/capacity_management/demand_signal_client.rb', line 250

def create_occm_demand_signal_item(create_occm_demand_signal_item_details, opts = {})
  logger.debug 'Calling operation DemandSignalClient#create_occm_demand_signal_item.' if logger

  raise "Missing the required parameter 'create_occm_demand_signal_item_details' when calling create_occm_demand_signal_item." if create_occm_demand_signal_item_details.nil?

  path = '/occmDemandSignalItems'
  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_occm_demand_signal_item_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DemandSignalClient#create_occm_demand_signal_item') 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::CapacityManagement::Models::OccmDemandSignalItem'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_occm_demand_signal(occm_demand_signal_id, opts = {}) ⇒ Response

Note:

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

This is a DELETE API which deletes a demand signal with the provided demand signal ocid.

Parameters:

  • occm_demand_signal_id (String) —

    The OCID of the demand signal.

  • 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

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Returns:

  • (Response) —

    A Response object with data of type nil



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
344
345
346
347
348
349
350
351
 
# File 'lib/oci/capacity_management/demand_signal_client.rb', line 315

def delete_occm_demand_signal(occm_demand_signal_id, opts = {})
  logger.debug 'Calling operation DemandSignalClient#delete_occm_demand_signal.' if logger

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

  path = '/occmDemandSignals/{occmDemandSignalId}'.sub('{occmDemandSignalId}', occm_demand_signal_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[:'if-match'] = opts[:if_match] if opts[:if_match]
  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: 'DemandSignalClient#delete_occm_demand_signal') 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

#delete_occm_demand_signal_item(occm_demand_signal_item_id, opts = {}) ⇒ Response

Note:

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

This is a DELETE API which deletes a demand signal item with the provided demand signal item ocid.

Parameters:

  • occm_demand_signal_item_id (String) —

    The OCID of the demand signal item.

  • 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

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Returns:

  • (Response) —

    A Response object with data of type nil



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
 
# File 'lib/oci/capacity_management/demand_signal_client.rb', line 379

def delete_occm_demand_signal_item(occm_demand_signal_item_id, opts = {})
  logger.debug 'Calling operation DemandSignalClient#delete_occm_demand_signal_item.' if logger

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

  path = '/occmDemandSignalItems/{occmDemandSignalItemId}'.sub('{occmDemandSignalItemId}', occm_demand_signal_item_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[:'if-match'] = opts[:if_match] if opts[:if_match]
  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: 'DemandSignalClient#delete_occm_demand_signal_item') 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_occm_demand_signal(occm_demand_signal_id, opts = {}) ⇒ Response

Note:

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

This is a GET API which gets the detailed information about a specific demand signal.

Parameters:

  • occm_demand_signal_id (String) —

    The OCID of the demand signal.

  • 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) —

    The client request ID for tracing. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Returns:



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
469
470
471
472
473
 
# File 'lib/oci/capacity_management/demand_signal_client.rb', line 437

def get_occm_demand_signal(occm_demand_signal_id, opts = {})
  logger.debug 'Calling operation DemandSignalClient#get_occm_demand_signal.' if logger

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

  path = '/occmDemandSignals/{occmDemandSignalId}'.sub('{occmDemandSignalId}', occm_demand_signal_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: 'DemandSignalClient#get_occm_demand_signal') 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::CapacityManagement::Models::OccmDemandSignal'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_occm_demand_signal_item(occm_demand_signal_item_id, opts = {}) ⇒ Response

Note:

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

This is a GET API to get the details of a demand signal item resource representing the details of the resource demanded by you.

Parameters:

  • occm_demand_signal_item_id (String) —

    The OCID of the demand signal item.

  • 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) —

    The client request ID for tracing. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Returns:



495
496
497
498
499
500
501
502
503
504
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
 
# File 'lib/oci/capacity_management/demand_signal_client.rb', line 495

def get_occm_demand_signal_item(occm_demand_signal_item_id, opts = {})
  logger.debug 'Calling operation DemandSignalClient#get_occm_demand_signal_item.' if logger

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

  path = '/occmDemandSignalItems/{occmDemandSignalItemId}'.sub('{occmDemandSignalItemId}', occm_demand_signal_item_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: 'DemandSignalClient#get_occm_demand_signal_item') 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::CapacityManagement::Models::OccmDemandSignalItem'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

This API will list all the resources across all demand signal catalogs for a given namespace and customer group containing the caller compartment.

Allowed values are: name

Parameters:

  • compartment_id (String) —

    The ocid of the compartment or tenancy in which resources are to be listed. This will also be used for authorization purposes.

  • 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

  • :name (String) —

    A query parameter to filter the list of demand signal catalog resource based on the resource name.

  • :demand_signal_namespace (String) —

    A query parameter to filter the list of demand signal catalog resources based on the namespace.

  • :limit (Integer) —

    The maximum number of items to return. (default to 10)

  • :page (String) —

    A token representing the position at which to start retrieving results. This must come from opc-next-page header field of a previous response.

  • :opc_request_id (String) —

    The client request ID for tracing. The only valid characters for request IDs are letters, numbers, underscore, and dash.

  • :sort_order (String) —

    The sort order to use, either 'ASC' or 'DESC'.

  • :sort_by (String) —

    The field to sort the response of List Demand catalog resources API. Only one sort order may be provided. The default order for name is case sensitive alphabetical order. (default to name)

Returns:



562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
 
# File 'lib/oci/capacity_management/demand_signal_client.rb', line 562

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

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

  if opts[:demand_signal_namespace] && !OCI::CapacityManagement::Models::DEMAND_SIGNAL_NAMESPACE_ENUM.include?(opts[:demand_signal_namespace])
    raise 'Invalid value for "demand_signal_namespace", must be one of the values in OCI::CapacityManagement::Models::DEMAND_SIGNAL_NAMESPACE_ENUM.'
  end

  if opts[:sort_order] && !OCI::CapacityManagement::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::CapacityManagement::Models::SORT_ORDER_ENUM.'
  end

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

  path = '/occmDemandSignalCatalogResources'
  operation_signing_strategy = :standard

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

  # 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: 'DemandSignalClient#list_occm_demand_signal_catalog_resources') 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::CapacityManagement::Models::OccmDemandSignalCatalogResourceCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

This GET call is used to list all demand signals delivery resources within the compartment passed as a query param.

Allowed values are: resourceName

Parameters:

  • compartment_id (String) —

    The ocid of the compartment or tenancy in which resources are to be listed. This will also be used for authorization purposes.

  • 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

  • :id (String) —

    A query parameter to filter the list of demand signals based on it's OCID.

  • :occm_demand_signal_item_id (String) —

    A query parameter to filter the list of demand signal items based on it's OCID.

  • :limit (Integer) —

    The maximum number of items to return. (default to 10)

  • :page (String) —

    A token representing the position at which to start retrieving results. This must come from opc-next-page header field of a previous response.

  • :opc_request_id (String) —

    The client request ID for tracing. The only valid characters for request IDs are letters, numbers, underscore, and dash.

  • :sort_order (String) —

    The sort order to use, either 'ASC' or 'DESC'.

  • :sort_by (String) —

    The field to sort the response of List Demand Signal Delivery API. Only one sort order may be provided. The default order for resource name is case sensitive alphabetical order. (default to resourceName)

Returns:



647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
 
# File 'lib/oci/capacity_management/demand_signal_client.rb', line 647

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

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

  if opts[:sort_order] && !OCI::CapacityManagement::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::CapacityManagement::Models::SORT_ORDER_ENUM.'
  end

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

  path = '/occmDemandSignalDeliveries'
  operation_signing_strategy = :standard

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

  # 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: 'DemandSignalClient#list_occm_demand_signal_deliveries') 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::CapacityManagement::Models::OccmDemandSignalDeliveryCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

This API will list the detailed information about the resources demanded as part of the demand signal.

Allowed values are: resourceName

Parameters:

  • compartment_id (String) —

    The ocid of the compartment or tenancy in which resources are to be listed. This will also be used for authorization purposes.

  • 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

  • :occm_demand_signal_id (String) —

    A query parameter to filter the list of demand signal items based on a demand signal id.

  • :resource_name (String) —

    A query parameter to filter the list of demand signal details based on the resource name.

  • :demand_signal_namespace (String) —

    A query parameter to filter the list of demand signal details based on the namespace.

  • :limit (Integer) —

    The maximum number of items to return. (default to 10)

  • :page (String) —

    A token representing the position at which to start retrieving results. This must come from opc-next-page header field of a previous response.

  • :opc_request_id (String) —

    The client request ID for tracing. The only valid characters for request IDs are letters, numbers, underscore, and dash.

  • :sort_order (String) —

    The sort order to use, either 'ASC' or 'DESC'.

  • :sort_by (String) —

    The field to sort the response of List Demand Signal Details API. Only one sort order may be provided. The default order for resource name is case sensitive alphabetical order. (default to resourceName)

Returns:



730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
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
 
# File 'lib/oci/capacity_management/demand_signal_client.rb', line 730

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

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

  if opts[:demand_signal_namespace] && !OCI::CapacityManagement::Models::DEMAND_SIGNAL_NAMESPACE_ENUM.include?(opts[:demand_signal_namespace])
    raise 'Invalid value for "demand_signal_namespace", must be one of the values in OCI::CapacityManagement::Models::DEMAND_SIGNAL_NAMESPACE_ENUM.'
  end

  if opts[:sort_order] && !OCI::CapacityManagement::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::CapacityManagement::Models::SORT_ORDER_ENUM.'
  end

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

  path = '/occmDemandSignalItems'
  operation_signing_strategy = :standard

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

  # 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: 'DemandSignalClient#list_occm_demand_signal_items') 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::CapacityManagement::Models::OccmDemandSignalItemCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

This GET call is used to list all demand signals within the compartment passed as a query parameter.

Allowed values are: timeCreated, displayName

Parameters:

  • compartment_id (String) —

    The ocid of the compartment or tenancy in which resources are to be listed. This will also be used for authorization purposes.

  • 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

  • :id (String) —

    A query parameter to filter the list of demand signals based on it's OCID.

  • :lifecycle_details (String) —

    A query parameter to filter the list of demand signals based on its state.

  • :display_name (String) —

    A filter to return only the resources that match the entire display name. The match is not case sensitive.

  • :limit (Integer) —

    The maximum number of items to return. (default to 10)

  • :page (String) —

    A token representing the position at which to start retrieving results. This must come from opc-next-page header field of a previous response.

  • :opc_request_id (String) —

    The client request ID for tracing. The only valid characters for request IDs are letters, numbers, underscore, and dash.

  • :sort_order (String) —

    The sort order to use, either 'ASC' or 'DESC'.

  • :sort_by (String) —

    The field to sort the response of List Demand Signal API. Only one sort order may be provided. The default order for timeCreated is reverse chronological order (latest date at the top). The default order for displayName is case sensitive alphabetical order. (default to timeCreated)

Returns:



817
818
819
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
859
860
861
862
863
864
865
866
867
868
 
# File 'lib/oci/capacity_management/demand_signal_client.rb', line 817

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

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

  if opts[:sort_order] && !OCI::CapacityManagement::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::CapacityManagement::Models::SORT_ORDER_ENUM.'
  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 = '/occmDemandSignals'
  operation_signing_strategy = :standard

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

  # 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: 'DemandSignalClient#list_occm_demand_signals') 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::CapacityManagement::Models::OccmDemandSignalCollection'
    )
  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.



94
95
96
 
# File 'lib/oci/capacity_management/demand_signal_client.rb', line 94

def logger
  @api_client.config.logger
end

#update_occm_demand_signal(update_occm_demand_signal_details, occm_demand_signal_id, opts = {}) ⇒ Response

Note:

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

This is a PUT API which shall be used to update the metadata of the demand signal.

Parameters:

  • update_occm_demand_signal_details (OCI::CapacityManagement::Models::UpdateOccmDemandSignalDetails) —

    The request details for this PUT API to update the metadata for a given demand signal resource.

  • occm_demand_signal_id (String) —

    The OCID of the demand signal.

  • 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

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Returns:



898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
 
# File 'lib/oci/capacity_management/demand_signal_client.rb', line 898

def update_occm_demand_signal(update_occm_demand_signal_details, occm_demand_signal_id, opts = {})
  logger.debug 'Calling operation DemandSignalClient#update_occm_demand_signal.' if logger

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

  path = '/occmDemandSignals/{occmDemandSignalId}'.sub('{occmDemandSignalId}', occm_demand_signal_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[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_occm_demand_signal_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DemandSignalClient#update_occm_demand_signal') 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::CapacityManagement::Models::OccmDemandSignal'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_occm_demand_signal_item(update_occm_demand_signal_item_details, occm_demand_signal_item_id, opts = {}) ⇒ Response

Note:

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

This is a PUT API which can be used to update the demand signal item resource.

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

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Returns:



966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
 
# File 'lib/oci/capacity_management/demand_signal_client.rb', line 966

def update_occm_demand_signal_item(update_occm_demand_signal_item_details, occm_demand_signal_item_id, opts = {})
  logger.debug 'Calling operation DemandSignalClient#update_occm_demand_signal_item.' if logger

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

  path = '/occmDemandSignalItems/{occmDemandSignalItemId}'.sub('{occmDemandSignalItemId}', occm_demand_signal_item_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[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_occm_demand_signal_item_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DemandSignalClient#update_occm_demand_signal_item') 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::CapacityManagement::Models::OccmDemandSignalItem'
    )
  end
  # rubocop:enable Metrics/BlockLength
end