All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

OrganizationClient
```
@Generated(value="OracleSDKGenerator",
           comments="API Version: 20230401")
public interface Organization
extends AutoCloseable
```
Use the Organizations API to consolidate multiple OCI tenancies into an organization, and centrally manage your tenancies and organization resources.
For more information, see Organization Management Overview. 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
`ApproveOrganizationTenancyForTransferResponse`	`approveOrganizationTenancyForTransfer(ApproveOrganizationTenancyForTransferRequest request)`	Approve an organization’s child tenancy for transfer.
`CreateChildTenancyResponse`	`createChildTenancy(CreateChildTenancyRequest request)`	Creates a child tenancy asynchronously.
`DeleteOrganizationTenancyResponse`	`deleteOrganizationTenancy(DeleteOrganizationTenancyRequest request)`	If certain validations are successful, initiate tenancy termination.
`String`	`getEndpoint()`	Gets the set endpoint for REST call (ex, https://www.example.com)
`GetOrganizationResponse`	`getOrganization(GetOrganizationRequest request)`	Gets information about the organization.
`GetOrganizationTenancyResponse`	`getOrganizationTenancy(GetOrganizationTenancyRequest request)`	Gets information about the organization’s tenancy.
`OrganizationPaginators`	`getPaginators()`	Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
`OrganizationWaiters`	`getWaiters()`	Gets the pre-configured waiters available for resources for this service.
`ListOrganizationsResponse`	`listOrganizations(ListOrganizationsRequest request)`	Lists organizations associated with the caller.
`ListOrganizationTenanciesResponse`	`listOrganizationTenancies(ListOrganizationTenanciesRequest request)`	Gets a list of tenancies in the organization.
`void`	`refreshClient()`	Rebuilds the client from scratch.
`RestoreOrganizationTenancyResponse`	`restoreOrganizationTenancy(RestoreOrganizationTenancyRequest request)`	An asynchronous API to restore a tenancy.
`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’).
`UnapproveOrganizationTenancyForTransferResponse`	`unapproveOrganizationTenancyForTransfer(UnapproveOrganizationTenancyForTransferRequest request)`	Cancel an organization’s child tenancy for transfer.
`UpdateOrganizationResponse`	`updateOrganization(UpdateOrganizationRequest request)`	Map the default subscription to the organization.
`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
  - approveOrganizationTenancyForTransfer
```
ApproveOrganizationTenancyForTransferResponse approveOrganizationTenancyForTransfer(ApproveOrganizationTenancyForTransferRequest request)
```
    Approve an organization’s child tenancy for transfer.
    
    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 will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. 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.63.0/tenantmanagercontrolplane/ApproveOrganizationTenancyForTransferExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ApproveOrganizationTenancyForTransfer API.
  - createChildTenancy
```
CreateChildTenancyResponse createChildTenancy(CreateChildTenancyRequest request)
```
    Creates a child tenancy asynchronously.
    
    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 will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. 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.63.0/tenantmanagercontrolplane/CreateChildTenancyExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateChildTenancy API.
  - deleteOrganizationTenancy
```
DeleteOrganizationTenancyResponse deleteOrganizationTenancy(DeleteOrganizationTenancyRequest request)
```
    If certain validations are successful, initiate tenancy termination.
    
    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 will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. 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.63.0/tenantmanagercontrolplane/DeleteOrganizationTenancyExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteOrganizationTenancy API.
  - getOrganization
```
GetOrganizationResponse getOrganization(GetOrganizationRequest request)
```
    Gets information about the organization.
    
    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 will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. 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.63.0/tenantmanagercontrolplane/GetOrganizationExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetOrganization API.
  - getOrganizationTenancy
```
GetOrganizationTenancyResponse getOrganizationTenancy(GetOrganizationTenancyRequest request)
```
    Gets information about the organization’s tenancy.
    
    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 will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. 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.63.0/tenantmanagercontrolplane/GetOrganizationTenancyExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetOrganizationTenancy API.
  - listOrganizationTenancies
```
ListOrganizationTenanciesResponse listOrganizationTenancies(ListOrganizationTenanciesRequest request)
```
    Gets a list of tenancies in the organization.
    
    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 will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. 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.63.0/tenantmanagercontrolplane/ListOrganizationTenanciesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListOrganizationTenancies API.
  - listOrganizations
```
ListOrganizationsResponse listOrganizations(ListOrganizationsRequest request)
```
    Lists organizations associated with the caller.
    
    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 will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. 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.63.0/tenantmanagercontrolplane/ListOrganizationsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListOrganizations API.
  - restoreOrganizationTenancy
```
RestoreOrganizationTenancyResponse restoreOrganizationTenancy(RestoreOrganizationTenancyRequest request)
```
    An asynchronous API to restore a tenancy.
    
    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 will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. 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.63.0/tenantmanagercontrolplane/RestoreOrganizationTenancyExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use RestoreOrganizationTenancy API.
  - unapproveOrganizationTenancyForTransfer
```
UnapproveOrganizationTenancyForTransferResponse unapproveOrganizationTenancyForTransfer(UnapproveOrganizationTenancyForTransferRequest request)
```
    Cancel an organization’s child tenancy for transfer.
    
    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 will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. 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.63.0/tenantmanagercontrolplane/UnapproveOrganizationTenancyForTransferExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UnapproveOrganizationTenancyForTransfer API.
  - updateOrganization
```
UpdateOrganizationResponse updateOrganization(UpdateOrganizationRequest request)
```
    Map the default subscription to the organization.
    
    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 will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. 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.63.0/tenantmanagercontrolplane/UpdateOrganizationExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateOrganization API.
  - getWaiters
```
OrganizationWaiters getWaiters()
```
    Gets the pre-configured waiters available for resources for this service.
    
    Returns:
    
    The service waiters.
  - getPaginators
```
OrganizationPaginators 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 Organization

Method Summary

Methods inherited from interface java.lang.AutoCloseable

Method Detail

refreshClient

setEndpoint

getEndpoint

setRegion

setRegion

useRealmSpecificEndpointTemplate

approveOrganizationTenancyForTransfer

createChildTenancy

deleteOrganizationTenancy

getOrganization

getOrganizationTenancy

listOrganizationTenancies

listOrganizations

restoreOrganizationTenancy

unapproveOrganizationTenancyForTransfer

updateOrganization

getWaiters

getPaginators