Class: OCI::CapacityManagement::InternalDemandSignalClient

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/capacity_management/internal_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) ⇒ InternalDemandSignalClient

Creates a new InternalDemandSignalClient. 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/internal_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 "InternalDemandSignalClient 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/internal_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/internal_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/internal_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/internal_demand_signal_client.rb', line 25

def retry_config
  @retry_config
end

Instance Method Details

#create_internal_occm_demand_signal_delivery(create_internal_occm_demand_signal_delivery_details, opts = {}) ⇒ Response

Note:

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

This is a post API which is used to create a demand signal delivery resource. operationId: CreateInternalOccmDemandSignalDelivery summary: A post call to create a demand signal delivery.

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:



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

def create_internal_occm_demand_signal_delivery(create_internal_occm_demand_signal_delivery_details, opts = {})
  logger.debug 'Calling operation InternalDemandSignalClient#create_internal_occm_demand_signal_delivery.' if logger

  raise "Missing the required parameter 'create_internal_occm_demand_signal_delivery_details' when calling create_internal_occm_demand_signal_delivery." if create_internal_occm_demand_signal_delivery_details.nil?

  path = '/internal/occmDemandSignalDeliveries'
  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_internal_occm_demand_signal_delivery_details)

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

#delete_internal_occm_demand_signal_delivery(occm_demand_signal_delivery_id, opts = {}) ⇒ Response

Note:

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

This is an internal DELETE API which is used to delete a demand signal delivery resource.

Parameters:

  • occm_demand_signal_delivery_id (String) —

    The OCID of the demand signal delivery.

  • 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.

  • :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.

Returns:

  • (Response) —

    A Response object with data of type nil



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
223
224
 
# File 'lib/oci/capacity_management/internal_demand_signal_client.rb', line 188

def delete_internal_occm_demand_signal_delivery(occm_demand_signal_delivery_id, opts = {})
  logger.debug 'Calling operation InternalDemandSignalClient#delete_internal_occm_demand_signal_delivery.' if logger

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

  path = '/internal/occmDemandSignalDeliveries/{occmDemandSignalDeliveryId}'.sub('{occmDemandSignalDeliveryId}', occm_demand_signal_delivery_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: 'InternalDemandSignalClient#delete_internal_occm_demand_signal_delivery') 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_internal_occm_demand_signal(occm_demand_signal_id, opts = {}) ⇒ Response

Note:

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

This is an internal 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:



246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/oci/capacity_management/internal_demand_signal_client.rb', line 246

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

  raise "Missing the required parameter 'occm_demand_signal_id' when calling get_internal_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 = '/internal/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: 'InternalDemandSignalClient#get_internal_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::InternalOccmDemandSignal'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_internal_occm_demand_signal_catalog(occm_demand_signal_catalog_id, opts = {}) ⇒ Response

Note:

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

This API helps in getting the details about a specific occm demand signal catalog.

Parameters:

  • occm_demand_signal_catalog_id (String) —

    The OCID of the demand signal catalog.

  • 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:



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

def get_internal_occm_demand_signal_catalog(occm_demand_signal_catalog_id, opts = {})
  logger.debug 'Calling operation InternalDemandSignalClient#get_internal_occm_demand_signal_catalog.' if logger

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

  path = '/internal/occmDemandSignalCatalog/{occmDemandSignalCatalogId}'.sub('{occmDemandSignalCatalogId}', occm_demand_signal_catalog_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: 'InternalDemandSignalClient#get_internal_occm_demand_signal_catalog') 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::OccmDemandSignalCatalog'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_internal_occm_demand_signal_delivery(occm_demand_signal_delivery_id, opts = {}) ⇒ Response

Note:

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

This is an internal GET API to get the details of a demand signal delivery resource corresponding to a demand signal item.

Parameters:

  • occm_demand_signal_delivery_id (String) —

    The OCID of the demand signal delivery.

  • 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:



362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
 
# File 'lib/oci/capacity_management/internal_demand_signal_client.rb', line 362

