com.oracle.bmc.capacitymanagement

Interface CapacityManagement

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

CapacityManagementClient

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

A description of the OciControlCenterCp API This service client uses CircuitBreakerUtils.DEFAULT_CIRCUIT_BREAKER for all the operations by default if no circuit breaker configuration is defined by the user.

Method Summary

Modifier and Type	Method and Description
CreateOccAvailabilityCatalogResponse	createOccAvailabilityCatalog(CreateOccAvailabilityCatalogRequest request) Create availability catalog
CreateOccCapacityRequestResponse	createOccCapacityRequest(CreateOccCapacityRequestRequest request) Create Capacity Request.
DeleteOccAvailabilityCatalogResponse	deleteOccAvailabilityCatalog(DeleteOccAvailabilityCatalogRequest request) Deletes the availability catalog resource.
DeleteOccCapacityRequestResponse	deleteOccCapacityRequest(DeleteOccCapacityRequestRequest request) Deletes the capacity request resource.
String	getEndpoint() Gets the set endpoint for REST call (ex, https://www.example.com)
GetOccAvailabilityCatalogResponse	getOccAvailabilityCatalog(GetOccAvailabilityCatalogRequest request) Get details about availability catalog.
GetOccAvailabilityCatalogContentResponse	getOccAvailabilityCatalogContent(GetOccAvailabilityCatalogContentRequest request) Returns the binary contents of the availability catalog.
GetOccCapacityRequestResponse	getOccCapacityRequest(GetOccCapacityRequestRequest request) Get details about the capacity request.
GetOccCustomerGroupResponse	getOccCustomerGroup(GetOccCustomerGroupRequest request) Gets information about the specified customer group.
CapacityManagementPaginators	getPaginators() Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
CapacityManagementWaiters	getWaiters() Gets the pre-configured waiters available for resources for this service.
ListOccAvailabilitiesResponse	listOccAvailabilities(ListOccAvailabilitiesRequest request) Lists availabilities for a particular availability catalog.
ListOccAvailabilityCatalogsResponse	listOccAvailabilityCatalogs(ListOccAvailabilityCatalogsRequest request) Lists all availability catalogs.
ListOccAvailabilityCatalogsInternalResponse	listOccAvailabilityCatalogsInternal(ListOccAvailabilityCatalogsInternalRequest request) An internal api to list availability catalogs.
ListOccCapacityRequestsResponse	listOccCapacityRequests(ListOccCapacityRequestsRequest request) Lists all capacity requests.
ListOccCapacityRequestsInternalResponse	listOccCapacityRequestsInternal(ListOccCapacityRequestsInternalRequest request) An internal api to list all capacity requests.
ListOccCustomerGroupsResponse	listOccCustomerGroups(ListOccCustomerGroupsRequest request) Lists all the customer groups.
PatchOccCapacityRequestResponse	patchOccCapacityRequest(PatchOccCapacityRequestRequest request) Updates the OccCapacityRequest by evaluating a sequence of instructions.
PublishOccAvailabilityCatalogResponse	publishOccAvailabilityCatalog(PublishOccAvailabilityCatalogRequest request) Publishes the version of availability catalog specified by the operator.
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’).
UpdateInternalOccCapacityRequestResponse	updateInternalOccCapacityRequest(UpdateInternalOccCapacityRequestRequest request) The internal api to update the capacity request.
UpdateOccAvailabilityCatalogResponse	updateOccAvailabilityCatalog(UpdateOccAvailabilityCatalogRequest request) The request to update the availability catalog.
UpdateOccCapacityRequestResponse	updateOccCapacityRequest(UpdateOccCapacityRequestRequest request) The request to update the capacity request.
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 service.

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

createOccAvailabilityCatalog

CreateOccAvailabilityCatalogResponse createOccAvailabilityCatalog(CreateOccAvailabilityCatalogRequest request)

Create availability catalog

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use CreateOccAvailabilityCatalog API.

createOccCapacityRequest

CreateOccCapacityRequestResponse createOccCapacityRequest(CreateOccCapacityRequestRequest request)

Create Capacity Request.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use CreateOccCapacityRequest API.

deleteOccAvailabilityCatalog

