Class: OCI::AccessGovernanceCp::AccessGovernanceCPClient
- Inherits:
-
Object
- Object
- OCI::AccessGovernanceCp::AccessGovernanceCPClient
- Defined in:
- lib/oci/access_governance_cp/access_governance_cp_client.rb
Overview
Use the Oracle Access Governance API to create, view, and manage GovernanceInstances.
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_governance_instance_compartment(governance_instance_id, change_governance_instance_compartment_details, opts = {}) ⇒ Response
Moves a GovernanceInstance resource from one compartment identifier to another.
-
#create_governance_instance(create_governance_instance_details, opts = {}) ⇒ Response
Creates a new GovernanceInstance.
-
#delete_governance_instance(governance_instance_id, opts = {}) ⇒ Response
Deletes an existing GovernanceInstance.
-
#get_governance_instance(governance_instance_id, opts = {}) ⇒ Response
Gets a GovernanceInstance by OCID.
-
#get_governance_instance_configuration(compartment_id, opts = {}) ⇒ Response
Gets the tenancy-wide configuration for GovernanceInstances.
-
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ AccessGovernanceCPClient
constructor
Creates a new AccessGovernanceCPClient.
-
#list_governance_instances(compartment_id, opts = {}) ⇒ Response
Returns a list of Governance Instances.
-
#logger ⇒ Logger
The logger for this client.
-
#update_governance_instance(update_governance_instance_details, governance_instance_id, opts = {}) ⇒ Response
Updates the GovernanceInstance.
-
#update_governance_instance_configuration(update_governance_instance_configuration_details, compartment_id, opts = {}) ⇒ Response
Updates the tenancy-wide configuration for GovernanceInstances.
Constructor Details
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ AccessGovernanceCPClient
Creates a new AccessGovernanceCPClient. 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/access_governance_cp/access_governance_cp_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 + '/20220518' else region ||= config.region region ||= signer.region if signer.respond_to?(:region) self.region = region end logger.info "AccessGovernanceCPClient 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/access_governance_cp/access_governance_cp_client.rb', line 15 def api_client @api_client end |
#endpoint ⇒ String (readonly)
Fully qualified endpoint URL
19 20 21 |
# File 'lib/oci/access_governance_cp/access_governance_cp_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/access_governance_cp/access_governance_cp_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/access_governance_cp/access_governance_cp_client.rb', line 25 def retry_config @retry_config end |
Instance Method Details
#change_governance_instance_compartment(governance_instance_id, change_governance_instance_compartment_details, opts = {}) ⇒ Response
Click here to see an example of how to use change_governance_instance_compartment API.
Moves a GovernanceInstance resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.
124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 |
# File 'lib/oci/access_governance_cp/access_governance_cp_client.rb', line 124 def change_governance_instance_compartment(governance_instance_id, change_governance_instance_compartment_details, opts = {}) logger.debug 'Calling operation AccessGovernanceCPClient#change_governance_instance_compartment.' if logger raise "Missing the required parameter 'governance_instance_id' when calling change_governance_instance_compartment." if governance_instance_id.nil? raise "Missing the required parameter 'change_governance_instance_compartment_details' when calling change_governance_instance_compartment." if change_governance_instance_compartment_details.nil? raise "Parameter value for 'governance_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(governance_instance_id) path = '/governanceInstances/{governanceInstanceId}/actions/changeCompartment'.sub('{governanceInstanceId}', governance_instance_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] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(change_governance_instance_compartment_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'AccessGovernanceCPClient#change_governance_instance_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_governance_instance(create_governance_instance_details, opts = {}) ⇒ Response
Click here to see an example of how to use create_governance_instance API.
Creates a new GovernanceInstance.
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 225 |
# File 'lib/oci/access_governance_cp/access_governance_cp_client.rb', line 188 def create_governance_instance(create_governance_instance_details, opts = {}) logger.debug 'Calling operation AccessGovernanceCPClient#create_governance_instance.' if logger raise "Missing the required parameter 'create_governance_instance_details' when calling create_governance_instance." if create_governance_instance_details.nil? path = '/governanceInstances' 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_governance_instance_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'AccessGovernanceCPClient#create_governance_instance') 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::AccessGovernanceCp::Models::GovernanceInstance' ) end # rubocop:enable Metrics/BlockLength end |
#delete_governance_instance(governance_instance_id, opts = {}) ⇒ Response
Click here to see an example of how to use delete_governance_instance API.
Deletes an existing GovernanceInstance.
256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 |
# File 'lib/oci/access_governance_cp/access_governance_cp_client.rb', line 256 def delete_governance_instance(governance_instance_id, opts = {}) logger.debug 'Calling operation AccessGovernanceCPClient#delete_governance_instance.' if logger raise "Missing the required parameter 'governance_instance_id' when calling delete_governance_instance." if governance_instance_id.nil? raise "Parameter value for 'governance_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(governance_instance_id) path = '/governanceInstances/{governanceInstanceId}'.sub('{governanceInstanceId}', governance_instance_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-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 = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'AccessGovernanceCPClient#delete_governance_instance') 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_governance_instance(governance_instance_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_governance_instance API.
Gets a GovernanceInstance by OCID.
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 348 |
# File 'lib/oci/access_governance_cp/access_governance_cp_client.rb', line 312 def get_governance_instance(governance_instance_id, opts = {}) logger.debug 'Calling operation AccessGovernanceCPClient#get_governance_instance.' if logger raise "Missing the required parameter 'governance_instance_id' when calling get_governance_instance." if governance_instance_id.nil? raise "Parameter value for 'governance_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(governance_instance_id) path = '/governanceInstances/{governanceInstanceId}'.sub('{governanceInstanceId}', governance_instance_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: 'AccessGovernanceCPClient#get_governance_instance') 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::AccessGovernanceCp::Models::GovernanceInstance' ) end # rubocop:enable Metrics/BlockLength end |
#get_governance_instance_configuration(compartment_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_governance_instance_configuration API.
Gets the tenancy-wide configuration for GovernanceInstances
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 399 400 401 402 |
# File 'lib/oci/access_governance_cp/access_governance_cp_client.rb', line 366 def get_governance_instance_configuration(compartment_id, opts = {}) logger.debug 'Calling operation AccessGovernanceCPClient#get_governance_instance_configuration.' if logger raise "Missing the required parameter 'compartment_id' when calling get_governance_instance_configuration." if compartment_id.nil? path = '/governanceInstances/configuration' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id # 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: 'AccessGovernanceCPClient#get_governance_instance_configuration') 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::AccessGovernanceCp::Models::GovernanceInstanceConfiguration' ) end # rubocop:enable Metrics/BlockLength end |
#list_governance_instances(compartment_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_governance_instances API.
Returns a list of Governance Instances.
Allowed values are: timeCreated, displayName, timeUpdated, lifecycleState
430 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 |
# File 'lib/oci/access_governance_cp/access_governance_cp_client.rb', line 430 def list_governance_instances(compartment_id, opts = {}) logger.debug 'Calling operation AccessGovernanceCPClient#list_governance_instances.' if logger raise "Missing the required parameter 'compartment_id' when calling list_governance_instances." if compartment_id.nil? if opts[:sort_order] && !OCI::AccessGovernanceCp::Models::SORT_ORDER_ENUM.include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of the values in OCI::AccessGovernanceCp::Models::SORT_ORDER_ENUM.' end if opts[:sort_by] && !%w[timeCreated displayName timeUpdated lifecycleState].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of timeCreated, displayName, timeUpdated, lifecycleState.' end path = '/governanceInstances' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state] query_params[:displayName] = opts[:display_name] if opts[:display_name] query_params[: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: 'AccessGovernanceCPClient#list_governance_instances') 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::AccessGovernanceCp::Models::GovernanceInstanceCollection' ) end # rubocop:enable Metrics/BlockLength end |
#logger ⇒ Logger
Returns The logger for this client. May be nil.
94 95 96 |
# File 'lib/oci/access_governance_cp/access_governance_cp_client.rb', line 94 def logger @api_client.config.logger end |
#update_governance_instance(update_governance_instance_details, governance_instance_id, opts = {}) ⇒ Response
Click here to see an example of how to use update_governance_instance API.
Updates the GovernanceInstance.
506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 |
# File 'lib/oci/access_governance_cp/access_governance_cp_client.rb', line 506 def update_governance_instance(update_governance_instance_details, governance_instance_id, opts = {}) logger.debug 'Calling operation AccessGovernanceCPClient#update_governance_instance.' if logger raise "Missing the required parameter 'update_governance_instance_details' when calling update_governance_instance." if update_governance_instance_details.nil? raise "Missing the required parameter 'governance_instance_id' when calling update_governance_instance." if governance_instance_id.nil? raise "Parameter value for 'governance_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(governance_instance_id) path = '/governanceInstances/{governanceInstanceId}'.sub('{governanceInstanceId}', governance_instance_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_governance_instance_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'AccessGovernanceCPClient#update_governance_instance') 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::AccessGovernanceCp::Models::GovernanceInstance' ) end # rubocop:enable Metrics/BlockLength end |
#update_governance_instance_configuration(update_governance_instance_configuration_details, compartment_id, opts = {}) ⇒ Response
Click here to see an example of how to use update_governance_instance_configuration API.
Updates the tenancy-wide configuration for GovernanceInstances
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 |
# File 'lib/oci/access_governance_cp/access_governance_cp_client.rb', line 569 def update_governance_instance_configuration(update_governance_instance_configuration_details, compartment_id, opts = {}) logger.debug 'Calling operation AccessGovernanceCPClient#update_governance_instance_configuration.' if logger raise "Missing the required parameter 'update_governance_instance_configuration_details' when calling update_governance_instance_configuration." if update_governance_instance_configuration_details.nil? raise "Missing the required parameter 'compartment_id' when calling update_governance_instance_configuration." if compartment_id.nil? path = '/governanceInstances/configuration' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id # 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_governance_instance_configuration_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'AccessGovernanceCPClient#update_governance_instance_configuration') 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::AccessGovernanceCp::Models::GovernanceInstanceConfiguration' ) end # rubocop:enable Metrics/BlockLength end |