AccessGovernanceCP (Oracle Cloud Infrastructure Java SDK

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

AccessGovernanceCPClient
```
@Generated(value="OracleSDKGenerator",
           comments="API Version: 20220518")
public interface AccessGovernanceCP
extends AutoCloseable
```
Use the Oracle Access Governance API to create, view, and manage GovernanceInstances. 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 and Description
`ChangeGovernanceInstanceCompartmentResponse`	`changeGovernanceInstanceCompartment(ChangeGovernanceInstanceCompartmentRequest request)` Moves a GovernanceInstance resource from one compartment identifier to another.
`CreateGovernanceInstanceResponse`	`createGovernanceInstance(CreateGovernanceInstanceRequest request)` Creates a new GovernanceInstance.
`DeleteGovernanceInstanceResponse`	`deleteGovernanceInstance(DeleteGovernanceInstanceRequest request)` Deletes an existing GovernanceInstance.
`String`	`getEndpoint()` Gets the set endpoint for REST call (ex, https://www.example.com)
`GetGovernanceInstanceResponse`	`getGovernanceInstance(GetGovernanceInstanceRequest request)` Gets a GovernanceInstance by OCID.
`GetGovernanceInstanceConfigurationResponse`	`getGovernanceInstanceConfiguration(GetGovernanceInstanceConfigurationRequest request)` Gets the tenancy-wide configuration for GovernanceInstances
`AccessGovernanceCPPaginators`	`getPaginators()` Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
`AccessGovernanceCPWaiters`	`getWaiters()` Gets the pre-configured waiters available for resources for this service.
`ListGovernanceInstancesResponse`	`listGovernanceInstances(ListGovernanceInstancesRequest request)` Returns a list of Governance Instances.
`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’).
`UpdateGovernanceInstanceResponse`	`updateGovernanceInstance(UpdateGovernanceInstanceRequest request)` Updates the GovernanceInstance.
`UpdateGovernanceInstanceConfigurationResponse`	`updateGovernanceInstanceConfiguration(UpdateGovernanceInstanceConfigurationRequest request)` Updates the tenancy-wide configuration for GovernanceInstances
`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
  - changeGovernanceInstanceCompartment
```
ChangeGovernanceInstanceCompartmentResponse changeGovernanceInstanceCompartment(ChangeGovernanceInstanceCompartmentRequest request)
```
    Moves a GovernanceInstance resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.
    
    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 here to see how to use ChangeGovernanceInstanceCompartment API.
  - createGovernanceInstance
```
CreateGovernanceInstanceResponse createGovernanceInstance(CreateGovernanceInstanceRequest request)
```
    Creates a new GovernanceInstance.
    
    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 here to see how to use CreateGovernanceInstance API.
  - deleteGovernanceInstance
```
DeleteGovernanceInstanceResponse deleteGovernanceInstance(DeleteGovernanceInstanceRequest request)
```
    Deletes an existing GovernanceInstance.
    
    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 here to see how to use DeleteGovernanceInstance API.
  - getGovernanceInstance
```
GetGovernanceInstanceResponse getGovernanceInstance(GetGovernanceInstanceRequest request)
```
    Gets a GovernanceInstance by OCID.
    
    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 here to see how to use GetGovernanceInstance API.
  - getGovernanceInstanceConfiguration
```
GetGovernanceInstanceConfigurationResponse getGovernanceInstanceConfiguration(GetGovernanceInstanceConfigurationRequest request)
```
    Gets the tenancy-wide configuration for GovernanceInstances
    
    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 here to see how to use GetGovernanceInstanceConfiguration API.
  - listGovernanceInstances
```
ListGovernanceInstancesResponse listGovernanceInstances(ListGovernanceInstancesRequest request)
```
    Returns a list of Governance 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 here to see how to use ListGovernanceInstances API.
  - updateGovernanceInstance
```
UpdateGovernanceInstanceResponse updateGovernanceInstance(UpdateGovernanceInstanceRequest request)
```
    Updates the GovernanceInstance.
    
    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 here to see how to use UpdateGovernanceInstance API.
  - updateGovernanceInstanceConfiguration
```
UpdateGovernanceInstanceConfigurationResponse updateGovernanceInstanceConfiguration(UpdateGovernanceInstanceConfigurationRequest request)
```
    Updates the tenancy-wide configuration for GovernanceInstances
    
    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 here to see how to use UpdateGovernanceInstanceConfiguration API.
  - getWaiters
```
AccessGovernanceCPWaiters getWaiters()
```
    Gets the pre-configured waiters available for resources for this service.
    
    Returns:
    
    The service waiters.
  - getPaginators
```
AccessGovernanceCPPaginators 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 AccessGovernanceCP

Method Summary

Methods inherited from interface java.lang.AutoCloseable

Method Detail

refreshClient

setEndpoint

getEndpoint

setRegion

setRegion

useRealmSpecificEndpointTemplate

changeGovernanceInstanceCompartment

createGovernanceInstance

deleteGovernanceInstance

getGovernanceInstance

getGovernanceInstanceConfiguration

listGovernanceInstances

updateGovernanceInstance

updateGovernanceInstanceConfiguration

getWaiters

getPaginators