Package com.oracle.bmc.capacitymanagement

Class CapacityManagementClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

com.oracle.bmc.capacitymanagement.CapacityManagementClient

All Implemented Interfaces:

CapacityManagement, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20231107")
public class CapacityManagementClient
extends BaseSyncClient
implements CapacityManagement

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CapacityManagementClient.Builder	Builder class for this client.

Field Summary

Fields

Modifier and Type	Field	Description
String	clientCommonLibraryVersion	Compatible SDK version, provided by the codegen.
Optional<String>	minimumClientCommonLibraryVersionFromClient	Minimum compatible SDK version, maybe provided by the codegen.
static Service	SERVICE	Service instance for CapacityManagement.

Constructor Summary

Constructors

Constructor	Description
CapacityManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)	Deprecated. Use the builder instead.
CapacityManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)	Deprecated. Use the builder instead.
CapacityManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)	Deprecated. Use the builder instead.
CapacityManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)	Deprecated. Use the builder instead.
CapacityManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)	Deprecated. Use the builder instead.
CapacityManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)	Deprecated. Use the builder instead.
CapacityManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)	Deprecated. Use the builder instead.
CapacityManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)	Deprecated. Use the builder instead.

Method Summary

Modifier and Type	Method	Description
static CapacityManagementClient.Builder	builder()	Create a builder for this client.
void	close()
CreateOccAvailabilityCatalogResponse	createOccAvailabilityCatalog(CreateOccAvailabilityCatalogRequest request)	Create availability catalog
CreateOccCapacityRequestResponse	createOccCapacityRequest(CreateOccCapacityRequestRequest request)	Create Capacity Request.
CreateOccCustomerResponse	createOccCustomer(CreateOccCustomerRequest request)	Create customer.
CreateOccCustomerGroupResponse	createOccCustomerGroup(CreateOccCustomerGroupRequest request)	Create customer group.
DeleteOccAvailabilityCatalogResponse	deleteOccAvailabilityCatalog(DeleteOccAvailabilityCatalogRequest request)	Deletes the availability catalog resource.
DeleteOccCapacityRequestResponse	deleteOccCapacityRequest(DeleteOccCapacityRequestRequest request)	Deletes the capacity request resource.
DeleteOccCustomerResponse	deleteOccCustomer(DeleteOccCustomerRequest request)	Deletes the customer resource.
DeleteOccCustomerGroupResponse	deleteOccCustomerGroup(DeleteOccCustomerGroupRequest request)	Deletes the customer group resource.
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
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.
ListInternalNamespaceOccOverviewsResponse	listInternalNamespaceOccOverviews(ListInternalNamespaceOccOverviewsRequest request)	Lists an overview of all resources in that namespace in a given time interval.
ListInternalOccHandoverResourceBlockDetailsResponse	listInternalOccHandoverResourceBlockDetails(ListInternalOccHandoverResourceBlockDetailsRequest request)	List details about a given occHandoverResourceBlock.
ListInternalOccHandoverResourceBlocksResponse	listInternalOccHandoverResourceBlocks(ListInternalOccHandoverResourceBlocksRequest request)	List Occ Handover Resource blocks.
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.
ListOccHandoverResourceBlockDetailsResponse	listOccHandoverResourceBlockDetails(ListOccHandoverResourceBlockDetailsRequest request)	List details about a given occHandoverResourceBlock.
ListOccHandoverResourceBlocksResponse	listOccHandoverResourceBlocks(ListOccHandoverResourceBlocksRequest request)	List Occ Handover Resource blocks.
ListOccOverviewsResponse	listOccOverviews(ListOccOverviewsRequest request)	Lists an overview of all resources in that namespace in a given time interval.
PatchInternalOccCapacityRequestResponse	patchInternalOccCapacityRequest(PatchInternalOccCapacityRequestRequest request)	Updates the OccCapacityRequest by evaluating a sequence of instructions.
PatchOccCapacityRequestResponse	patchOccCapacityRequest(PatchOccCapacityRequestRequest request)	Updates the OccCapacityRequest by evaluating a sequence of instructions.
void	populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)	Populate the parameters in the endpoint with its corresponding value and update the base endpoint.
PublishOccAvailabilityCatalogResponse	publishOccAvailabilityCatalog(PublishOccAvailabilityCatalogRequest request)	Publishes the version of availability catalog specified by the operator.
void	refreshClient()	Rebuild the backing HttpClient.
void	setEndpoint(String endpoint)
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’).
void	updateBaseEndpoint(String endpoint)	This method should be used for parameterized endpoint templates only.
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.
UpdateOccCustomerResponse	updateOccCustomer(UpdateOccCustomerRequest request)	The request to update the customer.
UpdateOccCustomerGroupResponse	updateOccCustomerGroup(UpdateOccCustomerGroupRequest request)	The request to update the customer group.
void	useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)	This method should be used to enable or disable the use of realm-specific endpoint template.

