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_nat_rules(network_firewall_policy_id, bulk_upload_nat_rules_details, opts = {}) ⇒ Response

Note:

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

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

Parameters:

  • network_firewall_policy_id (String) —

    Unique Network Firewall Policy identifier

  • bulk_upload_nat_rules_details (String, IO) —

    Request Details to create the NAT 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_nat_rules(network_firewall_policy_id, bulk_upload_nat_rules_details, opts = {})
  logger.debug 'Calling operation NetworkFirewallClient#bulk_upload_nat_rules.' if logger

  raise "Missing the required parameter 'network_firewall_policy_id' when calling bulk_upload_nat_rules." if network_firewall_policy_id.nil?
  raise "Missing the required parameter 'bulk_upload_nat_rules_details' when calling bulk_upload_nat_rules." if bulk_upload_nat_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}/natRules/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_nat_rules_details)

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



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



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



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_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_tunnel_inspection_rules(network_firewall_policy_id, bulk_upload_tunnel_inspection_rules_details, opts = {}) ⇒ Response

Note:

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

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

Parameters:

  • network_firewall_policy_id (String) —

    Unique Network Firewall Policy identifier

  • bulk_upload_tunnel_inspection_rules_details (String, IO) —

    Request details to create the tunnel inspection 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



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
935
936
937
938
939
940
941
942
943
944
945
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 906

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

  raise "Missing the required parameter 'network_firewall_policy_id' when calling bulk_upload_tunnel_inspection_rules." if network_firewall_policy_id.nil?
  raise "Missing the required parameter 'bulk_upload_tunnel_inspection_rules_details' when calling bulk_upload_tunnel_inspection_rules." if bulk_upload_tunnel_inspection_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}/tunnelInspectionRules/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_tunnel_inspection_rules_details)

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



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
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 977

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



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

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



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

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



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
1211
1212
1213
1214
1215
1216
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 1177

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.

Clones a NetworkFirewallPolicy resource from an existing Network Firewall Policy. 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:



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
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 1247

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:



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
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 1313

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:



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
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 1378

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:



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
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 1443

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:



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
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 1508

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:



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
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 1573

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:



1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 1638

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_nat_rule(network_firewall_policy_id, create_nat_rule_details, opts = {}) ⇒ Response

Note:

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

Creates a new NAT Rule for the Network Firewall Policy.

Parameters:

  • network_firewall_policy_id (String) —

    Unique Network Firewall Policy identifier

  • create_nat_rule_details (OCI::NetworkFirewall::Models::CreateNatRuleDetails) —

    Request Details to create NAT rule under a 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:



1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 1703

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

  raise "Missing the required parameter 'network_firewall_policy_id' when calling create_nat_rule." if network_firewall_policy_id.nil?
  raise "Missing the required parameter 'create_nat_rule_details' when calling create_nat_rule." if create_nat_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}/natRules'.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_nat_rule_details)

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



1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 1767

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:



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
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 1829

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:



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
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 1892

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:



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
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 1957

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:



2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 2022

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_tunnel_inspection_rule(network_firewall_policy_id, create_tunnel_inspection_rule_details, opts = {}) ⇒ Response

Note:

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

Creates a new tunnel inspection rule for the 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:



2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 2087

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

  raise "Missing the required parameter 'network_firewall_policy_id' when calling create_tunnel_inspection_rule." if network_firewall_policy_id.nil?
  raise "Missing the required parameter 'create_tunnel_inspection_rule_details' when calling create_tunnel_inspection_rule." if create_tunnel_inspection_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}/tunnelInspectionRules'.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_tunnel_inspection_rule_details)

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



2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 2152

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



2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 2216

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



2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 2279

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



2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 2342

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



2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 2405

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



2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 2468

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



2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 2531

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_nat_rule(network_firewall_policy_id, nat_rule_name, opts = {}) ⇒ Response

Note:

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

Deletes a NAT Rule resource with the given identifier.

Parameters:

  • network_firewall_policy_id (String) —

    Unique Network Firewall Policy identifier

  • nat_rule_name (String) —

    Unique identifier for NAT 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