DeleteOccAvailabilityCatalogResponse deleteOccAvailabilityCatalog(DeleteOccAvailabilityCatalogRequest request)

Deletes the availability catalog resource.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use DeleteOccAvailabilityCatalog API.

deleteOccCapacityRequest

DeleteOccCapacityRequestResponse deleteOccCapacityRequest(DeleteOccCapacityRequestRequest request)

Deletes the capacity request resource.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use DeleteOccCapacityRequest API.

getOccAvailabilityCatalog

GetOccAvailabilityCatalogResponse getOccAvailabilityCatalog(GetOccAvailabilityCatalogRequest request)

Get details about availability catalog.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use GetOccAvailabilityCatalog API.

getOccAvailabilityCatalogContent

GetOccAvailabilityCatalogContentResponse getOccAvailabilityCatalogContent(GetOccAvailabilityCatalogContentRequest request)

Returns the binary contents of the availability catalog. Can be saved as a csv file.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use GetOccAvailabilityCatalogContent API.

getOccCapacityRequest

GetOccCapacityRequestResponse getOccCapacityRequest(GetOccCapacityRequestRequest request)

Get details about the capacity request.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use GetOccCapacityRequest API.

getOccCustomerGroup

GetOccCustomerGroupResponse getOccCustomerGroup(GetOccCustomerGroupRequest request)

Gets information about the specified customer group.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use GetOccCustomerGroup API.

listOccAvailabilities

ListOccAvailabilitiesResponse listOccAvailabilities(ListOccAvailabilitiesRequest request)

Lists availabilities for a particular availability catalog.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use ListOccAvailabilities API.

listOccAvailabilityCatalogs

ListOccAvailabilityCatalogsResponse listOccAvailabilityCatalogs(ListOccAvailabilityCatalogsRequest request)

Lists all availability catalogs.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use ListOccAvailabilityCatalogs API.

listOccAvailabilityCatalogsInternal

ListOccAvailabilityCatalogsInternalResponse listOccAvailabilityCatalogsInternal(ListOccAvailabilityCatalogsInternalRequest request)

An internal api to list availability catalogs.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use ListOccAvailabilityCatalogsInternal API.

listOccCapacityRequests

ListOccCapacityRequestsResponse listOccCapacityRequests(ListOccCapacityRequestsRequest request)

Lists all capacity requests.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use ListOccCapacityRequests API.

listOccCapacityRequestsInternal

ListOccCapacityRequestsInternalResponse listOccCapacityRequestsInternal(ListOccCapacityRequestsInternalRequest request)

An internal api to list all capacity requests.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use ListOccCapacityRequestsInternal API.

listOccCustomerGroups

ListOccCustomerGroupsResponse listOccCustomerGroups(ListOccCustomerGroupsRequest request)

Lists all the customer groups.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use ListOccCustomerGroups API.

patchOccCapacityRequest

PatchOccCapacityRequestResponse patchOccCapacityRequest(PatchOccCapacityRequestRequest request)

Updates the OccCapacityRequest by evaluating a sequence of instructions.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use PatchOccCapacityRequest API.

publishOccAvailabilityCatalog

PublishOccAvailabilityCatalogResponse publishOccAvailabilityCatalog(PublishOccAvailabilityCatalogRequest request)

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 send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use PublishOccAvailabilityCatalog API.

updateInternalOccCapacityRequest

UpdateInternalOccCapacityRequestResponse updateInternalOccCapacityRequest(UpdateInternalOccCapacityRequestRequest request)

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 send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use UpdateInternalOccCapacityRequest API.

updateOccAvailabilityCatalog

UpdateOccAvailabilityCatalogResponse updateOccAvailabilityCatalog(UpdateOccAvailabilityCatalogRequest request)

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 send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use UpdateOccAvailabilityCatalog API.

updateOccCapacityRequest

UpdateOccCapacityRequestResponse updateOccCapacityRequest(UpdateOccCapacityRequestRequest request)

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 send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use UpdateOccCapacityRequest API.

getWaiters

CapacityManagementWaiters getWaiters()

Gets the pre-configured waiters available for resources for this service.

Returns:

The service waiters.

getPaginators

CapacityManagementPaginators getPaginators()

Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data. These paginators provide an Iterable interface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.

Returns:

The service paginators.