com.oracle.bmc.networkfirewall

Class NetworkFirewallClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

com.oracle.bmc.networkfirewall.NetworkFirewallClient

All Implemented Interfaces:

NetworkFirewall, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20211001")
public class NetworkFirewallClient
extends BaseSyncClient
implements NetworkFirewall

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NetworkFirewallClient.Builder Builder class for this client.

Field Summary

Fields

Modifier and Type	Field and Description
static Service	SERVICE Service instance for NetworkFirewall.

Constructor Summary

Constructors

Constructor and Description
NetworkFirewallClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory) Deprecated. Use the builder instead.
NetworkFirewallClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators) Deprecated. Use the builder instead.
NetworkFirewallClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Deprecated. Use the builder instead.
NetworkFirewallClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Deprecated. Use the builder instead.
NetworkFirewallClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService) Deprecated. Use the builder instead.
NetworkFirewallClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider) Deprecated. Use the builder instead.
NetworkFirewallClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration) Deprecated. Use the builder instead.
NetworkFirewallClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator) Deprecated. Use the builder instead.

Method Summary

Modifier and Type	Method and Description
static NetworkFirewallClient.Builder	builder() Create a builder for this client.
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.
void	close()
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.
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
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() Rebuild the backing HttpClient.
void	setEndpoint(String endpoint)
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 class com.oracle.bmc.http.internal.BaseSyncClient

clientCall

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.oracle.bmc.networkfirewall.NetworkFirewall

getEndpoint, refreshClient, setEndpoint

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE

public static final Service SERVICE

Service instance for NetworkFirewall.

Constructor Detail

NetworkFirewallClient

@Deprecated
public NetworkFirewallClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see NetworkFirewallClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

NetworkFirewallClient

@Deprecated
public NetworkFirewallClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                         ClientConfiguration configuration)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see NetworkFirewallClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

NetworkFirewallClient

@Deprecated
public NetworkFirewallClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                         ClientConfiguration configuration,
                                         ClientConfigurator clientConfigurator)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see NetworkFirewallClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

NetworkFirewallClient

@Deprecated
public NetworkFirewallClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                         ClientConfiguration configuration,
                                         ClientConfigurator clientConfigurator,
                                         RequestSignerFactory defaultRequestSignerFactory)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see NetworkFirewallClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

NetworkFirewallClient

@Deprecated
public NetworkFirewallClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                         ClientConfiguration configuration,
                                         ClientConfigurator clientConfigurator,
                                         RequestSignerFactory defaultRequestSignerFactory,
                                         List<ClientConfigurator> additionalClientConfigurators)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see NetworkFirewallClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

NetworkFirewallClient

@Deprecated
public NetworkFirewallClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                         ClientConfiguration configuration,
                                         ClientConfigurator clientConfigurator,
                                         RequestSignerFactory defaultRequestSignerFactory,
                                         List<ClientConfigurator> additionalClientConfigurators,
                                         String endpoint)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see NetworkFirewallClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

NetworkFirewallClient

@Deprecated
public NetworkFirewallClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                         ClientConfiguration configuration,
                                         ClientConfigurator clientConfigurator,
                                         RequestSignerFactory defaultRequestSignerFactory,
                                         Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                                         List<ClientConfigurator> additionalClientConfigurators,
                                         String endpoint)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see NetworkFirewallClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

signingStrategyRequestSignerFactories - ClientBuilderBase.signingStrategyRequestSignerFactories

NetworkFirewallClient

@Deprecated
public NetworkFirewallClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                         ClientConfiguration configuration,
                                         ClientConfigurator clientConfigurator,
                                         RequestSignerFactory defaultRequestSignerFactory,
                                         Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                                         List<ClientConfigurator> additionalClientConfigurators,
                                         String endpoint,
                                         ExecutorService executorService)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see NetworkFirewallClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

signingStrategyRequestSignerFactories - ClientBuilderBase.signingStrategyRequestSignerFactories

executorService - NetworkFirewallClient.Builder.executorService

Method Detail

builder

public static NetworkFirewallClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: NetworkFirewall

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.

Specified by:

setRegion in interface NetworkFirewall

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: NetworkFirewall

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.

Specified by:

setRegion in interface NetworkFirewall

Parameters:

regionId - The public region ID.

cancelWorkRequest

public CancelWorkRequestResponse cancelWorkRequest(CancelWorkRequestRequest request)

Description copied from interface: NetworkFirewall

Cancel work request with the given ID.

Specified by:

cancelWorkRequest in interface NetworkFirewall

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

changeNetworkFirewallCompartment

public ChangeNetworkFirewallCompartmentResponse changeNetworkFirewallCompartment(ChangeNetworkFirewallCompartmentRequest request)

Description copied from interface: NetworkFirewall

Moves a NetworkFirewall resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.

Specified by:

changeNetworkFirewallCompartment in interface NetworkFirewall

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

changeNetworkFirewallPolicyCompartment