2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 2594

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

  raise "Missing the required parameter 'network_firewall_policy_id' when calling delete_nat_rule." if network_firewall_policy_id.nil?
  raise "Missing the required parameter 'nat_rule_name' when calling delete_nat_rule." if nat_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 'nat_rule_name' must not be blank" if OCI::Internal::Util.blank_string?(nat_rule_name)

  path = '/networkFirewallPolicies/{networkFirewallPolicyId}/natRules/{natRuleName}'.sub('{networkFirewallPolicyId}', network_firewall_policy_id.to_s).sub('{natRuleName}', nat_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_nat_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_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



2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 2656

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



2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 2716

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



2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 2777

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



2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 2840

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



2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 2903

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_tunnel_inspection_rule(network_firewall_policy_id, tunnel_inspection_rule_name, opts = {}) ⇒ Response

Note:

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

Deletes a tunnel inspection rule resource with the given identifier.

Parameters:

  • network_firewall_policy_id (String) —

    Unique Network Firewall Policy identifier

  • tunnel_inspection_rule_name (String) —

    Unique identifier for Tunnel Inspection 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



2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 2966

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

  raise "Missing the required parameter 'network_firewall_policy_id' when calling delete_tunnel_inspection_rule." if network_firewall_policy_id.nil?
  raise "Missing the required parameter 'tunnel_inspection_rule_name' when calling delete_tunnel_inspection_rule." if tunnel_inspection_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 'tunnel_inspection_rule_name' must not be blank" if OCI::Internal::Util.blank_string?(tunnel_inspection_rule_name)

  path = '/networkFirewallPolicies/{networkFirewallPolicyId}/tunnelInspectionRules/{tunnelInspectionRuleName}'.sub('{networkFirewallPolicyId}', network_firewall_policy_id.to_s).sub('{tunnelInspectionRuleName}', tunnel_inspection_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_tunnel_inspection_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_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



3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
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
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 3029

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:



3086
3087
3088
3089
3090
3091
3092
3093
3094
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
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 3086

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:



3145
3146
3147
3148
3149
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
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 3145

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:



3204
3205
3206
3207
3208
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
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 3204

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:



3261
3262
3263
3264
3265
3266
3267
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
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 3261

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:



3320
3321
3322
3323
3324
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
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 3320

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:



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
3418
3419
3420
3421
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 3381

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_nat_rule(network_firewall_policy_id, nat_rule_name, opts = {}) ⇒ Response

Note:

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

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

Parameters:

  • network_firewall_policy_id (String) —

    Unique Network Firewall Policy identifier

  • nat_rule_name (String) —

    Unique identifier for NAT 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:



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

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

  raise "Missing the required parameter 'network_firewall_policy_id' when calling get_nat_rule." if network_firewall_policy_id.nil?
  raise "Missing the required parameter 'nat_rule_name' when calling get_nat_rule." if nat_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 'nat_rule_name' must not be blank" if OCI::Internal::Util.blank_string?(nat_rule_name)

  path = '/networkFirewallPolicies/{networkFirewallPolicyId}/natRules/{natRuleName}'.sub('{networkFirewallPolicyId}', network_firewall_policy_id.to_s).sub('{natRuleName}', nat_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_nat_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::NatRule'
    )
  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:



3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 3496

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:



3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 3550

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:



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

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:



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

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:



3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 3723

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_tunnel_inspection_rule(network_firewall_policy_id, tunnel_inspection_rule_name, opts = {}) ⇒ Response

Note:

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

Get tunnel inspection rule by the given name in the context of network firewall policy.

Parameters:

  • network_firewall_policy_id (String) —

    Unique Network Firewall Policy identifier

  • tunnel_inspection_rule_name (String) —

    Unique identifier for Tunnel Inspection 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:



3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 3780

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

  raise "Missing the required parameter 'network_firewall_policy_id' when calling get_tunnel_inspection_rule." if network_firewall_policy_id.nil?
  raise "Missing the required parameter 'tunnel_inspection_rule_name' when calling get_tunnel_inspection_rule." if tunnel_inspection_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 'tunnel_inspection_rule_name' must not be blank" if OCI::Internal::Util.blank_string?(tunnel_inspection_rule_name)

  path = '/networkFirewallPolicies/{networkFirewallPolicyId}/tunnelInspectionRules/{tunnelInspectionRuleName}'.sub('{networkFirewallPolicyId}', network_firewall_policy_id.to_s).sub('{tunnelInspectionRuleName}', tunnel_inspection_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_tunnel_inspection_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::TunnelInspectionRule'
    )
  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:



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
3870
3871
3872
3873
3874
3875
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 3837

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:



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

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:



3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 3955

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:



4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 4030

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:



4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 4105

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:



4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 4180

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:



4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 4256

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:



4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 4332

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_nat_rules(network_firewall_policy_id, opts = {}) ⇒ Response

Note:

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

Returns a list of NAT Rules 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.

  • :nat_rule_priority_order (Integer) —

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

Returns:



4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 4408

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

  raise "Missing the required parameter 'network_firewall_policy_id' when calling list_nat_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}/natRules'.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[:natRulePriorityOrder] = opts[:nat_rule_priority_order] if opts[:nat_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_nat_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::NatRuleCollection'
    )
  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:



4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 4486

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:



4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
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
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 4574

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:



4658
4659
4660
4661
4662
4663
4664
4665
4666
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
4708
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 4658

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:



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
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 4734

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:



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
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 4809

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_tunnel_inspection_rules(network_firewall_policy_id, opts = {}) ⇒ Response

Note:

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

Returns a list of tunnel inspection rules 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.

  • :tunnel_inspection_rule_priority_order (Integer) —

    Unique priority order for Tunnel Inspection rules in the network firewall policy.

Returns:



4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 4885

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

  raise "Missing the required parameter 'network_firewall_policy_id' when calling list_tunnel_inspection_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}/tunnelInspectionRules'.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[:tunnelInspectionRulePriorityOrder] = opts[:tunnel_inspection_rule_priority_order] if opts[:tunnel_inspection_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_tunnel_inspection_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::TunnelInspectionRuleSummaryCollection'
    )
  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:



