Class: OCI::OperatorAccessControl::OperatorControlAssignmentClient
- Inherits:
-
Object
- Object
- OCI::OperatorAccessControl::OperatorControlAssignmentClient
- Defined in:
- lib/oci/operator_access_control/operator_control_assignment_client.rb
Overview
Operator Access Control enables you to control the time duration and the actions an Oracle operator can perform on your Exadata Cloud@Customer infrastructure. Using logging service, you can view a near real-time audit report of all actions performed by an Oracle operator.
Use the table of contents and search tool to explore the OperatorAccessControl API.
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_operator_control_assignment_compartment(operator_control_assignment_id, change_operator_control_assignment_compartment_details, opts = {}) ⇒ Response
Changes the compartment of the specified Operator Control assignment ID.
-
#create_operator_control_assignment(create_operator_control_assignment_details, opts = {}) ⇒ Response
Creates an Operator Control Assignment resource.
-
#delete_operator_control_assignment(operator_control_assignment_id, opts = {}) ⇒ Response
Deletes the specified Operator Control Assignment.
-
#get_assignment_validation_status(operator_control_assignment_id, opts = {}) ⇒ Response
Returns the status of assignment validation associated with the assignmentId and the executionId.
-
#get_operator_control_assignment(operator_control_assignment_id, opts = {}) ⇒ Response
Gets the details of an Operator Control Assignment of the specified ID.
-
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ OperatorControlAssignmentClient
constructor
Creates a new OperatorControlAssignmentClient.
-
#list_operator_control_assignments(compartment_id, opts = {}) ⇒ Response
Lists all Operator Control Assignments.
-
#logger ⇒ Logger
The logger for this client.
-
#update_operator_control_assignment(operator_control_assignment_id, update_operator_control_assignment_details, opts = {}) ⇒ Response
Modifies the existing Operator Control assignment of the specified Operator Control assignment ID.
-
#validate_operator_assignment(operator_control_assignment_id, validate_operator_assignment_details, opts = {}) ⇒ Response
Validates the assignment for the specified Operator Control Assignment ID.
Constructor Details
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ OperatorControlAssignmentClient
Creates a new OperatorControlAssignmentClient. 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.
58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 |
# File 'lib/oci/operator_access_control/operator_control_assignment_client.rb', line 58 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 + '/20200630' else region ||= config.region region ||= signer.region if signer.respond_to?(:region) self.region = region end logger.info "OperatorControlAssignmentClient endpoint set to '#{@endpoint}'." if logger end |
Instance Attribute Details
#api_client ⇒ OCI::ApiClient (readonly)
Client used to make HTTP requests.
18 19 20 |
# File 'lib/oci/operator_access_control/operator_control_assignment_client.rb', line 18 def api_client @api_client end |
#endpoint ⇒ String (readonly)
Fully qualified endpoint URL
22 23 24 |
# File 'lib/oci/operator_access_control/operator_control_assignment_client.rb', line 22 def endpoint @endpoint end |
#region ⇒ String
The region, which will usually correspond to a value in Regions::REGION_ENUM.
32 33 34 |
# File 'lib/oci/operator_access_control/operator_control_assignment_client.rb', line 32 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
28 29 30 |
# File 'lib/oci/operator_access_control/operator_control_assignment_client.rb', line 28 def retry_config @retry_config end |
Instance Method Details
#change_operator_control_assignment_compartment(operator_control_assignment_id, change_operator_control_assignment_compartment_details, opts = {}) ⇒ Response
Click here to see an example of how to use change_operator_control_assignment_compartment API.
Changes the compartment of the specified Operator Control assignment ID.
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 164 165 166 167 |
# File 'lib/oci/operator_access_control/operator_control_assignment_client.rb', line 128 def change_operator_control_assignment_compartment(operator_control_assignment_id, change_operator_control_assignment_compartment_details, opts = {}) logger.debug 'Calling operation OperatorControlAssignmentClient#change_operator_control_assignment_compartment.' if logger raise "Missing the required parameter 'operator_control_assignment_id' when calling change_operator_control_assignment_compartment." if operator_control_assignment_id.nil? raise "Missing the required parameter 'change_operator_control_assignment_compartment_details' when calling change_operator_control_assignment_compartment." if change_operator_control_assignment_compartment_details.nil? raise "Parameter value for 'operator_control_assignment_id' must not be blank" if OCI::Internal::Util.blank_string?(operator_control_assignment_id) path = '/operatorControlAssignments/{operatorControlAssignmentId}/actions/changeCompartment'.sub('{operatorControlAssignmentId}', operator_control_assignment_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-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] 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 header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(change_operator_control_assignment_compartment_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'OperatorControlAssignmentClient#change_operator_control_assignment_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_operator_control_assignment(create_operator_control_assignment_details, opts = {}) ⇒ Response
Click here to see an example of how to use create_operator_control_assignment API.
Creates an Operator Control Assignment resource. In effect, this brings the target resource under the governance of the Operator Control for specified time duration.
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 227 228 |
# File 'lib/oci/operator_access_control/operator_control_assignment_client.rb', line 191 def create_operator_control_assignment(create_operator_control_assignment_details, opts = {}) logger.debug 'Calling operation OperatorControlAssignmentClient#create_operator_control_assignment.' if logger raise "Missing the required parameter 'create_operator_control_assignment_details' when calling create_operator_control_assignment." if create_operator_control_assignment_details.nil? path = '/operatorControlAssignments' 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_operator_control_assignment_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'OperatorControlAssignmentClient#create_operator_control_assignment') 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::OperatorAccessControl::Models::OperatorControlAssignment' ) end # rubocop:enable Metrics/BlockLength end |
#delete_operator_control_assignment(operator_control_assignment_id, opts = {}) ⇒ Response
Click here to see an example of how to use delete_operator_control_assignment API.
Deletes the specified Operator Control Assignment. This has the effect of unassigning the specific Operator Control from the target resource.
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 290 |
# File 'lib/oci/operator_access_control/operator_control_assignment_client.rb', line 253 def delete_operator_control_assignment(operator_control_assignment_id, opts = {}) logger.debug 'Calling operation OperatorControlAssignmentClient#delete_operator_control_assignment.' if logger raise "Missing the required parameter 'operator_control_assignment_id' when calling delete_operator_control_assignment." if operator_control_assignment_id.nil? raise "Parameter value for 'operator_control_assignment_id' must not be blank" if OCI::Internal::Util.blank_string?(operator_control_assignment_id) path = '/operatorControlAssignments/{operatorControlAssignmentId}'.sub('{operatorControlAssignmentId}', operator_control_assignment_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:description] = opts[:description] if opts[:description] # 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: 'OperatorControlAssignmentClient#delete_operator_control_assignment') 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_assignment_validation_status(operator_control_assignment_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_assignment_validation_status API.
Returns the status of assignment validation associated with the assignmentId and the executionId.
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 341 342 343 344 345 |
# File 'lib/oci/operator_access_control/operator_control_assignment_client.rb', line 309 def get_assignment_validation_status(operator_control_assignment_id, opts = {}) logger.debug 'Calling operation OperatorControlAssignmentClient#get_assignment_validation_status.' if logger raise "Missing the required parameter 'operator_control_assignment_id' when calling get_assignment_validation_status." if operator_control_assignment_id.nil? raise "Parameter value for 'operator_control_assignment_id' must not be blank" if OCI::Internal::Util.blank_string?(operator_control_assignment_id) path = '/operatorControlAssignments/{operatorControlAssignmentId}/actions/getAssignmentValidationStatus'.sub('{operatorControlAssignmentId}', operator_control_assignment_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: 'OperatorControlAssignmentClient#get_assignment_validation_status') 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::OperatorAccessControl::Models::AssignmentValidationStatus' ) end # rubocop:enable Metrics/BlockLength end |
#get_operator_control_assignment(operator_control_assignment_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_operator_control_assignment API.
Gets the details of an Operator Control Assignment of the specified ID.
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 399 |
# File 'lib/oci/operator_access_control/operator_control_assignment_client.rb', line 363 def get_operator_control_assignment(operator_control_assignment_id, opts = {}) logger.debug 'Calling operation OperatorControlAssignmentClient#get_operator_control_assignment.' if logger raise "Missing the required parameter 'operator_control_assignment_id' when calling get_operator_control_assignment." if operator_control_assignment_id.nil? raise "Parameter value for 'operator_control_assignment_id' must not be blank" if OCI::Internal::Util.blank_string?(operator_control_assignment_id) path = '/operatorControlAssignments/{operatorControlAssignmentId}'.sub('{operatorControlAssignmentId}', operator_control_assignment_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: 'OperatorControlAssignmentClient#get_operator_control_assignment') 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::OperatorAccessControl::Models::OperatorControlAssignment' ) end # rubocop:enable Metrics/BlockLength end |
#list_operator_control_assignments(compartment_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_operator_control_assignments API.
Lists all Operator Control Assignments. Allowed values are: timeCreated, displayName
427 428 429 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 482 483 |
# File 'lib/oci/operator_access_control/operator_control_assignment_client.rb', line 427 def list_operator_control_assignments(compartment_id, opts = {}) logger.debug 'Calling operation OperatorControlAssignmentClient#list_operator_control_assignments.' if logger raise "Missing the required parameter 'compartment_id' when calling list_operator_control_assignments." if compartment_id.nil? if opts[:lifecycle_state] && !OCI::OperatorAccessControl::Models::OPERATOR_CONTROL_ASSIGNMENT_LIFECYCLE_STATES_ENUM.include?(opts[:lifecycle_state]) raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::OperatorAccessControl::Models::OPERATOR_CONTROL_ASSIGNMENT_LIFECYCLE_STATES_ENUM.' end if opts[:sort_order] && !OCI::OperatorAccessControl::Models::SORT_ORDERS_ENUM.include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of the values in OCI::OperatorAccessControl::Models::SORT_ORDERS_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 = '/operatorControlAssignments' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:operatorControlName] = opts[:operator_control_name] if opts[:operator_control_name] query_params[:resourceName] = opts[:resource_name] if opts[:resource_name] query_params[:resourceType] = opts[:resource_type] if opts[:resource_type] query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state] 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: 'OperatorControlAssignmentClient#list_operator_control_assignments') 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::OperatorAccessControl::Models::OperatorControlAssignmentCollection' ) end # rubocop:enable Metrics/BlockLength end |
#logger ⇒ Logger
Returns The logger for this client. May be nil.
97 98 99 |
# File 'lib/oci/operator_access_control/operator_control_assignment_client.rb', line 97 def logger @api_client.config.logger end |
#update_operator_control_assignment(operator_control_assignment_id, update_operator_control_assignment_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_operator_control_assignment API.
Modifies the existing Operator Control assignment of the specified Operator Control assignment ID. Modifying the assignment does not change the Operator Control assignment ID.
509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 |
# File 'lib/oci/operator_access_control/operator_control_assignment_client.rb', line 509 def update_operator_control_assignment(operator_control_assignment_id, update_operator_control_assignment_details, opts = {}) logger.debug 'Calling operation OperatorControlAssignmentClient#update_operator_control_assignment.' if logger raise "Missing the required parameter 'operator_control_assignment_id' when calling update_operator_control_assignment." if operator_control_assignment_id.nil? raise "Missing the required parameter 'update_operator_control_assignment_details' when calling update_operator_control_assignment." if update_operator_control_assignment_details.nil? raise "Parameter value for 'operator_control_assignment_id' must not be blank" if OCI::Internal::Util.blank_string?(operator_control_assignment_id) path = '/operatorControlAssignments/{operatorControlAssignmentId}'.sub('{operatorControlAssignmentId}', operator_control_assignment_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_operator_control_assignment_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'OperatorControlAssignmentClient#update_operator_control_assignment') 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::OperatorAccessControl::Models::OperatorControlAssignment' ) end # rubocop:enable Metrics/BlockLength end |
#validate_operator_assignment(operator_control_assignment_id, validate_operator_assignment_details, opts = {}) ⇒ Response
Click here to see an example of how to use validate_operator_assignment API.
Validates the assignment for the specified Operator Control Assignment ID.
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 617 618 |
# File 'lib/oci/operator_access_control/operator_control_assignment_client.rb', line 579 def validate_operator_assignment(operator_control_assignment_id, validate_operator_assignment_details, opts = {}) logger.debug 'Calling operation OperatorControlAssignmentClient#validate_operator_assignment.' if logger raise "Missing the required parameter 'operator_control_assignment_id' when calling validate_operator_assignment." if operator_control_assignment_id.nil? raise "Missing the required parameter 'validate_operator_assignment_details' when calling validate_operator_assignment." if validate_operator_assignment_details.nil? raise "Parameter value for 'operator_control_assignment_id' must not be blank" if OCI::Internal::Util.blank_string?(operator_control_assignment_id) path = '/operatorControlAssignments/{operatorControlAssignmentId}/actions/validateAssignment'.sub('{operatorControlAssignmentId}', operator_control_assignment_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-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] 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 header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(validate_operator_assignment_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'OperatorControlAssignmentClient#validate_operator_assignment') 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 |