Class: OCI::Waas::RedirectClient
- Inherits:
-
Object
- Object
- OCI::Waas::RedirectClient
- Defined in:
- lib/oci/waas/redirect_client.rb
Overview
OCI Web Application Acceleration and Security Services
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_http_redirect_compartment(http_redirect_id, change_http_redirect_compartment_details, opts = {}) ⇒ Response
Moves HTTP Redirect into a different compartment.
-
#create_http_redirect(create_http_redirect_details, opts = {}) ⇒ Response
Creates a new HTTP Redirect on the WAF edge.
-
#delete_http_redirect(http_redirect_id, opts = {}) ⇒ Response
Deletes a redirect.
-
#get_http_redirect(http_redirect_id, opts = {}) ⇒ Response
Gets the details of a HTTP Redirect.
-
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ RedirectClient
constructor
Creates a new RedirectClient.
-
#list_http_redirects(compartment_id, opts = {}) ⇒ Response
Gets a list of HTTP Redirects.
-
#logger ⇒ Logger
The logger for this client.
-
#update_http_redirect(http_redirect_id, update_http_redirect_details, opts = {}) ⇒ Response
Updates the details of a HTTP Redirect, including target and tags.
Constructor Details
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ RedirectClient
Creates a new RedirectClient. 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.
55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 |
# File 'lib/oci/waas/redirect_client.rb', line 55 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 + '/20181116' else region ||= config.region region ||= signer.region if signer.respond_to?(:region) self.region = region end logger.info "RedirectClient endpoint set to '#{@endpoint}'." if logger end |
Instance Attribute Details
#api_client ⇒ OCI::ApiClient (readonly)
Client used to make HTTP requests.
15 16 17 |
# File 'lib/oci/waas/redirect_client.rb', line 15 def api_client @api_client end |
#endpoint ⇒ String (readonly)
Fully qualified endpoint URL
19 20 21 |
# File 'lib/oci/waas/redirect_client.rb', line 19 def endpoint @endpoint end |
#region ⇒ String
The region, which will usually correspond to a value in Regions::REGION_ENUM.
29 30 31 |
# File 'lib/oci/waas/redirect_client.rb', line 29 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
25 26 27 |
# File 'lib/oci/waas/redirect_client.rb', line 25 def retry_config @retry_config end |
Instance Method Details
#change_http_redirect_compartment(http_redirect_id, change_http_redirect_compartment_details, opts = {}) ⇒ Response
Click here to see an example of how to use change_http_redirect_compartment API.
Moves HTTP Redirect into a different compartment. When provided, If-Match is checked against ETag values of the WAAS policy.
115 116 117 118 119 120 121 122 123 124 125 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 |
# File 'lib/oci/waas/redirect_client.rb', line 115 def change_http_redirect_compartment(http_redirect_id, change_http_redirect_compartment_details, opts = {}) logger.debug 'Calling operation RedirectClient#change_http_redirect_compartment.' if logger raise "Missing the required parameter 'http_redirect_id' when calling change_http_redirect_compartment." if http_redirect_id.nil? raise "Missing the required parameter 'change_http_redirect_compartment_details' when calling change_http_redirect_compartment." if change_http_redirect_compartment_details.nil? raise "Parameter value for 'http_redirect_id' must not be blank" if OCI::Internal::Util.blank_string?(http_redirect_id) path = '/httpRedirects/{httpRedirectId}/actions/changeCompartment'.sub('{httpRedirectId}', http_redirect_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_http_redirect_compartment_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'RedirectClient#change_http_redirect_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_http_redirect(create_http_redirect_details, opts = {}) ⇒ Response
Click here to see an example of how to use create_http_redirect API.
Creates a new HTTP Redirect on the WAF edge.
174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 |
# File 'lib/oci/waas/redirect_client.rb', line 174 def create_http_redirect(create_http_redirect_details, opts = {}) logger.debug 'Calling operation RedirectClient#create_http_redirect.' if logger raise "Missing the required parameter 'create_http_redirect_details' when calling create_http_redirect." if create_http_redirect_details.nil? path = '/httpRedirects' 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[:'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(create_http_redirect_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'RedirectClient#create_http_redirect') 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 |
#delete_http_redirect(http_redirect_id, opts = {}) ⇒ Response
Click here to see an example of how to use delete_http_redirect API.
Deletes a redirect.
231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 |
# File 'lib/oci/waas/redirect_client.rb', line 231 def delete_http_redirect(http_redirect_id, opts = {}) logger.debug 'Calling operation RedirectClient#delete_http_redirect.' if logger raise "Missing the required parameter 'http_redirect_id' when calling delete_http_redirect." if http_redirect_id.nil? raise "Parameter value for 'http_redirect_id' must not be blank" if OCI::Internal::Util.blank_string?(http_redirect_id) path = '/httpRedirects/{httpRedirectId}'.sub('{httpRedirectId}', http_redirect_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[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] 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 = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'RedirectClient#delete_http_redirect') 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_http_redirect(http_redirect_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_http_redirect API.
Gets the details of a HTTP Redirect.
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 317 318 319 320 321 322 323 |
# File 'lib/oci/waas/redirect_client.rb', line 287 def get_http_redirect(http_redirect_id, opts = {}) logger.debug 'Calling operation RedirectClient#get_http_redirect.' if logger raise "Missing the required parameter 'http_redirect_id' when calling get_http_redirect." if http_redirect_id.nil? raise "Parameter value for 'http_redirect_id' must not be blank" if OCI::Internal::Util.blank_string?(http_redirect_id) path = '/httpRedirects/{httpRedirectId}'.sub('{httpRedirectId}', http_redirect_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: 'RedirectClient#get_http_redirect') 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::Waas::Models::HttpRedirect' ) end # rubocop:enable Metrics/BlockLength end |
#list_http_redirects(compartment_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_http_redirects API.
Gets a list of HTTP Redirects.
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 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 |
# File 'lib/oci/waas/redirect_client.rb', line 353 def list_http_redirects(compartment_id, opts = {}) logger.debug 'Calling operation RedirectClient#list_http_redirects.' if logger raise "Missing the required parameter 'compartment_id' when calling list_http_redirects." if compartment_id.nil? 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[id domain target displayName].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of id, domain, target, displayName.' end lifecycle_state_allowable_values = %w[CREATING ACTIVE FAILED UPDATING DELETING DELETED] if opts[:lifecycle_state] && !opts[:lifecycle_state].empty? opts[:lifecycle_state].each do |val_to_check| unless lifecycle_state_allowable_values.include?(val_to_check) raise 'Invalid value for "lifecycle_state", must be one of CREATING, ACTIVE, FAILED, UPDATING, DELETING, DELETED.' end end end path = '/httpRedirects' 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[:sortOrder] = opts[:sort_order] if opts[:sort_order] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] query_params[:id] = OCI::ApiClient.build_collection_params(opts[:id], :multi) if opts[:id] && !opts[:id].empty? query_params[:displayName] = OCI::ApiClient.build_collection_params(opts[:display_name], :multi) if opts[:display_name] && !opts[:display_name].empty? query_params[:lifecycleState] = OCI::ApiClient.build_collection_params(opts[:lifecycle_state], :multi) if opts[:lifecycle_state] && !opts[:lifecycle_state].empty? query_params[:timeCreatedGreaterThanOrEqualTo] = opts[:time_created_greater_than_or_equal_to] if opts[:time_created_greater_than_or_equal_to] query_params[:timeCreatedLessThan] = opts[:time_created_less_than] if opts[:time_created_less_than] # 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: 'RedirectClient#list_http_redirects') 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::Waas::Models::HttpRedirectSummary>' ) end # rubocop:enable Metrics/BlockLength end |
#logger ⇒ Logger
Returns The logger for this client. May be nil.
94 95 96 |
# File 'lib/oci/waas/redirect_client.rb', line 94 def logger @api_client.config.logger end |
#update_http_redirect(http_redirect_id, update_http_redirect_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_http_redirect API.
Updates the details of a HTTP Redirect, including target and tags. Only the fields specified in the request body will be updated; all other properties will remain unchanged.
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/waas/redirect_client.rb', line 438 def update_http_redirect(http_redirect_id, update_http_redirect_details, opts = {}) logger.debug 'Calling operation RedirectClient#update_http_redirect.' if logger raise "Missing the required parameter 'http_redirect_id' when calling update_http_redirect." if http_redirect_id.nil? raise "Missing the required parameter 'update_http_redirect_details' when calling update_http_redirect." if update_http_redirect_details.nil? raise "Parameter value for 'http_redirect_id' must not be blank" if OCI::Internal::Util.blank_string?(http_redirect_id) path = '/httpRedirects/{httpRedirectId}'.sub('{httpRedirectId}', http_redirect_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[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] 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(update_http_redirect_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'RedirectClient#update_http_redirect') 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 |