Options
All
  • Public
  • Public/Protected
  • All
Menu

Class WafClient

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

  • WafClient

Constructors

constructor

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

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

_waiters: WafWaiter

targetService

targetService: string = "Waf"

Static Protected endpointServiceName

endpointServiceName: string = ""

Static Protected serviceEndpointTemplate

serviceEndpointTemplate: string = "https://waf.{region}.oci.{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

changeNetworkAddressListCompartment

  • Moves a NetworkAddressList resource from one compartment 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 ChangeNetworkAddressListCompartment API.

    Parameters

    Returns Promise<ChangeNetworkAddressListCompartmentResponse>

    ChangeNetworkAddressListCompartmentResponse

changeWebAppFirewallCompartment

  • Moves a Web App Firewall resource from one compartment 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 ChangeWebAppFirewallCompartment API.

    Parameters

    Returns Promise<ChangeWebAppFirewallCompartmentResponse>

    ChangeWebAppFirewallCompartmentResponse

changeWebAppFirewallPolicyCompartment

  • Moves a WebAppFirewallfPolicy resource from one compartment 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 ChangeWebAppFirewallPolicyCompartment API.

    Parameters

    Returns Promise<ChangeWebAppFirewallPolicyCompartmentResponse>

    ChangeWebAppFirewallPolicyCompartmentResponse

close

  • close(): void

createNetworkAddressList

createWaiters

  • createWaiters(config?: common.WaiterConfiguration): WafWaiter
  • Creates a new WafWaiter for resources for this service.

    Parameters

    • Optional config: common.WaiterConfiguration

      The waiter configuration for termination and delay strategy

    Returns WafWaiter

    The service waiters.

createWebAppFirewall

  • Creates a new WebAppFirewall.

    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 CreateWebAppFirewall API.

    Parameters

    Returns Promise<CreateWebAppFirewallResponse>

    CreateWebAppFirewallResponse

createWebAppFirewallPolicy

deleteNetworkAddressList

  • Deletes a NetworkAddressList resource identified by the OCID. 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 DeleteNetworkAddressList API.

    Parameters

    Returns Promise<DeleteNetworkAddressListResponse>

    DeleteNetworkAddressListResponse

deleteWebAppFirewall

  • Deletes a WebAppFirewall resource identified by the OCID. 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 DeleteWebAppFirewall API.

    Parameters

    Returns Promise<DeleteWebAppFirewallResponse>

    DeleteWebAppFirewallResponse

deleteWebAppFirewallPolicy

  • Deletes a WebAppFirewallPolicy resource identified by the OCID. 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 DeleteWebAppFirewallPolicy API.

    Parameters

    Returns Promise<DeleteWebAppFirewallPolicyResponse>

    DeleteWebAppFirewallPolicyResponse

getNetworkAddressList

  • Gets a NetworkAddressList by OCID. 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 GetNetworkAddressList API.

    Parameters

    Returns Promise<GetNetworkAddressListResponse>

    GetNetworkAddressListResponse

getWaiters

getWebAppFirewall

  • Gets a WebAppFirewall by OCID. 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 GetWebAppFirewall API.

    Parameters

    Returns Promise<GetWebAppFirewallResponse>

    GetWebAppFirewallResponse

getWebAppFirewallPolicy

  • Gets a WebAppFirewallPolicy with the given OCID. 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 GetWebAppFirewallPolicy API.

    Parameters

    Returns Promise<GetWebAppFirewallPolicyResponse>

    GetWebAppFirewallPolicyResponse

getWorkRequest

  • Gets the status of the WorkRequest with the given OCID. 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

listNetworkAddressLists

  • Gets a list of all NetworkAddressLists in a compartment.

    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 ListNetworkAddressLists API.

    Parameters

    Returns Promise<ListNetworkAddressListsResponse>

    ListNetworkAddressListsResponse

listProtectionCapabilities

  • Lists of protection capabilities filtered by query parameters.

    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 ListProtectionCapabilities API.

    Parameters

    Returns Promise<ListProtectionCapabilitiesResponse>

    ListProtectionCapabilitiesResponse

listProtectionCapabilityGroupTags

listWebAppFirewallPolicies

  • Gets a list of all WebAppFirewallPolicies in a compartment.

    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 ListWebAppFirewallPolicies API.

    Parameters

    Returns Promise<ListWebAppFirewallPoliciesResponse>

    ListWebAppFirewallPoliciesResponse

listWebAppFirewalls

  • Gets a list of all WebAppFirewalls in a compartment.

    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 ListWebAppFirewalls API.

    Parameters

    Returns Promise<ListWebAppFirewallsResponse>

    ListWebAppFirewallsResponse

listWorkRequestErrors

  • Return a (paginated) list of errors for a given WorkRequest.

    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 ListWorkRequestErrors API.

    Parameters

    Returns Promise<ListWorkRequestErrorsResponse>

    ListWorkRequestErrorsResponse

listWorkRequestLogs

  • Return a (paginated) list of logs for a given WorkRequest.

    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 ListWorkRequestLogs API.

    Parameters

    Returns Promise<ListWorkRequestLogsResponse>

    ListWorkRequestLogsResponse

listWorkRequests

  • Lists the WorkRequests in a compartment.

    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 ListWorkRequests API.

    Parameters

    Returns Promise<ListWorkRequestsResponse>

    ListWorkRequestsResponse

shutdownCircuitBreaker

  • shutdownCircuitBreaker(): void

updateNetworkAddressList

  • Update the NetworkAddressList identified by the OCID. 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 UpdateNetworkAddressList API.

    Parameters

    Returns Promise<UpdateNetworkAddressListResponse>

    UpdateNetworkAddressListResponse

updateWebAppFirewall

  • Updates the WebAppFirewall identified by the OCID. 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 UpdateWebAppFirewall API.

    Parameters

    Returns Promise<UpdateWebAppFirewallResponse>

    UpdateWebAppFirewallResponse

updateWebAppFirewallPolicy

  • Update the WebAppFirewallPolicy identified by the OCID. 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 UpdateWebAppFirewallPolicy API.

    Parameters

    Returns Promise<UpdateWebAppFirewallPolicyResponse>

    UpdateWebAppFirewallPolicyResponse