Class PrivateServiceAccessClient
- java.lang.Object
-
- com.oracle.bmc.http.internal.BaseSyncClient
-
- com.oracle.bmc.psa.PrivateServiceAccessClient
-
- All Implemented Interfaces:
PrivateServiceAccess,AutoCloseable
@Generated(value="OracleSDKGenerator", comments="API Version: 20240301") public class PrivateServiceAccessClient extends BaseSyncClient implements PrivateServiceAccess
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classPrivateServiceAccessClient.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 PrivateServiceAccessClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)Deprecated.Use thebuilderinstead.PrivateServiceAccessClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)Deprecated.Use thebuilderinstead.PrivateServiceAccessClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.PrivateServiceAccessClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.PrivateServiceAccessClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)Deprecated.Use thebuilderinstead.PrivateServiceAccessClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)Deprecated.Use thebuilderinstead.PrivateServiceAccessClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)Deprecated.Use thebuilderinstead.PrivateServiceAccessClient(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 PrivateServiceAccessClient.Builderbuilder()Create a builder for this client.CancelPsaWorkRequestResponsecancelPsaWorkRequest(CancelPsaWorkRequestRequest request)Cancels a PrivateServiceAccess work request.ChangePrivateServiceAccessCompartmentResponsechangePrivateServiceAccessCompartment(ChangePrivateServiceAccessCompartmentRequest request)Moves a PrivateServiceAccess into a different compartment within the same tenancy.voidclose()CreatePrivateServiceAccessResponsecreatePrivateServiceAccess(CreatePrivateServiceAccessRequest request)Creates a private service access in the specified subnet (in the consumer’s VCN) and the specified compartment for a particular service.DeletePrivateServiceAccessResponsedeletePrivateServiceAccess(DeletePrivateServiceAccessRequest request)Deletes a PrivateServiceAccess.voidenableDualStackEndpoints(boolean enableDualStackEndpoints)This method should be used to enable or disable the use of dual-stack endpoints.StringgetClientCommonLibraryVersion()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.PrivateServiceAccessPaginatorsgetPaginators()Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.GetPrivateServiceAccessResponsegetPrivateServiceAccess(GetPrivateServiceAccessRequest request)Gets information about a PrivateServiceAccess.GetPsaWorkRequestResponsegetPsaWorkRequest(GetPsaWorkRequestRequest request)Gets the details of a PrivateServiceAccess work request.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.PrivateServiceAccessWaitersgetWaiters()Gets the pre-configured waiters available for resources for this service.ListPrivateServiceAccessesResponselistPrivateServiceAccesses(ListPrivateServiceAccessesRequest request)List the private service accesses in the specified compartment.ListPsaServicesResponselistPsaServices(ListPsaServicesRequest request)List the OCI services available for Private Service Access catalog in the region, sorted by service name.ListPsaWorkRequestErrorsResponselistPsaWorkRequestErrors(ListPsaWorkRequestErrorsRequest request)Lists the errors for a PrivateServiceAccess work request.ListPsaWorkRequestLogsResponselistPsaWorkRequestLogs(ListPsaWorkRequestLogsRequest request)Lists the logs for a PrivateServiceAccess work request.ListPsaWorkRequestsResponselistPsaWorkRequests(ListPsaWorkRequestsRequest request)Lists the PrivateServiceAccess 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’).UpdatePrivateServiceAccessResponseupdatePrivateServiceAccess(UpdatePrivateServiceAccessRequest request)Updates a PrivateServiceAccess.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.psa.PrivateServiceAccess
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
-
-
-
-
Constructor Detail
-
PrivateServiceAccessClient
@Deprecated public PrivateServiceAccessClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seePrivateServiceAccessClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
-
PrivateServiceAccessClient
@Deprecated public PrivateServiceAccessClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seePrivateServiceAccessClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configuration
-
PrivateServiceAccessClient
@Deprecated public PrivateServiceAccessClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seePrivateServiceAccessClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
-
PrivateServiceAccessClient
@Deprecated public PrivateServiceAccessClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seePrivateServiceAccessClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactory
-
PrivateServiceAccessClient
@Deprecated public PrivateServiceAccessClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seePrivateServiceAccessClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfigurators
-
PrivateServiceAccessClient
@Deprecated public PrivateServiceAccessClient(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 (seePrivateServiceAccessClient.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)
-
PrivateServiceAccessClient
@Deprecated public PrivateServiceAccessClient(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 (seePrivateServiceAccessClient.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
-
PrivateServiceAccessClient
@Deprecated public PrivateServiceAccessClient(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 (seePrivateServiceAccessClient.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-PrivateServiceAccessClient.Builder.executorService
-
-
Method Detail
-
builder
public static PrivateServiceAccessClient.Builder builder()
Create a builder for this client.- Returns:
- builder
-
setRegion
public void setRegion(Region region)
Description copied from interface:PrivateServiceAccessSets 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 interfacePrivateServiceAccess- Parameters:
region- The region of the service.
-
setRegion
public void setRegion(String regionId)
Description copied from interface:PrivateServiceAccessSets 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 interfacePrivateServiceAccess- Parameters:
regionId- The public region ID.
-
cancelPsaWorkRequest
public CancelPsaWorkRequestResponse cancelPsaWorkRequest(CancelPsaWorkRequestRequest request)
Description copied from interface:PrivateServiceAccessCancels a PrivateServiceAccess work request.- Specified by:
cancelPsaWorkRequestin interfacePrivateServiceAccess- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changePrivateServiceAccessCompartment
public ChangePrivateServiceAccessCompartmentResponse changePrivateServiceAccessCompartment(ChangePrivateServiceAccessCompartmentRequest request)
Description copied from interface:PrivateServiceAccessMoves 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 interfacePrivateServiceAccess- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createPrivateServiceAccess
public CreatePrivateServiceAccessResponse createPrivateServiceAccess(CreatePrivateServiceAccessRequest request)
Description copied from interface:PrivateServiceAccessCreates a private service access in the specified subnet (in the consumer’s VCN) and the specified compartment for a particular service.- Specified by:
createPrivateServiceAccessin interfacePrivateServiceAccess- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deletePrivateServiceAccess
public DeletePrivateServiceAccessResponse deletePrivateServiceAccess(DeletePrivateServiceAccessRequest request)
Description copied from interface:PrivateServiceAccessDeletes a PrivateServiceAccess.- Specified by:
deletePrivateServiceAccessin interfacePrivateServiceAccess- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getPrivateServiceAccess
public GetPrivateServiceAccessResponse getPrivateServiceAccess(GetPrivateServiceAccessRequest request)
Description copied from interface:PrivateServiceAccessGets information about a PrivateServiceAccess.- Specified by:
getPrivateServiceAccessin interfacePrivateServiceAccess- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getPsaWorkRequest
public GetPsaWorkRequestResponse getPsaWorkRequest(GetPsaWorkRequestRequest request)
Description copied from interface:PrivateServiceAccessGets the details of a PrivateServiceAccess work request.- Specified by:
getPsaWorkRequestin interfacePrivateServiceAccess- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listPrivateServiceAccesses
public ListPrivateServiceAccessesResponse listPrivateServiceAccesses(ListPrivateServiceAccessesRequest request)
Description copied from interface:PrivateServiceAccessList 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 interfacePrivateServiceAccess- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listPsaServices
public ListPsaServicesResponse listPsaServices(ListPsaServicesRequest request)
Description copied from interface:PrivateServiceAccessList the OCI services available for Private Service Access catalog in the region, sorted by service name.- Specified by:
listPsaServicesin interfacePrivateServiceAccess- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listPsaWorkRequestErrors
public ListPsaWorkRequestErrorsResponse listPsaWorkRequestErrors(ListPsaWorkRequestErrorsRequest request)
Description copied from interface:PrivateServiceAccessLists the errors for a PrivateServiceAccess work request.- Specified by:
listPsaWorkRequestErrorsin interfacePrivateServiceAccess- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listPsaWorkRequestLogs
public ListPsaWorkRequestLogsResponse listPsaWorkRequestLogs(ListPsaWorkRequestLogsRequest request)
Description copied from interface:PrivateServiceAccessLists the logs for a PrivateServiceAccess work request.- Specified by:
listPsaWorkRequestLogsin interfacePrivateServiceAccess- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listPsaWorkRequests
public ListPsaWorkRequestsResponse listPsaWorkRequests(ListPsaWorkRequestsRequest request)
Description copied from interface:PrivateServiceAccessLists the PrivateServiceAccess work requests in a compartment.- Specified by:
listPsaWorkRequestsin interfacePrivateServiceAccess- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updatePrivateServiceAccess
public UpdatePrivateServiceAccessResponse updatePrivateServiceAccess(UpdatePrivateServiceAccessRequest request)
Description copied from interface:PrivateServiceAccessUpdates a PrivateServiceAccess.- Specified by:
updatePrivateServiceAccessin interfacePrivateServiceAccess- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getWaiters
public PrivateServiceAccessWaiters getWaiters()
Description copied from interface:PrivateServiceAccessGets the pre-configured waiters available for resources for this service.- Specified by:
getWaitersin interfacePrivateServiceAccess- Returns:
- The service waiters.
-
getPaginators
public PrivateServiceAccessPaginators getPaginators()
Description copied from interface:PrivateServiceAccessGets 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 interfacePrivateServiceAccess- 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()
-
-