com.oracle.bmc.clusterplacementgroups

Interface ClusterPlacementGroupsCPAsync

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

ClusterPlacementGroupsCPAsyncClient

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

API for managing cluster placement groups.

Method Summary

Modifier and Type	Method and Description
Future<ActivateClusterPlacementGroupResponse>	activateClusterPlacementGroup(ActivateClusterPlacementGroupRequest request, AsyncHandler<ActivateClusterPlacementGroupRequest,ActivateClusterPlacementGroupResponse> handler) Activates the specified, previously deactivated cluster placement group to let resources be created in it.
Future<CancelWorkRequestResponse>	cancelWorkRequest(CancelWorkRequestRequest request, AsyncHandler<CancelWorkRequestRequest,CancelWorkRequestResponse> handler) Cancels the work request with the specified ID.
Future<ChangeClusterPlacementGroupCompartmentResponse>	changeClusterPlacementGroupCompartment(ChangeClusterPlacementGroupCompartmentRequest request, AsyncHandler<ChangeClusterPlacementGroupCompartmentRequest,ChangeClusterPlacementGroupCompartmentResponse> handler) Moves a cluster placement group resource from one compartment to another in the same tenancy.
Future<CreateClusterPlacementGroupResponse>	createClusterPlacementGroup(CreateClusterPlacementGroupRequest request, AsyncHandler<CreateClusterPlacementGroupRequest,CreateClusterPlacementGroupResponse> handler) Creates a new cluster placement group in the specified compartment.
Future<DeactivateClusterPlacementGroupResponse>	deactivateClusterPlacementGroup(DeactivateClusterPlacementGroupRequest request, AsyncHandler<DeactivateClusterPlacementGroupRequest,DeactivateClusterPlacementGroupResponse> handler) Deactivates the specified cluster placement group to prevent new resources from being created in it.
Future<DeleteClusterPlacementGroupResponse>	deleteClusterPlacementGroup(DeleteClusterPlacementGroupRequest request, AsyncHandler<DeleteClusterPlacementGroupRequest,DeleteClusterPlacementGroupResponse> handler) Deletes the specified cluster placement group.
Future<GetClusterPlacementGroupResponse>	getClusterPlacementGroup(GetClusterPlacementGroupRequest request, AsyncHandler<GetClusterPlacementGroupRequest,GetClusterPlacementGroupResponse> handler) Gets the specified cluster placement group.
String	getEndpoint() Gets the set endpoint for REST call (ex, https://www.example.com)
Future<GetWorkRequestResponse>	getWorkRequest(GetWorkRequestRequest request, AsyncHandler<GetWorkRequestRequest,GetWorkRequestResponse> handler) Gets details of the work request with the specified ID.
Future<ListClusterPlacementGroupsResponse>	listClusterPlacementGroups(ListClusterPlacementGroupsRequest request, AsyncHandler<ListClusterPlacementGroupsRequest,ListClusterPlacementGroupsResponse> handler) Gets a list of all cluster placement groups in the specified compartment.
Future<ListWorkRequestErrorsResponse>	listWorkRequestErrors(ListWorkRequestErrorsRequest request, AsyncHandler<ListWorkRequestErrorsRequest,ListWorkRequestErrorsResponse> handler) Returns a (paginated) list of errors for the work request with the specified ID.
Future<ListWorkRequestLogsResponse>	listWorkRequestLogs(ListWorkRequestLogsRequest request, AsyncHandler<ListWorkRequestLogsRequest,ListWorkRequestLogsResponse> handler) Returns a (paginated) list of logs for the work request with the specified ID.
Future<ListWorkRequestsResponse>	listWorkRequests(ListWorkRequestsRequest request, AsyncHandler<ListWorkRequestsRequest,ListWorkRequestsResponse> handler) Lists all work requests 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<UpdateClusterPlacementGroupResponse>	updateClusterPlacementGroup(UpdateClusterPlacementGroupRequest request, AsyncHandler<UpdateClusterPlacementGroupRequest,UpdateClusterPlacementGroupResponse> handler) Updates the specified cluster placement group.
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

activateClusterPlacementGroup

Future<ActivateClusterPlacementGroupResponse> activateClusterPlacementGroup(ActivateClusterPlacementGroupRequest request,
                                                                            AsyncHandler<ActivateClusterPlacementGroupRequest,ActivateClusterPlacementGroupResponse> handler)

Activates the specified, previously deactivated cluster placement group to let resources be created in it.

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.

cancelWorkRequest

Future<CancelWorkRequestResponse> cancelWorkRequest(CancelWorkRequestRequest request,
                                                    AsyncHandler<CancelWorkRequestRequest,CancelWorkRequestResponse> handler)

Cancels the work request with the specified ID.

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.

changeClusterPlacementGroupCompartment

Future<ChangeClusterPlacementGroupCompartmentResponse> changeClusterPlacementGroupCompartment(ChangeClusterPlacementGroupCompartmentRequest request,
                                                                                              AsyncHandler<ChangeClusterPlacementGroupCompartmentRequest,ChangeClusterPlacementGroupCompartmentResponse> handler)

Moves a cluster placement group resource from one compartment to another in the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

When provided, If-Match is checked against ETag values of the resource.

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.

createClusterPlacementGroup

Future<CreateClusterPlacementGroupResponse> createClusterPlacementGroup(CreateClusterPlacementGroupRequest request,
                                                                        AsyncHandler<CreateClusterPlacementGroupRequest,CreateClusterPlacementGroupResponse> handler)

Creates a new cluster placement group in the specified 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.

deactivateClusterPlacementGroup

Future<DeactivateClusterPlacementGroupResponse> deactivateClusterPlacementGroup(DeactivateClusterPlacementGroupRequest request,
                                                                                AsyncHandler<DeactivateClusterPlacementGroupRequest,DeactivateClusterPlacementGroupResponse> handler)

Deactivates the specified cluster placement group to prevent new resources from being created in it.

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.

deleteClusterPlacementGroup

Future<DeleteClusterPlacementGroupResponse> deleteClusterPlacementGroup(DeleteClusterPlacementGroupRequest request,
                                                                        AsyncHandler<DeleteClusterPlacementGroupRequest,DeleteClusterPlacementGroupResponse> handler)

Deletes the specified cluster placement group.

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.

getClusterPlacementGroup

Future<GetClusterPlacementGroupResponse> getClusterPlacementGroup(GetClusterPlacementGroupRequest request,
                                                                  AsyncHandler<GetClusterPlacementGroupRequest,GetClusterPlacementGroupResponse> handler)

Gets the specified cluster placement group.

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.

getWorkRequest

Future<GetWorkRequestResponse> getWorkRequest(GetWorkRequestRequest request,
                                              AsyncHandler<GetWorkRequestRequest,GetWorkRequestResponse> handler)

Gets details of the work request with the specified ID.

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.

listClusterPlacementGroups

Future<ListClusterPlacementGroupsResponse> listClusterPlacementGroups(ListClusterPlacementGroupsRequest request,
                                                                      AsyncHandler<ListClusterPlacementGroupsRequest,ListClusterPlacementGroupsResponse> handler)

Gets a list of all cluster placement groups in the specified 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.

listWorkRequestErrors

Future<ListWorkRequestErrorsResponse> listWorkRequestErrors(ListWorkRequestErrorsRequest request,
                                                            AsyncHandler<ListWorkRequestErrorsRequest,ListWorkRequestErrorsResponse> handler)

Returns a (paginated) list of errors for the work request with the specified ID.

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.

listWorkRequestLogs

Future<ListWorkRequestLogsResponse> listWorkRequestLogs(ListWorkRequestLogsRequest request,
                                                        AsyncHandler<ListWorkRequestLogsRequest,ListWorkRequestLogsResponse> handler)

Returns a (paginated) list of logs for the work request with the specified ID.

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.

listWorkRequests

Future<ListWorkRequestsResponse> listWorkRequests(ListWorkRequestsRequest request,
                                                  AsyncHandler<ListWorkRequestsRequest,ListWorkRequestsResponse> handler)

Lists all work requests in the specified 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.

updateClusterPlacementGroup

Future<UpdateClusterPlacementGroupResponse> updateClusterPlacementGroup(UpdateClusterPlacementGroupRequest request,
                                                                        AsyncHandler<UpdateClusterPlacementGroupRequest,UpdateClusterPlacementGroupResponse> handler)

Updates the specified cluster placement group.

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.