Package com.oracle.bmc.ocvp

Interface ByolAllocationAsync

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

ByolAllocationAsyncClient

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

Use the Oracle Cloud VMware API to create SDDCs and manage ESXi hosts and software.

For more information, see Oracle Cloud VMware Solution.

Method Summary

Modifier and Type	Method	Description
Future<ChangeByolAllocationCompartmentResponse>	changeByolAllocationCompartment(ChangeByolAllocationCompartmentRequest request, AsyncHandler<ChangeByolAllocationCompartmentRequest,ChangeByolAllocationCompartmentResponse> handler)	Moves an BYOL Allocation into a different compartment within the same tenancy.
Future<CreateByolAllocationResponse>	createByolAllocation(CreateByolAllocationRequest request, AsyncHandler<CreateByolAllocationRequest,CreateByolAllocationResponse> handler)	Creates an Allocation on an specific Bring-You-Own-License (BYOL).
Future<DeleteByolAllocationResponse>	deleteByolAllocation(DeleteByolAllocationRequest request, AsyncHandler<DeleteByolAllocationRequest,DeleteByolAllocationResponse> handler)	Deletes the specified BYOL Allocation.
Future<GetByolAllocationResponse>	getByolAllocation(GetByolAllocationRequest request, AsyncHandler<GetByolAllocationRequest,GetByolAllocationResponse> handler)	Gets the specified BYOL Allocation’s information.
String	getEndpoint()	Gets the set endpoint for REST call (ex, https://www.example.com)
Future<ListByolAllocationsResponse>	listByolAllocations(ListByolAllocationsRequest request, AsyncHandler<ListByolAllocationsRequest,ListByolAllocationsResponse> handler)	Lists the BYOL Allocations in the specified 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’).
Future<UpdateByolAllocationResponse>	updateByolAllocation(UpdateByolAllocationRequest request, AsyncHandler<UpdateByolAllocationRequest,UpdateByolAllocationResponse> handler)	Updates the specified BYOL Allocation.
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

changeByolAllocationCompartment

Future<ChangeByolAllocationCompartmentResponse> changeByolAllocationCompartment(ChangeByolAllocationCompartmentRequest request,
                                                                                AsyncHandler<ChangeByolAllocationCompartmentRequest,ChangeByolAllocationCompartmentResponse> handler)

Moves an BYOL Allocation 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

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.

createByolAllocation

Future<CreateByolAllocationResponse> createByolAllocation(CreateByolAllocationRequest request,
                                                          AsyncHandler<CreateByolAllocationRequest,CreateByolAllocationResponse> handler)

Creates an Allocation on an specific Bring-You-Own-License (BYOL).

Use the WorkRequest operations to track the creation of the BYOL.

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.

deleteByolAllocation

Future<DeleteByolAllocationResponse> deleteByolAllocation(DeleteByolAllocationRequest request,
                                                          AsyncHandler<DeleteByolAllocationRequest,DeleteByolAllocationResponse> handler)

Deletes the specified BYOL Allocation.

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.

getByolAllocation

Future<GetByolAllocationResponse> getByolAllocation(GetByolAllocationRequest request,
                                                    AsyncHandler<GetByolAllocationRequest,GetByolAllocationResponse> handler)

Gets the specified BYOL Allocation’s information.

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.

listByolAllocations

Future<ListByolAllocationsResponse> listByolAllocations(ListByolAllocationsRequest request,
                                                        AsyncHandler<ListByolAllocationsRequest,ListByolAllocationsResponse> handler)

Lists the BYOL Allocations in the specified compartment.

The list can be filtered by display name or availability 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.

updateByolAllocation

Future<UpdateByolAllocationResponse> updateByolAllocation(UpdateByolAllocationRequest request,
                                                          AsyncHandler<UpdateByolAllocationRequest,UpdateByolAllocationResponse> handler)

Updates the specified BYOL Allocation.

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.