com.oracle.bmc.tenantmanagercontrolplane

Interface OrdersAsync

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

OrdersAsyncClient

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20230401")
public interface OrdersAsync
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.

Method Summary

Modifier and Type	Method and Description
Future<ActivateOrderResponse>	activateOrder(ActivateOrderRequest request, AsyncHandler<ActivateOrderRequest,ActivateOrderResponse> handler) Triggers an order activation workflow on behalf of the tenant, given by compartment ID in the body.
String	getEndpoint() Gets the set endpoint for REST call (ex, https://www.example.com)
Future<GetOrderResponse>	getOrder(GetOrderRequest request, AsyncHandler<GetOrderRequest,GetOrderResponse> handler) Returns the order details given by the order ID in the JWT.
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’).
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 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.

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

activateOrder

Future<ActivateOrderResponse> activateOrder(ActivateOrderRequest request,
                                            AsyncHandler<ActivateOrderRequest,ActivateOrderResponse> handler)

Triggers an order activation workflow on behalf of the tenant, given by compartment ID in the body.

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.

getOrder

Future<GetOrderResponse> getOrder(GetOrderRequest request,
                                  AsyncHandler<GetOrderRequest,GetOrderResponse> handler)

Returns the order details given by the order ID in the JWT.

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.