Package com.oracle.bmc.zpr

Class ZprAsyncClient

java.lang.Object

com.oracle.bmc.http.internal.BaseAsyncClient

com.oracle.bmc.zpr.ZprAsyncClient

All Implemented Interfaces:

ZprAsync, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20240301")
public class ZprAsyncClient
extends BaseAsyncClient
implements ZprAsync

Async client implementation for Zpr service.
There are two ways to use async client: 1. Use AsyncHandler: using AsyncHandler, if the response to the call is an InputStream, like getObject Api in object storage service, developers need to process the stream in AsyncHandler, and not anywhere else, because the stream will be closed right after the AsyncHandler is invoked.
2. Use Java Future: using Java Future, developers need to close the stream after they are done with the Java Future.
Accessing the result should be done in a mutually exclusive manner, either through the Future or the AsyncHandler, but not both. If the Future is used, the caller should pass in null as the AsyncHandler. If the AsyncHandler is used, it is still safe to use the Future to determine whether or not the request was completed via Future.isDone/isCancelled.
Please refer to https://github.com/oracle/oci-java-sdk/blob/master/bmc-examples/src/main/java/ResteasyClientWithObjectStorageExample.java

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
String	clientCommonLibraryVersion	Compatible SDK version, provided by the codegen.
Optional<String>	minimumClientCommonLibraryVersionFromClient	Minimum compatible SDK version, maybe provided by the codegen.
static Service	SERVICE	Service instance for Zpr.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static ZprAsyncClient.Builder	builder()	Create a builder for this client.
protected <REQ extends BmcRequest<?>,RESP extends BmcResponse,RESP_BUILDER extends BmcResponse.Builder<RESP>> ClientCall<REQ,RESP,RESP_BUILDER>	clientCall(REQ request, Supplier<RESP_BUILDER> responseBuilder)
void	close()
Future<CreateConfigurationResponse>	createConfiguration(CreateConfigurationRequest request, AsyncHandler<CreateConfigurationRequest,CreateConfigurationResponse> handler)	Initiates the process to onboard ZPR in a root compartment (the root compartment is the tenancy).
Future<CreateZprPolicyResponse>	createZprPolicy(CreateZprPolicyRequest request, AsyncHandler<CreateZprPolicyRequest,CreateZprPolicyResponse> handler)	Creates a ZprPolicy.
Future<DeleteZprPolicyResponse>	deleteZprPolicy(DeleteZprPolicyRequest request, AsyncHandler<DeleteZprPolicyRequest,DeleteZprPolicyResponse> handler)	Deletes a ZprPolicy.
String	getClientCommonLibraryVersion()
Future<GetConfigurationResponse>	getConfiguration(GetConfigurationRequest request, AsyncHandler<GetConfigurationRequest,GetConfigurationResponse> handler)	Retrieves the ZPR configuration details for the root compartment (the root compartment is the tenancy).
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
Future<GetZprConfigurationWorkRequestResponse>	getZprConfigurationWorkRequest(GetZprConfigurationWorkRequestRequest request, AsyncHandler<GetZprConfigurationWorkRequestRequest,GetZprConfigurationWorkRequestResponse> handler)	Gets the details of a work request.
Future<GetZprPolicyResponse>	getZprPolicy(GetZprPolicyRequest request, AsyncHandler<GetZprPolicyRequest,GetZprPolicyResponse> handler)	Gets information about a ZprPolicy.
Future<GetZprPolicyWorkRequestResponse>	getZprPolicyWorkRequest(GetZprPolicyWorkRequestRequest request, AsyncHandler<GetZprPolicyWorkRequestRequest,GetZprPolicyWorkRequestResponse> handler)	Gets the details of a work request.
Future<ListZprConfigurationWorkRequestErrorsResponse>	listZprConfigurationWorkRequestErrors(ListZprConfigurationWorkRequestErrorsRequest request, AsyncHandler<ListZprConfigurationWorkRequestErrorsRequest,ListZprConfigurationWorkRequestErrorsResponse> handler)	Lists the errors for a work request.
Future<ListZprConfigurationWorkRequestLogsResponse>	listZprConfigurationWorkRequestLogs(ListZprConfigurationWorkRequestLogsRequest request, AsyncHandler<ListZprConfigurationWorkRequestLogsRequest,ListZprConfigurationWorkRequestLogsResponse> handler)	Lists the logs for a work request.
Future<ListZprConfigurationWorkRequestsResponse>	listZprConfigurationWorkRequests(ListZprConfigurationWorkRequestsRequest request, AsyncHandler<ListZprConfigurationWorkRequestsRequest,ListZprConfigurationWorkRequestsResponse> handler)	Lists the work requests in a compartment.
Future<ListZprPoliciesResponse>	listZprPolicies(ListZprPoliciesRequest request, AsyncHandler<ListZprPoliciesRequest,ListZprPoliciesResponse> handler)	Gets a list of ZprPolicies.
Future<ListZprPolicyWorkRequestErrorsResponse>	listZprPolicyWorkRequestErrors(ListZprPolicyWorkRequestErrorsRequest request, AsyncHandler<ListZprPolicyWorkRequestErrorsRequest,ListZprPolicyWorkRequestErrorsResponse> handler)	Lists the errors for a work request.
Future<ListZprPolicyWorkRequestLogsResponse>	listZprPolicyWorkRequestLogs(ListZprPolicyWorkRequestLogsRequest request, AsyncHandler<ListZprPolicyWorkRequestLogsRequest,ListZprPolicyWorkRequestLogsResponse> handler)	Lists the logs for a work request.
Future<ListZprPolicyWorkRequestsResponse>	listZprPolicyWorkRequests(ListZprPolicyWorkRequestsRequest request, AsyncHandler<ListZprPolicyWorkRequestsRequest,ListZprPolicyWorkRequestsResponse> handler)	Lists the work requests in a compartment.
void	populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)	Populate the parameters in the endpoint with its corresponding value and update the base endpoint.
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’).
void	updateBaseEndpoint(String endpoint)	This method should be used for parameterized endpoint templates only.
Future<UpdateZprPolicyResponse>	updateZprPolicy(UpdateZprPolicyRequest request, AsyncHandler<UpdateZprPolicyRequest,UpdateZprPolicyResponse> handler)	Updates a specific ZprPolicy.
void	useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)	This method should be used to enable or disable the use of realm-specific endpoint template.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.AutoCloseable

