com.oracle.bmc.zpr

Class ZprClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

com.oracle.bmc.zpr.ZprClient

All Implemented Interfaces:

Zpr, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20240301")
public class ZprClient
extends BaseSyncClient
implements Zpr

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and 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 and Description
ZprClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory) Deprecated. Use the builder instead.
ZprClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators) Deprecated. Use the builder instead.
ZprClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Deprecated. Use the builder instead.
ZprClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Deprecated. Use the builder instead.
ZprClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService) Deprecated. Use the builder instead.
ZprClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider) Deprecated. Use the builder instead.
ZprClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration) Deprecated. Use the builder instead.
ZprClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator) Deprecated. Use the builder instead.

Method Summary

Modifier and Type	Method and Description
static ZprClient.Builder	builder() Create a builder for this client.
void	close()
CreateConfigurationResponse	createConfiguration(CreateConfigurationRequest request) Initiates the process to onboard ZPR in a root compartment (the root compartment is the tenancy).
CreateZprPolicyResponse	createZprPolicy(CreateZprPolicyRequest request) Creates a ZprPolicy.
DeleteZprPolicyResponse	deleteZprPolicy(DeleteZprPolicyRequest request) Deletes a ZprPolicy.
String	getClientCommonLibraryVersion()
GetConfigurationResponse	getConfiguration(GetConfigurationRequest request) Retrieves the ZPR configuration details for the root compartment (the root compartment is the tenancy).
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
ZprPaginators	getPaginators() Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
ZprWaiters	getWaiters() Gets the pre-configured waiters available for resources for this service.
GetZprConfigurationWorkRequestResponse	getZprConfigurationWorkRequest(GetZprConfigurationWorkRequestRequest request) Gets the details of a work request.
GetZprPolicyResponse	getZprPolicy(GetZprPolicyRequest request) Gets information about a ZprPolicy.
GetZprPolicyWorkRequestResponse	getZprPolicyWorkRequest(GetZprPolicyWorkRequestRequest request) Gets the details of a work request.
ListZprConfigurationWorkRequestErrorsResponse	listZprConfigurationWorkRequestErrors(ListZprConfigurationWorkRequestErrorsRequest request) Lists the errors for a work request.
ListZprConfigurationWorkRequestLogsResponse	listZprConfigurationWorkRequestLogs(ListZprConfigurationWorkRequestLogsRequest request) Lists the logs for a work request.
ListZprConfigurationWorkRequestsResponse	listZprConfigurationWorkRequests(ListZprConfigurationWorkRequestsRequest request) Lists the work requests in a compartment.
ListZprPoliciesResponse	listZprPolicies(ListZprPoliciesRequest request) Gets a list of ZprPolicies.
ListZprPolicyWorkRequestErrorsResponse	listZprPolicyWorkRequestErrors(ListZprPolicyWorkRequestErrorsRequest request) Lists the errors for a work request.
ListZprPolicyWorkRequestLogsResponse	listZprPolicyWorkRequestLogs(ListZprPolicyWorkRequestLogsRequest request) Lists the logs for a work request.
ListZprPolicyWorkRequestsResponse	listZprPolicyWorkRequests(ListZprPolicyWorkRequestsRequest request) 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.
UpdateZprPolicyResponse	updateZprPolicy(UpdateZprPolicyRequest request) 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 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.zpr.Zpr

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Methods inherited from interface java.lang.AutoCloseable

close

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

ZprClient

@Deprecated
public ZprClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

ZprClient

@Deprecated
public ZprClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                             ClientConfiguration configuration)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

ZprClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

ZprClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

ZprClient

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

ZprClient

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

ZprClient

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

ZprClient

