Class: OCI::Events::EventsClient
- Inherits:
-
Object
- Object
- OCI::Events::EventsClient
- Defined in:
- lib/oci/events/events_client.rb
Overview
API for the Events Service. Use this API to manage rules and actions that create automation in your tenancy. For more information, see Overview of Events.
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_rule_compartment(rule_id, change_rule_compartment_details, opts = {}) ⇒ Response
Moves a rule into a different compartment within the same tenancy.
-
#create_rule(create_rule_details, opts = {}) ⇒ Response
Creates a new rule.
-
#delete_rule(rule_id, opts = {}) ⇒ Response
Deletes a rule.
-
#get_rule(rule_id, opts = {}) ⇒ Response
Retrieves a rule.
-
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ EventsClient
constructor
Creates a new EventsClient.
-
#list_rules(compartment_id, opts = {}) ⇒ Response
Lists rules for this compartment.
-
#logger ⇒ Logger
The logger for this client.
-
#update_rule(rule_id, update_rule_details, opts = {}) ⇒ Response
Updates a rule.
Constructor Details
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ EventsClient
Creates a new EventsClient. 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.
56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 |
# File 'lib/oci/events/events_client.rb', line 56 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 + '/20181201' else region ||= config.region region ||= signer.region if signer.respond_to?(:region) self.region = region end logger.info "EventsClient endpoint set to '#{@endpoint}'." if logger end |
Instance Attribute Details
#api_client ⇒ OCI::ApiClient (readonly)
Client used to make HTTP requests.
16 17 18 |
# File 'lib/oci/events/events_client.rb', line 16 def api_client @api_client end |
#endpoint ⇒ String (readonly)
Fully qualified endpoint URL
20 21 22 |
# File 'lib/oci/events/events_client.rb', line 20 def endpoint @endpoint end |
#region ⇒ String
The region, which will usually correspond to a value in Regions::REGION_ENUM.
30 31 32 |
# File 'lib/oci/events/events_client.rb', line 30 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
26 27 28 |
# File 'lib/oci/events/events_client.rb', line 26 def retry_config @retry_config end |
Instance Method Details
#change_rule_compartment(rule_id, change_rule_compartment_details, opts = {}) ⇒ Response
Click here to see an example of how to use change_rule_compartment API.
Moves a rule into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
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/events/events_client.rb', line 128 def change_rule_compartment(rule_id, change_rule_compartment_details, opts = {}) logger.debug 'Calling operation EventsClient#change_rule_compartment.' if logger raise "Missing the required parameter 'rule_id' when calling change_rule_compartment." if rule_id.nil? raise "Missing the required parameter 'change_rule_compartment_details' when calling change_rule_compartment." if change_rule_compartment_details.nil? raise "Parameter value for 'rule_id' must not be blank" if OCI::Internal::Util.blank_string?(rule_id) path = '/rules/{ruleId}/actions/changeCompartment'.sub('{ruleId}', rule_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_rule_compartment_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'EventsClient#change_rule_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_rule(create_rule_details, opts = {}) ⇒ Response
Click here to see an example of how to use create_rule API.
Creates a new rule.
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 229 230 231 |
# File 'lib/oci/events/events_client.rb', line 194 def create_rule(create_rule_details, opts = {}) logger.debug 'Calling operation EventsClient#create_rule.' if logger raise "Missing the required parameter 'create_rule_details' when calling create_rule." if create_rule_details.nil? path = '/rules' 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_rule_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'EventsClient#create_rule') 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::Events::Models::Rule' ) end # rubocop:enable Metrics/BlockLength end |
#delete_rule(rule_id, opts = {}) ⇒ Response
Click here to see an example of how to use delete_rule API.
Deletes a rule.
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 |
# File 'lib/oci/events/events_client.rb', line 256 def delete_rule(rule_id, opts = {}) logger.debug 'Calling operation EventsClient#delete_rule.' if logger raise "Missing the required parameter 'rule_id' when calling delete_rule." if rule_id.nil? raise "Parameter value for 'rule_id' must not be blank" if OCI::Internal::Util.blank_string?(rule_id) path = '/rules/{ruleId}'.sub('{ruleId}', rule_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: 'EventsClient#delete_rule') 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_rule(rule_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_rule API.
Retrieves a rule.
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 349 |
# File 'lib/oci/events/events_client.rb', line 313 def get_rule(rule_id, opts = {}) logger.debug 'Calling operation EventsClient#get_rule.' if logger raise "Missing the required parameter 'rule_id' when calling get_rule." if rule_id.nil? raise "Parameter value for 'rule_id' must not be blank" if OCI::Internal::Util.blank_string?(rule_id) path = '/rules/{ruleId}'.sub('{ruleId}', rule_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: 'EventsClient#get_rule') 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::Events::Models::Rule' ) end # rubocop:enable Metrics/BlockLength end |
#list_rules(compartment_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_rules API.
Lists rules for this compartment.
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 443 444 445 446 447 448 449 450 451 452 453 454 455 456 |
# File 'lib/oci/events/events_client.rb', line 402 def list_rules(compartment_id, opts = {}) logger.debug 'Calling operation EventsClient#list_rules.' if logger raise "Missing the required parameter 'compartment_id' when calling list_rules." if compartment_id.nil? if opts[:lifecycle_state] && !OCI::Events::Models::Rule::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state]) raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Events::Models::Rule::LIFECYCLE_STATE_ENUM.' end if opts[:sort_by] && !%w[TIME_CREATED ID DISPLAY_NAME].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of TIME_CREATED, ID, DISPLAY_NAME.' end if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end path = '/rules' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state] query_params[:displayName] = opts[:display_name] if opts[:display_name] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] # 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: 'EventsClient#list_rules') 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: 'Array<OCI::Events::Models::RuleSummary>' ) end # rubocop:enable Metrics/BlockLength end |
#logger ⇒ Logger
Returns The logger for this client. May be nil.
95 96 97 |
# File 'lib/oci/events/events_client.rb', line 95 def logger @api_client.config.logger end |
#update_rule(rule_id, update_rule_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_rule API.
Updates a rule.
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 509 510 511 512 513 514 515 516 517 518 519 520 521 |
# File 'lib/oci/events/events_client.rb', line 483 def update_rule(rule_id, update_rule_details, opts = {}) logger.debug 'Calling operation EventsClient#update_rule.' if logger raise "Missing the required parameter 'rule_id' when calling update_rule." if rule_id.nil? raise "Missing the required parameter 'update_rule_details' when calling update_rule." if update_rule_details.nil? raise "Parameter value for 'rule_id' must not be blank" if OCI::Internal::Util.blank_string?(rule_id) path = '/rules/{ruleId}'.sub('{ruleId}', rule_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_rule_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'EventsClient#update_rule') 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::Events::Models::Rule' ) end # rubocop:enable Metrics/BlockLength end |