Class PrivateServiceAccessAsyncClient
- java.lang.Object
-
- com.oracle.bmc.http.internal.BaseAsyncClient
-
- com.oracle.bmc.psa.PrivateServiceAccessAsyncClient
-
- All Implemented Interfaces:
PrivateServiceAccessAsync,AutoCloseable
@Generated(value="OracleSDKGenerator", comments="API Version: 20240301") public class PrivateServiceAccessAsyncClient extends BaseAsyncClient implements PrivateServiceAccessAsyncAsync client implementation for PrivateServiceAccess service.
There are two ways to use async client: 1. Use AsyncHandler: using AsyncHandler, if the response to the call is anInputStream, 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 classPrivateServiceAccessAsyncClient.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 PrivateServiceAccess.
-
Constructor Summary
Constructors Constructor Description PrivateServiceAccessAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)Deprecated.Use thebuilderinstead.PrivateServiceAccessAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)Deprecated.Use thebuilderinstead.PrivateServiceAccessAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.PrivateServiceAccessAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.PrivateServiceAccessAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)Deprecated.Use thebuilderinstead.PrivateServiceAccessAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)Deprecated.Use thebuilderinstead.PrivateServiceAccessAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)Deprecated.Use thebuilderinstead.
-
Method Summary
-
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.psa.PrivateServiceAccessAsync
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
-
-
-
-
Constructor Detail
-
PrivateServiceAccessAsyncClient
@Deprecated public PrivateServiceAccessAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seePrivateServiceAccessAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
-
PrivateServiceAccessAsyncClient
@Deprecated public PrivateServiceAccessAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seePrivateServiceAccessAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configuration
-
PrivateServiceAccessAsyncClient
@Deprecated public PrivateServiceAccessAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seePrivateServiceAccessAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
-
PrivateServiceAccessAsyncClient
@Deprecated public PrivateServiceAccessAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seePrivateServiceAccessAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactory
-
PrivateServiceAccessAsyncClient
@Deprecated public PrivateServiceAccessAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seePrivateServiceAccessAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfigurators
-
PrivateServiceAccessAsyncClient
@Deprecated public PrivateServiceAccessAsyncClient(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 (seePrivateServiceAccessAsyncClient.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)
-
PrivateServiceAccessAsyncClient
@Deprecated public PrivateServiceAccessAsyncClient(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 (seePrivateServiceAccessAsyncClient.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
-
-
Method Detail
-
builder
public static PrivateServiceAccessAsyncClient.Builder builder()
Create a builder for this client.- Returns:
- builder
-
setRegion
public void setRegion(Region region)
Description copied from interface:PrivateServiceAccessAsyncSets 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.- Specified by:
setRegionin interfacePrivateServiceAccessAsync- Parameters:
region- The region of the service.
-
setRegion
public void setRegion(String regionId)
Description copied from interface:PrivateServiceAccessAsyncSets 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.- Specified by:
setRegionin interfacePrivateServiceAccessAsync- Parameters:
regionId- The public region ID.
-
cancelPsaWorkRequest
public Future<CancelPsaWorkRequestResponse> cancelPsaWorkRequest(CancelPsaWorkRequestRequest request, AsyncHandler<CancelPsaWorkRequestRequest,CancelPsaWorkRequestResponse> handler)
Description copied from interface:PrivateServiceAccessAsyncCancels a PrivateServiceAccess work request.- Specified by:
cancelPsaWorkRequestin interfacePrivateServiceAccessAsync- Parameters:
request- The request object containing the details to sendhandler- 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.
-
changePrivateServiceAccessCompartment
public Future<ChangePrivateServiceAccessCompartmentResponse> changePrivateServiceAccessCompartment(ChangePrivateServiceAccessCompartmentRequest request, AsyncHandler<ChangePrivateServiceAccessCompartmentRequest,ChangePrivateServiceAccessCompartmentResponse> handler)
Description copied from interface:PrivateServiceAccessAsyncMoves a PrivateServiceAccess into a different compartment within the same tenancy.For information about moving resources between compartments, see Moving Resources to a Different Compartment.
- Specified by:
changePrivateServiceAccessCompartmentin interfacePrivateServiceAccessAsync- Parameters:
request- The request object containing the details to sendhandler- 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.
-
createPrivateServiceAccess
public Future<CreatePrivateServiceAccessResponse> createPrivateServiceAccess(CreatePrivateServiceAccessRequest request, AsyncHandler<CreatePrivateServiceAccessRequest,CreatePrivateServiceAccessResponse> handler)
Description copied from interface:PrivateServiceAccessAsyncCreates a private service access in the specified subnet (in the consumer’s VCN) and the specified compartment for a particular service.- Specified by:
createPrivateServiceAccessin interfacePrivateServiceAccessAsync- Parameters:
request- The request object containing the details to sendhandler- 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.
-
deletePrivateServiceAccess
public Future<DeletePrivateServiceAccessResponse> deletePrivateServiceAccess(DeletePrivateServiceAccessRequest request, AsyncHandler<DeletePrivateServiceAccessRequest,DeletePrivateServiceAccessResponse> handler)
Description copied from interface:PrivateServiceAccessAsyncDeletes a PrivateServiceAccess.- Specified by:
deletePrivateServiceAccessin interfacePrivateServiceAccessAsync- Parameters:
request- The request object containing the details to sendhandler- 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.
-
getPrivateServiceAccess
public Future<GetPrivateServiceAccessResponse> getPrivateServiceAccess(GetPrivateServiceAccessRequest request, AsyncHandler<GetPrivateServiceAccessRequest,GetPrivateServiceAccessResponse> handler)
Description copied from interface:PrivateServiceAccessAsyncGets information about a PrivateServiceAccess.- Specified by:
getPrivateServiceAccessin interfacePrivateServiceAccessAsync- Parameters:
request- The request object containing the details to sendhandler- 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.
-
getPsaWorkRequest
public Future<GetPsaWorkRequestResponse> getPsaWorkRequest(GetPsaWorkRequestRequest request, AsyncHandler<GetPsaWorkRequestRequest,GetPsaWorkRequestResponse> handler)
Description copied from interface:PrivateServiceAccessAsyncGets the details of a PrivateServiceAccess work request.- Specified by:
getPsaWorkRequestin interfacePrivateServiceAccessAsync- Parameters:
request- The request object containing the details to sendhandler- 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.
-
listPrivateServiceAccesses
public Future<ListPrivateServiceAccessesResponse> listPrivateServiceAccesses(ListPrivateServiceAccessesRequest request, AsyncHandler<ListPrivateServiceAccessesRequest,ListPrivateServiceAccessesResponse> handler)
Description copied from interface:PrivateServiceAccessAsyncList the private service accesses in the specified compartment.You can optionally filter the list by specifying the OCID of a subnet in the cunsumer’s VCN.
- Specified by:
listPrivateServiceAccessesin interfacePrivateServiceAccessAsync- Parameters:
request- The request object containing the details to sendhandler- 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.
-
listPsaServices
public Future<ListPsaServicesResponse> listPsaServices(ListPsaServicesRequest request, AsyncHandler<ListPsaServicesRequest,ListPsaServicesResponse> handler)
Description copied from interface:PrivateServiceAccessAsyncList the OCI services available for Private Service Access catalog in the region, sorted by service name.- Specified by:
listPsaServicesin interfacePrivateServiceAccessAsync- Parameters:
request- The request object containing the details to sendhandler- 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.
-
listPsaWorkRequestErrors
public Future<ListPsaWorkRequestErrorsResponse> listPsaWorkRequestErrors(ListPsaWorkRequestErrorsRequest request, AsyncHandler<ListPsaWorkRequestErrorsRequest,ListPsaWorkRequestErrorsResponse> handler)
Description copied from interface:PrivateServiceAccessAsyncLists the errors for a PrivateServiceAccess work request.- Specified by:
listPsaWorkRequestErrorsin interfacePrivateServiceAccessAsync- Parameters:
request- The request object containing the details to sendhandler- 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.
-
listPsaWorkRequestLogs
public Future<ListPsaWorkRequestLogsResponse> listPsaWorkRequestLogs(ListPsaWorkRequestLogsRequest request, AsyncHandler<ListPsaWorkRequestLogsRequest,ListPsaWorkRequestLogsResponse> handler)
Description copied from interface:PrivateServiceAccessAsyncLists the logs for a PrivateServiceAccess work request.- Specified by:
listPsaWorkRequestLogsin interfacePrivateServiceAccessAsync- Parameters:
request- The request object containing the details to sendhandler- 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.
-
listPsaWorkRequests
public Future<ListPsaWorkRequestsResponse> listPsaWorkRequests(ListPsaWorkRequestsRequest request, AsyncHandler<ListPsaWorkRequestsRequest,ListPsaWorkRequestsResponse> handler)
Description copied from interface:PrivateServiceAccessAsyncLists the PrivateServiceAccess work requests in a compartment.- Specified by:
listPsaWorkRequestsin interfacePrivateServiceAccessAsync- Parameters:
request- The request object containing the details to sendhandler- 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.
-
updatePrivateServiceAccess
public Future<UpdatePrivateServiceAccessResponse> updatePrivateServiceAccess(UpdatePrivateServiceAccessRequest request, AsyncHandler<UpdatePrivateServiceAccessRequest,UpdatePrivateServiceAccessResponse> handler)
Description copied from interface:PrivateServiceAccessAsyncUpdates a PrivateServiceAccess.- Specified by:
updatePrivateServiceAccessin interfacePrivateServiceAccessAsync- Parameters:
request- The request object containing the details to sendhandler- 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()
-
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()
-
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)
-
-