Class: OCI::Apigateway::SubscribersClient
- Inherits:
-
Object
- Object
- OCI::Apigateway::SubscribersClient
- Defined in:
- lib/oci/apigateway/subscribers_client.rb
Overview
API for the API Gateway service. Use this API to manage gateways, deployments, and related items. For more information, see Overview of API Gateway.
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_subscriber_compartment(subscriber_id, change_subscriber_compartment_details, opts = {}) ⇒ Response
Changes the subscriber compartment.
-
#create_subscriber(create_subscriber_details, opts = {}) ⇒ Response
Creates a new subscriber.
-
#delete_subscriber(subscriber_id, opts = {}) ⇒ Response
Deletes the subscriber with the given identifier.
-
#get_subscriber(subscriber_id, opts = {}) ⇒ Response
Gets a subscriber by identifier.
-
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ SubscribersClient
constructor
Creates a new SubscribersClient.
-
#list_subscribers(compartment_id, opts = {}) ⇒ Response
Returns a list of subscribers.
-
#logger ⇒ Logger
The logger for this client.
-
#update_subscriber(subscriber_id, update_subscriber_details, opts = {}) ⇒ Response
Updates the subscriber with the given identifier.
Constructor Details
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ SubscribersClient
Creates a new SubscribersClient. 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.
57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 |
# File 'lib/oci/apigateway/subscribers_client.rb', line 57 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 + '/20190501' else region ||= config.region region ||= signer.region if signer.respond_to?(:region) self.region = region end logger.info "SubscribersClient endpoint set to '#{@endpoint}'." if logger end |
Instance Attribute Details
#api_client ⇒ OCI::ApiClient (readonly)
Client used to make HTTP requests.
17 18 19 |
# File 'lib/oci/apigateway/subscribers_client.rb', line 17 def api_client @api_client end |
#endpoint ⇒ String (readonly)
Fully qualified endpoint URL
21 22 23 |
# File 'lib/oci/apigateway/subscribers_client.rb', line 21 def endpoint @endpoint end |
#region ⇒ String
The region, which will usually correspond to a value in Regions::REGION_ENUM.
31 32 33 |
# File 'lib/oci/apigateway/subscribers_client.rb', line 31 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
27 28 29 |
# File 'lib/oci/apigateway/subscribers_client.rb', line 27 def retry_config @retry_config end |
Instance Method Details
#change_subscriber_compartment(subscriber_id, change_subscriber_compartment_details, opts = {}) ⇒ Response
Click here to see an example of how to use change_subscriber_compartment API.
Changes the subscriber compartment.
126 127 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/apigateway/subscribers_client.rb', line 126 def change_subscriber_compartment(subscriber_id, change_subscriber_compartment_details, opts = {}) logger.debug 'Calling operation SubscribersClient#change_subscriber_compartment.' if logger raise "Missing the required parameter 'subscriber_id' when calling change_subscriber_compartment." if subscriber_id.nil? raise "Missing the required parameter 'change_subscriber_compartment_details' when calling change_subscriber_compartment." if change_subscriber_compartment_details.nil? raise "Parameter value for 'subscriber_id' must not be blank" if OCI::Internal::Util.blank_string?(subscriber_id) path = '/subscribers/{subscriberId}/actions/changeCompartment'.sub('{subscriberId}', subscriber_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_subscriber_compartment_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'SubscribersClient#change_subscriber_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_subscriber(create_subscriber_details, opts = {}) ⇒ Response
Click here to see an example of how to use create_subscriber API.
Creates a new subscriber.
189 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/apigateway/subscribers_client.rb', line 189 def create_subscriber(create_subscriber_details, opts = {}) logger.debug 'Calling operation SubscribersClient#create_subscriber.' if logger raise "Missing the required parameter 'create_subscriber_details' when calling create_subscriber." if create_subscriber_details.nil? path = '/subscribers' 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_subscriber_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'SubscribersClient#create_subscriber') 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::Apigateway::Models::Subscriber' ) end # rubocop:enable Metrics/BlockLength end |
#delete_subscriber(subscriber_id, opts = {}) ⇒ Response
Click here to see an example of how to use delete_subscriber API.
Deletes the subscriber with the given identifier.
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 |
# File 'lib/oci/apigateway/subscribers_client.rb', line 250 def delete_subscriber(subscriber_id, opts = {}) logger.debug 'Calling operation SubscribersClient#delete_subscriber.' if logger raise "Missing the required parameter 'subscriber_id' when calling delete_subscriber." if subscriber_id.nil? raise "Parameter value for 'subscriber_id' must not be blank" if OCI::Internal::Util.blank_string?(subscriber_id) path = '/subscribers/{subscriberId}'.sub('{subscriberId}', subscriber_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: 'SubscribersClient#delete_subscriber') 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_subscriber(subscriber_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_subscriber API.
Gets a subscriber by identifier.
304 305 306 307 308 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 |
# File 'lib/oci/apigateway/subscribers_client.rb', line 304 def get_subscriber(subscriber_id, opts = {}) logger.debug 'Calling operation SubscribersClient#get_subscriber.' if logger raise "Missing the required parameter 'subscriber_id' when calling get_subscriber." if subscriber_id.nil? raise "Parameter value for 'subscriber_id' must not be blank" if OCI::Internal::Util.blank_string?(subscriber_id) path = '/subscribers/{subscriberId}'.sub('{subscriberId}', subscriber_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: 'SubscribersClient#get_subscriber') 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::Apigateway::Models::Subscriber' ) end # rubocop:enable Metrics/BlockLength end |
#list_subscribers(compartment_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_subscribers API.
Returns a list of subscribers.
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 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 |
# File 'lib/oci/apigateway/subscribers_client.rb', line 375 def list_subscribers(compartment_id, opts = {}) logger.debug 'Calling operation SubscribersClient#list_subscribers.' if logger raise "Missing the required parameter 'compartment_id' when calling list_subscribers." if compartment_id.nil? if opts[:lifecycle_state] && !OCI::Apigateway::Models::Subscriber::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state]) raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Apigateway::Models::Subscriber::LIFECYCLE_STATE_ENUM.' 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[:sort_by] && !%w[timeCreated displayName].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of timeCreated, displayName.' end path = '/subscribers' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:displayName] = opts[:display_name] if opts[:display_name] 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: 'SubscribersClient#list_subscribers') 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::Apigateway::Models::SubscriberCollection' ) end # rubocop:enable Metrics/BlockLength end |
#logger ⇒ Logger
Returns The logger for this client. May be nil.
96 97 98 |
# File 'lib/oci/apigateway/subscribers_client.rb', line 96 def logger @api_client.config.logger end |
#update_subscriber(subscriber_id, update_subscriber_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_subscriber API.
Updates the subscriber with the given identifier.
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 484 485 486 487 488 489 490 491 |
# File 'lib/oci/apigateway/subscribers_client.rb', line 454 def update_subscriber(subscriber_id, update_subscriber_details, opts = {}) logger.debug 'Calling operation SubscribersClient#update_subscriber.' if logger raise "Missing the required parameter 'subscriber_id' when calling update_subscriber." if subscriber_id.nil? raise "Missing the required parameter 'update_subscriber_details' when calling update_subscriber." if update_subscriber_details.nil? raise "Parameter value for 'subscriber_id' must not be blank" if OCI::Internal::Util.blank_string?(subscriber_id) path = '/subscribers/{subscriberId}'.sub('{subscriberId}', subscriber_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_subscriber_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'SubscribersClient#update_subscriber') 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 ) end # rubocop:enable Metrics/BlockLength end |