Methods inherited from class com.oracle.bmc.http.internal.BaseSyncClient

clientCall

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.AutoCloseable

close

Methods inherited from interface com.oracle.bmc.capacitymanagement.CapacityManagement

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Field Detail

SERVICE

public static final Service SERVICE

Service instance for CapacityManagement.

clientCommonLibraryVersion

public final String clientCommonLibraryVersion

Compatible SDK version, provided by the codegen.

minimumClientCommonLibraryVersionFromClient

public final Optional<String> minimumClientCommonLibraryVersionFromClient

Minimum compatible SDK version, maybe provided by the codegen.

Constructor Detail

CapacityManagementClient

@Deprecated
public CapacityManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see CapacityManagementClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

CapacityManagementClient

@Deprecated
public CapacityManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                ClientConfiguration configuration)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see CapacityManagementClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

CapacityManagementClient

@Deprecated
public CapacityManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                ClientConfiguration configuration,
                                ClientConfigurator clientConfigurator)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see CapacityManagementClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

CapacityManagementClient

@Deprecated
public CapacityManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                ClientConfiguration configuration,
                                ClientConfigurator clientConfigurator,
                                RequestSignerFactory defaultRequestSignerFactory)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see CapacityManagementClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

CapacityManagementClient

@Deprecated
public CapacityManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                ClientConfiguration configuration,
                                ClientConfigurator clientConfigurator,
                                RequestSignerFactory defaultRequestSignerFactory,
                                List<ClientConfigurator> additionalClientConfigurators)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see CapacityManagementClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

CapacityManagementClient

@Deprecated
public CapacityManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                ClientConfiguration configuration,
                                ClientConfigurator clientConfigurator,
                                RequestSignerFactory defaultRequestSignerFactory,
                                List<ClientConfigurator> additionalClientConfigurators,
                                String endpoint)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see CapacityManagementClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

CapacityManagementClient

@Deprecated
public CapacityManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                ClientConfiguration configuration,
                                ClientConfigurator clientConfigurator,
                                RequestSignerFactory defaultRequestSignerFactory,
                                Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                                List<ClientConfigurator> additionalClientConfigurators,
                                String endpoint)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see CapacityManagementClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

signingStrategyRequestSignerFactories - ClientBuilderBase.signingStrategyRequestSignerFactories

CapacityManagementClient

@Deprecated
public CapacityManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                ClientConfiguration configuration,
                                ClientConfigurator clientConfigurator,
                                RequestSignerFactory defaultRequestSignerFactory,
                                Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                                List<ClientConfigurator> additionalClientConfigurators,
                                String endpoint,
                                ExecutorService executorService)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see CapacityManagementClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

signingStrategyRequestSignerFactories - ClientBuilderBase.signingStrategyRequestSignerFactories

executorService - CapacityManagementClient.Builder.executorService

Method Detail

builder

public static CapacityManagementClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: CapacityManagement

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.

Specified by:

setRegion in interface CapacityManagement

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: CapacityManagement

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.

Specified by:

setRegion in interface CapacityManagement

Parameters:

regionId - The public region ID.

