com.oracle.bmc.tenantmanagercontrolplane

Interface DomainAsync

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

DomainAsyncClient

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20200801")
public interface DomainAsync
extends AutoCloseable

The Organizations API allows you to consolidate multiple OCI tenancies into an organization, and centrally manage your tenancies and its resources.

Method Summary

Modifier and Type	Method and Description
Future<CreateDomainResponse>	createDomain(CreateDomainRequest request, AsyncHandler<CreateDomainRequest,CreateDomainResponse> handler) Begins the registration process for claiming a domain.
Future<DeleteDomainResponse>	deleteDomain(DeleteDomainRequest request, AsyncHandler<DeleteDomainRequest,DeleteDomainResponse> handler) Releases the domain, making it available to be claimed again by another tenancy.
Future<GetDomainResponse>	getDomain(GetDomainRequest request, AsyncHandler<GetDomainRequest,GetDomainResponse> handler) Gets information about the domain.
String	getEndpoint() Gets the set endpoint for REST call (ex, https://www.example.com)
Future<ListDomainsResponse>	listDomains(ListDomainsRequest request, AsyncHandler<ListDomainsRequest,ListDomainsResponse> handler) Return a (paginated) list of domains.
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’).
Future<UpdateDomainResponse>	updateDomain(UpdateDomainRequest request, AsyncHandler<UpdateDomainRequest,UpdateDomainResponse> handler) Updates the domain.

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 serice.

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.

createDomain

Future<CreateDomainResponse> createDomain(CreateDomainRequest request,
                                          AsyncHandler<CreateDomainRequest,CreateDomainResponse> handler)

Begins the registration process for claiming a domain.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

deleteDomain

Future<DeleteDomainResponse> deleteDomain(DeleteDomainRequest request,
                                          AsyncHandler<DeleteDomainRequest,DeleteDomainResponse> handler)

Releases the domain, making it available to be claimed again by another tenancy.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getDomain

Future<GetDomainResponse> getDomain(GetDomainRequest request,
                                    AsyncHandler<GetDomainRequest,GetDomainResponse> handler)

Gets information about the domain.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listDomains

Future<ListDomainsResponse> listDomains(ListDomainsRequest request,
                                        AsyncHandler<ListDomainsRequest,ListDomainsResponse> handler)

Return a (paginated) list of domains.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

updateDomain

Future<UpdateDomainResponse> updateDomain(UpdateDomainRequest request,
                                          AsyncHandler<UpdateDomainRequest,UpdateDomainResponse> handler)

Updates the domain.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.