Options
All
  • Public
  • Public/Protected
  • All
Menu

Class NetworkFirewallClient

This service client uses {@link common.CircuitBreaker.DefaultConfiguration} for all the operations by default if no circuit breaker configuration is defined by the user.

Hierarchy

  • NetworkFirewallClient

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new NetworkFirewallClient(params: common.AuthParams, clientConfiguration?: common.ClientConfiguration): NetworkFirewallClient

Properties

Protected _bodyDuplexMode

_bodyDuplexMode: any = undefined

Protected _circuitBreaker

_circuitBreaker: typeof Breaker | null = null

Protected _clientConfiguration

_clientConfiguration: ClientConfiguration

Protected _defaultHeaders

_defaultHeaders: any

Protected _endpoint

_endpoint: string = ""

Protected _httpClient

_httpClient: HttpClient

Protected _httpOptions

_httpOptions: any = undefined

Protected _lastSetRegionOrRegionId

_lastSetRegionOrRegionId: string = ""

Protected _realmSpecificEndpointTemplateEnabled

_realmSpecificEndpointTemplateEnabled: boolean | undefined = undefined

Protected _region

_region: Region

Protected _regionId

_regionId: string = ""

Protected _waiters

targetService

targetService: string = "NetworkFirewall"

Static Protected endpointServiceName

endpointServiceName: string = ""

Static Protected serviceEndpointTemplate

serviceEndpointTemplate: string = "https://network-firewall.{region}.ocs.{secondLevelDomain}"

Accessors

endpoint

  • get endpoint(): string
  • set endpoint(endpoint: string): void

logger