createOccAvailabilityCatalog

public CreateOccAvailabilityCatalogResponse createOccAvailabilityCatalog(CreateOccAvailabilityCatalogRequest request)

Description copied from interface: CapacityManagement

Create availability catalog

Specified by:

createOccAvailabilityCatalog in interface CapacityManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createOccCapacityRequest

public CreateOccCapacityRequestResponse createOccCapacityRequest(CreateOccCapacityRequestRequest request)

Description copied from interface: CapacityManagement

Create Capacity Request.

Specified by:

createOccCapacityRequest in interface CapacityManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createOccCustomer

public CreateOccCustomerResponse createOccCustomer(CreateOccCustomerRequest request)

Description copied from interface: CapacityManagement

Create customer.

Specified by:

createOccCustomer in interface CapacityManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createOccCustomerGroup

public CreateOccCustomerGroupResponse createOccCustomerGroup(CreateOccCustomerGroupRequest request)

Description copied from interface: CapacityManagement

Create customer group.

Specified by:

createOccCustomerGroup in interface CapacityManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteOccAvailabilityCatalog

public DeleteOccAvailabilityCatalogResponse deleteOccAvailabilityCatalog(DeleteOccAvailabilityCatalogRequest request)

Description copied from interface: CapacityManagement

Deletes the availability catalog resource.

Specified by:

deleteOccAvailabilityCatalog in interface CapacityManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteOccCapacityRequest

public DeleteOccCapacityRequestResponse deleteOccCapacityRequest(DeleteOccCapacityRequestRequest request)

Description copied from interface: CapacityManagement

Deletes the capacity request resource.

Specified by:

deleteOccCapacityRequest in interface CapacityManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteOccCustomer

public DeleteOccCustomerResponse deleteOccCustomer(DeleteOccCustomerRequest request)

Description copied from interface: CapacityManagement

Deletes the customer resource.

Specified by:

deleteOccCustomer in interface CapacityManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteOccCustomerGroup

public DeleteOccCustomerGroupResponse deleteOccCustomerGroup(DeleteOccCustomerGroupRequest request)

Description copied from interface: CapacityManagement

Deletes the customer group resource.

Specified by:

deleteOccCustomerGroup in interface CapacityManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getOccAvailabilityCatalog

public GetOccAvailabilityCatalogResponse getOccAvailabilityCatalog(GetOccAvailabilityCatalogRequest request)

Description copied from interface: CapacityManagement

Get details about availability catalog.

Specified by:

getOccAvailabilityCatalog in interface CapacityManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getOccAvailabilityCatalogContent

public GetOccAvailabilityCatalogContentResponse getOccAvailabilityCatalogContent(GetOccAvailabilityCatalogContentRequest request)

Description copied from interface: CapacityManagement

Returns the binary contents of the availability catalog.

Can be saved as a csv file.

Specified by:

getOccAvailabilityCatalogContent in interface CapacityManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getOccCapacityRequest

public GetOccCapacityRequestResponse getOccCapacityRequest(GetOccCapacityRequestRequest request)

Description copied from interface: CapacityManagement

Get details about the capacity request.

Specified by:

getOccCapacityRequest in interface CapacityManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getOccCustomerGroup

public GetOccCustomerGroupResponse getOccCustomerGroup(GetOccCustomerGroupRequest request)

Description copied from interface: CapacityManagement

Gets information about the specified customer group.

Specified by:

getOccCustomerGroup in interface CapacityManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listInternalNamespaceOccOverviews

public ListInternalNamespaceOccOverviewsResponse listInternalNamespaceOccOverviews(ListInternalNamespaceOccOverviewsRequest request)

Description copied from interface: CapacityManagement

Lists an overview of all resources in that namespace in a given time interval.

Specified by:

listInternalNamespaceOccOverviews in interface CapacityManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listInternalOccHandoverResourceBlockDetails

public ListInternalOccHandoverResourceBlockDetailsResponse listInternalOccHandoverResourceBlockDetails(ListInternalOccHandoverResourceBlockDetailsRequest request)

