Class: OCI::DemandSignal::OccDemandSignalClient
- Inherits:
-
Object
- Object
- OCI::DemandSignal::OccDemandSignalClient
- Defined in:
- lib/oci/demand_signal/occ_demand_signal_client.rb
Overview
Use the OCI Control Center Demand Signal API to manage Demand Signals.
Instance Attribute Summary collapse
-
#api_client ⇒ OCI::ApiClient
readonly
Client used to make HTTP requests.
-
#endpoint ⇒ String
readonly
Fully qualified endpoint URL.
-
#region ⇒ String
The region, which will usually correspond to a value in Regions::REGION_ENUM.
-
#retry_config ⇒ OCI::Retry::RetryConfig
readonly
The default retry configuration to apply to all operations in this service client.
Instance Method Summary collapse
-
#change_occ_demand_signal_compartment(occ_demand_signal_id, change_occ_demand_signal_compartment_details, opts = {}) ⇒ Response
Moves a OccDemandSignal into a different compartment within the same tenancy.
-
#create_occ_demand_signal(create_occ_demand_signal_details, opts = {}) ⇒ Response
Creates a OccDemandSignal.
-
#delete_occ_demand_signal(occ_demand_signal_id, opts = {}) ⇒ Response
Deletes a OccDemandSignal.
-
#get_occ_demand_signal(occ_demand_signal_id, opts = {}) ⇒ Response
Gets information about a OccDemandSignal.
-
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ OccDemandSignalClient
constructor
Creates a new OccDemandSignalClient.
-
#list_occ_demand_signals(opts = {}) ⇒ Response
Gets a list of OccDemandSignals.
-
#logger ⇒ Logger
The logger for this client.
-
#patch_occ_demand_signal(occ_demand_signal_id, patch_occ_demand_signal_details, opts = {}) ⇒ Response
Updates the data of an OccDemandSignal.
-
#update_occ_demand_signal(occ_demand_signal_id, update_occ_demand_signal_details, opts = {}) ⇒ Response
Updates a OccDemandSignal.
Constructor Details
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ OccDemandSignalClient
Creates a new OccDemandSignalClient. 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.
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/demand_signal/occ_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 + '/20240430' else region ||= config.region region ||= signer.region if signer.respond_to?(:region) self.region = region end logger.info "OccDemandSignalClient endpoint set to '#{@endpoint}'." if logger end |
Instance Attribute Details
#api_client ⇒ OCI::ApiClient (readonly)
Client used to make HTTP requests.
15 16 17 |
# File 'lib/oci/demand_signal/occ_demand_signal_client.rb', line 15 def api_client @api_client end |
#endpoint ⇒ String (readonly)
Fully qualified endpoint URL
19 20 21 |
# File 'lib/oci/demand_signal/occ_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.
29 30 31 |
# File 'lib/oci/demand_signal/occ_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
25 26 27 |
# File 'lib/oci/demand_signal/occ_demand_signal_client.rb', line 25 def retry_config @retry_config end |
Instance Method Details
#change_occ_demand_signal_compartment(occ_demand_signal_id, change_occ_demand_signal_compartment_details, opts = {}) ⇒ Response
Click here to see an example of how to use change_occ_demand_signal_compartment API.
Moves a OccDemandSignal into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
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/demand_signal/occ_demand_signal_client.rb', line 123 def change_occ_demand_signal_compartment(occ_demand_signal_id, change_occ_demand_signal_compartment_details, opts = {}) logger.debug 'Calling operation OccDemandSignalClient#change_occ_demand_signal_compartment.' if logger raise "Missing the required parameter 'occ_demand_signal_id' when calling change_occ_demand_signal_compartment." if occ_demand_signal_id.nil? raise "Missing the required parameter 'change_occ_demand_signal_compartment_details' when calling change_occ_demand_signal_compartment." if change_occ_demand_signal_compartment_details.nil? raise "Parameter value for 'occ_demand_signal_id' must not be blank" if OCI::Internal::Util.blank_string?(occ_demand_signal_id) path = '/occDemandSignals/{occDemandSignalId}/actions/changeCompartment'.sub('{occDemandSignalId}', occ_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(change_occ_demand_signal_compartment_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'OccDemandSignalClient#change_occ_demand_signal_compartment') 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_occ_demand_signal(create_occ_demand_signal_details, opts = {}) ⇒ Response
Click here to see an example of how to use create_occ_demand_signal API.
Creates a OccDemandSignal.
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 225 226 |
# File 'lib/oci/demand_signal/occ_demand_signal_client.rb', line 189 def create_occ_demand_signal(create_occ_demand_signal_details, opts = {}) logger.debug 'Calling operation OccDemandSignalClient#create_occ_demand_signal.' if logger raise "Missing the required parameter 'create_occ_demand_signal_details' when calling create_occ_demand_signal." if create_occ_demand_signal_details.nil? path = '/occDemandSignals' 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_occ_demand_signal_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'OccDemandSignalClient#create_occ_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::DemandSignal::Models::OccDemandSignal' ) end # rubocop:enable Metrics/BlockLength end |
#delete_occ_demand_signal(occ_demand_signal_id, opts = {}) ⇒ Response
Click here to see an example of how to use delete_occ_demand_signal API.
Deletes a OccDemandSignal.
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 288 289 |
# File 'lib/oci/demand_signal/occ_demand_signal_client.rb', line 253 def delete_occ_demand_signal(occ_demand_signal_id, opts = {}) logger.debug 'Calling operation OccDemandSignalClient#delete_occ_demand_signal.' if logger raise "Missing the required parameter 'occ_demand_signal_id' when calling delete_occ_demand_signal." if occ_demand_signal_id.nil? raise "Parameter value for 'occ_demand_signal_id' must not be blank" if OCI::Internal::Util.blank_string?(occ_demand_signal_id) path = '/occDemandSignals/{occDemandSignalId}'.sub('{occDemandSignalId}', occ_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.(applicable_retry_config(opts), call_name: 'OccDemandSignalClient#delete_occ_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 |
#get_occ_demand_signal(occ_demand_signal_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_occ_demand_signal API.
Gets information about a OccDemandSignal.
311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 |
# File 'lib/oci/demand_signal/occ_demand_signal_client.rb', line 311 def get_occ_demand_signal(occ_demand_signal_id, opts = {}) logger.debug 'Calling operation OccDemandSignalClient#get_occ_demand_signal.' if logger raise "Missing the required parameter 'occ_demand_signal_id' when calling get_occ_demand_signal." if occ_demand_signal_id.nil? raise "Parameter value for 'occ_demand_signal_id' must not be blank" if OCI::Internal::Util.blank_string?(occ_demand_signal_id) path = '/occDemandSignals/{occDemandSignalId}'.sub('{occDemandSignalId}', occ_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.(applicable_retry_config(opts), call_name: 'OccDemandSignalClient#get_occ_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::DemandSignal::Models::OccDemandSignal' ) end # rubocop:enable Metrics/BlockLength end |
#list_occ_demand_signals(opts = {}) ⇒ Response
Click here to see an example of how to use list_occ_demand_signals API.
Gets a list of OccDemandSignals.
388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 |
# File 'lib/oci/demand_signal/occ_demand_signal_client.rb', line 388 def list_occ_demand_signals(opts = {}) logger.debug 'Calling operation OccDemandSignalClient#list_occ_demand_signals.' if logger if opts[:lifecycle_state] && !OCI::DemandSignal::Models::OccDemandSignal::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state]) raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DemandSignal::Models::OccDemandSignal::LIFECYCLE_STATE_ENUM.' end if opts[:sort_order] && !OCI::DemandSignal::Models::SORT_ORDER_ENUM.include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of the values in OCI::DemandSignal::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 = '/occDemandSignals' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id] query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state] query_params[:displayName] = opts[:display_name] if opts[:display_name] query_params[:id] = opts[:id] if opts[: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.(applicable_retry_config(opts), call_name: 'OccDemandSignalClient#list_occ_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::DemandSignal::Models::OccDemandSignalCollection' ) end # rubocop:enable Metrics/BlockLength end |
#logger ⇒ Logger
Returns The logger for this client. May be nil.
94 95 96 |
# File 'lib/oci/demand_signal/occ_demand_signal_client.rb', line 94 def logger @api_client.config.logger end |
#patch_occ_demand_signal(occ_demand_signal_id, patch_occ_demand_signal_details, opts = {}) ⇒ Response
Click here to see an example of how to use patch_occ_demand_signal API.
Updates the data of an OccDemandSignal.
470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 |
# File 'lib/oci/demand_signal/occ_demand_signal_client.rb', line 470 def patch_occ_demand_signal(occ_demand_signal_id, patch_occ_demand_signal_details, opts = {}) logger.debug 'Calling operation OccDemandSignalClient#patch_occ_demand_signal.' if logger raise "Missing the required parameter 'occ_demand_signal_id' when calling patch_occ_demand_signal." if occ_demand_signal_id.nil? raise "Missing the required parameter 'patch_occ_demand_signal_details' when calling patch_occ_demand_signal." if patch_occ_demand_signal_details.nil? raise "Parameter value for 'occ_demand_signal_id' must not be blank" if OCI::Internal::Util.blank_string?(occ_demand_signal_id) path = '/occDemandSignals/{occDemandSignalId}'.sub('{occDemandSignalId}', occ_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(patch_occ_demand_signal_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'OccDemandSignalClient#patch_occ_demand_signal') do @api_client.call_api( :PATCH, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::DemandSignal::Models::OccDemandSignal' ) end # rubocop:enable Metrics/BlockLength end |
#update_occ_demand_signal(occ_demand_signal_id, update_occ_demand_signal_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_occ_demand_signal API.
Updates a OccDemandSignal.
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 570 571 572 573 574 |
# File 'lib/oci/demand_signal/occ_demand_signal_client.rb', line 536 def update_occ_demand_signal(occ_demand_signal_id, update_occ_demand_signal_details, opts = {}) logger.debug 'Calling operation OccDemandSignalClient#update_occ_demand_signal.' if logger raise "Missing the required parameter 'occ_demand_signal_id' when calling update_occ_demand_signal." if occ_demand_signal_id.nil? raise "Missing the required parameter 'update_occ_demand_signal_details' when calling update_occ_demand_signal." if update_occ_demand_signal_details.nil? raise "Parameter value for 'occ_demand_signal_id' must not be blank" if OCI::Internal::Util.blank_string?(occ_demand_signal_id) path = '/occDemandSignals/{occDemandSignalId}'.sub('{occDemandSignalId}', occ_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_occ_demand_signal_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'OccDemandSignalClient#update_occ_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::DemandSignal::Models::OccDemandSignal' ) end # rubocop:enable Metrics/BlockLength end |