All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

PrivateServiceAccessClient
```
@Generated(value="OracleSDKGenerator",
           comments="API Version: 20240301")
public interface PrivateServiceAccess
extends AutoCloseable
```
Use the PrivateServiceAccess Control Plane API to manage privateServiceAccess.
This service client uses CircuitBreakerUtils.DEFAULT_CIRCUIT_BREAKER for all the operations by default if no circuit breaker configuration is defined by the user.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`CancelPsaWorkRequestResponse`	`cancelPsaWorkRequest(CancelPsaWorkRequestRequest request)`	Cancels a PrivateServiceAccess work request.
`ChangePrivateServiceAccessCompartmentResponse`	`changePrivateServiceAccessCompartment(ChangePrivateServiceAccessCompartmentRequest request)`	Moves a PrivateServiceAccess into a different compartment within the same tenancy.
`CreatePrivateServiceAccessResponse`	`createPrivateServiceAccess(CreatePrivateServiceAccessRequest request)`	Creates a private service access in the specified subnet (in the consumer’s VCN) and the specified compartment for a particular service.
`DeletePrivateServiceAccessResponse`	`deletePrivateServiceAccess(DeletePrivateServiceAccessRequest request)`	Deletes a PrivateServiceAccess.
`String`	`getEndpoint()`	Gets the set endpoint for REST call (ex, https://www.example.com)
`PrivateServiceAccessPaginators`	`getPaginators()`	Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
`GetPrivateServiceAccessResponse`	`getPrivateServiceAccess(GetPrivateServiceAccessRequest request)`	Gets information about a PrivateServiceAccess.
`GetPsaWorkRequestResponse`	`getPsaWorkRequest(GetPsaWorkRequestRequest request)`	Gets the details of a PrivateServiceAccess work request.
`PrivateServiceAccessWaiters`	`getWaiters()`	Gets the pre-configured waiters available for resources for this service.
`ListPrivateServiceAccessesResponse`	`listPrivateServiceAccesses(ListPrivateServiceAccessesRequest request)`	List the private service accesses in the specified compartment.
`ListPsaServicesResponse`	`listPsaServices(ListPsaServicesRequest request)`	List the OCI services available for Private Service Access catalog in the region, sorted by service name.
`ListPsaWorkRequestErrorsResponse`	`listPsaWorkRequestErrors(ListPsaWorkRequestErrorsRequest request)`	Lists the errors for a PrivateServiceAccess work request.
`ListPsaWorkRequestLogsResponse`	`listPsaWorkRequestLogs(ListPsaWorkRequestLogsRequest request)`	Lists the logs for a PrivateServiceAccess work request.
`ListPsaWorkRequestsResponse`	`listPsaWorkRequests(ListPsaWorkRequestsRequest request)`	Lists the PrivateServiceAccess work requests in a compartment.
`void`	`refreshClient()`	Rebuilds the client from scratch.
`void`	`setEndpoint(String endpoint)`	Sets the endpoint to call (ex, https://www.example.com).
`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’).
`UpdatePrivateServiceAccessResponse`	`updatePrivateServiceAccess(UpdatePrivateServiceAccessRequest request)`	Updates a PrivateServiceAccess.
`void`	`useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)`	Determines whether realm specific endpoint should be used or not.

Methods inherited from interface java.lang.AutoCloseable
close

- Method Detail
  - refreshClient
```
void refreshClient()
```
    Rebuilds the client from scratch.
    Useful to refresh certificates.
  - setEndpoint
```
void setEndpoint(String endpoint)
```
    Sets the endpoint to call (ex, https://www.example.com).
    
    Parameters:
    
    endpoint - The endpoint of the service.
  - getEndpoint
```
String getEndpoint()
```
    Gets the set endpoint for REST call (ex, https://www.example.com)
  - setRegion
```
void setRegion(Region region)
```
    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.
    
    Parameters:
    
    region - The region of the service.
  - setRegion
```
void setRegion(String regionId)
```
    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.
    
    Parameters:
    
    regionId - The public region ID.
  - useRealmSpecificEndpointTemplate
```
void useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)
```
    Determines whether realm specific endpoint should be used or not.
    Set realmSpecificEndpointTemplateEnabled to “true” if the user wants to enable use of realm specific endpoint template, otherwise set it to “false”
    
    Parameters:
    
    realmSpecificEndpointTemplateEnabled - flag to enable the use of realm specific endpoint template
  - cancelPsaWorkRequest
```
CancelPsaWorkRequestResponse cancelPsaWorkRequest(CancelPsaWorkRequestRequest request)
```
    Cancels a PrivateServiceAccess work request.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.76.0/psa/CancelPsaWorkRequestExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CancelPsaWorkRequest API.
  - changePrivateServiceAccessCompartment
```
ChangePrivateServiceAccessCompartmentResponse changePrivateServiceAccessCompartment(ChangePrivateServiceAccessCompartmentRequest request)
```
    Moves a PrivateServiceAccess into a different compartment within the same tenancy.
    For information about moving resources between compartments, see Moving Resources to a Different Compartment.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.76.0/psa/ChangePrivateServiceAccessCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangePrivateServiceAccessCompartment API.
  - createPrivateServiceAccess
```
CreatePrivateServiceAccessResponse createPrivateServiceAccess(CreatePrivateServiceAccessRequest request)
```
    Creates a private service access in the specified subnet (in the consumer’s VCN) and the specified compartment for a particular service.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.76.0/psa/CreatePrivateServiceAccessExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreatePrivateServiceAccess API.
  - deletePrivateServiceAccess
```
DeletePrivateServiceAccessResponse deletePrivateServiceAccess(DeletePrivateServiceAccessRequest request)
```
    Deletes a PrivateServiceAccess.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.76.0/psa/DeletePrivateServiceAccessExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeletePrivateServiceAccess API.
  - getPrivateServiceAccess
```
GetPrivateServiceAccessResponse getPrivateServiceAccess(GetPrivateServiceAccessRequest request)
```
    Gets information about a PrivateServiceAccess.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.76.0/psa/GetPrivateServiceAccessExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetPrivateServiceAccess API.
  - getPsaWorkRequest
```
GetPsaWorkRequestResponse getPsaWorkRequest(GetPsaWorkRequestRequest request)
```
    Gets the details of a PrivateServiceAccess work request.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.76.0/psa/GetPsaWorkRequestExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetPsaWorkRequest API.
  - listPrivateServiceAccesses
```
ListPrivateServiceAccessesResponse listPrivateServiceAccesses(ListPrivateServiceAccessesRequest request)
```
    List 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.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.76.0/psa/ListPrivateServiceAccessesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListPrivateServiceAccesses API.
  - listPsaServices
```
ListPsaServicesResponse listPsaServices(ListPsaServicesRequest request)
```
    List the OCI services available for Private Service Access catalog in the region, sorted by service name.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.76.0/psa/ListPsaServicesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListPsaServices API.
  - listPsaWorkRequestErrors
```
ListPsaWorkRequestErrorsResponse listPsaWorkRequestErrors(ListPsaWorkRequestErrorsRequest request)
```
    Lists the errors for a PrivateServiceAccess work request.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.76.0/psa/ListPsaWorkRequestErrorsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListPsaWorkRequestErrors API.
  - listPsaWorkRequestLogs
```
ListPsaWorkRequestLogsResponse listPsaWorkRequestLogs(ListPsaWorkRequestLogsRequest request)
```
    Lists the logs for a PrivateServiceAccess work request.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.76.0/psa/ListPsaWorkRequestLogsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListPsaWorkRequestLogs API.
  - listPsaWorkRequests
```
ListPsaWorkRequestsResponse listPsaWorkRequests(ListPsaWorkRequestsRequest request)
```
    Lists the PrivateServiceAccess work requests in a compartment.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.76.0/psa/ListPsaWorkRequestsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListPsaWorkRequests API.
  - updatePrivateServiceAccess
```
UpdatePrivateServiceAccessResponse updatePrivateServiceAccess(UpdatePrivateServiceAccessRequest request)
```
    Updates a PrivateServiceAccess.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.76.0/psa/UpdatePrivateServiceAccessExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdatePrivateServiceAccess API.
  - getWaiters
```
PrivateServiceAccessWaiters getWaiters()
```
    Gets the pre-configured waiters available for resources for this service.
    
    Returns:
    
    The service waiters.
  - getPaginators
```
PrivateServiceAccessPaginators getPaginators()
```
    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.
    
    Returns:
    
    The service paginators.

Interface PrivateServiceAccess

Method Summary

Methods inherited from interface java.lang.AutoCloseable

Method Detail

refreshClient

setEndpoint

getEndpoint

setRegion

setRegion

useRealmSpecificEndpointTemplate

cancelPsaWorkRequest

changePrivateServiceAccessCompartment

createPrivateServiceAccess

deletePrivateServiceAccess

getPrivateServiceAccess

getPsaWorkRequest

listPrivateServiceAccesses

listPsaServices

listPsaWorkRequestErrors

listPsaWorkRequestLogs

listPsaWorkRequests

updatePrivateServiceAccess

getWaiters

getPaginators