Interface CapacityManagementAsync
-
- All Superinterfaces:
AutoCloseable
- All Known Implementing Classes:
CapacityManagementAsyncClient
@Generated(value="OracleSDKGenerator", comments="API Version: 20231107") public interface CapacityManagementAsync extends AutoCloseable
OCI Control Center (OCC) Capacity Management enables you to manage capacity requests in realms where OCI Control Center Capacity Management is available.For more information, see OCI Control Center.
-
-
Method Summary
-
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 callsetEndpoint
.- 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
-
createOccAvailabilityCatalog
Future<CreateOccAvailabilityCatalogResponse> createOccAvailabilityCatalog(CreateOccAvailabilityCatalogRequest request, AsyncHandler<CreateOccAvailabilityCatalogRequest,CreateOccAvailabilityCatalogResponse> handler)
Create availability catalog- Parameters:
request
- The request object containing the details to sendhandler
- 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.
-
createOccCapacityRequest
Future<CreateOccCapacityRequestResponse> createOccCapacityRequest(CreateOccCapacityRequestRequest request, AsyncHandler<CreateOccCapacityRequestRequest,CreateOccCapacityRequestResponse> handler)
Create Capacity Request.- Parameters:
request
- The request object containing the details to sendhandler
- 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.
-
createOccCustomer
Future<CreateOccCustomerResponse> createOccCustomer(CreateOccCustomerRequest request, AsyncHandler<CreateOccCustomerRequest,CreateOccCustomerResponse> handler)
Create customer.- Parameters:
request
- The request object containing the details to sendhandler
- 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.
-
createOccCustomerGroup
Future<CreateOccCustomerGroupResponse> createOccCustomerGroup(CreateOccCustomerGroupRequest request, AsyncHandler<CreateOccCustomerGroupRequest,CreateOccCustomerGroupResponse> handler)
Create customer group.- Parameters:
request
- The request object containing the details to sendhandler
- 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.
-
deleteOccAvailabilityCatalog
Future<DeleteOccAvailabilityCatalogResponse> deleteOccAvailabilityCatalog(DeleteOccAvailabilityCatalogRequest request, AsyncHandler<DeleteOccAvailabilityCatalogRequest,DeleteOccAvailabilityCatalogResponse> handler)
Deletes the availability catalog resource.- Parameters:
request
- The request object containing the details to sendhandler
- 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.
-
deleteOccCapacityRequest
Future<DeleteOccCapacityRequestResponse> deleteOccCapacityRequest(DeleteOccCapacityRequestRequest request, AsyncHandler<DeleteOccCapacityRequestRequest,DeleteOccCapacityRequestResponse> handler)
Deletes the capacity request resource.- Parameters:
request
- The request object containing the details to sendhandler
- 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.
-
deleteOccCustomer
Future<DeleteOccCustomerResponse> deleteOccCustomer(DeleteOccCustomerRequest request, AsyncHandler<DeleteOccCustomerRequest,DeleteOccCustomerResponse> handler)
Deletes the customer resource.- Parameters:
request
- The request object containing the details to sendhandler
- 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.
-
deleteOccCustomerGroup
Future<DeleteOccCustomerGroupResponse> deleteOccCustomerGroup(DeleteOccCustomerGroupRequest request, AsyncHandler<DeleteOccCustomerGroupRequest,DeleteOccCustomerGroupResponse> handler)
Deletes the customer group resource.- Parameters:
request
- The request object containing the details to sendhandler
- 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.
-
getOccAvailabilityCatalog
Future<GetOccAvailabilityCatalogResponse> getOccAvailabilityCatalog(GetOccAvailabilityCatalogRequest request, AsyncHandler<GetOccAvailabilityCatalogRequest,GetOccAvailabilityCatalogResponse> handler)
Get details about availability catalog.- Parameters:
request
- The request object containing the details to sendhandler
- 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.
-
getOccAvailabilityCatalogContent
Future<GetOccAvailabilityCatalogContentResponse> getOccAvailabilityCatalogContent(GetOccAvailabilityCatalogContentRequest request, AsyncHandler<GetOccAvailabilityCatalogContentRequest,GetOccAvailabilityCatalogContentResponse> handler)
Returns the binary contents of the availability catalog.Can be saved as a csv file.
- Parameters:
request
- The request object containing the details to sendhandler
- 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.
-
getOccCapacityRequest
Future<GetOccCapacityRequestResponse> getOccCapacityRequest(GetOccCapacityRequestRequest request, AsyncHandler<GetOccCapacityRequestRequest,GetOccCapacityRequestResponse> handler)
Get details about the capacity request.- Parameters:
request
- The request object containing the details to sendhandler
- 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.
-
getOccCustomerGroup
Future<GetOccCustomerGroupResponse> getOccCustomerGroup(GetOccCustomerGroupRequest request, AsyncHandler<GetOccCustomerGroupRequest,GetOccCustomerGroupResponse> handler)
Gets information about the specified customer group.- Parameters:
request
- The request object containing the details to sendhandler
- 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.
-
listInternalNamespaceOccOverviews
Future<ListInternalNamespaceOccOverviewsResponse> listInternalNamespaceOccOverviews(ListInternalNamespaceOccOverviewsRequest request, AsyncHandler<ListInternalNamespaceOccOverviewsRequest,ListInternalNamespaceOccOverviewsResponse> handler)
Lists an overview of all resources in that namespace in a given time interval.- Parameters:
request
- The request object containing the details to sendhandler
- 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.
-
listInternalOccHandoverResourceBlockDetails
Future<ListInternalOccHandoverResourceBlockDetailsResponse> listInternalOccHandoverResourceBlockDetails(ListInternalOccHandoverResourceBlockDetailsRequest request, AsyncHandler<ListInternalOccHandoverResourceBlockDetailsRequest,ListInternalOccHandoverResourceBlockDetailsResponse> handler)
List details about a given occHandoverResourceBlock.- Parameters:
request
- The request object containing the details to sendhandler
- 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.
-
listInternalOccHandoverResourceBlocks
Future<ListInternalOccHandoverResourceBlocksResponse> listInternalOccHandoverResourceBlocks(ListInternalOccHandoverResourceBlocksRequest request, AsyncHandler<ListInternalOccHandoverResourceBlocksRequest,ListInternalOccHandoverResourceBlocksResponse> handler)
List Occ Handover Resource blocks.- Parameters:
request
- The request object containing the details to sendhandler
- 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.
-
listOccAvailabilities
Future<ListOccAvailabilitiesResponse> listOccAvailabilities(ListOccAvailabilitiesRequest request, AsyncHandler<ListOccAvailabilitiesRequest,ListOccAvailabilitiesResponse> handler)
Lists availabilities for a particular availability catalog.- Parameters:
request
- The request object containing the details to sendhandler
- 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.
-
listOccAvailabilityCatalogs
Future<ListOccAvailabilityCatalogsResponse> listOccAvailabilityCatalogs(ListOccAvailabilityCatalogsRequest request, AsyncHandler<ListOccAvailabilityCatalogsRequest,ListOccAvailabilityCatalogsResponse> handler)
Lists all availability catalogs.- Parameters:
request
- The request object containing the details to sendhandler
- 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.
-
listOccAvailabilityCatalogsInternal
Future<ListOccAvailabilityCatalogsInternalResponse> listOccAvailabilityCatalogsInternal(ListOccAvailabilityCatalogsInternalRequest request, AsyncHandler<ListOccAvailabilityCatalogsInternalRequest,ListOccAvailabilityCatalogsInternalResponse> handler)
An internal api to list availability catalogs.- Parameters:
request
- The request object containing the details to sendhandler
- 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.
-
listOccCapacityRequests
Future<ListOccCapacityRequestsResponse> listOccCapacityRequests(ListOccCapacityRequestsRequest request, AsyncHandler<ListOccCapacityRequestsRequest,ListOccCapacityRequestsResponse> handler)
Lists all capacity requests.- Parameters:
request
- The request object containing the details to sendhandler
- 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.
-
listOccCapacityRequestsInternal
Future<ListOccCapacityRequestsInternalResponse> listOccCapacityRequestsInternal(ListOccCapacityRequestsInternalRequest request, AsyncHandler<ListOccCapacityRequestsInternalRequest,ListOccCapacityRequestsInternalResponse> handler)
An internal api to list all capacity requests.- Parameters:
request
- The request object containing the details to sendhandler
- 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.
-
listOccCustomerGroups
Future<ListOccCustomerGroupsResponse> listOccCustomerGroups(ListOccCustomerGroupsRequest request, AsyncHandler<ListOccCustomerGroupsRequest,ListOccCustomerGroupsResponse> handler)
Lists all the customer groups.- Parameters:
request
- The request object containing the details to sendhandler
- 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.
-
listOccHandoverResourceBlockDetails
Future<ListOccHandoverResourceBlockDetailsResponse> listOccHandoverResourceBlockDetails(ListOccHandoverResourceBlockDetailsRequest request, AsyncHandler<ListOccHandoverResourceBlockDetailsRequest,ListOccHandoverResourceBlockDetailsResponse> handler)
List details about a given occHandoverResourceBlock.- Parameters:
request
- The request object containing the details to sendhandler
- 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.
-
listOccHandoverResourceBlocks
Future<ListOccHandoverResourceBlocksResponse> listOccHandoverResourceBlocks(ListOccHandoverResourceBlocksRequest request, AsyncHandler<ListOccHandoverResourceBlocksRequest,ListOccHandoverResourceBlocksResponse> handler)
List Occ Handover Resource blocks.- Parameters:
request
- The request object containing the details to sendhandler
- 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.
-
listOccOverviews
Future<ListOccOverviewsResponse> listOccOverviews(ListOccOverviewsRequest request, AsyncHandler<ListOccOverviewsRequest,ListOccOverviewsResponse> handler)
Lists an overview of all resources in that namespace in a given time interval.- Parameters:
request
- The request object containing the details to sendhandler
- 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.
-
patchInternalOccCapacityRequest
Future<PatchInternalOccCapacityRequestResponse> patchInternalOccCapacityRequest(PatchInternalOccCapacityRequestRequest request, AsyncHandler<PatchInternalOccCapacityRequestRequest,PatchInternalOccCapacityRequestResponse> handler)
Updates the OccCapacityRequest by evaluating a sequence of instructions.- Parameters:
request
- The request object containing the details to sendhandler
- 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.
-
patchOccCapacityRequest
Future<PatchOccCapacityRequestResponse> patchOccCapacityRequest(PatchOccCapacityRequestRequest request, AsyncHandler<PatchOccCapacityRequestRequest,PatchOccCapacityRequestResponse> handler)
Updates the OccCapacityRequest by evaluating a sequence of instructions.- Parameters:
request
- The request object containing the details to sendhandler
- 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.
-
publishOccAvailabilityCatalog
Future<PublishOccAvailabilityCatalogResponse> publishOccAvailabilityCatalog(PublishOccAvailabilityCatalogRequest request, AsyncHandler<PublishOccAvailabilityCatalogRequest,PublishOccAvailabilityCatalogResponse> handler)
Publishes the version of availability catalog specified by the operator.This makes that catalog version visible to customers.
- Parameters:
request
- The request object containing the details to sendhandler
- 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.
-
updateInternalOccCapacityRequest
Future<UpdateInternalOccCapacityRequestResponse> updateInternalOccCapacityRequest(UpdateInternalOccCapacityRequestRequest request, AsyncHandler<UpdateInternalOccCapacityRequestRequest,UpdateInternalOccCapacityRequestResponse> handler)
The internal api to update the capacity request.This api will be used by operators for updating the capacity request to either completed, resubmitted or rejected.
- Parameters:
request
- The request object containing the details to sendhandler
- 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.
-
updateOccAvailabilityCatalog
Future<UpdateOccAvailabilityCatalogResponse> updateOccAvailabilityCatalog(UpdateOccAvailabilityCatalogRequest request, AsyncHandler<UpdateOccAvailabilityCatalogRequest,UpdateOccAvailabilityCatalogResponse> handler)
The request to update the availability catalog.Currently only freeform tags can be updated via this api.
- Parameters:
request
- The request object containing the details to sendhandler
- 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.
-
updateOccCapacityRequest
Future<UpdateOccCapacityRequestResponse> updateOccCapacityRequest(UpdateOccCapacityRequestRequest request, AsyncHandler<UpdateOccCapacityRequestRequest,UpdateOccCapacityRequestResponse> handler)
The request to update the capacity request.The user can perform actions like closing a partially completed request so that it doesn’t go ahead for full completion.
- Parameters:
request
- The request object containing the details to sendhandler
- 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.
-
updateOccCustomer
Future<UpdateOccCustomerResponse> updateOccCustomer(UpdateOccCustomerRequest request, AsyncHandler<UpdateOccCustomerRequest,UpdateOccCustomerResponse> handler)
The request to update the customer.- Parameters:
request
- The request object containing the details to sendhandler
- 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.
-
updateOccCustomerGroup
Future<UpdateOccCustomerGroupResponse> updateOccCustomerGroup(UpdateOccCustomerGroupRequest request, AsyncHandler<UpdateOccCustomerGroupRequest,UpdateOccCustomerGroupResponse> handler)
The request to update the customer group.- Parameters:
request
- The request object containing the details to sendhandler
- 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.
-
-