Class: OCI::Waa::WaaClient

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/waa/waa_client.rb

Overview

API for the Web Application Acceleration service. Use this API to manage regional Web App Acceleration policies such as Caching and Compression for accelerating HTTP services.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ WaaClient

Creates a new WaaClient. 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.

Parameters:

  • config (Config) (defaults to: nil) —

    A Config object.

  • region (String) (defaults to: nil) —

    A region used to determine the service endpoint. This will usually correspond to a value in Regions::REGION_ENUM, but may be an arbitrary string.

  • endpoint (String) (defaults to: nil) —

    The fully qualified endpoint URL

  • signer (OCI::BaseSigner) (defaults to: nil) —

    A signer implementation which can be used by this client. If this is not provided then a signer will be constructed via the provided config. One use case of this parameter is instance principals authentication, so that the instance principals signer can be provided to the client

  • proxy_settings (OCI::ApiClientProxySettings) (defaults to: nil) —

    If your environment requires you to use a proxy server for outgoing HTTP requests the details for the proxy can be provided in this parameter

  • retry_config (OCI::Retry::RetryConfig) (defaults to: nil) —

    The retry configuration for this service client. This represents the default retry configuration to apply across all operations. 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



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/waa/waa_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 + '/20211230'
  else
    region ||= config.region
    region ||= signer.region if signer.respond_to?(:region)
    self.region = region
  end
  logger.info "WaaClient endpoint set to '#{@endpoint}'." if logger
end

Instance Attribute Details

#api_client ⇒ OCI::ApiClient (readonly)

Client used to make HTTP requests.

Returns:



17
18
19
 
# File 'lib/oci/waa/waa_client.rb', line 17

def api_client
  @api_client
end

#endpoint ⇒ String (readonly)

Fully qualified endpoint URL

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/waa/waa_client.rb', line 21

def endpoint
  @endpoint
end

#region ⇒ String

The region, which will usually correspond to a value in Regions::REGION_ENUM.

Returns:

  • (String) 


31
32
33
 
# File 'lib/oci/waa/waa_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

Returns:



27
28
29
 
# File 'lib/oci/waa/waa_client.rb', line 27

def retry_config
  @retry_config
end

Instance Method Details

#change_web_app_acceleration_compartment(web_app_acceleration_id, change_web_app_acceleration_compartment_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use change_web_app_acceleration_compartment API.

Moves a Web App Acceleration resource from one compartment to another. When provided, If-Match is checked against ETag values of the resource.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



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
155
156
157
 
# File 'lib/oci/waa/waa_client.rb', line 120