region

  • set region(region: Region): void
  • Sets the region to call (ex, Region.US_PHOENIX_1). Note, this will call {@link #endpoint(String) endpoint} after resolving the endpoint.

    Parameters

    • region: Region

      The region of the service.

    Returns void

regionId

  • set regionId(regionId: string): void
  • Sets the regionId to call (ex, 'us-phoenix-1').

    Note, this will first try to map the region ID to a known Region and call {@link #region(Region) region}. If no known Region could be determined, it will create an endpoint assuming its in default Realm OC1 and then call {@link #endpoint(String) endpoint}.

    Parameters

    • regionId: string

      The public region ID.

    Returns void

useRealmSpecificEndpointTemplate

  • set useRealmSpecificEndpointTemplate(realmSpecificEndpointTemplateEnabled: boolean): void
  • Determines whether realm specific endpoint should be used or not. Set realmSpecificEndpointTemplateEnabled to "true" if the user wants to enable use of realm specific endpoint template, otherwise set it to "false"

    Parameters

    • realmSpecificEndpointTemplateEnabled: boolean

      flag to enable the use of realm specific endpoint template

    Returns void

Methods

applyNetworkFirewallPolicy

  • Applies the candidate version of the NetworkFirewallPolicy resource. When provided, If-Match is checked against ETag values of the resource. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ApplyNetworkFirewallPolicy API.

    Parameters

    Returns Promise<ApplyNetworkFirewallPolicyResponse>

    ApplyNetworkFirewallPolicyResponse

bulkUploadAddressLists

bulkUploadApplicationGroups

bulkUploadApplications

bulkUploadDecryptionProfiles

bulkUploadDecryptionRules

bulkUploadMappedSecrets

bulkUploadSecurityRules

bulkUploadServiceLists

bulkUploadServices

  • Creates new Services at bulk for the Network Firewall Policy.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use BulkUploadServices API.

    Parameters

    Returns Promise<BulkUploadServicesResponse>

    BulkUploadServicesResponse

bulkUploadUrlLists

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use BulkUploadUrlLists API.

    Parameters

    Returns Promise<BulkUploadUrlListsResponse>

    BulkUploadUrlListsResponse

cancelWorkRequest

changeNetworkFirewallCompartment

  • Moves a NetworkFirewall resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ChangeNetworkFirewallCompartment API.

    Parameters

    Returns Promise<ChangeNetworkFirewallCompartmentResponse>

    ChangeNetworkFirewallCompartmentResponse

changeNetworkFirewallPolicyCompartment

cloneNetworkFirewallPolicy

  • Moves a NetworkFirewallPolicy resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CloneNetworkFirewallPolicy API.

    Parameters

    Returns Promise<CloneNetworkFirewallPolicyResponse>

    CloneNetworkFirewallPolicyResponse

close

  • close(): void

createAddressList

  • Creates a new Address List for the Network Firewall Policy.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateAddressList API.

    Parameters

    Returns Promise<CreateAddressListResponse>

    CreateAddressListResponse

createApplication

  • Creates a new Application for the Network Firewall Policy.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateApplication API.

    Parameters

    Returns Promise<CreateApplicationResponse>

    CreateApplicationResponse

createApplicationGroup

createDecryptionProfile

createDecryptionRule

createMappedSecret

createNetworkFirewall

createNetworkFirewallPolicy

createSecurityRule

createService

  • Creates a new Service for the Network Firewall Policy.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateService API.

    Parameters

    Returns Promise<CreateServiceResponse>

    CreateServiceResponse

createServiceList

  • Creates a new ServiceList for the Network Firewall Policy.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateServiceList API.

    Parameters

    Returns Promise<CreateServiceListResponse>

    CreateServiceListResponse

createUrlList

  • Creates a new Url List for the Network Firewall Policy.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateUrlList API.

    Parameters

    Returns Promise<CreateUrlListResponse>

    CreateUrlListResponse

createWaiters

deleteAddressList

  • Deletes a Address List resource with the given identifier. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteAddressList API.

    Parameters

    Returns Promise<DeleteAddressListResponse>

    DeleteAddressListResponse

deleteApplication

  • Deletes a Application resource with the given identifier. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteApplication API.

    Parameters

    Returns Promise<DeleteApplicationResponse>

    DeleteApplicationResponse

deleteApplicationGroup

deleteDecryptionProfile

deleteDecryptionRule

deleteMappedSecret

deleteNetworkFirewall

deleteNetworkFirewallPolicy

deleteSecurityRule

deleteService

  • Deletes a Service resource with the given identifier. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteService API.

    Parameters

    Returns Promise<DeleteServiceResponse>

    DeleteServiceResponse

deleteServiceList

  • Deletes a ServiceList resource with the given identifier. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteServiceList API.

    Parameters

    Returns Promise<DeleteServiceListResponse>

    DeleteServiceListResponse

deleteUrlList

  • Deletes a Url List resource with the given identifier. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteUrlList API.

    Parameters

    Returns Promise<DeleteUrlListResponse>

    DeleteUrlListResponse

getAddressList

  • Get Address List by the given name in the context of network firewall policy. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetAddressList API.

    Parameters

    Returns Promise<GetAddressListResponse>

    GetAddressListResponse

getApplication

  • Get Application by the given name in the context of network firewall policy. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetApplication API.

    Parameters

    Returns Promise<GetApplicationResponse>

    GetApplicationResponse

getApplicationGroup

  • Get ApplicationGroup by the given name in the context of network firewall policy. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetApplicationGroup API.

    Parameters

    Returns Promise<GetApplicationGroupResponse>

    GetApplicationGroupResponse

getDecryptionProfile

  • Get Decryption Profile by the given name in the context of network firewall policy. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetDecryptionProfile API.

    Parameters

    Returns Promise<GetDecryptionProfileResponse>

    GetDecryptionProfileResponse

getDecryptionRule

  • Get Decryption Rule by the given name in the context of network firewall policy. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetDecryptionRule API.

    Parameters

    Returns Promise<GetDecryptionRuleResponse>

    GetDecryptionRuleResponse

getMappedSecret

  • Get Mapped Secret by the given name in the context of network firewall policy. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetMappedSecret API.

    Parameters

    Returns Promise<GetMappedSecretResponse>

    GetMappedSecretResponse

getNetworkFirewall

getNetworkFirewallPolicy

getSecurityRule

  • Get Security Rule by the given name in the context of network firewall policy. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetSecurityRule API.

    Parameters

    Returns Promise<GetSecurityRuleResponse>

    GetSecurityRuleResponse

getService

  • Get Service by the given name in the context of network firewall policy. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetService API.

    Parameters

    Returns Promise<GetServiceResponse>

    GetServiceResponse

getServiceList

  • Get ServiceList by the given name in the context of network firewall policy. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetServiceList API.

    Parameters

    Returns Promise<GetServiceListResponse>

    GetServiceListResponse

getUrlList

  • Get Url List by the given name in the context of network firewall policy. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetUrlList API.

    Parameters

    Returns Promise<GetUrlListResponse>

    GetUrlListResponse

getWaiters

getWorkRequest

  • Gets the status of the work request with the given ID. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetWorkRequest API.

    Parameters

    Returns Promise<GetWorkRequestResponse>

    GetWorkRequestResponse

listAddressLists

listApplicationGroups

listApplications

listDecryptionProfiles

listDecryptionRules

listMappedSecrets

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListMappedSecrets API.

    Parameters

    Returns Promise<ListMappedSecretsResponse>

    ListMappedSecretsResponse

listNetworkFirewallPolicies

listNetworkFirewalls

listSecurityRules

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListSecurityRules API.

    Parameters

    Returns Promise<ListSecurityRulesResponse>

    ListSecurityRulesResponse

listServiceLists

listServices

  • Returns a list of Services for the policy.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListServices API.

    Parameters

    Returns Promise<ListServicesResponse>

    ListServicesResponse

listUrlLists

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListUrlLists API.

    Parameters

    Returns Promise<ListUrlListsResponse>

    ListUrlListsResponse

listWorkRequestErrors

listWorkRequestLogs

listWorkRequests

migrateNetworkFirewallPolicy

  • Moves a NetworkFirewallPolicy resource from one version to latest version. When provided, If-Match is checked against ETag values of the resource. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use MigrateNetworkFirewallPolicy API.

    Parameters

    Returns Promise<MigrateNetworkFirewallPolicyResponse>

    MigrateNetworkFirewallPolicyResponse

shutdownCircuitBreaker

  • shutdownCircuitBreaker(): void

updateAddressList

  • Updates the Address list with the given name in the network firewall policy. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateAddressList API.

    Parameters

    Returns Promise<UpdateAddressListResponse>

    UpdateAddressListResponse

updateApplication

  • Updates the Application with the given name in the network firewall policy. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateApplication API.

    Parameters

    Returns Promise<UpdateApplicationResponse>

    UpdateApplicationResponse

updateApplicationGroup

updateDecryptionProfile

updateDecryptionRule

  • Updates the Decryption Rule with the given name in the network firewall policy. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateDecryptionRule API.

    Parameters

    Returns Promise<UpdateDecryptionRuleResponse>

    UpdateDecryptionRuleResponse

updateMappedSecret

  • Updates the Mapped Secret with the given name in the network firewall policy. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateMappedSecret API.

    Parameters

    Returns Promise<UpdateMappedSecretResponse>

    UpdateMappedSecretResponse

updateNetworkFirewall

updateNetworkFirewallPolicy

updateSecurityRule

  • Updates the Security Rule with the given name in the network firewall policy. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateSecurityRule API.

    Parameters

    Returns Promise<UpdateSecurityRuleResponse>

    UpdateSecurityRuleResponse

updateService

  • Updates the Service with the given name in the network firewall policy. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateService API.

    Parameters

    Returns Promise<UpdateServiceResponse>

    UpdateServiceResponse

updateServiceList

  • Updates the ServiceList with the given name in the network firewall policy. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateServiceList API.

    Parameters

    Returns Promise<UpdateServiceListResponse>

    UpdateServiceListResponse

updateUrlList

  • Updates the Url list with the given name in the network firewall policy. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateUrlList API.

    Parameters

    Returns Promise<UpdateUrlListResponse>

    UpdateUrlListResponse