@Deprecated
public ZprClient(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 ZprClient.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 - ZprClient.Builder.executorService

Method Detail

builder

public static ZprClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: Zpr

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 Zpr

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: Zpr

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 Zpr

Parameters:

regionId - The public region ID.

createConfiguration

public CreateConfigurationResponse createConfiguration(CreateConfigurationRequest request)

Description copied from interface: Zpr

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 Zpr

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createZprPolicy

public CreateZprPolicyResponse createZprPolicy(CreateZprPolicyRequest request)

Description copied from interface: Zpr

Creates a ZprPolicy.

Specified by:

createZprPolicy in interface Zpr

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteZprPolicy

public DeleteZprPolicyResponse deleteZprPolicy(DeleteZprPolicyRequest request)

Description copied from interface: Zpr

Deletes a ZprPolicy.

Specified by:

deleteZprPolicy in interface Zpr

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getConfiguration

public GetConfigurationResponse getConfiguration(GetConfigurationRequest request)

Description copied from interface: Zpr

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 Zpr

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getZprConfigurationWorkRequest

public GetZprConfigurationWorkRequestResponse getZprConfigurationWorkRequest(GetZprConfigurationWorkRequestRequest request)

Description copied from interface: Zpr

Gets the details of a work request.

Specified by:

getZprConfigurationWorkRequest in interface Zpr

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getZprPolicy

public GetZprPolicyResponse getZprPolicy(GetZprPolicyRequest request)

Description copied from interface: Zpr

Gets information about a ZprPolicy.

Specified by:

getZprPolicy in interface Zpr

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getZprPolicyWorkRequest

public GetZprPolicyWorkRequestResponse getZprPolicyWorkRequest(GetZprPolicyWorkRequestRequest request)

Description copied from interface: Zpr

Gets the details of a work request.

Specified by:

getZprPolicyWorkRequest in interface Zpr

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listZprConfigurationWorkRequestErrors

public ListZprConfigurationWorkRequestErrorsResponse listZprConfigurationWorkRequestErrors(ListZprConfigurationWorkRequestErrorsRequest request)

Description copied from interface: Zpr

Lists the errors for a work request.

Specified by:

listZprConfigurationWorkRequestErrors in interface Zpr

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listZprConfigurationWorkRequestLogs

public ListZprConfigurationWorkRequestLogsResponse listZprConfigurationWorkRequestLogs(ListZprConfigurationWorkRequestLogsRequest request)

Description copied from interface: Zpr

Lists the logs for a work request.

Specified by:

listZprConfigurationWorkRequestLogs in interface Zpr

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listZprConfigurationWorkRequests

public ListZprConfigurationWorkRequestsResponse listZprConfigurationWorkRequests(ListZprConfigurationWorkRequestsRequest request)

Description copied from interface: Zpr

Lists the work requests in a compartment.

Specified by:

listZprConfigurationWorkRequests in interface Zpr

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listZprPolicies

public ListZprPoliciesResponse listZprPolicies(ListZprPoliciesRequest request)

Description copied from interface: Zpr

Gets a list of ZprPolicies.

Specified by:

listZprPolicies in interface Zpr

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listZprPolicyWorkRequestErrors

public ListZprPolicyWorkRequestErrorsResponse listZprPolicyWorkRequestErrors(ListZprPolicyWorkRequestErrorsRequest request)

Description copied from interface: Zpr

Lists the errors for a work request.

Specified by:

listZprPolicyWorkRequestErrors in interface Zpr

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listZprPolicyWorkRequestLogs

public ListZprPolicyWorkRequestLogsResponse listZprPolicyWorkRequestLogs(ListZprPolicyWorkRequestLogsRequest request)

Description copied from interface: Zpr

Lists the logs for a work request.

Specified by:

listZprPolicyWorkRequestLogs in interface Zpr

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listZprPolicyWorkRequests

public ListZprPolicyWorkRequestsResponse listZprPolicyWorkRequests(ListZprPolicyWorkRequestsRequest request)

Description copied from interface: Zpr

Lists the work requests in a compartment.

Specified by:

listZprPolicyWorkRequests in interface Zpr

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateZprPolicy

public UpdateZprPolicyResponse updateZprPolicy(UpdateZprPolicyRequest request)

Description copied from interface: Zpr

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 Zpr

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWaiters

public ZprWaiters getWaiters()

Description copied from interface: Zpr

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

Specified by:

getWaiters in interface Zpr

Returns:

The service waiters.

getPaginators

public ZprPaginators getPaginators()

Description copied from interface: Zpr

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 Zpr

Returns:

The service paginators.

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()