def get_internal_occm_demand_signal_delivery(occm_demand_signal_delivery_id, opts = {})
  logger.debug 'Calling operation InternalDemandSignalClient#get_internal_occm_demand_signal_delivery.' if logger

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

  path = '/internal/occmDemandSignalDeliveries/{occmDemandSignalDeliveryId}'.sub('{occmDemandSignalDeliveryId}', occm_demand_signal_delivery_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: 'InternalDemandSignalClient#get_internal_occm_demand_signal_delivery') 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::InternalOccmDemandSignalDelivery'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_internal_occm_demand_signal_catalog_resources(compartment_id, occ_customer_group_id, occm_demand_signal_catalog_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_internal_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.

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.

  • occ_customer_group_id (String) —

    The customer group ocid by which we would filter the list.

  • occm_demand_signal_catalog_id (String) —

    The ocid of demand signal catalog id.

  • 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:



431
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
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
 
# File 'lib/oci/capacity_management/internal_demand_signal_client.rb', line 431

def list_internal_occm_demand_signal_catalog_resources(compartment_id, occ_customer_group_id, occm_demand_signal_catalog_id, opts = {})
  logger.debug 'Calling operation InternalDemandSignalClient#list_internal_occm_demand_signal_catalog_resources.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_internal_occm_demand_signal_catalog_resources." if compartment_id.nil?
  raise "Missing the required parameter 'occ_customer_group_id' when calling list_internal_occm_demand_signal_catalog_resources." if occ_customer_group_id.nil?
  raise "Missing the required parameter 'occm_demand_signal_catalog_id' when calling list_internal_occm_demand_signal_catalog_resources." if occm_demand_signal_catalog_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 = '/internal/occmDemandSignalCatalogResources'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:occCustomerGroupId] = occ_customer_group_id
  query_params[:occmDemandSignalCatalogId] = occm_demand_signal_catalog_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: 'InternalDemandSignalClient#list_internal_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::InternalOccmDemandSignalCatalogResourceCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_internal_occm_demand_signal_catalogs(compartment_id, occ_customer_group_id, opts = {}) ⇒ Response

Note:

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

This API will list demand signal catalogs for a given customer group.

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.

  • occ_customer_group_id (String) —

    The customer group ocid by which we would filter the list.

  • 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

  • :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 catalog API. Only one sort order may be provided. The default order for name is case sensitive alphabetical order. (default to name)

Returns:



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
557
558
559
560
561
562
563
564
565
566
567
568
569
 
# File 'lib/oci/capacity_management/internal_demand_signal_client.rb', line 518

def list_internal_occm_demand_signal_catalogs(compartment_id, occ_customer_group_id, opts = {})
  logger.debug 'Calling operation InternalDemandSignalClient#list_internal_occm_demand_signal_catalogs.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_internal_occm_demand_signal_catalogs." if compartment_id.nil?
  raise "Missing the required parameter 'occ_customer_group_id' when calling list_internal_occm_demand_signal_catalogs." if occ_customer_group_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[name].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of name.'
  end

  path = '/internal/occmDemandSignalCatalog'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:occCustomerGroupId] = occ_customer_group_id
  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: 'InternalDemandSignalClient#list_internal_occm_demand_signal_catalogs') 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::OccmDemandSignalCatalogCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_internal_occm_demand_signal_deliveries(compartment_id, occ_customer_group_id, opts = {}) ⇒ Response

Note:

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

This GET call is used to list all demand signal delivery resources within the customer group passed as a query parameter.

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.

  • occ_customer_group_id (String) —

    The customer group ocid by which we would filter the list.

  • 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:



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
645
646
647
648
649
650
651
652
653
 
# File 'lib/oci/capacity_management/internal_demand_signal_client.rb', line 601

def list_internal_occm_demand_signal_deliveries(compartment_id, occ_customer_group_id, opts = {})
  logger.debug 'Calling operation InternalDemandSignalClient#list_internal_occm_demand_signal_deliveries.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_internal_occm_demand_signal_deliveries." if compartment_id.nil?
  raise "Missing the required parameter 'occ_customer_group_id' when calling list_internal_occm_demand_signal_deliveries." if occ_customer_group_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 = '/internal/occmDemandSignalDeliveries'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:occCustomerGroupId] = occ_customer_group_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: 'InternalDemandSignalClient#list_internal_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::InternalOccmDemandSignalDeliveryCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_internal_occm_demand_signal_items(compartment_id, occ_customer_group_id, opts = {}) ⇒ Response