close

Methods inherited from interface com.oracle.bmc.zpr.ZprAsync

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Field Detail

SERVICE

public static final Service SERVICE

Service instance for Zpr.

clientCommonLibraryVersion

public final String clientCommonLibraryVersion

Compatible SDK version, provided by the codegen.

minimumClientCommonLibraryVersionFromClient

public final Optional<String> minimumClientCommonLibraryVersionFromClient

Minimum compatible SDK version, maybe provided by the codegen.

Constructor Detail

ZprAsyncClient

@Deprecated
public ZprAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

ZprAsyncClient

@Deprecated
public ZprAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                      ClientConfiguration configuration)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

ZprAsyncClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

ZprAsyncClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

ZprAsyncClient

@Deprecated
public ZprAsyncClient(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 ZprAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

ZprAsyncClient

@Deprecated
public ZprAsyncClient(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 ZprAsyncClient.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)

ZprAsyncClient

@Deprecated
public ZprAsyncClient(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 ZprAsyncClient.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

Method Detail

builder

public static ZprAsyncClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: ZprAsync

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 ZprAsync

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: ZprAsync

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 ZprAsync

Parameters:

regionId - The public region ID.

createConfiguration

public Future<CreateConfigurationResponse> createConfiguration(CreateConfigurationRequest request,
                                                               AsyncHandler<CreateConfigurationRequest,CreateConfigurationResponse> handler)

Description copied from interface: ZprAsync

Initiates the process to onboard ZPR in a root compartment (the root compartment is the tenancy).

It creates an object of ZPR configuration as part of onboarding.

Specified by:

createConfiguration in interface ZprAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

createZprPolicy

public Future<CreateZprPolicyResponse> createZprPolicy(CreateZprPolicyRequest request,
                                                       AsyncHandler<CreateZprPolicyRequest,CreateZprPolicyResponse> handler)

Description copied from interface: ZprAsync

Creates a ZprPolicy.

Specified by:

createZprPolicy in interface ZprAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

deleteZprPolicy

public Future<DeleteZprPolicyResponse> deleteZprPolicy(DeleteZprPolicyRequest request,
                                                       AsyncHandler<DeleteZprPolicyRequest,DeleteZprPolicyResponse> handler)

Description copied from interface: ZprAsync

Deletes a ZprPolicy.

Specified by:

deleteZprPolicy in interface ZprAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getConfiguration

public Future<GetConfigurationResponse> getConfiguration(GetConfigurationRequest request,
                                                         AsyncHandler<GetConfigurationRequest,GetConfigurationResponse> handler)

Description copied from interface: ZprAsync

Retrieves the ZPR configuration details for the root compartment (the root compartment is the tenancy).

Returns ZPR configuration for root compartment (the root compartment is the tenancy).

Specified by:

getConfiguration in interface ZprAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getZprConfigurationWorkRequest

public Future<GetZprConfigurationWorkRequestResponse> getZprConfigurationWorkRequest(GetZprConfigurationWorkRequestRequest request,
                                                                                     AsyncHandler<GetZprConfigurationWorkRequestRequest,GetZprConfigurationWorkRequestResponse> handler)

Description copied from interface: ZprAsync

Gets the details of a work request.

Specified by:

getZprConfigurationWorkRequest in interface ZprAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getZprPolicy

public Future<GetZprPolicyResponse> getZprPolicy(GetZprPolicyRequest request,
                                                 AsyncHandler<GetZprPolicyRequest,GetZprPolicyResponse> handler)

Description copied from interface: ZprAsync

Gets information about a ZprPolicy.

Specified by:

getZprPolicy in interface ZprAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getZprPolicyWorkRequest

public Future<GetZprPolicyWorkRequestResponse> getZprPolicyWorkRequest(GetZprPolicyWorkRequestRequest request,
                                                                       AsyncHandler<GetZprPolicyWorkRequestRequest,GetZprPolicyWorkRequestResponse> handler)

Description copied from interface: ZprAsync

Gets the details of a work request.

Specified by:

getZprPolicyWorkRequest in interface ZprAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listZprConfigurationWorkRequestErrors

public Future<ListZprConfigurationWorkRequestErrorsResponse> listZprConfigurationWorkRequestErrors(ListZprConfigurationWorkRequestErrorsRequest request,
                                                                                                   AsyncHandler<ListZprConfigurationWorkRequestErrorsRequest,ListZprConfigurationWorkRequestErrorsResponse> handler)

Description copied from interface: ZprAsync

Lists the errors for a work request.

Specified by:

listZprConfigurationWorkRequestErrors in interface ZprAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listZprConfigurationWorkRequestLogs

public Future<ListZprConfigurationWorkRequestLogsResponse> listZprConfigurationWorkRequestLogs(ListZprConfigurationWorkRequestLogsRequest request,
                                                                                               AsyncHandler<ListZprConfigurationWorkRequestLogsRequest,ListZprConfigurationWorkRequestLogsResponse> handler)

Description copied from interface: ZprAsync

Lists the logs for a work request.

Specified by:

listZprConfigurationWorkRequestLogs in interface ZprAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listZprConfigurationWorkRequests

public Future<ListZprConfigurationWorkRequestsResponse> listZprConfigurationWorkRequests(ListZprConfigurationWorkRequestsRequest request,
                                                                                         AsyncHandler<ListZprConfigurationWorkRequestsRequest,ListZprConfigurationWorkRequestsResponse> handler)

Description copied from interface: ZprAsync

Lists the work requests in a compartment.

Specified by:

listZprConfigurationWorkRequests in interface ZprAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listZprPolicies

public Future<ListZprPoliciesResponse> listZprPolicies(ListZprPoliciesRequest request,
                                                       AsyncHandler<ListZprPoliciesRequest,ListZprPoliciesResponse> handler)

Description copied from interface: ZprAsync

Gets a list of ZprPolicies.

Specified by:

listZprPolicies in interface ZprAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listZprPolicyWorkRequestErrors

public Future<ListZprPolicyWorkRequestErrorsResponse> listZprPolicyWorkRequestErrors(ListZprPolicyWorkRequestErrorsRequest request,
                                                                                     AsyncHandler<ListZprPolicyWorkRequestErrorsRequest,ListZprPolicyWorkRequestErrorsResponse> handler)

Description copied from interface: ZprAsync

Lists the errors for a work request.

Specified by:

listZprPolicyWorkRequestErrors in interface ZprAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listZprPolicyWorkRequestLogs

public Future<ListZprPolicyWorkRequestLogsResponse> listZprPolicyWorkRequestLogs(ListZprPolicyWorkRequestLogsRequest request,
                                                                                 AsyncHandler<ListZprPolicyWorkRequestLogsRequest,ListZprPolicyWorkRequestLogsResponse> handler)

Description copied from interface: ZprAsync

Lists the logs for a work request.

Specified by:

listZprPolicyWorkRequestLogs in interface ZprAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listZprPolicyWorkRequests

public Future<ListZprPolicyWorkRequestsResponse> listZprPolicyWorkRequests(ListZprPolicyWorkRequestsRequest request,
                                                                           AsyncHandler<ListZprPolicyWorkRequestsRequest,ListZprPolicyWorkRequestsResponse> handler)

Description copied from interface: ZprAsync

Lists the work requests in a compartment.

Specified by:

listZprPolicyWorkRequests in interface ZprAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

updateZprPolicy

public Future<UpdateZprPolicyResponse> updateZprPolicy(UpdateZprPolicyRequest request,
                                                       AsyncHandler<UpdateZprPolicyRequest,UpdateZprPolicyResponse> handler)

Description copied from interface: ZprAsync

Updates a specific ZprPolicy.

If updating on statements, the entire list of policy statements is required, which will replace the existing policy statements associated with the policy ID.

Specified by:

updateZprPolicy in interface ZprAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getDefaultConfigurator

protected ClientConfigurator getDefaultConfigurator()

useRealmSpecificEndpointTemplate

public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)

This method should be used to enable or disable the use of realm-specific endpoint template.

The default value is null. To enable the use of endpoint template defined for the realm in use, set the flag to true To disable the use of endpoint template defined for the realm in use, set the flag to false

Parameters:

useOfRealmSpecificEndpointTemplateEnabled - This flag can be set to true or false to enable or disable the use of realm-specific endpoint template respectively

populateServiceParametersInEndpoint

public final void populateServiceParametersInEndpoint(String endpoint,
                                                      Map<String,Object> requiredParametersMap)

Populate the parameters in the endpoint with its corresponding value and update the base endpoint.

The value will be populated iff the parameter in endpoint is a required request path parameter or a required request query parameter. If not, the parameter in the endpoint will be ignored and left blank.

Parameters:

endpoint - The endpoint template in use

requiredParametersMap - Map of parameter name as key and value set in request path or query parameter as value

updateBaseEndpoint

public final void updateBaseEndpoint(String endpoint)

This method should be used for parameterized endpoint templates only.

This does not include {region} and {secondLevelDomain} parameters.

Parameters:

endpoint - The updated endpoint to use

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

getClientCommonLibraryVersion

public String getClientCommonLibraryVersion()

getMinimumClientCommonLibraryVersionFromClient

public Optional<String> getMinimumClientCommonLibraryVersionFromClient()

clientCall

protected <REQ extends BmcRequest<?>,RESP extends BmcResponse,RESP_BUILDER extends BmcResponse.Builder<RESP>> ClientCall<REQ,RESP,RESP_BUILDER> clientCall(REQ request,
                                                                                                                                                                                   Supplier<RESP_BUILDER> responseBuilder)