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 Description static classZprClient.BuilderBuilder class for this client.
-
Field Summary
Fields Modifier and Type Field Description StringclientCommonLibraryVersionCompatible SDK version, provided by the codegen.Optional<String>minimumClientCommonLibraryVersionFromClientMinimum compatible SDK version, maybe provided by the codegen.static ServiceSERVICEService instance for Zpr.
-
Constructor Summary
Constructors Constructor Description ZprClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)Deprecated.Use thebuilderinstead.ZprClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)Deprecated.Use thebuilderinstead.ZprClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.ZprClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.ZprClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)Deprecated.Use thebuilderinstead.ZprClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)Deprecated.Use thebuilderinstead.ZprClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)Deprecated.Use thebuilderinstead.ZprClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)Deprecated.Use thebuilderinstead.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ZprClient.Builderbuilder()Create a builder for this client.voidclose()CreateConfigurationResponsecreateConfiguration(CreateConfigurationRequest request)Initiates the process to onboard ZPR in a root compartment (the root compartment is the tenancy).CreateZprPolicyResponsecreateZprPolicy(CreateZprPolicyRequest request)Creates a ZprPolicy.DeleteZprPolicyResponsedeleteZprPolicy(DeleteZprPolicyRequest request)Deletes a ZprPolicy.voidenableDualStackEndpoints(boolean enableDualStackEndpoints)This method should be used to enable or disable the use of dual-stack endpoints.StringgetClientCommonLibraryVersion()GetConfigurationResponsegetConfiguration(GetConfigurationRequest request)Retrieves the ZPR configuration details for the root compartment (the root compartment is the tenancy).protected ClientConfiguratorgetDefaultConfigurator()StringgetEndpoint()Get the endpoint of the client.Optional<String>getMinimumClientCommonLibraryVersionFromClient()Map<String,Boolean>getOptionsMap()Return an immutable snapshot representing the current options set for this client.ZprPaginatorsgetPaginators()Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.StringgetResolvedEndpoint(Map<String,Object> requiredParametersMap)Returns the endpoint after filling in the current options, as determined byBaseClient.getOptionsMap(), and then filling in the required parameters in requiredParametersMap into the placeholders in the endpoint.ZprWaitersgetWaiters()Gets the pre-configured waiters available for resources for this service.GetZprConfigurationWorkRequestResponsegetZprConfigurationWorkRequest(GetZprConfigurationWorkRequestRequest request)Gets the details of a work request.GetZprPolicyResponsegetZprPolicy(GetZprPolicyRequest request)Gets information about a ZprPolicy.GetZprPolicyWorkRequestResponsegetZprPolicyWorkRequest(GetZprPolicyWorkRequestRequest request)Gets the details of a work request.ListZprConfigurationWorkRequestErrorsResponselistZprConfigurationWorkRequestErrors(ListZprConfigurationWorkRequestErrorsRequest request)Lists the errors for a work request.ListZprConfigurationWorkRequestLogsResponselistZprConfigurationWorkRequestLogs(ListZprConfigurationWorkRequestLogsRequest request)Lists the logs for a work request.ListZprConfigurationWorkRequestsResponselistZprConfigurationWorkRequests(ListZprConfigurationWorkRequestsRequest request)Lists the work requests in a compartment.ListZprPoliciesResponselistZprPolicies(ListZprPoliciesRequest request)Gets a list of ZprPolicies.ListZprPolicyWorkRequestErrorsResponselistZprPolicyWorkRequestErrors(ListZprPolicyWorkRequestErrorsRequest request)Lists the errors for a work request.ListZprPolicyWorkRequestLogsResponselistZprPolicyWorkRequestLogs(ListZprPolicyWorkRequestLogsRequest request)Lists the logs for a work request.ListZprPolicyWorkRequestsResponselistZprPolicyWorkRequests(ListZprPolicyWorkRequestsRequest request)Lists the work requests in a compartment.voidrefreshClient()Rebuild the backingHttpClient.voidsetEndpoint(String endpoint)voidsetRegion(Region region)Sets the region to call (ex, Region.US_PHOENIX_1).voidsetRegion(String regionId)Sets the region to call (ex, ‘us-phoenix-1’).UpdateZprPolicyResponseupdateZprPolicy(UpdateZprPolicyRequest request)Updates a specific ZprPolicy.voiduseRealmSpecificEndpointTemplate(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 java.lang.AutoCloseable
close
-
Methods inherited from interface com.oracle.bmc.zpr.Zpr
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
-
-
-
-
Constructor Detail
-
ZprClient
@Deprecated public ZprClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeZprClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
-
ZprClient
@Deprecated public ZprClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeZprClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configuration
-
ZprClient
@Deprecated public ZprClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeZprClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
-
ZprClient
@Deprecated public ZprClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeZprClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-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 thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeZprClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfigurators
-
ZprClient
@Deprecated public ZprClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeZprClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfiguratorsendpoint-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 thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeZprClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfiguratorsendpoint-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 thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeZprClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfiguratorsendpoint-ClientBuilderBase.endpoint(java.lang.String)signingStrategyRequestSignerFactories-ClientBuilderBase.signingStrategyRequestSignerFactoriesexecutorService-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:ZprSets the region to call (ex, Region.US_PHOENIX_1).Note, this will call
setEndpointafter resolving the endpoint. If the service is not available in this Region, however, an IllegalArgumentException will be raised.
-
setRegion
public void setRegion(String regionId)
Description copied from interface:ZprSets 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 callsetEndpoint.
-
createConfiguration
public CreateConfigurationResponse createConfiguration(CreateConfigurationRequest request)
Description copied from interface:ZprInitiates 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:
createConfigurationin interfaceZpr- 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:ZprCreates a ZprPolicy.- Specified by:
createZprPolicyin interfaceZpr- 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:ZprDeletes a ZprPolicy.- Specified by:
deleteZprPolicyin interfaceZpr- 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:ZprRetrieves 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:
getConfigurationin interfaceZpr- 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:ZprGets the details of a work request.- Specified by:
getZprConfigurationWorkRequestin interfaceZpr- 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:ZprGets information about a ZprPolicy.- Specified by:
getZprPolicyin interfaceZpr- 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:ZprGets the details of a work request.- Specified by:
getZprPolicyWorkRequestin interfaceZpr- 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:ZprLists the errors for a work request.- Specified by:
listZprConfigurationWorkRequestErrorsin interfaceZpr- 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:ZprLists the logs for a work request.- Specified by:
listZprConfigurationWorkRequestLogsin interfaceZpr- 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:ZprLists the work requests in a compartment.- Specified by:
listZprConfigurationWorkRequestsin interfaceZpr- 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:ZprGets a list of ZprPolicies.- Specified by:
listZprPoliciesin interfaceZpr- 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:ZprLists the errors for a work request.- Specified by:
listZprPolicyWorkRequestErrorsin interfaceZpr- 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:ZprLists the logs for a work request.- Specified by:
listZprPolicyWorkRequestLogsin interfaceZpr- 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:ZprLists the work requests in a compartment.- Specified by:
listZprPolicyWorkRequestsin interfaceZpr- 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:ZprUpdates 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:
updateZprPolicyin interfaceZpr- 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:ZprGets the pre-configured waiters available for resources for this service.- Specified by:
getWaitersin interfaceZpr- Returns:
- The service waiters.
-
getPaginators
public ZprPaginators getPaginators()
Description copied from interface:ZprGets the pre-configured paginators available for list operations in this service which may return multiple pages of data.These paginators provide an
Iterableinterface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.- Specified by:
getPaginatorsin interfaceZpr- Returns:
- The service paginators.
-
getDefaultConfigurator
protected ClientConfigurator getDefaultConfigurator()
-
enableDualStackEndpoints
public void enableDualStackEndpoints(boolean enableDualStackEndpoints)
This method should be used to enable or disable the use of dual-stack endpoints.The default value is false i.e. dual-stack endpoints are disabled by default.
- Parameters:
enableDualStackEndpoints- This flag can be set to true or false to enable or disable the use of dual-stack endpoints respectively
-
getOptionsMap
public Map<String,Boolean> getOptionsMap()
Return an immutable snapshot representing the current options set for this client.- Returns:
- immutable snapshot representing the current options set for this client
-
getResolvedEndpoint
public String getResolvedEndpoint(Map<String,Object> requiredParametersMap)
Returns the endpoint after filling in the current options, as determined byBaseClient.getOptionsMap(), and then filling in the required parameters in requiredParametersMap into the placeholders in the endpoint.- Parameters:
requiredParametersMap- the map from required parameter name to their values- Returns:
- resolved endpoint, with all options and placeholders filled in
-
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
-
setEndpoint
public final void setEndpoint(String endpoint)
-
getEndpoint
public final String getEndpoint()
Get the endpoint of the client.Note that the endpoint may be parameterized and contain placeholders and options. The region subdomain and realm domain will have been properly replaced already if the endpoint was selected using a
Region.Examples of endpoints this may return:
- Unparameterized endpoints
https://identity.us-phoenix-1.oci.oraclecloud.com https://identity.us-ashburn-1.oci.oraclecloud.com https://test-namespace.objectstorage.us-ashburn-1.oci.customer-oci.com - Parameterized endpoints with placeholders
https://{namespaceName+Dot}objectstorage.us-phoenix-1.oci.customer-oci.com https://{namespaceName+Dot}objectstorage.us-ashburn-1.oci.customer-oci.com - Parameterized endpoints with options
https://{dualStack?ds.:}identity.us-phoenix-1.oci.oraclecloud.com https://{dualStack?ds.:}identity.us-ashburn-1.oci.oraclecloud.com - Parameterized endpoints with placeholders and options
https://{namespaceName+Dot}{dualStack?ds.:}objectstorage.us-phoenix-1.oci.customer-oci.com https://{namespaceName+Dot}{dualStack?ds.:}objectstorage.us-ashburn-1.oci.customer-oci.com
To get the actual endpoint for a parameterized request, you can use
BaseClient.getResolvedEndpoint(Map)orParameterizedEndpointUtil.getEndpointWithPopulatedServiceParameters(String, Map, Map).- Returns:
- the endpoint being used by the client
- Unparameterized endpoints
-
refreshClient
public final void refreshClient()
Rebuild the backingHttpClient.This will call
ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.
-
close
public final void close()
- Specified by:
closein interfaceAutoCloseable
-
getClientCommonLibraryVersion
public String getClientCommonLibraryVersion()
-
-