def change_web_app_acceleration_compartment(web_app_acceleration_id, change_web_app_acceleration_compartment_details, opts = {})
  logger.debug 'Calling operation WaaClient#change_web_app_acceleration_compartment.' if logger

  raise "Missing the required parameter 'web_app_acceleration_id' when calling change_web_app_acceleration_compartment." if web_app_acceleration_id.nil?
  raise "Missing the required parameter 'change_web_app_acceleration_compartment_details' when calling change_web_app_acceleration_compartment." if change_web_app_acceleration_compartment_details.nil?
  raise "Parameter value for 'web_app_acceleration_id' must not be blank" if OCI::Internal::Util.blank_string?(web_app_acceleration_id)

  path = '/webAppAccelerations/{webAppAccelerationId}/actions/changeCompartment'.sub('{webAppAccelerationId}', web_app_acceleration_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(change_web_app_acceleration_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'WaaClient#change_web_app_acceleration_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

#change_web_app_acceleration_policy_compartment(web_app_acceleration_policy_id, change_web_app_acceleration_policy_compartment_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use change_web_app_acceleration_policy_compartment API.

Moves a WebAppAccelerationfPolicy resource from one compartment to another. When provided, If-Match is checked against ETag values of the resource.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



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
211
212
213
214
215
216
217
218
219
 
# File 'lib/oci/waa/waa_client.rb', line 182

def change_web_app_acceleration_policy_compartment(web_app_acceleration_policy_id, change_web_app_acceleration_policy_compartment_details, opts = {})
  logger.debug 'Calling operation WaaClient#change_web_app_acceleration_policy_compartment.' if logger

  raise "Missing the required parameter 'web_app_acceleration_policy_id' when calling change_web_app_acceleration_policy_compartment." if web_app_acceleration_policy_id.nil?
  raise "Missing the required parameter 'change_web_app_acceleration_policy_compartment_details' when calling change_web_app_acceleration_policy_compartment." if change_web_app_acceleration_policy_compartment_details.nil?
  raise "Parameter value for 'web_app_acceleration_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(web_app_acceleration_policy_id)

  path = '/webAppAccelerationPolicies/{webAppAccelerationPolicyId}/actions/changeCompartment'.sub('{webAppAccelerationPolicyId}', web_app_acceleration_policy_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(change_web_app_acceleration_policy_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'WaaClient#change_web_app_acceleration_policy_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_web_app_acceleration(create_web_app_acceleration_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_web_app_acceleration API.

Creates a new WebAppAcceleration.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



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
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/oci/waa/waa_client.rb', line 243

def create_web_app_acceleration(create_web_app_acceleration_details, opts = {})
  logger.debug 'Calling operation WaaClient#create_web_app_acceleration.' if logger

  raise "Missing the required parameter 'create_web_app_acceleration_details' when calling create_web_app_acceleration." if create_web_app_acceleration_details.nil?

  path = '/webAppAccelerations'
  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_web_app_acceleration_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'WaaClient#create_web_app_acceleration') 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::Waa::Models::WebAppAcceleration'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_web_app_acceleration_policy(create_web_app_acceleration_policy_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_web_app_acceleration_policy API.

Creates a new WebAppAccelerationPolicy.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



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
341
 
# File 'lib/oci/waa/waa_client.rb', line 304

def create_web_app_acceleration_policy(create_web_app_acceleration_policy_details, opts = {})
  logger.debug 'Calling operation WaaClient#create_web_app_acceleration_policy.' if logger

  raise "Missing the required parameter 'create_web_app_acceleration_policy_details' when calling create_web_app_acceleration_policy." if create_web_app_acceleration_policy_details.nil?

  path = '/webAppAccelerationPolicies'
  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_web_app_acceleration_policy_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'WaaClient#create_web_app_acceleration_policy') 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::Waa::Models::WebAppAccelerationPolicy'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_web_app_acceleration(web_app_acceleration_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_web_app_acceleration API.

Deletes a WebAppAcceleration resource identified by the OCID.

Parameters:

  • web_app_acceleration_id (String) —

    The OCID of the WebAppAcceleration.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



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
 
# File 'lib/oci/waa/waa_client.rb', line 363

def delete_web_app_acceleration(web_app_acceleration_id, opts = {})
  logger.debug 'Calling operation WaaClient#delete_web_app_acceleration.' if logger

  raise "Missing the required parameter 'web_app_acceleration_id' when calling delete_web_app_acceleration." if web_app_acceleration_id.nil?
  raise "Parameter value for 'web_app_acceleration_id' must not be blank" if OCI::Internal::Util.blank_string?(web_app_acceleration_id)

  path = '/webAppAccelerations/{webAppAccelerationId}'.sub('{webAppAccelerationId}', web_app_acceleration_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.make_retrying_call(applicable_retry_config(opts), call_name: 'WaaClient#delete_web_app_acceleration') 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

#delete_web_app_acceleration_policy(web_app_acceleration_policy_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_web_app_acceleration_policy API.

Deletes a WebAppAccelerationPolicy resource identified by the OCID.

Parameters:

  • web_app_acceleration_policy_id (String) —

    The OCID of the WebAppAccelerationPolicy.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



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
 
# File 'lib/oci/waa/waa_client.rb', line 421

def delete_web_app_acceleration_policy(web_app_acceleration_policy_id, opts = {})
  logger.debug 'Calling operation WaaClient#delete_web_app_acceleration_policy.' if logger

  raise "Missing the required parameter 'web_app_acceleration_policy_id' when calling delete_web_app_acceleration_policy." if web_app_acceleration_policy_id.nil?
  raise "Parameter value for 'web_app_acceleration_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(web_app_acceleration_policy_id)

  path = '/webAppAccelerationPolicies/{webAppAccelerationPolicyId}'.sub('{webAppAccelerationPolicyId}', web_app_acceleration_policy_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.make_retrying_call(applicable_retry_config(opts), call_name: 'WaaClient#delete_web_app_acceleration_policy') 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_web_app_acceleration(web_app_acceleration_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_web_app_acceleration API.

Gets a WebAppAcceleration by OCID.

Parameters:

  • web_app_acceleration_id (String) —

    The OCID of the WebAppAcceleration.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



475
476
477
478
479
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
 
# File 'lib/oci/waa/waa_client.rb', line 475

def get_web_app_acceleration(web_app_acceleration_id, opts = {})
  logger.debug 'Calling operation WaaClient#get_web_app_acceleration.' if logger

  raise "Missing the required parameter 'web_app_acceleration_id' when calling get_web_app_acceleration." if web_app_acceleration_id.nil?
  raise "Parameter value for 'web_app_acceleration_id' must not be blank" if OCI::Internal::Util.blank_string?(web_app_acceleration_id)

  path = '/webAppAccelerations/{webAppAccelerationId}'.sub('{webAppAccelerationId}', web_app_acceleration_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.make_retrying_call(applicable_retry_config(opts), call_name: 'WaaClient#get_web_app_acceleration') 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::Waa::Models::WebAppAcceleration'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_web_app_acceleration_policy(web_app_acceleration_policy_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_web_app_acceleration_policy API.

Gets a WebAppAccelerationPolicy with the given OCID.

Parameters:

  • web_app_acceleration_policy_id (String) —

    The OCID of the WebAppAccelerationPolicy.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
 
# File 'lib/oci/waa/waa_client.rb', line 529

def get_web_app_acceleration_policy(web_app_acceleration_policy_id, opts = {})
  logger.debug 'Calling operation WaaClient#get_web_app_acceleration_policy.' if logger

  raise "Missing the required parameter 'web_app_acceleration_policy_id' when calling get_web_app_acceleration_policy." if web_app_acceleration_policy_id.nil?
  raise "Parameter value for 'web_app_acceleration_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(web_app_acceleration_policy_id)

  path = '/webAppAccelerationPolicies/{webAppAccelerationPolicyId}'.sub('{webAppAccelerationPolicyId}', web_app_acceleration_policy_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.make_retrying_call(applicable_retry_config(opts), call_name: 'WaaClient#get_web_app_acceleration_policy') 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::Waa::Models::WebAppAccelerationPolicy'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_web_app_acceleration_policies(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_web_app_acceleration_policies API.

Gets a list of all WebAppAccelerationPolicies in a compartment.

Parameters:

  • compartment_id (String) —

    The OCID of the compartment in which to list resources.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :lifecycle_state (Array<OCI::Waa::Models::OCI::Waa::Models::WebAppAccelerationPolicyLifecycleState>) —

    A filter to return only resources that match the given lifecycleState.

  • :display_name (String) —

    A filter to return only resources that match the entire display name given.

  • :id (String) —

    A filter to return only the WebAppAccelerationPolicy with the given OCID.

  • :limit (Integer) —

    The maximum number of items to return. (default to 100)

  • :page (String) —

    A token representing the position at which to start retrieving results. This must come from the opc-next-page header field of a previous response.

  • :sort_order (String) —

    The sort order to use, either 'ASC' or 'DESC'.

  • :sort_by (String) —

    The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default. (default to timeCreated) Allowed values are: timeCreated, displayName

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
 
# File 'lib/oci/waa/waa_client.rb', line 598

def list_web_app_acceleration_policies(compartment_id, opts = {})
  logger.debug 'Calling operation WaaClient#list_web_app_acceleration_policies.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_web_app_acceleration_policies." if compartment_id.nil?

  if opts[:sort_order] && !OCI::Waa::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::Waa::Models::SORT_ORDER_ENUM.'
  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 = '/webAppAccelerationPolicies'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:lifecycleState] = OCI::ApiClient.build_collection_params(opts[:lifecycle_state], :multi) if opts[:lifecycle_state] && !opts[:lifecycle_state].empty?
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:id] = opts[:id] if opts[: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]

  # 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.make_retrying_call(applicable_retry_config(opts), call_name: 'WaaClient#list_web_app_acceleration_policies') 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::Waa::Models::WebAppAccelerationPolicyCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_web_app_accelerations(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_web_app_accelerations API.

Gets a list of all WebAppAccelerations in a compartment.

Parameters:

  • compartment_id (String) —

    The OCID of the compartment in which to list resources.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :id (String) —

    A filter to return only the WebAppAcceleration with the given OCID.

  • :web_app_acceleration_policy_id (String) —

    A filter to return only the WebAppAcceleration with the given OCID of related WebAppAccelerationPolicy.

  • :lifecycle_state (Array<OCI::Waa::Models::OCI::Waa::Models::WebAppAccelerationLifecycleState>) —

    A filter to return only resources that match the given lifecycleState.

  • :display_name (String) —

    A filter to return only resources that match the entire display name given.

  • :limit (Integer) —

    The maximum number of items to return. (default to 100)

  • :page (String) —

    A token representing the position at which to start retrieving results. This must come from the opc-next-page header field of a previous response.

  • :sort_order (String) —

    The sort order to use, either 'ASC' or 'DESC'.

  • :sort_by (String) —

    The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default. (default to timeCreated) Allowed values are: timeCreated, displayName

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
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
 
# File 'lib/oci/waa/waa_client.rb', line 685

def list_web_app_accelerations(compartment_id, opts = {})
  logger.debug 'Calling operation WaaClient#list_web_app_accelerations.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_web_app_accelerations." if compartment_id.nil?

  if opts[:sort_order] && !OCI::Waa::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::Waa::Models::SORT_ORDER_ENUM.'
  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 = '/webAppAccelerations'
  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[:webAppAccelerationPolicyId] = opts[:web_app_acceleration_policy_id] if opts[:web_app_acceleration_policy_id]
  query_params[:lifecycleState] = OCI::ApiClient.build_collection_params(opts[:lifecycle_state], :multi) if opts[:lifecycle_state] && !opts[:lifecycle_state].empty?
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  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.make_retrying_call(applicable_retry_config(opts), call_name: 'WaaClient#list_web_app_accelerations') 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::Waa::Models::WebAppAccelerationCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#logger ⇒ Logger

Returns The logger for this client. May be nil.

Returns:

  • (Logger) —

    The logger for this client. May be nil.



96
97
98
 
# File 'lib/oci/waa/waa_client.rb', line 96

def logger
  @api_client.config.logger
end

#purge_web_app_acceleration_cache(web_app_acceleration_id, purge_web_app_acceleration_cache_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use purge_web_app_acceleration_cache API.

Clears resources from the cache of the WebAppAcceleration. Each new request for a purged resource will be forwarded to the origin server to fetch a new version of the resource.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
 
# File 'lib/oci/waa/waa_client.rb', line 758

def purge_web_app_acceleration_cache(web_app_acceleration_id, purge_web_app_acceleration_cache_details, opts = {})
  logger.debug 'Calling operation WaaClient#purge_web_app_acceleration_cache.' if logger

  raise "Missing the required parameter 'web_app_acceleration_id' when calling purge_web_app_acceleration_cache." if web_app_acceleration_id.nil?
  raise "Missing the required parameter 'purge_web_app_acceleration_cache_details' when calling purge_web_app_acceleration_cache." if purge_web_app_acceleration_cache_details.nil?
  raise "Parameter value for 'web_app_acceleration_id' must not be blank" if OCI::Internal::Util.blank_string?(web_app_acceleration_id)

  path = '/webAppAccelerations/{webAppAccelerationId}/actions/purgeCache'.sub('{webAppAccelerationId}', web_app_acceleration_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 = @api_client.object_to_http_body(purge_web_app_acceleration_cache_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'WaaClient#purge_web_app_acceleration_cache') 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

#update_web_app_acceleration(web_app_acceleration_id, update_web_app_acceleration_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_web_app_acceleration API.

Updates the WebAppAcceleration identified by the OCID.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
 
# File 'lib/oci/waa/waa_client.rb', line 817

def update_web_app_acceleration(web_app_acceleration_id, update_web_app_acceleration_details, opts = {})
  logger.debug 'Calling operation WaaClient#update_web_app_acceleration.' if logger

  raise "Missing the required parameter 'web_app_acceleration_id' when calling update_web_app_acceleration." if web_app_acceleration_id.nil?
  raise "Missing the required parameter 'update_web_app_acceleration_details' when calling update_web_app_acceleration." if update_web_app_acceleration_details.nil?
  raise "Parameter value for 'web_app_acceleration_id' must not be blank" if OCI::Internal::Util.blank_string?(web_app_acceleration_id)

  path = '/webAppAccelerations/{webAppAccelerationId}'.sub('{webAppAccelerationId}', web_app_acceleration_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_web_app_acceleration_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'WaaClient#update_web_app_acceleration') 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

#update_web_app_acceleration_policy(web_app_acceleration_policy_id, update_web_app_acceleration_policy_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_web_app_acceleration_policy API.

Update the WebAppAccelerationPolicy identified by the OCID.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
 
# File 'lib/oci/waa/waa_client.rb', line 877

def update_web_app_acceleration_policy(web_app_acceleration_policy_id, update_web_app_acceleration_policy_details, opts = {})
  logger.debug 'Calling operation WaaClient#update_web_app_acceleration_policy.' if logger

  raise "Missing the required parameter 'web_app_acceleration_policy_id' when calling update_web_app_acceleration_policy." if web_app_acceleration_policy_id.nil?
  raise "Missing the required parameter 'update_web_app_acceleration_policy_details' when calling update_web_app_acceleration_policy." if update_web_app_acceleration_policy_details.nil?
  raise "Parameter value for 'web_app_acceleration_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(web_app_acceleration_policy_id)

  path = '/webAppAccelerationPolicies/{webAppAccelerationPolicyId}'.sub('{webAppAccelerationPolicyId}', web_app_acceleration_policy_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_web_app_acceleration_policy_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'WaaClient#update_web_app_acceleration_policy') 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