Class: OCI::NetworkFirewall::NetworkFirewallClient

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/network_firewall/network_firewall_client.rb

Overview

Use the Network Firewall API to create network firewalls and configure policies that regulates network traffic in and across VCNs.

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) ⇒ NetworkFirewallClient

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



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

Instance Attribute Details

#api_client ⇒ OCI::ApiClient (readonly)

Client used to make HTTP requests.

Returns:



15
16
17
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 15

def api_client
  @api_client
end

#endpoint ⇒ String (readonly)

Fully qualified endpoint URL

Returns:

  • (String) 


19
20
21
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 19

def endpoint
  @endpoint
end

#region ⇒ String

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

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/network_firewall/network_firewall_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

Returns:



25
26
27
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 25

def retry_config
  @retry_config
end

Instance Method Details

#apply_network_firewall_policy(network_firewall_policy_id, apply_network_firewall_policy_details, opts = {}) ⇒ Response

Note:

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

Applies the candidate version of the NetworkFirewallPolicy resource. 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.

  • :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.

Returns:



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
158
159
160
161
162
163
164
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 124

def apply_network_firewall_policy(network_firewall_policy_id, apply_network_firewall_policy_details, opts = {})
  logger.debug 'Calling operation NetworkFirewallClient#apply_network_firewall_policy.' if logger

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

  path = '/networkFirewallPolicies/{networkFirewallPolicyId}/actions/applyPolicy'.sub('{networkFirewallPolicyId}', network_firewall_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]
  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(apply_network_firewall_policy_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'NetworkFirewallClient#apply_network_firewall_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::NetworkFirewall::Models::NetworkFirewallPolicy'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#bulk_upload_address_lists(network_firewall_policy_id, bulk_upload_address_lists_details, opts = {}) ⇒ Response

Note:

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

Creates a new Address Lists at bulk for the Network Firewall Policy.

Parameters:

  • network_firewall_policy_id (String) —

    Unique Network Firewall Policy identifier

  • bulk_upload_address_lists_details (String, IO) —

    Request Details to create the Address Lists for the Network Firewall Policy Resource.

  • 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_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.

  • :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.

Returns:

  • (Response) —

    A Response object with data of type nil



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
227
228
229
230
231
232
233
234
235
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 196

def bulk_upload_address_lists(network_firewall_policy_id, bulk_upload_address_lists_details, opts = {})
  logger.debug 'Calling operation NetworkFirewallClient#bulk_upload_address_lists.' if logger

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

  path = '/networkFirewallPolicies/{networkFirewallPolicyId}/addressLists/actions/bulkUpload'.sub('{networkFirewallPolicyId}', network_firewall_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[:'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[:'content-type'] ||= 'application/octet-stream'
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(bulk_upload_address_lists_details)

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

#bulk_upload_application_groups(network_firewall_policy_id, bulk_upload_application_groups_details, opts = {}) ⇒ Response

Note:

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

Creates a new Application Group at bulk for the Network Firewall Policy.

Parameters:

  • network_firewall_policy_id (String) —

    Unique Network Firewall Policy identifier

  • bulk_upload_application_groups_details (String, IO) —

    Request Details to create the Application Group for the Network Firewall Policy Resource.

  • 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_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.

  • :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.

Returns:

  • (Response) —

    A Response object with data of type nil



267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 267

def bulk_upload_application_groups(network_firewall_policy_id, bulk_upload_application_groups_details, opts = {})
  logger.debug 'Calling operation NetworkFirewallClient#bulk_upload_application_groups.' if logger

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

  path = '/networkFirewallPolicies/{networkFirewallPolicyId}/applicationGroups/actions/bulkUpload'.sub('{networkFirewallPolicyId}', network_firewall_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[:'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[:'content-type'] ||= 'application/octet-stream'
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(bulk_upload_application_groups_details)

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

#bulk_upload_applications(network_firewall_policy_id, bulk_upload_applications_details, opts = {}) ⇒ Response

Note:

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

Creates new Applications at bulk for the Network Firewall Policy.

Parameters:

  • network_firewall_policy_id (String) —

    Unique Network Firewall Policy identifier

  • bulk_upload_applications_details (String, IO) —

    Request Details to create the Applications for the Network Firewall Policy Resource.

  • 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_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.

  • :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.

Returns:

  • (Response) —

    A Response object with data of type nil



338
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
376
377
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 338

def bulk_upload_applications(network_firewall_policy_id, bulk_upload_applications_details, opts = {})
  logger.debug 'Calling operation NetworkFirewallClient#bulk_upload_applications.' if logger

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

  path = '/networkFirewallPolicies/{networkFirewallPolicyId}/applications/actions/bulkUpload'.sub('{networkFirewallPolicyId}', network_firewall_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[:'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[:'content-type'] ||= 'application/octet-stream'
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(bulk_upload_applications_details)

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

#bulk_upload_decryption_profiles(network_firewall_policy_id, bulk_upload_decryption_profiles_details, opts = {}) ⇒ Response

Note:

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

Creates new Decryption Profiles at bulk for the Network Firewall Policy.

Parameters:

  • network_firewall_policy_id (String) —

    Unique Network Firewall Policy identifier

  • bulk_upload_decryption_profiles_details (String, IO) —

    Request Details to create the Decryption Profile for the Network Firewall Policy Resource.

  • 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_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.

  • :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.

Returns:

  • (Response) —

    A Response object with data of type nil



409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 409

def bulk_upload_decryption_profiles(network_firewall_policy_id, bulk_upload_decryption_profiles_details, opts = {})
  logger.debug 'Calling operation NetworkFirewallClient#bulk_upload_decryption_profiles.' if logger

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

  path = '/networkFirewallPolicies/{networkFirewallPolicyId}/decryptionProfiles/actions/bulkUpload'.sub('{networkFirewallPolicyId}', network_firewall_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[:'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[:'content-type'] ||= 'application/octet-stream'
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(bulk_upload_decryption_profiles_details)

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

#bulk_upload_decryption_rules(network_firewall_policy_id, bulk_upload_decryption_rules_details, opts = {}) ⇒ Response

Note:

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

Creates Decryption Rules at bulk for the Network Firewall Policy.

Parameters:

  • network_firewall_policy_id (String) —

    Unique Network Firewall Policy identifier

  • bulk_upload_decryption_rules_details (String, IO) —

    Request Details to create the Decryption Rule for the Network Firewall Policy Resource.

  • 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_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.

  • :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.

Returns:

  • (Response) —

    A Response object with data of type nil



480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 480

def bulk_upload_decryption_rules(network_firewall_policy_id, bulk_upload_decryption_rules_details, opts = {})
  logger.debug 'Calling operation NetworkFirewallClient#bulk_upload_decryption_rules.' if logger

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

  path = '/networkFirewallPolicies/{networkFirewallPolicyId}/decryptionRules/actions/bulkUpload'.sub('{networkFirewallPolicyId}', network_firewall_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[:'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[:'content-type'] ||= 'application/octet-stream'
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(bulk_upload_decryption_rules_details)

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

#bulk_upload_mapped_secrets(network_firewall_policy_id, bulk_upload_mapped_secrets_details, opts = {}) ⇒ Response

Note:

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

Creates new Mapped Secrets at bulk for the Network Firewall Policy.

Parameters:

  • network_firewall_policy_id (String) —

    Unique Network Firewall Policy identifier

  • bulk_upload_mapped_secrets_details (String, IO) —

    Request Details to create the Mapped Secret for the Network Firewall Policy Resource.

  • 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_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.

  • :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.

Returns:

  • (Response) —

    A Response object with data of type nil



551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 551

def bulk_upload_mapped_secrets(network_firewall_policy_id, bulk_upload_mapped_secrets_details, opts = {})
  logger.debug 'Calling operation NetworkFirewallClient#bulk_upload_mapped_secrets.' if logger

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

  path = '/networkFirewallPolicies/{networkFirewallPolicyId}/mappedSecrets/actions/bulkUpload'.sub('{networkFirewallPolicyId}', network_firewall_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[:'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[:'content-type'] ||= 'application/octet-stream'
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(bulk_upload_mapped_secrets_details)

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

#bulk_upload_security_rules(network_firewall_policy_id, bulk_upload_security_rules_details, opts = {}) ⇒ Response

Note:

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

Creates a new Security Rule at bulk for the Network Firewall Policy.

Parameters:

  • network_firewall_policy_id (String) —

    Unique Network Firewall Policy identifier

  • bulk_upload_security_rules_details (String, IO) —

    Request Details to create the Security Rule for the Network Firewall Policy Resource.

  • 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_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.

  • :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.

Returns:

  • (Response) —

    A Response object with data of type nil



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
650
651
652
653
654
655
656
657
658
659
660
661
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 622

def bulk_upload_security_rules(network_firewall_policy_id, bulk_upload_security_rules_details, opts = {})
  logger.debug 'Calling operation NetworkFirewallClient#bulk_upload_security_rules.' if logger

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

  path = '/networkFirewallPolicies/{networkFirewallPolicyId}/securityRules/actions/bulkUpload'.sub('{networkFirewallPolicyId}', network_firewall_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[:'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[:'content-type'] ||= 'application/octet-stream'
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(bulk_upload_security_rules_details)

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

#bulk_upload_service_lists(network_firewall_policy_id, bulk_upload_service_lists_details, opts = {}) ⇒ Response

Note:

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

Creates a new Service List at bulk for the Network Firewall Policy.

Parameters:

  • network_firewall_policy_id (String) —

    Unique Network Firewall Policy identifier

  • bulk_upload_service_lists_details (String, IO) —

    Request Details to create the Service List for the Network Firewall Policy Resource.

  • 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_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.

  • :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.

Returns:

  • (Response) —

    A Response object with data of type nil



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
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 693

def bulk_upload_service_lists(network_firewall_policy_id, bulk_upload_service_lists_details, opts = {})
  logger.debug 'Calling operation NetworkFirewallClient#bulk_upload_service_lists.' if logger

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

  path = '/networkFirewallPolicies/{networkFirewallPolicyId}/serviceLists/actions/bulkUpload'.sub('{networkFirewallPolicyId}', network_firewall_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[:'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[:'content-type'] ||= 'application/octet-stream'
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(bulk_upload_service_lists_details)

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

#bulk_upload_services(network_firewall_policy_id, bulk_upload_services_details, opts = {}) ⇒ Response

Note:

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

Creates new Services at bulk for the Network Firewall Policy.

Parameters:

  • network_firewall_policy_id (String) —

    Unique Network Firewall Policy identifier

  • bulk_upload_services_details (String, IO) —

    Request Details to create the Services for the Network Firewall Policy Resource.

  • 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_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.

  • :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.

Returns:

  • (Response) —

    A Response object with data of type nil



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
795
796
797
798
799
800
801
802
803
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 764

def bulk_upload_services(network_firewall_policy_id, bulk_upload_services_details, opts = {})
  logger.debug 'Calling operation NetworkFirewallClient#bulk_upload_services.' if logger

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

  path = '/networkFirewallPolicies/{networkFirewallPolicyId}/services/actions/bulkUpload'.sub('{networkFirewallPolicyId}', network_firewall_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[:'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[:'content-type'] ||= 'application/octet-stream'
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(bulk_upload_services_details)

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

#bulk_upload_url_lists(network_firewall_policy_id, bulk_upload_url_lists_details, opts = {}) ⇒ Response

Note:

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

Creates a new Url Lists at bulk for the Network Firewall Policy.

Parameters:

  • network_firewall_policy_id (String) —

    Unique Network Firewall Policy identifier

  • bulk_upload_url_lists_details (String, IO) —

    Request Details to create the Url Lists for the Network Firewall Policy Resource.

  • 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_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.

  • :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.

Returns:

  • (Response) —

    A Response object with data of type nil



835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 835

def bulk_upload_url_lists(network_firewall_policy_id, bulk_upload_url_lists_details, opts = {})
  logger.debug 'Calling operation NetworkFirewallClient#bulk_upload_url_lists.' if logger

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

  path = '/networkFirewallPolicies/{networkFirewallPolicyId}/urlLists/actions/bulkUpload'.sub('{networkFirewallPolicyId}', network_firewall_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[:'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[:'content-type'] ||= 'application/octet-stream'
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(bulk_upload_url_lists_details)

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

#cancel_work_request(work_request_id, opts = {}) ⇒ Response

Note:

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

Cancel work request with the given ID.

Parameters:

  • work_request_id (String) —

    The ID of the asynchronous request.

  • 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



898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 898

def cancel_work_request(work_request_id, opts = {})
  logger.debug 'Calling operation NetworkFirewallClient#cancel_work_request.' if logger

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

  path = '/workRequests/{workRequestId}'.sub('{workRequestId}', work_request_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: 'NetworkFirewallClient#cancel_work_request') 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

#change_network_firewall_compartment(network_firewall_id, change_network_firewall_compartment_details, opts = {}) ⇒ Response

Note:

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

Moves a NetworkFirewall resource from one compartment identifier 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.

  • :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.

Returns:

  • (Response) —

    A Response object with data of type nil



965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 965

def change_network_firewall_compartment(network_firewall_id, change_network_firewall_compartment_details, opts = {})
  logger.debug 'Calling operation NetworkFirewallClient#change_network_firewall_compartment.' if logger

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

  path = '/networkFirewalls/{networkFirewallId}/actions/changeCompartment'.sub('{networkFirewallId}', network_firewall_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_network_firewall_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'NetworkFirewallClient#change_network_firewall_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_network_firewall_policy_compartment(network_firewall_policy_id, change_network_firewall_policy_compartment_details, opts = {}) ⇒ Response

Note:

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

Moves a NetworkFirewallPolicy resource from one compartment identifier 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.

  • :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.

Returns:

  • (Response) —

    A Response object with data of type nil



1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 1035

def change_network_firewall_policy_compartment(network_firewall_policy_id, change_network_firewall_policy_compartment_details, opts = {})
  logger.debug 'Calling operation NetworkFirewallClient#change_network_firewall_policy_compartment.' if logger

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

  path = '/networkFirewallPolicies/{networkFirewallPolicyId}/actions/changeCompartment'.sub('{networkFirewallPolicyId}', network_firewall_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]
  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_network_firewall_policy_compartment_details)

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

#clone_network_firewall_policy(network_firewall_policy_id, clone_network_firewall_policy_details, opts = {}) ⇒ Response

Note:

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

Moves a NetworkFirewallPolicy resource from one compartment identifier 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.

  • :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.

Returns:



1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 1105

def clone_network_firewall_policy(network_firewall_policy_id, clone_network_firewall_policy_details, opts = {})
  logger.debug 'Calling operation NetworkFirewallClient#clone_network_firewall_policy.' if logger

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

  path = '/networkFirewallPolicies/{networkFirewallPolicyId}/actions/clonePolicy'.sub('{networkFirewallPolicyId}', network_firewall_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]
  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(clone_network_firewall_policy_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'NetworkFirewallClient#clone_network_firewall_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::NetworkFirewall::Models::NetworkFirewallPolicy'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_address_list(network_firewall_policy_id, create_address_list_details, opts = {}) ⇒ Response

Note:

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

Creates a new Address List for the Network Firewall Policy.

Parameters:

  • network_firewall_policy_id (String) —

    Unique Network Firewall Policy identifier

  • create_address_list_details (OCI::NetworkFirewall::Models::CreateAddressListDetails) —

    Request Details to create the Network Firewall Policy Resource.

  • 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_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:



1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 1171

def create_address_list(network_firewall_policy_id, create_address_list_details, opts = {})
  logger.debug 'Calling operation NetworkFirewallClient#create_address_list.' if logger

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

  path = '/networkFirewallPolicies/{networkFirewallPolicyId}/addressLists'.sub('{networkFirewallPolicyId}', network_firewall_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-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_address_list_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'NetworkFirewallClient#create_address_list') 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::NetworkFirewall::Models::AddressList'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_application(network_firewall_policy_id, create_application_details, opts = {}) ⇒ Response

Note:

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

Creates a new Application for the Network Firewall Policy.

Parameters:

  • network_firewall_policy_id (String) —

    Unique Network Firewall Policy identifier

  • create_application_details (OCI::NetworkFirewall::Models::CreateApplicationDetails) —

    Request Details to create the Application for the Network Firewall Policy Resource.

  • 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_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:



1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 1236

def create_application(network_firewall_policy_id, create_application_details, opts = {})
  logger.debug 'Calling operation NetworkFirewallClient#create_application.' if logger

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

  path = '/networkFirewallPolicies/{networkFirewallPolicyId}/applications'.sub('{networkFirewallPolicyId}', network_firewall_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-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_application_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'NetworkFirewallClient#create_application') 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::NetworkFirewall::Models::Application'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_application_group(network_firewall_policy_id, create_application_group_details, opts = {}) ⇒ Response

Note:

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

Creates a new ApplicationGroup for the Network Firewall Policy.

Parameters:

  • network_firewall_policy_id (String) —

    Unique Network Firewall Policy identifier

  • create_application_group_details (OCI::NetworkFirewall::Models::CreateApplicationGroupDetails) —

    Request Details to create the ApplicationGroup for the Network Firewall Policy Resource.

  • 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_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:



1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 1301

def create_application_group(network_firewall_policy_id, create_application_group_details, opts = {})
  logger.debug 'Calling operation NetworkFirewallClient#create_application_group.' if logger

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

  path = '/networkFirewallPolicies/{networkFirewallPolicyId}/applicationGroups'.sub('{networkFirewallPolicyId}', network_firewall_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-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_application_group_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'NetworkFirewallClient#create_application_group') 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::NetworkFirewall::Models::ApplicationGroup'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_decryption_profile(network_firewall_policy_id, create_decryption_profile_details, opts = {}) ⇒ Response

Note:

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

Creates a new Decryption Profile for the Network Firewall Policy.

Parameters:

  • network_firewall_policy_id (String) —

    Unique Network Firewall Policy identifier

  • create_decryption_profile_details (OCI::NetworkFirewall::Models::CreateDecryptionProfileDetails) —

    Request Details to create the Network Firewall Policy Resource.

  • 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_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:



1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 1366

def create_decryption_profile(network_firewall_policy_id, create_decryption_profile_details, opts = {})
  logger.debug 'Calling operation NetworkFirewallClient#create_decryption_profile.' if logger

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

  path = '/networkFirewallPolicies/{networkFirewallPolicyId}/decryptionProfiles'.sub('{networkFirewallPolicyId}', network_firewall_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-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_decryption_profile_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'NetworkFirewallClient#create_decryption_profile') 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::NetworkFirewall::Models::DecryptionProfile'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_decryption_rule(network_firewall_policy_id, create_decryption_rule_details, opts = {}) ⇒ Response

Note:

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

Creates a new Decryption Rule for the Network Firewall Policy.

Parameters:

  • network_firewall_policy_id (String) —

    Unique Network Firewall Policy identifier

  • create_decryption_rule_details (OCI::NetworkFirewall::Models::CreateDecryptionRuleDetails) —

    Request Details to create the Network Firewall Policy Resource.

  • 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_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:



1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 1431

def create_decryption_rule(network_firewall_policy_id, create_decryption_rule_details, opts = {})
  logger.debug 'Calling operation NetworkFirewallClient#create_decryption_rule.' if logger

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

  path = '/networkFirewallPolicies/{networkFirewallPolicyId}/decryptionRules'.sub('{networkFirewallPolicyId}', network_firewall_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-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_decryption_rule_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'NetworkFirewallClient#create_decryption_rule') 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::NetworkFirewall::Models::DecryptionRule'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_mapped_secret(network_firewall_policy_id, create_mapped_secret_details, opts = {}) ⇒ Response

Note:

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

Creates a new Mapped Secret for the Network Firewall Policy.

Parameters:

  • network_firewall_policy_id (String) —

    Unique Network Firewall Policy identifier

  • create_mapped_secret_details (OCI::NetworkFirewall::Models::CreateMappedSecretDetails) —

    Request Details to create the Network Firewall Policy Resource.

  • 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_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:



1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 1496

def create_mapped_secret(network_firewall_policy_id, create_mapped_secret_details, opts = {})
  logger.debug 'Calling operation NetworkFirewallClient#create_mapped_secret.' if logger

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

  path = '/networkFirewallPolicies/{networkFirewallPolicyId}/mappedSecrets'.sub('{networkFirewallPolicyId}', network_firewall_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-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_mapped_secret_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'NetworkFirewallClient#create_mapped_secret') 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::NetworkFirewall::Models::MappedSecret'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_network_firewall(create_network_firewall_details, opts = {}) ⇒ Response

Note:

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

Creates a new NetworkFirewall.

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:



1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 1560

def create_network_firewall(create_network_firewall_details, opts = {})
  logger.debug 'Calling operation NetworkFirewallClient#create_network_firewall.' if logger

  raise "Missing the required parameter 'create_network_firewall_details' when calling create_network_firewall." if create_network_firewall_details.nil?

  path = '/networkFirewalls'
  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_network_firewall_details)

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

#create_network_firewall_policy(create_network_firewall_policy_details, opts = {}) ⇒ Response

Note:

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

Creates a new Network Firewall Policy.

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:



1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 1622

def create_network_firewall_policy(create_network_firewall_policy_details, opts = {})
  logger.debug 'Calling operation NetworkFirewallClient#create_network_firewall_policy.' if logger

  raise "Missing the required parameter 'create_network_firewall_policy_details' when calling create_network_firewall_policy." if create_network_firewall_policy_details.nil?

  path = '/networkFirewallPolicies'
  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_network_firewall_policy_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'NetworkFirewallClient#create_network_firewall_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::NetworkFirewall::Models::NetworkFirewallPolicy'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_security_rule(network_firewall_policy_id, create_security_rule_details, opts = {}) ⇒ Response

Note:

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

Creates a new Security Rule for the Network Firewall Policy.

Parameters:

  • network_firewall_policy_id (String) —

    Unique Network Firewall Policy identifier

  • create_security_rule_details (OCI::NetworkFirewall::Models::CreateSecurityRuleDetails) —

    Request Details to create the Network Firewall Policy Resource.

  • 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_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:



1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 1685

def create_security_rule(network_firewall_policy_id, create_security_rule_details, opts = {})
  logger.debug 'Calling operation NetworkFirewallClient#create_security_rule.' if logger

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

  path = '/networkFirewallPolicies/{networkFirewallPolicyId}/securityRules'.sub('{networkFirewallPolicyId}', network_firewall_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-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_security_rule_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'NetworkFirewallClient#create_security_rule') 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::NetworkFirewall::Models::SecurityRule'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_service(network_firewall_policy_id, create_service_details, opts = {}) ⇒ Response

Note:

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

Creates a new Service for the Network Firewall Policy.

Parameters:

  • network_firewall_policy_id (String) —

    Unique Network Firewall Policy identifier

  • create_service_details (OCI::NetworkFirewall::Models::CreateServiceDetails) —

    Request Details to create the Service for the Network Firewall Policy Resource.

  • 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_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:



1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 1750

def create_service(network_firewall_policy_id, create_service_details, opts = {})
  logger.debug 'Calling operation NetworkFirewallClient#create_service.' if logger

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

  path = '/networkFirewallPolicies/{networkFirewallPolicyId}/services'.sub('{networkFirewallPolicyId}', network_firewall_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-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_service_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'NetworkFirewallClient#create_service') 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::NetworkFirewall::Models::Service'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_service_list(network_firewall_policy_id, create_service_list_details, opts = {}) ⇒ Response

Note:

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

Creates a new ServiceList for the Network Firewall Policy.

Parameters:

  • network_firewall_policy_id (String) —

    Unique Network Firewall Policy identifier

  • create_service_list_details (OCI::NetworkFirewall::Models::CreateServiceListDetails) —

    Request Details to create the ServiceList for the Network Firewall Policy Resource.

  • 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_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:



1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 1815

def create_service_list(network_firewall_policy_id, create_service_list_details, opts = {})
  logger.debug 'Calling operation NetworkFirewallClient#create_service_list.' if logger

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

  path = '/networkFirewallPolicies/{networkFirewallPolicyId}/serviceLists'.sub('{networkFirewallPolicyId}', network_firewall_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-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_service_list_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'NetworkFirewallClient#create_service_list') 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::NetworkFirewall::Models::ServiceList'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_url_list(network_firewall_policy_id, create_url_list_details, opts = {}) ⇒ Response

Note:

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

Creates a new Url List for the Network Firewall Policy.

Parameters:

  • network_firewall_policy_id (String) —

    Unique Network Firewall Policy identifier

  • create_url_list_details (OCI::NetworkFirewall::Models::CreateUrlListDetails) —

    Request Details to create the Network Firewall Policy Resource.

  • 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_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:



1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 1880

def create_url_list(network_firewall_policy_id, create_url_list_details, opts = {})
  logger.debug 'Calling operation NetworkFirewallClient#create_url_list.' if logger

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

  path = '/networkFirewallPolicies/{networkFirewallPolicyId}/urlLists'.sub('{networkFirewallPolicyId}', network_firewall_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-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_url_list_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'NetworkFirewallClient#create_url_list') 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::NetworkFirewall::Models::UrlList'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_address_list(network_firewall_policy_id, address_list_name, opts = {}) ⇒ Response

Note:

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

Deletes a Address List resource with the given identifier.

Parameters:

  • network_firewall_policy_id (String) —

    Unique Network Firewall Policy identifier

  • address_list_name (String) —

    Unique identifier for address lists.

  • 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



1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 1944

def delete_address_list(network_firewall_policy_id, address_list_name, opts = {})
  logger.debug 'Calling operation NetworkFirewallClient#delete_address_list.' if logger

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

  path = '/networkFirewallPolicies/{networkFirewallPolicyId}/addressLists/{addressListName}'.sub('{networkFirewallPolicyId}', network_firewall_policy_id.to_s).sub('{addressListName}', address_list_name.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: 'NetworkFirewallClient#delete_address_list') 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_application(network_firewall_policy_id, application_name, opts = {}) ⇒ Response

Note:

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

Deletes a Application resource with the given identifier.

Parameters:

  • network_firewall_policy_id (String) —

    Unique Network Firewall Policy identifier

  • application_name (String) —

    Unique identifier for Applications.

  • 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



2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 2007

def delete_application(network_firewall_policy_id, application_name, opts = {})
  logger.debug 'Calling operation NetworkFirewallClient#delete_application.' if logger

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

  path = '/networkFirewallPolicies/{networkFirewallPolicyId}/applications/{applicationName}'.sub('{networkFirewallPolicyId}', network_firewall_policy_id.to_s).sub('{applicationName}', application_name.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: 'NetworkFirewallClient#delete_application') 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_application_group(network_firewall_policy_id, application_group_name, opts = {}) ⇒ Response

Note:

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

Deletes a ApplicationGroup resource with the given identifier.

Parameters:

  • network_firewall_policy_id (String) —

    Unique Network Firewall Policy identifier

  • application_group_name (String) —

    Unique name identifier for Application Lists in the scope of Network Firewall Policy.

  • 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



2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 2070

def delete_application_group(network_firewall_policy_id, application_group_name, opts = {})
  logger.debug 'Calling operation NetworkFirewallClient#delete_application_group.' if logger

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

  path = '/networkFirewallPolicies/{networkFirewallPolicyId}/applicationGroups/{applicationGroupName}'.sub('{networkFirewallPolicyId}', network_firewall_policy_id.to_s).sub('{applicationGroupName}', application_group_name.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: 'NetworkFirewallClient#delete_application_group') 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_decryption_profile(network_firewall_policy_id, decryption_profile_name, opts = {}) ⇒ Response

Note:

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

Deletes a Decryption Profile resource with the given identifier.

Parameters:

  • network_firewall_policy_id (String) —

    Unique Network Firewall Policy identifier

  • decryption_profile_name (String) —

    Unique identifier for Decryption Profiles.

  • 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



2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 2133

def delete_decryption_profile(network_firewall_policy_id, decryption_profile_name, opts = {})
  logger.debug 'Calling operation NetworkFirewallClient#delete_decryption_profile.' if logger

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

  path = '/networkFirewallPolicies/{networkFirewallPolicyId}/decryptionProfiles/{decryptionProfileName}'.sub('{networkFirewallPolicyId}', network_firewall_policy_id.to_s).sub('{decryptionProfileName}', decryption_profile_name.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: 'NetworkFirewallClient#delete_decryption_profile') 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_decryption_rule(network_firewall_policy_id, decryption_rule_name, opts = {}) ⇒ Response

Note:

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

Deletes a Decryption Rule resource with the given identifier.

Parameters:

  • network_firewall_policy_id (String) —

    Unique Network Firewall Policy identifier

  • decryption_rule_name (String) —

    Unique identifier for Decryption Rules in the network firewall policy.

  • 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



2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 2196

def delete_decryption_rule(network_firewall_policy_id, decryption_rule_name, opts = {})
  logger.debug 'Calling operation NetworkFirewallClient#delete_decryption_rule.' if logger

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

  path = '/networkFirewallPolicies/{networkFirewallPolicyId}/decryptionRules/{decryptionRuleName}'.sub('{networkFirewallPolicyId}', network_firewall_policy_id.to_s).sub('{decryptionRuleName}', decryption_rule_name.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: 'NetworkFirewallClient#delete_decryption_rule') 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_mapped_secret(network_firewall_policy_id, mapped_secret_name, opts = {}) ⇒ Response

Note:

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

Deletes a Mapped Secret resource with the given identifier.

Parameters:

  • network_firewall_policy_id (String) —

    Unique Network Firewall Policy identifier

  • mapped_secret_name (String) —

    Unique identifier for Mapped Secrets.

  • 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



2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 2259

def delete_mapped_secret(network_firewall_policy_id, mapped_secret_name, opts = {})
  logger.debug 'Calling operation NetworkFirewallClient#delete_mapped_secret.' if logger

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

  path = '/networkFirewallPolicies/{networkFirewallPolicyId}/mappedSecrets/{mappedSecretName}'.sub('{networkFirewallPolicyId}', network_firewall_policy_id.to_s).sub('{mappedSecretName}', mapped_secret_name.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: 'NetworkFirewallClient#delete_mapped_secret') 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_network_firewall(network_firewall_id, opts = {}) ⇒ Response

Note:

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

Deletes a NetworkFirewall resource by identifier

Parameters:

  • network_firewall_id (String) —

    The OCID of the Network Firewall resource.

  • 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



2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 2321

def delete_network_firewall(network_firewall_id, opts = {})
  logger.debug 'Calling operation NetworkFirewallClient#delete_network_firewall.' if logger

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

  path = '/networkFirewalls/{networkFirewallId}'.sub('{networkFirewallId}', network_firewall_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: 'NetworkFirewallClient#delete_network_firewall') 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_network_firewall_policy(network_firewall_policy_id, opts = {}) ⇒ Response

Note:

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

Deletes a NetworkFirewallPolicy resource with the given identifier.

Parameters:

  • network_firewall_policy_id (String) —

    Unique Network Firewall Policy identifier

  • 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



2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 2381

def delete_network_firewall_policy(network_firewall_policy_id, opts = {})
  logger.debug 'Calling operation NetworkFirewallClient#delete_network_firewall_policy.' if logger

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

  path = '/networkFirewallPolicies/{networkFirewallPolicyId}'.sub('{networkFirewallPolicyId}', network_firewall_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: 'NetworkFirewallClient#delete_network_firewall_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

#delete_security_rule(network_firewall_policy_id, security_rule_name, opts = {}) ⇒ Response

Note:

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

Deletes a Security Rule resource with the given identifier.

Parameters:

  • network_firewall_policy_id (String) —

    Unique Network Firewall Policy identifier

  • security_rule_name (String) —

    Unique identifier for Security Rules in the network firewall policy.

  • 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



2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 2442

def delete_security_rule(network_firewall_policy_id, security_rule_name, opts = {})
  logger.debug 'Calling operation NetworkFirewallClient#delete_security_rule.' if logger

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

  path = '/networkFirewallPolicies/{networkFirewallPolicyId}/securityRules/{securityRuleName}'.sub('{networkFirewallPolicyId}', network_firewall_policy_id.to_s).sub('{securityRuleName}', security_rule_name.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: 'NetworkFirewallClient#delete_security_rule') 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_service(network_firewall_policy_id, service_name, opts = {}) ⇒ Response

Note:

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

Deletes a Service resource with the given identifier.

Parameters:

  • network_firewall_policy_id (String) —

    Unique Network Firewall Policy identifier

  • service_name (String) —

    Unique identifier for Services.

  • 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



2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 2505

def delete_service(network_firewall_policy_id, service_name, opts = {})
  logger.debug 'Calling operation NetworkFirewallClient#delete_service.' if logger

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

  path = '/networkFirewallPolicies/{networkFirewallPolicyId}/services/{serviceName}'.sub('{networkFirewallPolicyId}', network_firewall_policy_id.to_s).sub('{serviceName}', service_name.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: 'NetworkFirewallClient#delete_service') 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_service_list(network_firewall_policy_id, service_list_name, opts = {}) ⇒ Response

Note:

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

Deletes a ServiceList resource with the given identifier.

Parameters:

  • network_firewall_policy_id (String) —

    Unique Network Firewall Policy identifier

  • service_list_name (String) —

    Unique name identifier for Service Lists in the scope of Network Firewall Policy.

  • 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



2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 2568

def delete_service_list(network_firewall_policy_id, service_list_name, opts = {})
  logger.debug 'Calling operation NetworkFirewallClient#delete_service_list.' if logger

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

  path = '/networkFirewallPolicies/{networkFirewallPolicyId}/serviceLists/{serviceListName}'.sub('{networkFirewallPolicyId}', network_firewall_policy_id.to_s).sub('{serviceListName}', service_list_name.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: 'NetworkFirewallClient#delete_service_list') 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_url_list(network_firewall_policy_id, url_list_name, opts = {}) ⇒ Response

Note:

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

Deletes a Url List resource with the given identifier.

Parameters:

  • network_firewall_policy_id (String) —

    Unique Network Firewall Policy identifier

  • url_list_name (String) —

    Unique name identifier for url lists in the scope of Network Firewall Policy.

  • 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



2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 2631

def delete_url_list(network_firewall_policy_id, url_list_name, opts = {})
  logger.debug 'Calling operation NetworkFirewallClient#delete_url_list.' if logger

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

  path = '/networkFirewallPolicies/{networkFirewallPolicyId}/urlLists/{urlListName}'.sub('{networkFirewallPolicyId}', network_firewall_policy_id.to_s).sub('{urlListName}', url_list_name.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: 'NetworkFirewallClient#delete_url_list') 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_address_list(network_firewall_policy_id, address_list_name, opts = {}) ⇒ Response

Note:

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

Get Address List by the given name in the context of network firewall policy.

Parameters:

  • network_firewall_policy_id (String) —

    Unique Network Firewall Policy identifier

  • address_list_name (String) —

    Unique identifier for address lists.

  • 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:



2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 2688

def get_address_list(network_firewall_policy_id, address_list_name, opts = {})
  logger.debug 'Calling operation NetworkFirewallClient#get_address_list.' if logger

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

  path = '/networkFirewallPolicies/{networkFirewallPolicyId}/addressLists/{addressListName}'.sub('{networkFirewallPolicyId}', network_firewall_policy_id.to_s).sub('{addressListName}', address_list_name.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: 'NetworkFirewallClient#get_address_list') 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::NetworkFirewall::Models::AddressList'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_application(network_firewall_policy_id, application_name, opts = {}) ⇒ Response

Note:

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

Get Application by the given name in the context of network firewall policy.

Parameters:

  • network_firewall_policy_id (String) —

    Unique Network Firewall Policy identifier

  • application_name (String) —

    Unique identifier for Applications.

  • 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.

  • :limit (Integer) —

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

  • :page (String) —

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

Returns:



2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 2747

def get_application(network_firewall_policy_id, application_name, opts = {})
  logger.debug 'Calling operation NetworkFirewallClient#get_application.' if logger

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

  path = '/networkFirewallPolicies/{networkFirewallPolicyId}/applications/{applicationName}'.sub('{networkFirewallPolicyId}', network_firewall_policy_id.to_s).sub('{applicationName}', application_name.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

  # 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: 'NetworkFirewallClient#get_application') 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::NetworkFirewall::Models::Application'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_application_group(network_firewall_policy_id, application_group_name, opts = {}) ⇒ Response

Note:

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

Get ApplicationGroup by the given name in the context of network firewall policy.

Parameters:

  • network_firewall_policy_id (String) —

    Unique Network Firewall Policy identifier

  • application_group_name (String) —

    Unique name identifier for Application Lists in the scope of Network Firewall Policy.

  • 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:



2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 2806

def get_application_group(network_firewall_policy_id, application_group_name, opts = {})
  logger.debug 'Calling operation NetworkFirewallClient#get_application_group.' if logger

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

  path = '/networkFirewallPolicies/{networkFirewallPolicyId}/applicationGroups/{applicationGroupName}'.sub('{networkFirewallPolicyId}', network_firewall_policy_id.to_s).sub('{applicationGroupName}', application_group_name.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: 'NetworkFirewallClient#get_application_group') 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::NetworkFirewall::Models::ApplicationGroup'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_decryption_profile(network_firewall_policy_id, decryption_profile_name, opts = {}) ⇒ Response

Note:

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

Get Decryption Profile by the given name in the context of network firewall policy.

Parameters:

  • network_firewall_policy_id (String) —

    Unique Network Firewall Policy identifier

  • decryption_profile_name (String) —

    Unique identifier for Decryption Profiles.

  • 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:



2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 2863

def get_decryption_profile(network_firewall_policy_id, decryption_profile_name, opts = {})
  logger.debug 'Calling operation NetworkFirewallClient#get_decryption_profile.' if logger

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

  path = '/networkFirewallPolicies/{networkFirewallPolicyId}/decryptionProfiles/{decryptionProfileName}'.sub('{networkFirewallPolicyId}', network_firewall_policy_id.to_s).sub('{decryptionProfileName}', decryption_profile_name.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: 'NetworkFirewallClient#get_decryption_profile') 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::NetworkFirewall::Models::DecryptionProfile'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_decryption_rule(network_firewall_policy_id, decryption_rule_name, opts = {}) ⇒ Response

Note:

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

Get Decryption Rule by the given name in the context of network firewall policy.

Parameters:

  • network_firewall_policy_id (String) —

    Unique Network Firewall Policy identifier

  • decryption_rule_name (String) —

    Unique identifier for Decryption Rules in the network firewall policy.

  • 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.

  • :limit (Integer) —

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

  • :page (String) —

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

Returns:



2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 2922

def get_decryption_rule(network_firewall_policy_id, decryption_rule_name, opts = {})
  logger.debug 'Calling operation NetworkFirewallClient#get_decryption_rule.' if logger

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

  path = '/networkFirewallPolicies/{networkFirewallPolicyId}/decryptionRules/{decryptionRuleName}'.sub('{networkFirewallPolicyId}', network_firewall_policy_id.to_s).sub('{decryptionRuleName}', decryption_rule_name.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

  # 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: 'NetworkFirewallClient#get_decryption_rule') 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::NetworkFirewall::Models::DecryptionRule'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_mapped_secret(network_firewall_policy_id, mapped_secret_name, opts = {}) ⇒ Response

Note:

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

Get Mapped Secret by the given name in the context of network firewall policy.

Parameters:

  • network_firewall_policy_id (String) —

    Unique Network Firewall Policy identifier

  • mapped_secret_name (String) —

    Unique identifier for Mapped Secrets.

  • 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.

  • :limit (Integer) —

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

  • :page (String) —

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

Returns:



2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 2983

def get_mapped_secret(network_firewall_policy_id, mapped_secret_name, opts = {})
  logger.debug 'Calling operation NetworkFirewallClient#get_mapped_secret.' if logger

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

  path = '/networkFirewallPolicies/{networkFirewallPolicyId}/mappedSecrets/{mappedSecretName}'.sub('{networkFirewallPolicyId}', network_firewall_policy_id.to_s).sub('{mappedSecretName}', mapped_secret_name.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

  # 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: 'NetworkFirewallClient#get_mapped_secret') 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::NetworkFirewall::Models::MappedSecret'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_network_firewall(network_firewall_id, opts = {}) ⇒ Response

Note:

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

Gets a NetworkFirewall by identifier

Parameters:

  • network_firewall_id (String) —

    The OCID of the Network Firewall resource.

  • 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:



3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 3041

def get_network_firewall(network_firewall_id, opts = {})
  logger.debug 'Calling operation NetworkFirewallClient#get_network_firewall.' if logger

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

  path = '/networkFirewalls/{networkFirewallId}'.sub('{networkFirewallId}', network_firewall_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: 'NetworkFirewallClient#get_network_firewall') 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::NetworkFirewall::Models::NetworkFirewall'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_network_firewall_policy(network_firewall_policy_id, opts = {}) ⇒ Response

Note:

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

Gets a NetworkFirewallPolicy given the network firewall policy identifier.

Parameters:

  • network_firewall_policy_id (String) —

    Unique Network Firewall Policy identifier

  • 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:



3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 3095

def get_network_firewall_policy(network_firewall_policy_id, opts = {})
  logger.debug 'Calling operation NetworkFirewallClient#get_network_firewall_policy.' if logger

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

  path = '/networkFirewallPolicies/{networkFirewallPolicyId}'.sub('{networkFirewallPolicyId}', network_firewall_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: 'NetworkFirewallClient#get_network_firewall_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::NetworkFirewall::Models::NetworkFirewallPolicy'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_security_rule(network_firewall_policy_id, security_rule_name, opts = {}) ⇒ Response

Note:

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

Get Security Rule by the given name in the context of network firewall policy.

Parameters:

  • network_firewall_policy_id (String) —

    Unique Network Firewall Policy identifier

  • security_rule_name (String) —

    Unique identifier for Security Rules in the network firewall policy.

  • 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:



3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 3150

def get_security_rule(network_firewall_policy_id, security_rule_name, opts = {})
  logger.debug 'Calling operation NetworkFirewallClient#get_security_rule.' if logger

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

  path = '/networkFirewallPolicies/{networkFirewallPolicyId}/securityRules/{securityRuleName}'.sub('{networkFirewallPolicyId}', network_firewall_policy_id.to_s).sub('{securityRuleName}', security_rule_name.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: 'NetworkFirewallClient#get_security_rule') 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::NetworkFirewall::Models::SecurityRule'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_service(network_firewall_policy_id, service_name, opts = {}) ⇒ Response

Note:

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

Get Service by the given name in the context of network firewall policy.

Parameters:

  • network_firewall_policy_id (String) —

    Unique Network Firewall Policy identifier

  • service_name (String) —

    Unique identifier for Services.

  • 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.

  • :limit (Integer) —

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

  • :page (String) —

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

Returns:



3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 3209

def get_service(network_firewall_policy_id, service_name, opts = {})
  logger.debug 'Calling operation NetworkFirewallClient#get_service.' if logger

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

  path = '/networkFirewallPolicies/{networkFirewallPolicyId}/services/{serviceName}'.sub('{networkFirewallPolicyId}', network_firewall_policy_id.to_s).sub('{serviceName}', service_name.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

  # 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: 'NetworkFirewallClient#get_service') 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::NetworkFirewall::Models::Service'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_service_list(network_firewall_policy_id, service_list_name, opts = {}) ⇒ Response

Note:

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

Get ServiceList by the given name in the context of network firewall policy.

Parameters:

  • network_firewall_policy_id (String) —

    Unique Network Firewall Policy identifier

  • service_list_name (String) —

    Unique name identifier for Service Lists in the scope of Network Firewall Policy.

  • 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:



3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 3268

def get_service_list(network_firewall_policy_id, service_list_name, opts = {})
  logger.debug 'Calling operation NetworkFirewallClient#get_service_list.' if logger

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

  path = '/networkFirewallPolicies/{networkFirewallPolicyId}/serviceLists/{serviceListName}'.sub('{networkFirewallPolicyId}', network_firewall_policy_id.to_s).sub('{serviceListName}', service_list_name.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: 'NetworkFirewallClient#get_service_list') 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::NetworkFirewall::Models::ServiceList'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_url_list(network_firewall_policy_id, url_list_name, opts = {}) ⇒ Response

Note:

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

Get Url List by the given name in the context of network firewall policy.

Parameters:

  • network_firewall_policy_id (String) —

    Unique Network Firewall Policy identifier

  • url_list_name (String) —

    Unique name identifier for url lists in the scope of Network Firewall Policy.

  • 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:



3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 3325

def get_url_list(network_firewall_policy_id, url_list_name, opts = {})
  logger.debug 'Calling operation NetworkFirewallClient#get_url_list.' if logger

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

  path = '/networkFirewallPolicies/{networkFirewallPolicyId}/urlLists/{urlListName}'.sub('{networkFirewallPolicyId}', network_firewall_policy_id.to_s).sub('{urlListName}', url_list_name.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: 'NetworkFirewallClient#get_url_list') 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::NetworkFirewall::Models::UrlList'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_work_request(work_request_id, opts = {}) ⇒ Response

Note:

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

Gets the status of the work request with the given ID.

Parameters:

  • work_request_id (String) —

    The ID of the asynchronous request.

  • 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:



3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 3381

def get_work_request(work_request_id, opts = {})
  logger.debug 'Calling operation NetworkFirewallClient#get_work_request.' if logger

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

  path = '/workRequests/{workRequestId}'.sub('{workRequestId}', work_request_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: 'NetworkFirewallClient#get_work_request') 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::NetworkFirewall::Models::WorkRequest'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_address_lists(network_firewall_policy_id, opts = {}) ⇒ Response

Note:

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

Returns a list of Network Firewall Policies.

Allowed values are: timeCreated, displayName

Parameters:

  • network_firewall_policy_id (String) —

    Unique Network Firewall Policy identifier

  • 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

  • :limit (Integer) —

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

  • :page (String) —

    A token representing the position at which to start retrieving results. This must come from the opc-next-page or opc-prev-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. (default to timeCreated)

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :display_name (String) —

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

Returns:



3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 3443

def list_address_lists(network_firewall_policy_id, opts = {})
  logger.debug 'Calling operation NetworkFirewallClient#list_address_lists.' if logger

  raise "Missing the required parameter 'network_firewall_policy_id' when calling list_address_lists." if network_firewall_policy_id.nil?

  if opts[:sort_order] && !OCI::NetworkFirewall::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::NetworkFirewall::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
  raise "Parameter value for 'network_firewall_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(network_firewall_policy_id)

  path = '/networkFirewallPolicies/{networkFirewallPolicyId}/addressLists'.sub('{networkFirewallPolicyId}', network_firewall_policy_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  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[:displayName] = opts[:display_name] if opts[:display_name]

  # 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: 'NetworkFirewallClient#list_address_lists') 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::NetworkFirewall::Models::AddressListSummaryCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_application_groups(network_firewall_policy_id, opts = {}) ⇒ Response

Note:

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

Returns a list of ApplicationGroups for the policy.

Allowed values are: timeCreated, displayName

Parameters:

  • network_firewall_policy_id (String) —

    Unique Network Firewall Policy identifier

  • 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

  • :limit (Integer) —

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

  • :page (String) —

    A token representing the position at which to start retrieving results. This must come from the opc-next-page or opc-prev-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. (default to timeCreated)

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :display_name (String) —

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

Returns:



3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 3518

def list_application_groups(network_firewall_policy_id, opts = {})
  logger.debug 'Calling operation NetworkFirewallClient#list_application_groups.' if logger

  raise "Missing the required parameter 'network_firewall_policy_id' when calling list_application_groups." if network_firewall_policy_id.nil?

  if opts[:sort_order] && !OCI::NetworkFirewall::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::NetworkFirewall::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
  raise "Parameter value for 'network_firewall_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(network_firewall_policy_id)

  path = '/networkFirewallPolicies/{networkFirewallPolicyId}/applicationGroups'.sub('{networkFirewallPolicyId}', network_firewall_policy_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  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[:displayName] = opts[:display_name] if opts[:display_name]

  # 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: 'NetworkFirewallClient#list_application_groups') 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::NetworkFirewall::Models::ApplicationGroupSummaryCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_applications(network_firewall_policy_id, opts = {}) ⇒ Response

Note:

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

Returns a list of Applications for the policy.

Allowed values are: timeCreated, displayName

Parameters:

  • network_firewall_policy_id (String) —

    Unique Network Firewall Policy identifier

  • 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

  • :limit (Integer) —

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

  • :page (String) —

    A token representing the position at which to start retrieving results. This must come from the opc-next-page or opc-prev-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. (default to timeCreated)

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :display_name (String) —

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

Returns:



3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 3593

def list_applications(network_firewall_policy_id, opts = {})
  logger.debug 'Calling operation NetworkFirewallClient#list_applications.' if logger

  raise "Missing the required parameter 'network_firewall_policy_id' when calling list_applications." if network_firewall_policy_id.nil?

  if opts[:sort_order] && !OCI::NetworkFirewall::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::NetworkFirewall::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
  raise "Parameter value for 'network_firewall_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(network_firewall_policy_id)

  path = '/networkFirewallPolicies/{networkFirewallPolicyId}/applications'.sub('{networkFirewallPolicyId}', network_firewall_policy_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  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[:displayName] = opts[:display_name] if opts[:display_name]

  # 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: 'NetworkFirewallClient#list_applications') 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::NetworkFirewall::Models::ApplicationSummaryCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_decryption_profiles(network_firewall_policy_id, opts = {}) ⇒ Response

Note:

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

Returns a list of Decryption Profile for the Network Firewall Policy.

Allowed values are: timeCreated, displayName

Parameters:

  • network_firewall_policy_id (String) —

    Unique Network Firewall Policy identifier

  • 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

  • :limit (Integer) —

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

  • :page (String) —

    A token representing the position at which to start retrieving results. This must come from the opc-next-page or opc-prev-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. (default to timeCreated)

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :display_name (String) —

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

Returns:



3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 3668

def list_decryption_profiles(network_firewall_policy_id, opts = {})
  logger.debug 'Calling operation NetworkFirewallClient#list_decryption_profiles.' if logger

  raise "Missing the required parameter 'network_firewall_policy_id' when calling list_decryption_profiles." if network_firewall_policy_id.nil?

  if opts[:sort_order] && !OCI::NetworkFirewall::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::NetworkFirewall::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
  raise "Parameter value for 'network_firewall_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(network_firewall_policy_id)

  path = '/networkFirewallPolicies/{networkFirewallPolicyId}/decryptionProfiles'.sub('{networkFirewallPolicyId}', network_firewall_policy_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  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[:displayName] = opts[:display_name] if opts[:display_name]

  # 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: 'NetworkFirewallClient#list_decryption_profiles') 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::NetworkFirewall::Models::DecryptionProfileSummaryCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_decryption_rules(network_firewall_policy_id, opts = {}) ⇒ Response

Note:

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

Returns a list of Decryption Rule for the Network Firewall Policy.

Allowed values are: timeCreated, displayName

Parameters:

  • network_firewall_policy_id (String) —

    Unique Network Firewall Policy identifier

  • 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

  • :limit (Integer) —

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

  • :page (String) —

    A token representing the position at which to start retrieving results. This must come from the opc-next-page or opc-prev-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. (default to timeCreated)

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :display_name (String) —

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

  • :decryption_rule_priority_order (Integer) —

    Unique priority order for Decryption Rules in the network firewall policy.

Returns:



3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 3744

def list_decryption_rules(network_firewall_policy_id, opts = {})
  logger.debug 'Calling operation NetworkFirewallClient#list_decryption_rules.' if logger

  raise "Missing the required parameter 'network_firewall_policy_id' when calling list_decryption_rules." if network_firewall_policy_id.nil?

  if opts[:sort_order] && !OCI::NetworkFirewall::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::NetworkFirewall::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
  raise "Parameter value for 'network_firewall_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(network_firewall_policy_id)

  path = '/networkFirewallPolicies/{networkFirewallPolicyId}/decryptionRules'.sub('{networkFirewallPolicyId}', network_firewall_policy_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  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[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:decryptionRulePriorityOrder] = opts[:decryption_rule_priority_order] if opts[:decryption_rule_priority_order]

  # 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: 'NetworkFirewallClient#list_decryption_rules') 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::NetworkFirewall::Models::DecryptionRuleSummaryCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_mapped_secrets(network_firewall_policy_id, opts = {}) ⇒ Response

Note:

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

Returns a list of Mapped Secret for the Network Firewall Policy.

Allowed values are: timeCreated, displayName

Parameters:

  • network_firewall_policy_id (String) —

    Unique Network Firewall Policy identifier

  • 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

  • :limit (Integer) —

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

  • :page (String) —

    A token representing the position at which to start retrieving results. This must come from the opc-next-page or opc-prev-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. (default to timeCreated)

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :display_name (String) —

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

Returns:



3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 3820

def list_mapped_secrets(network_firewall_policy_id, opts = {})
  logger.debug 'Calling operation NetworkFirewallClient#list_mapped_secrets.' if logger

  raise "Missing the required parameter 'network_firewall_policy_id' when calling list_mapped_secrets." if network_firewall_policy_id.nil?

  if opts[:sort_order] && !OCI::NetworkFirewall::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::NetworkFirewall::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
  raise "Parameter value for 'network_firewall_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(network_firewall_policy_id)

  path = '/networkFirewallPolicies/{networkFirewallPolicyId}/mappedSecrets'.sub('{networkFirewallPolicyId}', network_firewall_policy_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  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[:displayName] = opts[:display_name] if opts[:display_name]

  # 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: 'NetworkFirewallClient#list_mapped_secrets') 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::NetworkFirewall::Models::MappedSecretSummaryCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Returns a list of Network Firewall Policies.

Allowed values are: timeCreated, displayName

Parameters:

  • compartment_id (String) —

    The ID 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

  • :display_name (String) —

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

  • :id (String) —

    Unique Network Firewall Policy identifier

  • :limit (Integer) —

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

  • :page (String) —

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

  • :lifecycle_state (String) —

    A filter to return only resources with a lifecycleState matching the given value.

  • :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. (default to timeCreated)

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 3897

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

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

  if opts[:lifecycle_state] && !OCI::NetworkFirewall::Models::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::NetworkFirewall::Models::LIFECYCLE_STATE_ENUM.'
  end

  if opts[:sort_order] && !OCI::NetworkFirewall::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::NetworkFirewall::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 = '/networkFirewallPolicies'
  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[:id] = opts[:id] if opts[:id]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  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: 'NetworkFirewallClient#list_network_firewall_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::NetworkFirewall::Models::NetworkFirewallPolicySummaryCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Returns a list of NetworkFirewalls.

Allowed values are: timeCreated, displayName

Parameters:

  • compartment_id (String) —

    The ID 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

  • :display_name (String) —

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

  • :network_firewall_policy_id (String) —

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

  • :id (String) —

    The OCID of the Network Firewall resource.

  • :availability_domain (String) —

    A filter to return only resources that are present within the specified availability domain. To get a list of availability domains for a tenancy, use list_availability_domains operation. Example: kIdk:PHX-AD-1

  • :limit (Integer) —

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

  • :page (String) —

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

  • :lifecycle_state (String) —

    A filter to return only resources with a lifecycleState matching the given value.

  • :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. (default to timeCreated)

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 3985

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

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

  if opts[:lifecycle_state] && !OCI::NetworkFirewall::Models::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::NetworkFirewall::Models::LIFECYCLE_STATE_ENUM.'
  end

  if opts[:sort_order] && !OCI::NetworkFirewall::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::NetworkFirewall::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 = '/networkFirewalls'
  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[:networkFirewallPolicyId] = opts[:network_firewall_policy_id] if opts[:network_firewall_policy_id]
  query_params[:id] = opts[:id] if opts[:id]
  query_params[:availabilityDomain] = opts[:availability_domain] if opts[:availability_domain]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  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: 'NetworkFirewallClient#list_network_firewalls') 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::NetworkFirewall::Models::NetworkFirewallCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_security_rules(network_firewall_policy_id, opts = {}) ⇒ Response

Note:

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

Returns a list of Security Rule for the Network Firewall Policy.

Allowed values are: timeCreated, displayName

Parameters:

  • network_firewall_policy_id (String) —

    Unique Network Firewall Policy identifier

  • 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

  • :limit (Integer) —

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

  • :page (String) —

    A token representing the position at which to start retrieving results. This must come from the opc-next-page or opc-prev-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. (default to timeCreated)

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :display_name (String) —

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

  • :security_rule_priority_order (Integer) —

    Unique priority order for Security Rules in the network firewall policy.

Returns:



4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 4069

def list_security_rules(network_firewall_policy_id, opts = {})
  logger.debug 'Calling operation NetworkFirewallClient#list_security_rules.' if logger

  raise "Missing the required parameter 'network_firewall_policy_id' when calling list_security_rules." if network_firewall_policy_id.nil?

  if opts[:sort_order] && !OCI::NetworkFirewall::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::NetworkFirewall::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
  raise "Parameter value for 'network_firewall_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(network_firewall_policy_id)

  path = '/networkFirewallPolicies/{networkFirewallPolicyId}/securityRules'.sub('{networkFirewallPolicyId}', network_firewall_policy_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  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[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:securityRulePriorityOrder] = opts[:security_rule_priority_order] if opts[:security_rule_priority_order]

  # 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: 'NetworkFirewallClient#list_security_rules') 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::NetworkFirewall::Models::SecurityRuleSummaryCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_service_lists(network_firewall_policy_id, opts = {}) ⇒ Response

Note:

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

Returns a list of ServiceLists for the policy.

Allowed values are: timeCreated, displayName

Parameters:

  • network_firewall_policy_id (String) —

    Unique Network Firewall Policy identifier

  • 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

  • :limit (Integer) —

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

  • :page (String) —

    A token representing the position at which to start retrieving results. This must come from the opc-next-page or opc-prev-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. (default to timeCreated)

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :display_name (String) —

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

Returns:



4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 4145

def list_service_lists(network_firewall_policy_id, opts = {})
  logger.debug 'Calling operation NetworkFirewallClient#list_service_lists.' if logger

  raise "Missing the required parameter 'network_firewall_policy_id' when calling list_service_lists." if network_firewall_policy_id.nil?

  if opts[:sort_order] && !OCI::NetworkFirewall::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::NetworkFirewall::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
  raise "Parameter value for 'network_firewall_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(network_firewall_policy_id)

  path = '/networkFirewallPolicies/{networkFirewallPolicyId}/serviceLists'.sub('{networkFirewallPolicyId}', network_firewall_policy_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  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[:displayName] = opts[:display_name] if opts[:display_name]

  # 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: 'NetworkFirewallClient#list_service_lists') 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::NetworkFirewall::Models::ServiceListSummaryCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_services(network_firewall_policy_id, opts = {}) ⇒ Response

Note:

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

Returns a list of Services for the policy.

Allowed values are: timeCreated, displayName

Parameters:

  • network_firewall_policy_id (String) —

    Unique Network Firewall Policy identifier

  • 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

  • :limit (Integer) —

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

  • :page (String) —

    A token representing the position at which to start retrieving results. This must come from the opc-next-page or opc-prev-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. (default to timeCreated)

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :display_name (String) —

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

Returns:



4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 4220

def list_services(network_firewall_policy_id, opts = {})
  logger.debug 'Calling operation NetworkFirewallClient#list_services.' if logger

  raise "Missing the required parameter 'network_firewall_policy_id' when calling list_services." if network_firewall_policy_id.nil?

  if opts[:sort_order] && !OCI::NetworkFirewall::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::NetworkFirewall::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
  raise "Parameter value for 'network_firewall_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(network_firewall_policy_id)

  path = '/networkFirewallPolicies/{networkFirewallPolicyId}/services'.sub('{networkFirewallPolicyId}', network_firewall_policy_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  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[:displayName] = opts[:display_name] if opts[:display_name]

  # 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: 'NetworkFirewallClient#list_services') 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::NetworkFirewall::Models::ServiceSummaryCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_url_lists(network_firewall_policy_id, opts = {}) ⇒ Response

Note:

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

Returns a list of URL lists for the Network Firewall Policy.

Allowed values are: timeCreated, displayName

Parameters:

  • network_firewall_policy_id (String) —

    Unique Network Firewall Policy identifier

  • 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

  • :limit (Integer) —

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

  • :page (String) —

    A token representing the position at which to start retrieving results. This must come from the opc-next-page or opc-prev-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. (default to timeCreated)

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :display_name (String) —

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

Returns:



4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 4295

def list_url_lists(network_firewall_policy_id, opts = {})
  logger.debug 'Calling operation NetworkFirewallClient#list_url_lists.' if logger

  raise "Missing the required parameter 'network_firewall_policy_id' when calling list_url_lists." if network_firewall_policy_id.nil?

  if opts[:sort_order] && !OCI::NetworkFirewall::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::NetworkFirewall::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
  raise "Parameter value for 'network_firewall_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(network_firewall_policy_id)

  path = '/networkFirewallPolicies/{networkFirewallPolicyId}/urlLists'.sub('{networkFirewallPolicyId}', network_firewall_policy_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  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[:displayName] = opts[:display_name] if opts[:display_name]

  # 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: 'NetworkFirewallClient#list_url_lists') 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::NetworkFirewall::Models::UrlListSummaryCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_work_request_errors(work_request_id, opts = {}) ⇒ Response

Note:

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

Return a (paginated) list of errors for a given work request.

Allowed values are: timeAccepted

Parameters:

  • work_request_id (String) —

    The ID of the asynchronous request.

  • 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.

  • :page (String) —

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

  • :limit (Integer) —

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

  • :sort_by (String) —

    The field to sort by. Only one sort order may be provided. Default order for timeAccepted is descending. (default to timeAccepted)

  • :sort_order (String) —

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

Returns:



4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 4369

def list_work_request_errors(work_request_id, opts = {})
  logger.debug 'Calling operation NetworkFirewallClient#list_work_request_errors.' if logger

  raise "Missing the required parameter 'work_request_id' when calling list_work_request_errors." if work_request_id.nil?

  if opts[:sort_by] && !%w[timeAccepted].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeAccepted.'
  end

  if opts[:sort_order] && !OCI::NetworkFirewall::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::NetworkFirewall::Models::SORT_ORDER_ENUM.'
  end
  raise "Parameter value for 'work_request_id' must not be blank" if OCI::Internal::Util.blank_string?(work_request_id)

  path = '/workRequests/{workRequestId}/errors'.sub('{workRequestId}', work_request_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  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]

  # 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: 'NetworkFirewallClient#list_work_request_errors') 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::NetworkFirewall::Models::WorkRequestErrorCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_work_request_logs(work_request_id, opts = {}) ⇒ Response

Note:

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

Return a (paginated) list of logs for a given work request.

Allowed values are: timeAccepted

Parameters:

  • work_request_id (String) —

    The ID of the asynchronous request.

  • 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.

  • :page (String) —

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

  • :limit (Integer) —

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

  • :sort_by (String) —

    The field to sort by. Only one sort order may be provided. Default order for timeAccepted is descending. (default to timeAccepted)

  • :sort_order (String) —

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

Returns:



4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 4442

def list_work_request_logs(work_request_id, opts = {})
  logger.debug 'Calling operation NetworkFirewallClient#list_work_request_logs.' if logger

  raise "Missing the required parameter 'work_request_id' when calling list_work_request_logs." if work_request_id.nil?

  if opts[:sort_by] && !%w[timeAccepted].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeAccepted.'
  end

  if opts[:sort_order] && !OCI::NetworkFirewall::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::NetworkFirewall::Models::SORT_ORDER_ENUM.'
  end
  raise "Parameter value for 'work_request_id' must not be blank" if OCI::Internal::Util.blank_string?(work_request_id)

  path = '/workRequests/{workRequestId}/logs'.sub('{workRequestId}', work_request_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  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]

  # 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: 'NetworkFirewallClient#list_work_request_logs') 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::NetworkFirewall::Models::WorkRequestLogEntryCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Lists the work requests in a compartment.

Allowed values are: timeAccepted

Parameters:

  • compartment_id (String) —

    The ID 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

  • :work_request_id (String) —

    The ID of the asynchronous work request.

  • :status (String) —

    A filter to return only resources their lifecycleState matches the given OperationStatus.

  • :resource_id (String) —

    The ID of the resource affected by the work request.

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :page (String) —

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

  • :limit (Integer) —

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

  • :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 timeAccepted is descending. (default to timeAccepted)

Returns:



4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 4518

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

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

  if opts[:status] && !OCI::NetworkFirewall::Models::OPERATION_STATUS_ENUM.include?(opts[:status])
    raise 'Invalid value for "status", must be one of the values in OCI::NetworkFirewall::Models::OPERATION_STATUS_ENUM.'
  end

  if opts[:sort_order] && !OCI::NetworkFirewall::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::NetworkFirewall::Models::SORT_ORDER_ENUM.'
  end

  if opts[:sort_by] && !%w[timeAccepted].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeAccepted.'
  end

  path = '/workRequests'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:workRequestId] = opts[:work_request_id] if opts[:work_request_id]
  query_params[:status] = opts[:status] if opts[:status]
  query_params[:resourceId] = opts[:resource_id] if opts[:resource_id]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:limit] = opts[:limit] if opts[:limit]
  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: 'NetworkFirewallClient#list_work_requests') 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::NetworkFirewall::Models::WorkRequestSummaryCollection'
    )
  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.



94
95
96
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 94

def logger
  @api_client.config.logger
end

#migrate_network_firewall_policy(network_firewall_policy_id, opts = {}) ⇒ Response

Note:

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

Moves a NetworkFirewallPolicy resource from one version to latest version. When provided, If-Match is checked against ETag values of the resource.

Parameters:

  • network_firewall_policy_id (String) —

    Unique Network Firewall Policy identifier

  • 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.

  • :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.

Returns:

  • (Response) —

    A Response object with data of type nil



4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 4603

def migrate_network_firewall_policy(network_firewall_policy_id, opts = {})
  logger.debug 'Calling operation NetworkFirewallClient#migrate_network_firewall_policy.' if logger

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

  path = '/networkFirewallPolicies/{networkFirewallPolicyId}/actions/migrate'.sub('{networkFirewallPolicyId}', network_firewall_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]
  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 = nil

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

#update_address_list(network_firewall_policy_id, address_list_name, update_address_list_details, opts = {}) ⇒ Response

Note:

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

Updates the Address list with the given name in the network firewall policy.

Parameters:

  • network_firewall_policy_id (String) —

    Unique Network Firewall Policy identifier

  • address_list_name (String) —

    Unique identifier for address lists.

  • update_address_list_details (OCI::NetworkFirewall::Models::UpdateAddressListDetails) —

    The information to be updated.

  • 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:



4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 4667

def update_address_list(network_firewall_policy_id, address_list_name, update_address_list_details, opts = {})
  logger.debug 'Calling operation NetworkFirewallClient#update_address_list.' if logger

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

  path = '/networkFirewallPolicies/{networkFirewallPolicyId}/addressLists/{addressListName}'.sub('{networkFirewallPolicyId}', network_firewall_policy_id.to_s).sub('{addressListName}', address_list_name.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_address_list_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'NetworkFirewallClient#update_address_list') 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::NetworkFirewall::Models::AddressList'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_application(network_firewall_policy_id, application_name, update_application_details, opts = {}) ⇒ Response

Note:

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

Updates the Application with the given name in the network firewall policy.

Parameters:

  • network_firewall_policy_id (String) —

    Unique Network Firewall Policy identifier

  • application_name (String) —

    Unique identifier for Applications.

  • update_application_details (OCI::NetworkFirewall::Models::UpdateApplicationDetails) —

    The information to be updated.

  • 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:



4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 4733

def update_application(network_firewall_policy_id, application_name, update_application_details, opts = {})
  logger.debug 'Calling operation NetworkFirewallClient#update_application.' if logger

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

  path = '/networkFirewallPolicies/{networkFirewallPolicyId}/applications/{applicationName}'.sub('{networkFirewallPolicyId}', network_firewall_policy_id.to_s).sub('{applicationName}', application_name.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_application_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'NetworkFirewallClient#update_application') 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::NetworkFirewall::Models::Application'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_application_group(network_firewall_policy_id, application_group_name, update_application_group_details, opts = {}) ⇒ Response

Note:

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

Updates the ApplicationGroup with the given name in the network firewall policy.

Parameters:

  • network_firewall_policy_id (String) —

    Unique Network Firewall Policy identifier

  • application_group_name (String) —

    Unique name identifier for Application Lists in the scope of Network Firewall Policy.

  • update_application_group_details (OCI::NetworkFirewall::Models::UpdateApplicationGroupDetails) —

    The information to be updated.

  • 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:



4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 4799

def update_application_group(network_firewall_policy_id, application_group_name, update_application_group_details, opts = {})
  logger.debug 'Calling operation NetworkFirewallClient#update_application_group.' if logger

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

  path = '/networkFirewallPolicies/{networkFirewallPolicyId}/applicationGroups/{applicationGroupName}'.sub('{networkFirewallPolicyId}', network_firewall_policy_id.to_s).sub('{applicationGroupName}', application_group_name.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_application_group_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'NetworkFirewallClient#update_application_group') 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::NetworkFirewall::Models::ApplicationGroup'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_decryption_profile(network_firewall_policy_id, decryption_profile_name, update_decryption_profile_details, opts = {}) ⇒ Response

Note:

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

Updates the Decryption Profile with the given name in the network firewall policy.

Parameters:

  • network_firewall_policy_id (String) —

    Unique Network Firewall Policy identifier

  • decryption_profile_name (String) —

    Unique identifier for Decryption Profiles.

  • update_decryption_profile_details (OCI::NetworkFirewall::Models::UpdateDecryptionProfileDetails) —

    The information to be updated.

  • 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:



4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 4865

def update_decryption_profile(network_firewall_policy_id, decryption_profile_name, update_decryption_profile_details, opts = {})
  logger.debug 'Calling operation NetworkFirewallClient#update_decryption_profile.' if logger

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

  path = '/networkFirewallPolicies/{networkFirewallPolicyId}/decryptionProfiles/{decryptionProfileName}'.sub('{networkFirewallPolicyId}', network_firewall_policy_id.to_s).sub('{decryptionProfileName}', decryption_profile_name.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_decryption_profile_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'NetworkFirewallClient#update_decryption_profile') 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::NetworkFirewall::Models::DecryptionProfile'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_decryption_rule(network_firewall_policy_id, decryption_rule_name, update_decryption_rule_details, opts = {}) ⇒ Response

Note:

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

Updates the Decryption Rule with the given name in the network firewall policy.

Parameters:

  • network_firewall_policy_id (String) —

    Unique Network Firewall Policy identifier

  • decryption_rule_name (String) —

    Unique identifier for Decryption Rules in the network firewall policy.

  • update_decryption_rule_details (OCI::NetworkFirewall::Models::UpdateDecryptionRuleDetails) —

    The information to be updated.

  • 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:



4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 4931

def update_decryption_rule(network_firewall_policy_id, decryption_rule_name, update_decryption_rule_details, opts = {})
  logger.debug 'Calling operation NetworkFirewallClient#update_decryption_rule.' if logger

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

  path = '/networkFirewallPolicies/{networkFirewallPolicyId}/decryptionRules/{decryptionRuleName}'.sub('{networkFirewallPolicyId}', network_firewall_policy_id.to_s).sub('{decryptionRuleName}', decryption_rule_name.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_decryption_rule_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'NetworkFirewallClient#update_decryption_rule') 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::NetworkFirewall::Models::DecryptionRule'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_mapped_secret(network_firewall_policy_id, mapped_secret_name, update_mapped_secret_details, opts = {}) ⇒ Response

Note:

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

Updates the Mapped Secret with the given name in the network firewall policy.

Parameters:

  • network_firewall_policy_id (String) —

    Unique Network Firewall Policy identifier

  • mapped_secret_name (String) —

    Unique identifier for Mapped Secrets.

  • update_mapped_secret_details (OCI::NetworkFirewall::Models::UpdateMappedSecretDetails) —

    The information to be updated.

  • 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:



4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 4997

def update_mapped_secret(network_firewall_policy_id, mapped_secret_name, update_mapped_secret_details, opts = {})
  logger.debug 'Calling operation NetworkFirewallClient#update_mapped_secret.' if logger

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

  path = '/networkFirewallPolicies/{networkFirewallPolicyId}/mappedSecrets/{mappedSecretName}'.sub('{networkFirewallPolicyId}', network_firewall_policy_id.to_s).sub('{mappedSecretName}', mapped_secret_name.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_mapped_secret_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'NetworkFirewallClient#update_mapped_secret') 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::NetworkFirewall::Models::MappedSecret'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_network_firewall(network_firewall_id, update_network_firewall_details, opts = {}) ⇒ Response

Note:

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

Updates the NetworkFirewall

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



5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 5062

def update_network_firewall(network_firewall_id, update_network_firewall_details, opts = {})
  logger.debug 'Calling operation NetworkFirewallClient#update_network_firewall.' if logger

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

  path = '/networkFirewalls/{networkFirewallId}'.sub('{networkFirewallId}', network_firewall_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_network_firewall_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'NetworkFirewallClient#update_network_firewall') 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_network_firewall_policy(network_firewall_policy_id, update_network_firewall_policy_details, opts = {}) ⇒ Response

Note:

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

Updates the NetworkFirewallPolicy

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



5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 5124

def update_network_firewall_policy(network_firewall_policy_id, update_network_firewall_policy_details, opts = {})
  logger.debug 'Calling operation NetworkFirewallClient#update_network_firewall_policy.' if logger

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

  path = '/networkFirewallPolicies/{networkFirewallPolicyId}'.sub('{networkFirewallPolicyId}', network_firewall_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_network_firewall_policy_details)

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

#update_security_rule(network_firewall_policy_id, security_rule_name, update_security_rule_details, opts = {}) ⇒ Response

Note:

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

Updates the Security Rule with the given name in the network firewall policy.

Parameters:

  • network_firewall_policy_id (String) —

    Unique Network Firewall Policy identifier

  • security_rule_name (String) —

    Unique identifier for Security Rules in the network firewall policy.

  • update_security_rule_details (OCI::NetworkFirewall::Models::UpdateSecurityRuleDetails) —

    The information to be updated.

  • 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:



5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 5187

def update_security_rule(network_firewall_policy_id, security_rule_name, update_security_rule_details, opts = {})
  logger.debug 'Calling operation NetworkFirewallClient#update_security_rule.' if logger

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

  path = '/networkFirewallPolicies/{networkFirewallPolicyId}/securityRules/{securityRuleName}'.sub('{networkFirewallPolicyId}', network_firewall_policy_id.to_s).sub('{securityRuleName}', security_rule_name.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_security_rule_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'NetworkFirewallClient#update_security_rule') 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::NetworkFirewall::Models::SecurityRule'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_service(network_firewall_policy_id, service_name, update_service_details, opts = {}) ⇒ Response

Note:

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

Updates the Service with the given name in the network firewall policy.

Parameters:

  • network_firewall_policy_id (String) —

    Unique Network Firewall Policy identifier

  • service_name (String) —

    Unique identifier for Services.

  • update_service_details (OCI::NetworkFirewall::Models::UpdateServiceDetails) —

    The information to be updated.

  • 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:



5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 5253

def update_service(network_firewall_policy_id, service_name, update_service_details, opts = {})
  logger.debug 'Calling operation NetworkFirewallClient#update_service.' if logger

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

  path = '/networkFirewallPolicies/{networkFirewallPolicyId}/services/{serviceName}'.sub('{networkFirewallPolicyId}', network_firewall_policy_id.to_s).sub('{serviceName}', service_name.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_service_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'NetworkFirewallClient#update_service') 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::NetworkFirewall::Models::Service'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_service_list(network_firewall_policy_id, service_list_name, update_service_list_details, opts = {}) ⇒ Response

Note:

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

Updates the ServiceList with the given name in the network firewall policy.

Parameters:

  • network_firewall_policy_id (String) —

    Unique Network Firewall Policy identifier

  • service_list_name (String) —

    Unique name identifier for Service Lists in the scope of Network Firewall Policy.

  • update_service_list_details (OCI::NetworkFirewall::Models::UpdateServiceListDetails) —

    The information to be updated.

  • 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:



5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 5319

def update_service_list(network_firewall_policy_id, service_list_name, update_service_list_details, opts = {})
  logger.debug 'Calling operation NetworkFirewallClient#update_service_list.' if logger

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

  path = '/networkFirewallPolicies/{networkFirewallPolicyId}/serviceLists/{serviceListName}'.sub('{networkFirewallPolicyId}', network_firewall_policy_id.to_s).sub('{serviceListName}', service_list_name.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_service_list_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'NetworkFirewallClient#update_service_list') 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::NetworkFirewall::Models::ServiceList'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_url_list(network_firewall_policy_id, url_list_name, update_url_list_details, opts = {}) ⇒ Response

Note:

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

Updates the Url list with the given name in the network firewall policy.

Parameters:

  • network_firewall_policy_id (String) —

    Unique Network Firewall Policy identifier

  • url_list_name (String) —

    Unique name identifier for url lists in the scope of Network Firewall Policy.

  • update_url_list_details (OCI::NetworkFirewall::Models::UpdateUrlListDetails) —

    The information to be updated.

  • 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:



5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 5385

def update_url_list(network_firewall_policy_id, url_list_name, update_url_list_details, opts = {})
  logger.debug 'Calling operation NetworkFirewallClient#update_url_list.' if logger

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

  path = '/networkFirewallPolicies/{networkFirewallPolicyId}/urlLists/{urlListName}'.sub('{networkFirewallPolicyId}', network_firewall_policy_id.to_s).sub('{urlListName}', url_list_name.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_url_list_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'NetworkFirewallClient#update_url_list') 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::NetworkFirewall::Models::UrlList'
    )
  end
  # rubocop:enable Metrics/BlockLength
end