Note:

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

This internal 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.

  • occ_customer_group_id (String) —

    The customer group ocid by which we would filter the list.

  • 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:



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
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
 
# File 'lib/oci/capacity_management/internal_demand_signal_client.rb', line 687

def list_internal_occm_demand_signal_items(compartment_id, occ_customer_group_id, opts = {})
  logger.debug 'Calling operation InternalDemandSignalClient#list_internal_occm_demand_signal_items.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_internal_occm_demand_signal_items." if compartment_id.nil?
  raise "Missing the required parameter 'occ_customer_group_id' when calling list_internal_occm_demand_signal_items." if occ_customer_group_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 = '/internal/occmDemandSignalItems'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:occCustomerGroupId] = occ_customer_group_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: 'InternalDemandSignalClient#list_internal_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::InternalOccmDemandSignalItemCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_internal_occm_demand_signals(compartment_id, occ_customer_group_id, opts = {}) ⇒ Response

Note:

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

This is an internal 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.

  • occ_customer_group_id (String) —

    The customer group ocid by which we would filter the list.

  • 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:



777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
 
# File 'lib/oci/capacity_management/internal_demand_signal_client.rb', line 777

def list_internal_occm_demand_signals(compartment_id, occ_customer_group_id, opts = {})
  logger.debug 'Calling operation InternalDemandSignalClient#list_internal_occm_demand_signals.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_internal_occm_demand_signals." if compartment_id.nil?
  raise "Missing the required parameter 'occ_customer_group_id' when calling list_internal_occm_demand_signals." if occ_customer_group_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 = '/internal/occmDemandSignals'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:occCustomerGroupId] = occ_customer_group_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: 'InternalDemandSignalClient#list_internal_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::InternalOccmDemandSignalCollection'
    )
  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/internal_demand_signal_client.rb', line 94

def logger
  @api_client.config.logger
end

#update_internal_occm_demand_signal(update_internal_occm_demand_signal_details, occm_demand_signal_id, opts = {}) ⇒ Response

Note:

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

This is a internal PUT API which shall be used to update the metadata of the 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

  • :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:



860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
 
# File 'lib/oci/capacity_management/internal_demand_signal_client.rb', line 860

def update_internal_occm_demand_signal(update_internal_occm_demand_signal_details, occm_demand_signal_id, opts = {})
  logger.debug 'Calling operation InternalDemandSignalClient#update_internal_occm_demand_signal.' if logger

  raise "Missing the required parameter 'update_internal_occm_demand_signal_details' when calling update_internal_occm_demand_signal." if update_internal_occm_demand_signal_details.nil?
  raise "Missing the required parameter 'occm_demand_signal_id' when calling update_internal_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 = '/internal/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_internal_occm_demand_signal_details)

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

#update_internal_occm_demand_signal_delivery(update_internal_occm_demand_signal_delivery_details, occm_demand_signal_delivery_id, opts = {}) ⇒ Response

Note:

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

This is an internal PUT API which is used to update the demand signal delivery 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

  • :opc_request_id (String) —

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

  • :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.

Returns:



928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
 
# File 'lib/oci/capacity_management/internal_demand_signal_client.rb', line 928

def update_internal_occm_demand_signal_delivery(update_internal_occm_demand_signal_delivery_details, occm_demand_signal_delivery_id, opts = {})
  logger.debug 'Calling operation InternalDemandSignalClient#update_internal_occm_demand_signal_delivery.' if logger

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

  path = '/internal/occmDemandSignalDeliveries/{occmDemandSignalDeliveryId}'.sub('{occmDemandSignalDeliveryId}', occm_demand_signal_delivery_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_internal_occm_demand_signal_delivery_details)

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