4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 4961

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:



5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 5035

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:



5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
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
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 5108

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:



5184
5185
5186
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
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 5184

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



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
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 5269

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:



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
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 5333

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:



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
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 5399

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:



5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 5465

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:



5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 5531

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:



5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636
5637
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 5597

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:



5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 5663

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_nat_rule(network_firewall_policy_id, nat_rule_name, update_nat_rule_details, opts = {}) ⇒ Response

Note:

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

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

Parameters:

  • network_firewall_policy_id (String) —

    Unique Network Firewall Policy identifier

  • nat_rule_name (String) —

    Unique identifier for NAT Rules in the network firewall policy.

  • update_nat_rule_details (OCI::NetworkFirewall::Models::UpdateNatRuleDetails) —

    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:



5729
5730
5731
5732
5733
5734
5735
5736
5737
5738
5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 5729

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

  raise "Missing the required parameter 'network_firewall_policy_id' when calling update_nat_rule." if network_firewall_policy_id.nil?
  raise "Missing the required parameter 'nat_rule_name' when calling update_nat_rule." if nat_rule_name.nil?
  raise "Missing the required parameter 'update_nat_rule_details' when calling update_nat_rule." if update_nat_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 'nat_rule_name' must not be blank" if OCI::Internal::Util.blank_string?(nat_rule_name)

  path = '/networkFirewallPolicies/{networkFirewallPolicyId}/natRules/{natRuleName}'.sub('{networkFirewallPolicyId}', network_firewall_policy_id.to_s).sub('{natRuleName}', nat_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_nat_rule_details)

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



5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
5814
5815
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
5827
5828
5829
5830
5831
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 5794

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



5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
5889
5890
5891
5892
5893
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 5856

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:



5919
5920
5921
5922
5923
5924
5925
5926
5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
5952
5953
5954
5955
5956
5957
5958
5959
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 5919

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:



5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 5985

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:



6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
6086
6087
6088
6089
6090
6091
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 6051

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_tunnel_inspection_rule(network_firewall_policy_id, tunnel_inspection_rule_name, update_tunnel_inspection_rule_details, opts = {}) ⇒ Response

Note:

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

Updates the tunnel inspection rule with the given name in the network firewall policy.

Parameters:

  • network_firewall_policy_id (String) —

    Unique Network Firewall Policy identifier

  • tunnel_inspection_rule_name (String) —

    Unique identifier for Tunnel Inspection Rules in the network firewall policy.

  • update_tunnel_inspection_rule_details (OCI::NetworkFirewall::Models::UpdateTunnelInspectionRuleDetails) —

    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:



6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 6117

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

  raise "Missing the required parameter 'network_firewall_policy_id' when calling update_tunnel_inspection_rule." if network_firewall_policy_id.nil?
  raise "Missing the required parameter 'tunnel_inspection_rule_name' when calling update_tunnel_inspection_rule." if tunnel_inspection_rule_name.nil?
  raise "Missing the required parameter 'update_tunnel_inspection_rule_details' when calling update_tunnel_inspection_rule." if update_tunnel_inspection_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 'tunnel_inspection_rule_name' must not be blank" if OCI::Internal::Util.blank_string?(tunnel_inspection_rule_name)

  path = '/networkFirewallPolicies/{networkFirewallPolicyId}/tunnelInspectionRules/{tunnelInspectionRuleName}'.sub('{networkFirewallPolicyId}', network_firewall_policy_id.to_s).sub('{tunnelInspectionRuleName}', tunnel_inspection_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_tunnel_inspection_rule_details)

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



6183
6184
6185
6186
6187
6188
6189
6190
6191
6192
6193
6194
6195
6196
6197
6198
6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
6223
 
# File 'lib/oci/network_firewall/network_firewall_client.rb', line 6183

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