NetworkFirewall (Oracle Cloud Infrastructure Java SDK

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

NetworkFirewallClient
```
@Generated(value="OracleSDKGenerator",
           comments="API Version: 20211001")
public interface NetworkFirewall
extends AutoCloseable
```
Use the Network Firewall API to create network firewalls and configure policies that regulates network traffic in and across VCNs. This service client uses CircuitBreakerUtils.DEFAULT_CIRCUIT_BREAKER for all the operations by default if no circuit breaker configuration is defined by the user.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`CancelWorkRequestResponse`	`cancelWorkRequest(CancelWorkRequestRequest request)` Cancel work request with the given ID.
`ChangeNetworkFirewallCompartmentResponse`	`changeNetworkFirewallCompartment(ChangeNetworkFirewallCompartmentRequest request)` Moves a NetworkFirewall resource from one compartment identifier to another.
`ChangeNetworkFirewallPolicyCompartmentResponse`	`changeNetworkFirewallPolicyCompartment(ChangeNetworkFirewallPolicyCompartmentRequest request)` Moves a NetworkFirewallPolicy resource from one compartment identifier to another.
`CreateNetworkFirewallResponse`	`createNetworkFirewall(CreateNetworkFirewallRequest request)` Creates a new NetworkFirewall.
`CreateNetworkFirewallPolicyResponse`	`createNetworkFirewallPolicy(CreateNetworkFirewallPolicyRequest request)` Creates a new Network Firewall Policy.
`DeleteNetworkFirewallResponse`	`deleteNetworkFirewall(DeleteNetworkFirewallRequest request)` Deletes a NetworkFirewall resource by identifier
`DeleteNetworkFirewallPolicyResponse`	`deleteNetworkFirewallPolicy(DeleteNetworkFirewallPolicyRequest request)` Deletes a NetworkFirewallPolicy resource with the given identifier.
`String`	`getEndpoint()` Gets the set endpoint for REST call (ex, https://www.example.com)
`GetNetworkFirewallResponse`	`getNetworkFirewall(GetNetworkFirewallRequest request)` Gets a NetworkFirewall by identifier
`GetNetworkFirewallPolicyResponse`	`getNetworkFirewallPolicy(GetNetworkFirewallPolicyRequest request)` Gets a NetworkFirewallPolicy given the network firewall policy identifier.
`NetworkFirewallPaginators`	`getPaginators()` Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
`NetworkFirewallWaiters`	`getWaiters()` Gets the pre-configured waiters available for resources for this service.
`GetWorkRequestResponse`	`getWorkRequest(GetWorkRequestRequest request)` Gets the status of the work request with the given ID.
`ListNetworkFirewallPoliciesResponse`	`listNetworkFirewallPolicies(ListNetworkFirewallPoliciesRequest request)` Returns a list of Network Firewall Policies.
`ListNetworkFirewallsResponse`	`listNetworkFirewalls(ListNetworkFirewallsRequest request)` Returns a list of NetworkFirewalls.
`ListWorkRequestErrorsResponse`	`listWorkRequestErrors(ListWorkRequestErrorsRequest request)` Return a (paginated) list of errors for a given work request.
`ListWorkRequestLogsResponse`	`listWorkRequestLogs(ListWorkRequestLogsRequest request)` Return a (paginated) list of logs for a given work request.
`ListWorkRequestsResponse`	`listWorkRequests(ListWorkRequestsRequest request)` Lists the work requests in a compartment.
`void`	`refreshClient()` Rebuilds the client from scratch.
`void`	`setEndpoint(String endpoint)` Sets the endpoint to call (ex, https://www.example.com).
`void`	`setRegion(Region region)` Sets the region to call (ex, Region.US_PHOENIX_1).
`void`	`setRegion(String regionId)` Sets the region to call (ex, ‘us-phoenix-1’).
`UpdateNetworkFirewallResponse`	`updateNetworkFirewall(UpdateNetworkFirewallRequest request)` Updates the NetworkFirewall
`UpdateNetworkFirewallPolicyResponse`	`updateNetworkFirewallPolicy(UpdateNetworkFirewallPolicyRequest request)` Updates the NetworkFirewallPolicy

Methods inherited from interface java.lang.AutoCloseable
close

- Method Detail
  - refreshClient
```
void refreshClient()
```
    Rebuilds the client from scratch. Useful to refresh certificates.
  - setEndpoint
```
void setEndpoint(String endpoint)
```
    Sets the endpoint to call (ex, https://www.example.com).
    
    Parameters:
    
    endpoint - The endpoint of the service.
  - getEndpoint
```
String getEndpoint()
```
    Gets the set endpoint for REST call (ex, https://www.example.com)
  - setRegion
```
void setRegion(Region region)
```
    Sets the region to call (ex, Region.US_PHOENIX_1).
    
    Note, this will call setEndpoint after resolving the endpoint. If the service is not available in this Region, however, an IllegalArgumentException will be raised.
    
    Parameters:
    
    region - The region of the service.
  - setRegion
```
void setRegion(String regionId)
```
    Sets the region to call (ex, ‘us-phoenix-1’).
    
    Note, this will first try to map the region ID to a known Region and call setRegion.
    If no known Region could be determined, it will create an endpoint based on the default endpoint format (Region.formatDefaultRegionEndpoint(Service, String) and then call setEndpoint.
    
    Parameters:
    
    regionId - The public region ID.
  - cancelWorkRequest
```
CancelWorkRequestResponse cancelWorkRequest(CancelWorkRequestRequest request)
```
    Cancel work request with the given ID.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use CancelWorkRequest API.
  - changeNetworkFirewallCompartment
```
ChangeNetworkFirewallCompartmentResponse changeNetworkFirewallCompartment(ChangeNetworkFirewallCompartmentRequest request)
```
    Moves a NetworkFirewall resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use ChangeNetworkFirewallCompartment API.
  - changeNetworkFirewallPolicyCompartment
```
ChangeNetworkFirewallPolicyCompartmentResponse changeNetworkFirewallPolicyCompartment(ChangeNetworkFirewallPolicyCompartmentRequest request)
```
    Moves a NetworkFirewallPolicy resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use ChangeNetworkFirewallPolicyCompartment API.
  - createNetworkFirewall
```
CreateNetworkFirewallResponse createNetworkFirewall(CreateNetworkFirewallRequest request)
```
    Creates a new NetworkFirewall.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use CreateNetworkFirewall API.
  - createNetworkFirewallPolicy
```
CreateNetworkFirewallPolicyResponse createNetworkFirewallPolicy(CreateNetworkFirewallPolicyRequest request)
```
    Creates a new Network Firewall Policy.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use CreateNetworkFirewallPolicy API.
  - deleteNetworkFirewall
```
DeleteNetworkFirewallResponse deleteNetworkFirewall(DeleteNetworkFirewallRequest request)
```
    Deletes a NetworkFirewall resource by identifier
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use DeleteNetworkFirewall API.
  - deleteNetworkFirewallPolicy
```
DeleteNetworkFirewallPolicyResponse deleteNetworkFirewallPolicy(DeleteNetworkFirewallPolicyRequest request)
```
    Deletes a NetworkFirewallPolicy resource with the given identifier.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use DeleteNetworkFirewallPolicy API.
  - getNetworkFirewall
```
GetNetworkFirewallResponse getNetworkFirewall(GetNetworkFirewallRequest request)
```
    Gets a NetworkFirewall by identifier
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use GetNetworkFirewall API.
  - getNetworkFirewallPolicy
```
GetNetworkFirewallPolicyResponse getNetworkFirewallPolicy(GetNetworkFirewallPolicyRequest request)
```
    Gets a NetworkFirewallPolicy given the network firewall policy identifier.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use GetNetworkFirewallPolicy API.
  - getWorkRequest
```
GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)
```
    Gets the status of the work request with the given ID.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use GetWorkRequest API.
  - listNetworkFirewallPolicies
```
ListNetworkFirewallPoliciesResponse listNetworkFirewallPolicies(ListNetworkFirewallPoliciesRequest request)
```
    Returns a list of Network Firewall Policies.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use ListNetworkFirewallPolicies API.
  - listNetworkFirewalls
```
ListNetworkFirewallsResponse listNetworkFirewalls(ListNetworkFirewallsRequest request)
```
    Returns a list of NetworkFirewalls.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use ListNetworkFirewalls API.
  - listWorkRequestErrors
```
ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)
```
    Return a (paginated) list of errors for a given work request.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use ListWorkRequestErrors API.
  - listWorkRequestLogs
```
ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)
```
    Return a (paginated) list of logs for a given work request.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use ListWorkRequestLogs API.
  - listWorkRequests
```
ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)
```
    Lists the work requests in a compartment.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use ListWorkRequests API.
  - updateNetworkFirewall
```
UpdateNetworkFirewallResponse updateNetworkFirewall(UpdateNetworkFirewallRequest request)
```
    Updates the NetworkFirewall
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use UpdateNetworkFirewall API.
  - updateNetworkFirewallPolicy
```
UpdateNetworkFirewallPolicyResponse updateNetworkFirewallPolicy(UpdateNetworkFirewallPolicyRequest request)
```
    Updates the NetworkFirewallPolicy
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use UpdateNetworkFirewallPolicy API.
  - getWaiters
```
NetworkFirewallWaiters getWaiters()
```
    Gets the pre-configured waiters available for resources for this service.
    
    Returns:
    
    The service waiters.
  - getPaginators
```
NetworkFirewallPaginators getPaginators()
```
    Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data. These paginators provide an Iterable interface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.
    
    Returns:
    
    The service paginators.

Interface NetworkFirewall

Method Summary

Methods inherited from interface java.lang.AutoCloseable

Method Detail

refreshClient

setEndpoint

getEndpoint

setRegion

setRegion

cancelWorkRequest

changeNetworkFirewallCompartment

changeNetworkFirewallPolicyCompartment

createNetworkFirewall

createNetworkFirewallPolicy

deleteNetworkFirewall

deleteNetworkFirewallPolicy

getNetworkFirewall

getNetworkFirewallPolicy

getWorkRequest

listNetworkFirewallPolicies

listNetworkFirewalls

listWorkRequestErrors

listWorkRequestLogs

listWorkRequests

updateNetworkFirewall

updateNetworkFirewallPolicy

getWaiters

getPaginators