com.oracle.bmc.capacitymanagement.CapacityManagementAsync Maven / Gradle / Ivy
/**
* Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved.
* This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
*/
package com.oracle.bmc.capacitymanagement;
import com.oracle.bmc.capacitymanagement.requests.*;
import com.oracle.bmc.capacitymanagement.responses.*;
/**
* 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](https://docs.cloud.oracle.com/iaas/Content/control-center/home.htm).
*/
@jakarta.annotation.Generated(value = "OracleSDKGenerator", comments = "API Version: 20231107")
public interface CapacityManagementAsync extends AutoCloseable {
/** Rebuilds the client from scratch. Useful to refresh certificates. */
void refreshClient();
/**
* Sets the endpoint to call (ex, https://www.example.com).
*
* @param endpoint The endpoint of the serice.
*/
void setEndpoint(String endpoint);
/** Gets the set endpoint for REST call (ex, https://www.example.com) */
String getEndpoint();
/**
* Sets the region to call (ex, Region.US_PHOENIX_1).
*
* Note, this will call {@link #setEndpoint(String) setEndpoint} after resolving the
* endpoint. If the service is not available in this region, however, an
* IllegalArgumentException will be raised.
*
* @param region The region of the service.
*/
void setRegion(com.oracle.bmc.Region region);
/**
* 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 {@link
* #setRegion(Region) setRegion}.
*
*
If no known Region could be determined, it will create an endpoint based on the default
* endpoint format ({@link com.oracle.bmc.Region#formatDefaultRegionEndpoint(Service, String)}
* and then call {@link #setEndpoint(String) setEndpoint}.
*
* @param regionId The public region ID.
*/
void setRegion(String regionId);
/**
* 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"
*
* @param realmSpecificEndpointTemplateEnabled flag to enable the use of realm specific endpoint
* template
*/
void useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled);
/**
* Create availability catalog
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return 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.
*/
java.util.concurrent.Future createOccAvailabilityCatalog(
CreateOccAvailabilityCatalogRequest request,
com.oracle.bmc.responses.AsyncHandler<
CreateOccAvailabilityCatalogRequest,
CreateOccAvailabilityCatalogResponse>
handler);
/**
* Create Capacity Request.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return 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.
*/
java.util.concurrent.Future createOccCapacityRequest(
CreateOccCapacityRequestRequest request,
com.oracle.bmc.responses.AsyncHandler<
CreateOccCapacityRequestRequest, CreateOccCapacityRequestResponse>
handler);
/**
* Create customer.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return 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.
*/
java.util.concurrent.Future createOccCustomer(
CreateOccCustomerRequest request,
com.oracle.bmc.responses.AsyncHandler<
CreateOccCustomerRequest, CreateOccCustomerResponse>
handler);
/**
* Create customer group.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return 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.
*/
java.util.concurrent.Future createOccCustomerGroup(
CreateOccCustomerGroupRequest request,
com.oracle.bmc.responses.AsyncHandler<
CreateOccCustomerGroupRequest, CreateOccCustomerGroupResponse>
handler);
/**
* Deletes the availability catalog resource.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return 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.
*/
java.util.concurrent.Future deleteOccAvailabilityCatalog(
DeleteOccAvailabilityCatalogRequest request,
com.oracle.bmc.responses.AsyncHandler<
DeleteOccAvailabilityCatalogRequest,
DeleteOccAvailabilityCatalogResponse>
handler);
/**
* Deletes the capacity request resource.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return 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.
*/
java.util.concurrent.Future deleteOccCapacityRequest(
DeleteOccCapacityRequestRequest request,
com.oracle.bmc.responses.AsyncHandler<
DeleteOccCapacityRequestRequest, DeleteOccCapacityRequestResponse>
handler);
/**
* Deletes the customer resource.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return 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.
*/
java.util.concurrent.Future deleteOccCustomer(
DeleteOccCustomerRequest request,
com.oracle.bmc.responses.AsyncHandler<
DeleteOccCustomerRequest, DeleteOccCustomerResponse>
handler);
/**
* Deletes the customer group resource.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return 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.
*/
java.util.concurrent.Future deleteOccCustomerGroup(
DeleteOccCustomerGroupRequest request,
com.oracle.bmc.responses.AsyncHandler<
DeleteOccCustomerGroupRequest, DeleteOccCustomerGroupResponse>
handler);
/**
* Get details about availability catalog.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return 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.
*/
java.util.concurrent.Future getOccAvailabilityCatalog(
GetOccAvailabilityCatalogRequest request,
com.oracle.bmc.responses.AsyncHandler<
GetOccAvailabilityCatalogRequest, GetOccAvailabilityCatalogResponse>
handler);
/**
* Returns the binary contents of the availability catalog. Can be saved as a csv file.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return 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.
*/
java.util.concurrent.Future
getOccAvailabilityCatalogContent(
GetOccAvailabilityCatalogContentRequest request,
com.oracle.bmc.responses.AsyncHandler<
GetOccAvailabilityCatalogContentRequest,
GetOccAvailabilityCatalogContentResponse>
handler);
/**
* Get details about the capacity request.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return 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.
*/
java.util.concurrent.Future getOccCapacityRequest(
GetOccCapacityRequestRequest request,
com.oracle.bmc.responses.AsyncHandler<
GetOccCapacityRequestRequest, GetOccCapacityRequestResponse>
handler);
/**
* Gets information about the specified customer group.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return 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.
*/
java.util.concurrent.Future getOccCustomerGroup(
GetOccCustomerGroupRequest request,
com.oracle.bmc.responses.AsyncHandler<
GetOccCustomerGroupRequest, GetOccCustomerGroupResponse>
handler);
/**
* Lists an overview of all resources in that namespace in a given time interval.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return 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.
*/
java.util.concurrent.Future
listInternalNamespaceOccOverviews(
ListInternalNamespaceOccOverviewsRequest request,
com.oracle.bmc.responses.AsyncHandler<
ListInternalNamespaceOccOverviewsRequest,
ListInternalNamespaceOccOverviewsResponse>
handler);
/**
* List details about a given occHandoverResourceBlock.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return 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.
*/
java.util.concurrent.Future
listInternalOccHandoverResourceBlockDetails(
ListInternalOccHandoverResourceBlockDetailsRequest request,
com.oracle.bmc.responses.AsyncHandler<
ListInternalOccHandoverResourceBlockDetailsRequest,
ListInternalOccHandoverResourceBlockDetailsResponse>
handler);
/**
* List Occ Handover Resource blocks.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return 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.
*/
java.util.concurrent.Future
listInternalOccHandoverResourceBlocks(
ListInternalOccHandoverResourceBlocksRequest request,
com.oracle.bmc.responses.AsyncHandler<
ListInternalOccHandoverResourceBlocksRequest,
ListInternalOccHandoverResourceBlocksResponse>
handler);
/**
* Lists availabilities for a particular availability catalog.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return 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.
*/
java.util.concurrent.Future listOccAvailabilities(
ListOccAvailabilitiesRequest request,
com.oracle.bmc.responses.AsyncHandler<
ListOccAvailabilitiesRequest, ListOccAvailabilitiesResponse>
handler);
/**
* Lists all availability catalogs.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return 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.
*/
java.util.concurrent.Future listOccAvailabilityCatalogs(
ListOccAvailabilityCatalogsRequest request,
com.oracle.bmc.responses.AsyncHandler<
ListOccAvailabilityCatalogsRequest, ListOccAvailabilityCatalogsResponse>
handler);
/**
* An internal api to list availability catalogs.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return 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.
*/
java.util.concurrent.Future
listOccAvailabilityCatalogsInternal(
ListOccAvailabilityCatalogsInternalRequest request,
com.oracle.bmc.responses.AsyncHandler<
ListOccAvailabilityCatalogsInternalRequest,
ListOccAvailabilityCatalogsInternalResponse>
handler);
/**
* Lists all capacity requests.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return 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.
*/
java.util.concurrent.Future listOccCapacityRequests(
ListOccCapacityRequestsRequest request,
com.oracle.bmc.responses.AsyncHandler<
ListOccCapacityRequestsRequest, ListOccCapacityRequestsResponse>
handler);
/**
* An internal api to list all capacity requests.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return 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.
*/
java.util.concurrent.Future
listOccCapacityRequestsInternal(
ListOccCapacityRequestsInternalRequest request,
com.oracle.bmc.responses.AsyncHandler<
ListOccCapacityRequestsInternalRequest,
ListOccCapacityRequestsInternalResponse>
handler);
/**
* Lists all the customer groups.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return 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.
*/
java.util.concurrent.Future listOccCustomerGroups(
ListOccCustomerGroupsRequest request,
com.oracle.bmc.responses.AsyncHandler<
ListOccCustomerGroupsRequest, ListOccCustomerGroupsResponse>
handler);
/**
* List details about a given occHandoverResourceBlock.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return 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.
*/
java.util.concurrent.Future
listOccHandoverResourceBlockDetails(
ListOccHandoverResourceBlockDetailsRequest request,
com.oracle.bmc.responses.AsyncHandler<
ListOccHandoverResourceBlockDetailsRequest,
ListOccHandoverResourceBlockDetailsResponse>
handler);
/**
* List Occ Handover Resource blocks.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return 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.
*/
java.util.concurrent.Future
listOccHandoverResourceBlocks(
ListOccHandoverResourceBlocksRequest request,
com.oracle.bmc.responses.AsyncHandler<
ListOccHandoverResourceBlocksRequest,
ListOccHandoverResourceBlocksResponse>
handler);
/**
* Lists an overview of all resources in that namespace in a given time interval.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return 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.
*/
java.util.concurrent.Future listOccOverviews(
ListOccOverviewsRequest request,
com.oracle.bmc.responses.AsyncHandler
handler);
/**
* Updates the OccCapacityRequest by evaluating a sequence of instructions.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return 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.
*/
java.util.concurrent.Future
patchInternalOccCapacityRequest(
PatchInternalOccCapacityRequestRequest request,
com.oracle.bmc.responses.AsyncHandler<
PatchInternalOccCapacityRequestRequest,
PatchInternalOccCapacityRequestResponse>
handler);
/**
* Updates the OccCapacityRequest by evaluating a sequence of instructions.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return 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.
*/
java.util.concurrent.Future patchOccCapacityRequest(
PatchOccCapacityRequestRequest request,
com.oracle.bmc.responses.AsyncHandler<
PatchOccCapacityRequestRequest, PatchOccCapacityRequestResponse>
handler);
/**
* Publishes the version of availability catalog specified by the operator. This makes that
* catalog version visible to customers.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return 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.
*/
java.util.concurrent.Future
publishOccAvailabilityCatalog(
PublishOccAvailabilityCatalogRequest request,
com.oracle.bmc.responses.AsyncHandler<
PublishOccAvailabilityCatalogRequest,
PublishOccAvailabilityCatalogResponse>
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.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return 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.
*/
java.util.concurrent.Future
updateInternalOccCapacityRequest(
UpdateInternalOccCapacityRequestRequest request,
com.oracle.bmc.responses.AsyncHandler<
UpdateInternalOccCapacityRequestRequest,
UpdateInternalOccCapacityRequestResponse>
handler);
/**
* The request to update the availability catalog. Currently only freeform tags can be updated
* via this api.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return 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.
*/
java.util.concurrent.Future updateOccAvailabilityCatalog(
UpdateOccAvailabilityCatalogRequest request,
com.oracle.bmc.responses.AsyncHandler<
UpdateOccAvailabilityCatalogRequest,
UpdateOccAvailabilityCatalogResponse>
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.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return 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.
*/
java.util.concurrent.Future updateOccCapacityRequest(
UpdateOccCapacityRequestRequest request,
com.oracle.bmc.responses.AsyncHandler<
UpdateOccCapacityRequestRequest, UpdateOccCapacityRequestResponse>
handler);
/**
* The request to update the customer.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return 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.
*/
java.util.concurrent.Future updateOccCustomer(
UpdateOccCustomerRequest request,
com.oracle.bmc.responses.AsyncHandler<
UpdateOccCustomerRequest, UpdateOccCustomerResponse>
handler);
/**
* The request to update the customer group.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return 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.
*/
java.util.concurrent.Future updateOccCustomerGroup(
UpdateOccCustomerGroupRequest request,
com.oracle.bmc.responses.AsyncHandler<
UpdateOccCustomerGroupRequest, UpdateOccCustomerGroupResponse>
handler);
}