Class: OCI::Ons::NotificationDataPlaneClient
- Inherits:
-
Object
- Object
- OCI::Ons::NotificationDataPlaneClient
- Defined in:
- lib/oci/ons/notification_data_plane_client.rb
Overview
Use the Notification API to broadcast messages to distributed components by topic, using a publish-subscribe pattern. For information about managing topics, subscriptions, and messages, see [Notification Overview](/iaas/Content/Notification/Concepts/notificationoverview.htm).
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
-
#create_subscription(create_subscription_details, opts = {}) ⇒ Response
Creates a subscription for the specified topic.
-
#delete_subscription(subscription_id, opts = {}) ⇒ Response
Deletes the specified subscription.
-
#get_confirm_subscription(id, token, protocol, opts = {}) ⇒ Response
Gets the confirmation details for the specified subscription.
-
#get_subscription(subscription_id, opts = {}) ⇒ Response
Gets the specified subscription’s configuration information.
-
#get_unsubscription(id, token, protocol, opts = {}) ⇒ Response
Gets the unsubscription details for the specified subscription.
-
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ NotificationDataPlaneClient
constructor
Creates a new NotificationDataPlaneClient.
-
#list_subscriptions(compartment_id, opts = {}) ⇒ Response
Lists the subscriptions in the specified compartment or topic.
-
#logger ⇒ Logger
The logger for this client.
-
#publish_message(topic_id, message_details, opts = {}) ⇒ Response
Publishes a message to the specified topic.
-
#resend_subscription_confirmation(id, opts = {}) ⇒ Response
Resends the confirmation details for the specified subscription.
-
#update_subscription(subscription_id, update_subscription_details, opts = {}) ⇒ Response
Updates the specified subscription’s configuration.
Constructor Details
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ NotificationDataPlaneClient
Creates a new NotificationDataPlaneClient. 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.
53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 |
# File 'lib/oci/ons/notification_data_plane_client.rb', line 53 def initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) # If the signer is an InstancePrincipalsSecurityTokenSigner and no config was supplied (which is valid for instance principals) # 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 unless signer.is_a?(OCI::Auth::Signers::InstancePrincipalsSecurityTokenSigner) config ||= OCI::Config.new if signer.is_a?(OCI::Auth::Signers::InstancePrincipalsSecurityTokenSigner) config.validate unless signer.is_a?(OCI::Auth::Signers::InstancePrincipalsSecurityTokenSigner) if signer.nil? signer = OCI::Signer.new( config.user, config.fingerprint, config.tenancy, config.key_file, pass_phrase: config.pass_phrase, private_key_content: config.key_content ) end @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 "NotificationDataPlaneClient endpoint set to '#{@endpoint}'." if logger end |
Instance Attribute Details
#api_client ⇒ OCI::ApiClient (readonly)
Client used to make HTTP requests.
13 14 15 |
# File 'lib/oci/ons/notification_data_plane_client.rb', line 13 def api_client @api_client end |
#endpoint ⇒ String (readonly)
Fully qualified endpoint URL
17 18 19 |
# File 'lib/oci/ons/notification_data_plane_client.rb', line 17 def endpoint @endpoint end |
#region ⇒ String
The region, which will usually correspond to a value in Regions::REGION_ENUM.
27 28 29 |
# File 'lib/oci/ons/notification_data_plane_client.rb', line 27 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
23 24 25 |
# File 'lib/oci/ons/notification_data_plane_client.rb', line 23 def retry_config @retry_config end |
Instance Method Details
#create_subscription(create_subscription_details, opts = {}) ⇒ Response
Creates a subscription for the specified topic.
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 |
# File 'lib/oci/ons/notification_data_plane_client.rb', line 128 def create_subscription(create_subscription_details, opts = {}) logger.debug 'Calling operation NotificationDataPlaneClient#create_subscription.' if logger raise "Missing the required parameter 'create_subscription_details' when calling create_subscription." if create_subscription_details.nil? path = '/subscriptions' 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_subscription_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'NotificationDataPlaneClient#create_subscription') 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::Ons::Models::Subscription' ) end # rubocop:enable Metrics/BlockLength end |
#delete_subscription(subscription_id, opts = {}) ⇒ Response
Deletes the specified subscription.
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/ons/notification_data_plane_client.rb', line 190 def delete_subscription(subscription_id, opts = {}) logger.debug 'Calling operation NotificationDataPlaneClient#delete_subscription.' if logger raise "Missing the required parameter 'subscription_id' when calling delete_subscription." if subscription_id.nil? raise "Parameter value for 'subscription_id' must not be blank" if OCI::Internal::Util.blank_string?(subscription_id) path = '/subscriptions/{subscriptionId}'.sub('{subscriptionId}', subscription_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.(applicable_retry_config(opts), call_name: 'NotificationDataPlaneClient#delete_subscription') 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_confirm_subscription(id, token, protocol, opts = {}) ⇒ Response
Gets the confirmation details for the specified subscription.
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 283 284 285 286 287 288 289 290 |
# File 'lib/oci/ons/notification_data_plane_client.rb', line 250 def get_confirm_subscription(id, token, protocol, opts = {}) logger.debug 'Calling operation NotificationDataPlaneClient#get_confirm_subscription.' if logger raise "Missing the required parameter 'id' when calling get_confirm_subscription." if id.nil? raise "Missing the required parameter 'token' when calling get_confirm_subscription." if token.nil? raise "Missing the required parameter 'protocol' when calling get_confirm_subscription." if protocol.nil? raise "Parameter value for 'id' must not be blank" if OCI::Internal::Util.blank_string?(id) path = '/subscriptions/{id}/confirmation'.sub('{id}', id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:token] = token query_params[:protocol] = protocol # 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: 'NotificationDataPlaneClient#get_confirm_subscription') 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::Ons::Models::ConfirmationResult' ) end # rubocop:enable Metrics/BlockLength end |
#get_subscription(subscription_id, opts = {}) ⇒ Response
Gets the specified subscription’s configuration information.
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/ons/notification_data_plane_client.rb', line 311 def get_subscription(subscription_id, opts = {}) logger.debug 'Calling operation NotificationDataPlaneClient#get_subscription.' if logger raise "Missing the required parameter 'subscription_id' when calling get_subscription." if subscription_id.nil? raise "Parameter value for 'subscription_id' must not be blank" if OCI::Internal::Util.blank_string?(subscription_id) path = '/subscriptions/{subscriptionId}'.sub('{subscriptionId}', subscription_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: 'NotificationDataPlaneClient#get_subscription') 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::Ons::Models::Subscription' ) end # rubocop:enable Metrics/BlockLength end |
#get_unsubscription(id, token, protocol, opts = {}) ⇒ Response
Gets the unsubscription details for the specified subscription.
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 403 404 405 406 407 408 409 410 411 |
# File 'lib/oci/ons/notification_data_plane_client.rb', line 371 def get_unsubscription(id, token, protocol, opts = {}) logger.debug 'Calling operation NotificationDataPlaneClient#get_unsubscription.' if logger raise "Missing the required parameter 'id' when calling get_unsubscription." if id.nil? raise "Missing the required parameter 'token' when calling get_unsubscription." if token.nil? raise "Missing the required parameter 'protocol' when calling get_unsubscription." if protocol.nil? raise "Parameter value for 'id' must not be blank" if OCI::Internal::Util.blank_string?(id) path = '/subscriptions/{id}/unsubscription'.sub('{id}', id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:token] = token query_params[:protocol] = protocol # 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: 'NotificationDataPlaneClient#get_unsubscription') 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: 'String' ) end # rubocop:enable Metrics/BlockLength end |
#list_subscriptions(compartment_id, opts = {}) ⇒ Response
Lists the subscriptions in the specified compartment or topic.
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 |
# File 'lib/oci/ons/notification_data_plane_client.rb', line 438 def list_subscriptions(compartment_id, opts = {}) logger.debug 'Calling operation NotificationDataPlaneClient#list_subscriptions.' if logger raise "Missing the required parameter 'compartment_id' when calling list_subscriptions." if compartment_id.nil? path = '/subscriptions' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:topicId] = opts[:topic_id] if opts[:topic_id] query_params[:page] = opts[:page] if opts[:page] query_params[:limit] = opts[:limit] if opts[:limit] # 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: 'NotificationDataPlaneClient#list_subscriptions') 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::Ons::Models::SubscriptionSummary>' ) end # rubocop:enable Metrics/BlockLength end |
#logger ⇒ Logger
Returns The logger for this client. May be nil.
103 104 105 |
# File 'lib/oci/ons/notification_data_plane_client.rb', line 103 def logger @api_client.config.logger end |
#publish_message(topic_id, message_details, opts = {}) ⇒ Response
Publishes a message to the specified topic. For more information about publishing messages, see [Publishing Messages](docs.cloud.oracle.com/iaas/Content/Notification/Tasks/publishingmessages.htm).
Allowed values are: JSON, RAW_TEXT
502 503 504 505 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/ons/notification_data_plane_client.rb', line 502 def (topic_id, , opts = {}) logger.debug 'Calling operation NotificationDataPlaneClient#publish_message.' if logger raise "Missing the required parameter 'topic_id' when calling publish_message." if topic_id.nil? raise "Missing the required parameter 'message_details' when calling publish_message." if .nil? if opts[:message_type] && !%w[JSON RAW_TEXT].include?(opts[:message_type]) raise 'Invalid value for "message_type", must be one of JSON, RAW_TEXT.' end raise "Parameter value for 'topic_id' must not be blank" if OCI::Internal::Util.blank_string?(topic_id) path = '/topics/{topicId}/messages'.sub('{topicId}', topic_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[:messagetype] = opts[:message_type] if opts[:message_type] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body() # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'NotificationDataPlaneClient#publish_message') 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::Ons::Models::PublishResult' ) end # rubocop:enable Metrics/BlockLength end |
#resend_subscription_confirmation(id, opts = {}) ⇒ Response
Resends the confirmation details for the specified subscription.
565 566 567 568 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 |
# File 'lib/oci/ons/notification_data_plane_client.rb', line 565 def resend_subscription_confirmation(id, opts = {}) logger.debug 'Calling operation NotificationDataPlaneClient#resend_subscription_confirmation.' if logger raise "Missing the required parameter 'id' when calling resend_subscription_confirmation." if id.nil? raise "Parameter value for 'id' must not be blank" if OCI::Internal::Util.blank_string?(id) path = '/subscriptions/{id}/resendConfirmation'.sub('{id}', 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: 'NotificationDataPlaneClient#resend_subscription_confirmation') 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::Ons::Models::Subscription' ) end # rubocop:enable Metrics/BlockLength end |
#update_subscription(subscription_id, update_subscription_details, opts = {}) ⇒ Response
Updates the specified subscription’s configuration.
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 654 655 656 657 658 659 660 661 662 663 664 665 666 |
# File 'lib/oci/ons/notification_data_plane_client.rb', line 628 def update_subscription(subscription_id, update_subscription_details, opts = {}) logger.debug 'Calling operation NotificationDataPlaneClient#update_subscription.' if logger raise "Missing the required parameter 'subscription_id' when calling update_subscription." if subscription_id.nil? raise "Missing the required parameter 'update_subscription_details' when calling update_subscription." if update_subscription_details.nil? raise "Parameter value for 'subscription_id' must not be blank" if OCI::Internal::Util.blank_string?(subscription_id) path = '/subscriptions/{subscriptionId}'.sub('{subscriptionId}', subscription_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_subscription_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'NotificationDataPlaneClient#update_subscription') 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::Ons::Models::UpdateSubscriptionDetails' ) end # rubocop:enable Metrics/BlockLength end |