All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

InstanceClient
```
@Generated(value="OracleSDKGenerator",
           comments="API Version: 20260831")
public interface Instance
extends AutoCloseable
```
Use the Device Data FHIR Service API to manage DDFS instances.
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
`CancelWorkRequestResponse`	`cancelWorkRequest(CancelWorkRequestRequest request)`	Cancels a work request.
`ChangeInstanceCompartmentResponse`	`changeInstanceCompartment(ChangeInstanceCompartmentRequest request)`	Moves an Instance into a different compartment within the same tenancy.
`CreateInstanceResponse`	`createInstance(CreateInstanceRequest request)`	Creates an Instance.
`DeleteInstanceResponse`	`deleteInstance(DeleteInstanceRequest request)`	Deletes an Instance.
`String`	`getEndpoint()`	Gets the set endpoint for REST call (ex, https://www.example.com)
`GetInstanceResponse`	`getInstance(GetInstanceRequest request)`	Gets information about an Instance.
`InstancePaginators`	`getPaginators()`	Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
`InstanceWaiters`	`getWaiters()`	Gets the pre-configured waiters available for resources for this service.
`GetWorkRequestResponse`	`getWorkRequest(GetWorkRequestRequest request)`	Gets the details of a work request.
`ListInstancesResponse`	`listInstances(ListInstancesRequest request)`	Gets a list of Instances.
`ListWorkRequestErrorsResponse`	`listWorkRequestErrors(ListWorkRequestErrorsRequest request)`	Lists the errors for a work request.
`ListWorkRequestLogsResponse`	`listWorkRequestLogs(ListWorkRequestLogsRequest request)`	Lists the logs for a work request.
`ListWorkRequestsResponse`	`listWorkRequests(ListWorkRequestsRequest request)`	Lists the 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’).
`UpdateInstanceResponse`	`updateInstance(UpdateInstanceRequest request)`	Updates an Instance.
`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
  - cancelWorkRequest
```
CancelWorkRequestResponse cancelWorkRequest(CancelWorkRequestRequest request)
```
    Cancels a 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.94.1/ddfs/CancelWorkRequestExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CancelWorkRequest API.
  - changeInstanceCompartment
```
ChangeInstanceCompartmentResponse changeInstanceCompartment(ChangeInstanceCompartmentRequest request)
```
    Moves an Instance 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.94.1/ddfs/ChangeInstanceCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeInstanceCompartment API.
  - createInstance
```
CreateInstanceResponse createInstance(CreateInstanceRequest request)
```
    Creates an Instance.
    
    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.94.1/ddfs/CreateInstanceExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateInstance API.
  - deleteInstance
```
DeleteInstanceResponse deleteInstance(DeleteInstanceRequest request)
```
    Deletes an Instance.
    
    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.94.1/ddfs/DeleteInstanceExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteInstance API.
  - getInstance
```
GetInstanceResponse getInstance(GetInstanceRequest request)
```
    Gets information about an Instance.
    
    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.94.1/ddfs/GetInstanceExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetInstance API.
  - getWorkRequest
```
GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)
```
    Gets the details of a 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.94.1/ddfs/GetWorkRequestExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetWorkRequest API.
  - listInstances
```
ListInstancesResponse listInstances(ListInstancesRequest request)
```
    Gets a list of Instances.
    
    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.94.1/ddfs/ListInstancesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListInstances API.
  - listWorkRequestErrors
```
ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)
```
    Lists the errors for a 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.94.1/ddfs/ListWorkRequestErrorsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListWorkRequestErrors API.
  - listWorkRequestLogs
```
ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)
```
    Lists the logs for a 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.94.1/ddfs/ListWorkRequestLogsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListWorkRequestLogs API.
  - listWorkRequests
```
ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)
```
    Lists the 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.94.1/ddfs/ListWorkRequestsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListWorkRequests API.
  - updateInstance
```
UpdateInstanceResponse updateInstance(UpdateInstanceRequest request)
```
    Updates an Instance.
    
    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.94.1/ddfs/UpdateInstanceExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateInstance API.
  - getWaiters
```
InstanceWaiters getWaiters()
```
    Gets the pre-configured waiters available for resources for this service.
    
    Returns:
    
    The service waiters.
  - getPaginators
```
InstancePaginators 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 Instance

Method Summary

Methods inherited from interface java.lang.AutoCloseable

Method Detail

refreshClient

setEndpoint

getEndpoint

setRegion

setRegion

useRealmSpecificEndpointTemplate

cancelWorkRequest

changeInstanceCompartment

createInstance

deleteInstance

getInstance

getWorkRequest

listInstances

listWorkRequestErrors

listWorkRequestLogs

listWorkRequests

updateInstance

getWaiters

getPaginators