Class: OCI::Ons::NotificationDataPlaneClient
- Inherits:
-
Object
- Object
- OCI::Ons::NotificationDataPlaneClient
- Defined in:
- lib/oci/ons/notification_data_plane_client.rb
Overview
Use the Notifications API to broadcast messages to distributed components by topic, using a publish-subscribe pattern. For information about managing topics, subscriptions, and messages, see Notifications Overview.
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_subscription_compartment(subscription_id, change_subscription_compartment_details, opts = {}) ⇒ Response
Moves a subscription into a different compartment within the same tenancy.
-
#create_subscription(create_subscription_details, opts = {}) ⇒ Response
Creates a subscription for the specified topic and sends a subscription confirmation URL to the endpoint.
-
#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
Unsubscribes the subscription from the topic.
-
#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.
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/ons/notification_data_plane_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 "NotificationDataPlaneClient 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/ons/notification_data_plane_client.rb', line 16 def api_client @api_client end |
#endpoint ⇒ String (readonly)
Fully qualified endpoint URL
20 21 22 |
# File 'lib/oci/ons/notification_data_plane_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/ons/notification_data_plane_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/ons/notification_data_plane_client.rb', line 26 def retry_config @retry_config end |
Instance Method Details
#change_subscription_compartment(subscription_id, change_subscription_compartment_details, opts = {}) ⇒ Response
Click here to see an example of how to use change_subscription_compartment API.
Moves a subscription into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.
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 168 169 170 |
# File 'lib/oci/ons/notification_data_plane_client.rb', line 131 def change_subscription_compartment(subscription_id, change_subscription_compartment_details, opts = {}) logger.debug 'Calling operation NotificationDataPlaneClient#change_subscription_compartment.' if logger raise "Missing the required parameter 'subscription_id' when calling change_subscription_compartment." if subscription_id.nil? raise "Missing the required parameter 'change_subscription_compartment_details' when calling change_subscription_compartment." if change_subscription_compartment_details.nil? raise "Parameter value for 'subscription_id' must not be blank" if OCI::Internal::Util.blank_string?(subscription_id) path = '/subscriptions/{subscriptionId}/actions/changeCompartment'.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-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] header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(change_subscription_compartment_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'NotificationDataPlaneClient#change_subscription_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_subscription(create_subscription_details, opts = {}) ⇒ Response
Click here to see an example of how to use create_subscription API.
Creates a subscription for the specified topic and sends a subscription confirmation URL to the endpoint. The subscription remains in "Pending" status until it has been confirmed. For information about confirming subscriptions, see To confirm a subscription.
Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.
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 232 233 234 235 236 237 238 |
# File 'lib/oci/ons/notification_data_plane_client.rb', line 201 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
Click here to see an example of how to use delete_subscription API.
Deletes the specified subscription.
Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.
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 295 296 297 298 299 300 301 302 |
# File 'lib/oci/ons/notification_data_plane_client.rb', line 266 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
Click here to see an example of how to use get_confirm_subscription API.
Gets the confirmation details for the specified subscription.
Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.
341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 |
# File 'lib/oci/ons/notification_data_plane_client.rb', line 341 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
Click here to see an example of how to use get_subscription API.
Gets the specified subscription's configuration information.
Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.
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 |
# File 'lib/oci/ons/notification_data_plane_client.rb', line 405 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
Click here to see an example of how to use get_unsubscription API.
Unsubscribes the subscription from the topic.
Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.
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 509 510 511 512 513 514 515 516 517 518 519 520 |
# File 'lib/oci/ons/notification_data_plane_client.rb', line 480 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
Click here to see an example of how to use list_subscriptions API.
Lists the subscriptions in the specified compartment or topic.
Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.
552 553 554 555 556 557 558 559 560 561 562 563 564 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 |
# File 'lib/oci/ons/notification_data_plane_client.rb', line 552 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.
95 96 97 |
# File 'lib/oci/ons/notification_data_plane_client.rb', line 95 def logger @api_client.config.logger end |
#publish_message(topic_id, message_details, opts = {}) ⇒ Response
Click here to see an example of how to use publish_message API.
Publishes a message to the specified topic.
The topic endpoint is required for this operation. To get the topic endpoint, use get_topic and review the apiEndpoint
value in the response (NotificationTopic).
Limits information follows.
Message size limit per request: 64KB.
Message delivery rate limit per endpoint: 60 messages per minute for HTTP-based protocols, 10 messages per minute for the EMAIL
protocol. HTTP-based protocols use URL endpoints that begin with "http:" or "https:".
Transactions Per Minute (TPM) per-tenancy limit for this operation: 60 per topic. (This TPM limit represents messages per minute.)
For more information about publishing messages, see Publishing Messages. For steps to request a limit increase, see Requesting a Service Limit Increase.
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 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 |
# File 'lib/oci/ons/notification_data_plane_client.rb', line 639 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
Click here to see an example of how to use resend_subscription_confirmation API.
Resends the confirmation details for the specified subscription.
Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.
705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 |
# File 'lib/oci/ons/notification_data_plane_client.rb', line 705 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
Click here to see an example of how to use update_subscription API.
Updates the specified subscription's configuration.
Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.
771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 |
# File 'lib/oci/ons/notification_data_plane_client.rb', line 771 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 |