Class: OCI::Ons::NotificationControlPlaneClient
- Inherits:
-
Object
- Object
- OCI::Ons::NotificationControlPlaneClient
- Defined in:
- lib/oci/ons/notification_control_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](/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
-
#change_topic_compartment(topic_id, change_topic_compartment_details, opts = {}) ⇒ Response
Moves a topic into a different compartment within the same tenancy.
-
#create_topic(create_topic_details, opts = {}) ⇒ Response
Creates a topic in the specified compartment.
-
#delete_topic(topic_id, opts = {}) ⇒ Response
Deletes the specified topic.
-
#get_topic(topic_id, opts = {}) ⇒ Response
Gets the specified topic’s configuration information.
-
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ NotificationControlPlaneClient
constructor
Creates a new NotificationControlPlaneClient.
-
#list_topics(compartment_id, opts = {}) ⇒ Response
Lists topics in the specified compartment.
-
#logger ⇒ Logger
The logger for this client.
-
#update_topic(topic_id, opts = {}) ⇒ Response
Updates the specified topic’s configuration.
Constructor Details
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ NotificationControlPlaneClient
Creates a new NotificationControlPlaneClient. 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_control_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 "NotificationControlPlaneClient 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_control_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_control_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_control_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_control_plane_client.rb', line 23 def retry_config @retry_config end |
Instance Method Details
#change_topic_compartment(topic_id, change_topic_compartment_details, opts = {}) ⇒ Response
Moves a topic into a different compartment within the same tenancy. For information about moving resources between compartments, see [Moving Resources to a Different Compartment](docs.cloud.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).
Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.
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 171 172 173 174 175 176 177 |
# File 'lib/oci/ons/notification_control_plane_client.rb', line 138 def change_topic_compartment(topic_id, change_topic_compartment_details, opts = {}) logger.debug 'Calling operation NotificationControlPlaneClient#change_topic_compartment.' if logger raise "Missing the required parameter 'topic_id' when calling change_topic_compartment." if topic_id.nil? raise "Missing the required parameter 'change_topic_compartment_details' when calling change_topic_compartment." if change_topic_compartment_details.nil? raise "Parameter value for 'topic_id' must not be blank" if OCI::Internal::Util.blank_string?(topic_id) path = '/topics/{topicId}/actions/changeCompartment'.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-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_topic_compartment_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'NotificationControlPlaneClient#change_topic_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_topic(create_topic_details, opts = {}) ⇒ Response
Creates a topic in the specified compartment. For general information about topics, see [Managing Topics and Subscriptions](docs.cloud.oracle.com/iaas/Content/Notification/Tasks/managingtopicsandsubscriptions.htm).
For the purposes of access control, you must provide the OCID of the compartment where you want the topic to reside. For information about access control and compartments, see [Overview of the IAM Service](docs.cloud.oracle.com/Content/Identity/Concepts/overview.htm).
You must specify a display name for the topic.
All Oracle Cloud Infrastructure resources, including topics, get an Oracle-assigned, unique ID called an Oracle Cloud Identifier (OCID). When you create a resource, you can find its OCID in the response. You can also retrieve a resource’s OCID by using a List API operation on that resource type, or by viewing the resource in the Console. For more information, see [Resource Identifiers](docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm).
Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.
216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 |
# File 'lib/oci/ons/notification_control_plane_client.rb', line 216 def create_topic(create_topic_details, opts = {}) logger.debug 'Calling operation NotificationControlPlaneClient#create_topic.' if logger raise "Missing the required parameter 'create_topic_details' when calling create_topic." if create_topic_details.nil? path = '/topics' 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_topic_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'NotificationControlPlaneClient#create_topic') 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::NotificationTopic' ) end # rubocop:enable Metrics/BlockLength end |
#delete_topic(topic_id, opts = {}) ⇒ Response
Deletes the specified topic.
Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.
280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 |
# File 'lib/oci/ons/notification_control_plane_client.rb', line 280 def delete_topic(topic_id, opts = {}) logger.debug 'Calling operation NotificationControlPlaneClient#delete_topic.' if logger raise "Missing the required parameter 'topic_id' when calling delete_topic." if topic_id.nil? raise "Parameter value for 'topic_id' must not be blank" if OCI::Internal::Util.blank_string?(topic_id) path = '/topics/{topicId}'.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[:'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: 'NotificationControlPlaneClient#delete_topic') 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_topic(topic_id, opts = {}) ⇒ Response
Gets the specified topic’s configuration information.
339 340 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 |
# File 'lib/oci/ons/notification_control_plane_client.rb', line 339 def get_topic(topic_id, opts = {}) logger.debug 'Calling operation NotificationControlPlaneClient#get_topic.' if logger raise "Missing the required parameter 'topic_id' when calling get_topic." if topic_id.nil? raise "Parameter value for 'topic_id' must not be blank" if OCI::Internal::Util.blank_string?(topic_id) path = '/topics/{topicId}'.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] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'NotificationControlPlaneClient#get_topic') 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::NotificationTopic' ) end # rubocop:enable Metrics/BlockLength end |
#list_topics(compartment_id, opts = {}) ⇒ Response
Lists topics in the specified compartment.
Transactions Per Minute (TPM) per-tenancy limit for this operation: 120.
Allowed values are: TIMECREATED, LIFECYCLESTATE
Allowed values are: ASC, DESC
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 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 |
# File 'lib/oci/ons/notification_control_plane_client.rb', line 416 def list_topics(compartment_id, opts = {}) logger.debug 'Calling operation NotificationControlPlaneClient#list_topics.' if logger raise "Missing the required parameter 'compartment_id' when calling list_topics." if compartment_id.nil? if opts[:sort_by] && !%w[TIMECREATED LIFECYCLESTATE].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of TIMECREATED, LIFECYCLESTATE.' 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 if opts[:lifecycle_state] && !OCI::Ons::Models::NotificationTopicSummary::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state]) raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Ons::Models::NotificationTopicSummary::LIFECYCLE_STATE_ENUM.' end path = '/topics' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:id] = opts[:id] if opts[:id] query_params[:name] = opts[:name] if opts[:name] query_params[:page] = opts[:page] if opts[:page] query_params[:limit] = opts[:limit] if opts[:limit] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state] # 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: 'NotificationControlPlaneClient#list_topics') 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::NotificationTopicSummary>' ) 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_control_plane_client.rb', line 103 def logger @api_client.config.logger end |
#update_topic(topic_id, opts = {}) ⇒ Response
Updates the specified topic’s configuration.
Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.
499 500 501 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 |
# File 'lib/oci/ons/notification_control_plane_client.rb', line 499 def update_topic(topic_id, opts = {}) logger.debug 'Calling operation NotificationControlPlaneClient#update_topic.' if logger raise "Missing the required parameter 'topic_id' when calling update_topic." if topic_id.nil? raise "Parameter value for 'topic_id' must not be blank" if OCI::Internal::Util.blank_string?(topic_id) path = '/topics/{topicId}'.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[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(opts[:topic_attributes_details]) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'NotificationControlPlaneClient#update_topic') 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::NotificationTopic' ) end # rubocop:enable Metrics/BlockLength end |