public ChangeNetworkFirewallPolicyCompartmentResponse changeNetworkFirewallPolicyCompartment(ChangeNetworkFirewallPolicyCompartmentRequest request)

Description copied from interface: NetworkFirewall

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

Specified by:

changeNetworkFirewallPolicyCompartment in interface NetworkFirewall

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createNetworkFirewall

public CreateNetworkFirewallResponse createNetworkFirewall(CreateNetworkFirewallRequest request)

Description copied from interface: NetworkFirewall

Creates a new NetworkFirewall.

Specified by:

createNetworkFirewall in interface NetworkFirewall

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createNetworkFirewallPolicy

public CreateNetworkFirewallPolicyResponse createNetworkFirewallPolicy(CreateNetworkFirewallPolicyRequest request)

Description copied from interface: NetworkFirewall

Creates a new Network Firewall Policy.

Specified by:

createNetworkFirewallPolicy in interface NetworkFirewall

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteNetworkFirewall

public DeleteNetworkFirewallResponse deleteNetworkFirewall(DeleteNetworkFirewallRequest request)

Description copied from interface: NetworkFirewall

Deletes a NetworkFirewall resource by identifier

Specified by:

deleteNetworkFirewall in interface NetworkFirewall

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteNetworkFirewallPolicy

public DeleteNetworkFirewallPolicyResponse deleteNetworkFirewallPolicy(DeleteNetworkFirewallPolicyRequest request)

Description copied from interface: NetworkFirewall

Deletes a NetworkFirewallPolicy resource with the given identifier.

Specified by:

deleteNetworkFirewallPolicy in interface NetworkFirewall

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getNetworkFirewall

public GetNetworkFirewallResponse getNetworkFirewall(GetNetworkFirewallRequest request)

Description copied from interface: NetworkFirewall

Gets a NetworkFirewall by identifier

Specified by:

getNetworkFirewall in interface NetworkFirewall

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getNetworkFirewallPolicy

public GetNetworkFirewallPolicyResponse getNetworkFirewallPolicy(GetNetworkFirewallPolicyRequest request)

Description copied from interface: NetworkFirewall

Gets a NetworkFirewallPolicy given the network firewall policy identifier.

Specified by:

getNetworkFirewallPolicy in interface NetworkFirewall

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWorkRequest

public GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)

Description copied from interface: NetworkFirewall

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

Specified by:

getWorkRequest in interface NetworkFirewall

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listNetworkFirewallPolicies

public ListNetworkFirewallPoliciesResponse listNetworkFirewallPolicies(ListNetworkFirewallPoliciesRequest request)

Description copied from interface: NetworkFirewall

Returns a list of Network Firewall Policies.

Specified by:

listNetworkFirewallPolicies in interface NetworkFirewall

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listNetworkFirewalls

public ListNetworkFirewallsResponse listNetworkFirewalls(ListNetworkFirewallsRequest request)

Description copied from interface: NetworkFirewall

Returns a list of NetworkFirewalls.

Specified by:

listNetworkFirewalls in interface NetworkFirewall

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listWorkRequestErrors

public ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)

Description copied from interface: NetworkFirewall

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

Specified by:

listWorkRequestErrors in interface NetworkFirewall

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listWorkRequestLogs

public ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)

Description copied from interface: NetworkFirewall

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

Specified by:

listWorkRequestLogs in interface NetworkFirewall

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listWorkRequests

public ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)

Description copied from interface: NetworkFirewall

Lists the work requests in a compartment.

Specified by:

listWorkRequests in interface NetworkFirewall

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateNetworkFirewall

public UpdateNetworkFirewallResponse updateNetworkFirewall(UpdateNetworkFirewallRequest request)

Description copied from interface: NetworkFirewall

Updates the NetworkFirewall

Specified by:

updateNetworkFirewall in interface NetworkFirewall

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateNetworkFirewallPolicy

public UpdateNetworkFirewallPolicyResponse updateNetworkFirewallPolicy(UpdateNetworkFirewallPolicyRequest request)

Description copied from interface: NetworkFirewall

Updates the NetworkFirewallPolicy

Specified by:

updateNetworkFirewallPolicy in interface NetworkFirewall

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWaiters

public NetworkFirewallWaiters getWaiters()

Description copied from interface: NetworkFirewall

Gets the pre-configured waiters available for resources for this service.

Specified by:

getWaiters in interface NetworkFirewall

Returns:

The service waiters.

getPaginators

public NetworkFirewallPaginators getPaginators()

Description copied from interface: NetworkFirewall

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.

Specified by:

getPaginators in interface NetworkFirewall

Returns:

The service paginators.

getDefaultConfigurator

protected ClientConfigurator getDefaultConfigurator()

setEndpoint

public final void setEndpoint(String endpoint)

getEndpoint

public final String getEndpoint()

refreshClient

public final void refreshClient()

Rebuild the backing HttpClient. This will call ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.

close

public final void close()

Specified by:

close in interface AutoCloseable