Description copied from interface: CapacityManagement

List details about a given occHandoverResourceBlock.

Specified by:

listInternalOccHandoverResourceBlockDetails in interface CapacityManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listInternalOccHandoverResourceBlocks

public ListInternalOccHandoverResourceBlocksResponse listInternalOccHandoverResourceBlocks(ListInternalOccHandoverResourceBlocksRequest request)

Description copied from interface: CapacityManagement

List Occ Handover Resource blocks.

Specified by:

listInternalOccHandoverResourceBlocks in interface CapacityManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listOccAvailabilities

public ListOccAvailabilitiesResponse listOccAvailabilities(ListOccAvailabilitiesRequest request)

Description copied from interface: CapacityManagement

Lists availabilities for a particular availability catalog.

Specified by:

listOccAvailabilities in interface CapacityManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listOccAvailabilityCatalogs

public ListOccAvailabilityCatalogsResponse listOccAvailabilityCatalogs(ListOccAvailabilityCatalogsRequest request)

Description copied from interface: CapacityManagement

Lists all availability catalogs.

Specified by:

listOccAvailabilityCatalogs in interface CapacityManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listOccAvailabilityCatalogsInternal

public ListOccAvailabilityCatalogsInternalResponse listOccAvailabilityCatalogsInternal(ListOccAvailabilityCatalogsInternalRequest request)

Description copied from interface: CapacityManagement

An internal api to list availability catalogs.

Specified by:

listOccAvailabilityCatalogsInternal in interface CapacityManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listOccCapacityRequests

public ListOccCapacityRequestsResponse listOccCapacityRequests(ListOccCapacityRequestsRequest request)

Description copied from interface: CapacityManagement

Lists all capacity requests.

Specified by:

listOccCapacityRequests in interface CapacityManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listOccCapacityRequestsInternal

public ListOccCapacityRequestsInternalResponse listOccCapacityRequestsInternal(ListOccCapacityRequestsInternalRequest request)

Description copied from interface: CapacityManagement

An internal api to list all capacity requests.

Specified by:

listOccCapacityRequestsInternal in interface CapacityManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listOccCustomerGroups

public ListOccCustomerGroupsResponse listOccCustomerGroups(ListOccCustomerGroupsRequest request)

Description copied from interface: CapacityManagement

Lists all the customer groups.

Specified by:

listOccCustomerGroups in interface CapacityManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listOccHandoverResourceBlockDetails

public ListOccHandoverResourceBlockDetailsResponse listOccHandoverResourceBlockDetails(ListOccHandoverResourceBlockDetailsRequest request)

Description copied from interface: CapacityManagement

List details about a given occHandoverResourceBlock.

Specified by:

listOccHandoverResourceBlockDetails in interface CapacityManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listOccHandoverResourceBlocks

public ListOccHandoverResourceBlocksResponse listOccHandoverResourceBlocks(ListOccHandoverResourceBlocksRequest request)

Description copied from interface: CapacityManagement

List Occ Handover Resource blocks.

Specified by:

listOccHandoverResourceBlocks in interface CapacityManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listOccOverviews

public ListOccOverviewsResponse listOccOverviews(ListOccOverviewsRequest request)

Description copied from interface: CapacityManagement

Lists an overview of all resources in that namespace in a given time interval.

Specified by:

listOccOverviews in interface CapacityManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

patchInternalOccCapacityRequest

public PatchInternalOccCapacityRequestResponse patchInternalOccCapacityRequest(PatchInternalOccCapacityRequestRequest request)

Description copied from interface: CapacityManagement

Updates the OccCapacityRequest by evaluating a sequence of instructions.

Specified by:

patchInternalOccCapacityRequest in interface CapacityManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

patchOccCapacityRequest

public PatchOccCapacityRequestResponse patchOccCapacityRequest(PatchOccCapacityRequestRequest request)

Description copied from interface: CapacityManagement

Updates the OccCapacityRequest by evaluating a sequence of instructions.

Specified by:

patchOccCapacityRequest in interface CapacityManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

publishOccAvailabilityCatalog

public PublishOccAvailabilityCatalogResponse publishOccAvailabilityCatalog(PublishOccAvailabilityCatalogRequest request)

Description copied from interface: CapacityManagement

Publishes the version of availability catalog specified by the operator.

This makes that catalog version visible to customers.

Specified by:

publishOccAvailabilityCatalog in interface CapacityManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateInternalOccCapacityRequest

public UpdateInternalOccCapacityRequestResponse updateInternalOccCapacityRequest(UpdateInternalOccCapacityRequestRequest request)

Description copied from interface: CapacityManagement

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.

Specified by:

updateInternalOccCapacityRequest in interface CapacityManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateOccAvailabilityCatalog

public UpdateOccAvailabilityCatalogResponse updateOccAvailabilityCatalog(UpdateOccAvailabilityCatalogRequest request)

Description copied from interface: CapacityManagement

The request to update the availability catalog.

Currently only freeform tags can be updated via this api.

Specified by:

updateOccAvailabilityCatalog in interface CapacityManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateOccCapacityRequest

public UpdateOccCapacityRequestResponse updateOccCapacityRequest(UpdateOccCapacityRequestRequest request)

Description copied from interface: CapacityManagement

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.

Specified by:

updateOccCapacityRequest in interface CapacityManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateOccCustomer

public UpdateOccCustomerResponse updateOccCustomer(UpdateOccCustomerRequest request)

Description copied from interface: CapacityManagement

The request to update the customer.

Specified by:

updateOccCustomer in interface CapacityManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateOccCustomerGroup

public UpdateOccCustomerGroupResponse updateOccCustomerGroup(UpdateOccCustomerGroupRequest request)

Description copied from interface: CapacityManagement

The request to update the customer group.

Specified by:

updateOccCustomerGroup in interface CapacityManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWaiters

public CapacityManagementWaiters getWaiters()

Description copied from interface: CapacityManagement

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

Specified by:

getWaiters in interface CapacityManagement

Returns:

The service waiters.

getPaginators

public CapacityManagementPaginators getPaginators()

Description copied from interface: CapacityManagement

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.

Specified by:

getPaginators in interface CapacityManagement

Returns:

The service paginators.

getDefaultConfigurator

protected ClientConfigurator getDefaultConfigurator()

useRealmSpecificEndpointTemplate

public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)

This method should be used to enable or disable the use of realm-specific endpoint template.

The default value is null. To enable the use of endpoint template defined for the realm in use, set the flag to true To disable the use of endpoint template defined for the realm in use, set the flag to false

Parameters:

useOfRealmSpecificEndpointTemplateEnabled - This flag can be set to true or false to enable or disable the use of realm-specific endpoint template respectively

populateServiceParametersInEndpoint

public final void populateServiceParametersInEndpoint(String endpoint,
                                                      Map<String,Object> requiredParametersMap)

Populate the parameters in the endpoint with its corresponding value and update the base endpoint.

The value will be populated iff the parameter in endpoint is a required request path parameter or a required request query parameter. If not, the parameter in the endpoint will be ignored and left blank.

Parameters:

endpoint - The endpoint template in use

requiredParametersMap - Map of parameter name as key and value set in request path or query parameter as value

updateBaseEndpoint

public final void updateBaseEndpoint(String endpoint)

This method should be used for parameterized endpoint templates only.

This does not include {region} and {secondLevelDomain} parameters.

Parameters:

endpoint - The updated endpoint to use

setEndpoint

public final void setEndpoint(String endpoint)

getEndpoint

public final String getEndpoint()

refreshClient

public final void refreshClient()

Rebuild the backing HttpClient.

This will call ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.

close

public final void close()

Specified by:

close in interface AutoCloseable

getClientCommonLibraryVersion

public String getClientCommonLibraryVersion()

getMinimumClientCommonLibraryVersionFromClient

public Optional<String> getMinimumClientCommonLibraryVersionFromClient()