Class CapacityManagementAsyncClient
- java.lang.Object
-
- com.oracle.bmc.http.internal.BaseAsyncClient
-
- com.oracle.bmc.capacitymanagement.CapacityManagementAsyncClient
-
- All Implemented Interfaces:
CapacityManagementAsync,AutoCloseable
@Generated(value="OracleSDKGenerator", comments="API Version: 20231107") public class CapacityManagementAsyncClient extends BaseAsyncClient implements CapacityManagementAsyncAsync client implementation for CapacityManagement service.
There are two ways to use async client: 1. Use AsyncHandler: using AsyncHandler, if the response to the call is anInputStream, like getObject Api in object storage service, developers need to process the stream in AsyncHandler, and not anywhere else, because the stream will be closed right after the AsyncHandler is invoked.
2. Use Java Future: using Java Future, developers need to close the stream after they are done with the Java Future.
Accessing the result should be done in a mutually exclusive manner, either through the Future or the AsyncHandler, but not both. If the Future is used, the caller should pass in null as the AsyncHandler. If the AsyncHandler is used, it is still safe to use the Future to determine whether or not the request was completed via Future.isDone/isCancelled.
Please refer to https://github.com/oracle/oci-java-sdk/blob/master/bmc-examples/src/main/java/ResteasyClientWithObjectStorageExample.java
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classCapacityManagementAsyncClient.BuilderBuilder class for this client.
-
Field Summary
Fields Modifier and Type Field Description StringclientCommonLibraryVersionCompatible SDK version, provided by the codegen.Optional<String>minimumClientCommonLibraryVersionFromClientMinimum compatible SDK version, maybe provided by the codegen.static ServiceSERVICEService instance for CapacityManagement.
-
Constructor Summary
Constructors Constructor Description CapacityManagementAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)Deprecated.Use thebuilderinstead.CapacityManagementAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)Deprecated.Use thebuilderinstead.CapacityManagementAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.CapacityManagementAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.CapacityManagementAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)Deprecated.Use thebuilderinstead.CapacityManagementAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)Deprecated.Use thebuilderinstead.CapacityManagementAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)Deprecated.Use thebuilderinstead.
-
Method Summary
-
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.CapacityManagementAsync
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
-
-
-
-
Constructor Detail
-
CapacityManagementAsyncClient
@Deprecated public CapacityManagementAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeCapacityManagementAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
-
CapacityManagementAsyncClient
@Deprecated public CapacityManagementAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeCapacityManagementAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configuration
-
CapacityManagementAsyncClient
@Deprecated public CapacityManagementAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeCapacityManagementAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
-
CapacityManagementAsyncClient
@Deprecated public CapacityManagementAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeCapacityManagementAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactory
-
CapacityManagementAsyncClient
@Deprecated public CapacityManagementAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeCapacityManagementAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfigurators
-
CapacityManagementAsyncClient
@Deprecated public CapacityManagementAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeCapacityManagementAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfiguratorsendpoint-ClientBuilderBase.endpoint(java.lang.String)
-
CapacityManagementAsyncClient
@Deprecated public CapacityManagementAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeCapacityManagementAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfiguratorsendpoint-ClientBuilderBase.endpoint(java.lang.String)signingStrategyRequestSignerFactories-ClientBuilderBase.signingStrategyRequestSignerFactories
-
-
Method Detail
-
builder
public static CapacityManagementAsyncClient.Builder builder()
Create a builder for this client.- Returns:
- builder
-
setRegion
public void setRegion(Region region)
Description copied from interface:CapacityManagementAsyncSets the region to call (ex, Region.US_PHOENIX_1).Note, this will call
setEndpointafter resolving the endpoint. If the service is not available in this region, however, an IllegalArgumentException will be raised.- Specified by:
setRegionin interfaceCapacityManagementAsync- Parameters:
region- The region of the service.
-
setRegion
public void setRegion(String regionId)
Description copied from interface:CapacityManagementAsyncSets 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.- Specified by:
setRegionin interfaceCapacityManagementAsync- Parameters:
regionId- The public region ID.
-
createOccAvailabilityCatalog
public Future<CreateOccAvailabilityCatalogResponse> createOccAvailabilityCatalog(CreateOccAvailabilityCatalogRequest request, AsyncHandler<CreateOccAvailabilityCatalogRequest,CreateOccAvailabilityCatalogResponse> handler)
Description copied from interface:CapacityManagementAsyncCreate availability catalog- Specified by:
createOccAvailabilityCatalogin interfaceCapacityManagementAsync- 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
public Future<CreateOccCapacityRequestResponse> createOccCapacityRequest(CreateOccCapacityRequestRequest request, AsyncHandler<CreateOccCapacityRequestRequest,CreateOccCapacityRequestResponse> handler)
Description copied from interface:CapacityManagementAsyncCreate Capacity Request.- Specified by:
createOccCapacityRequestin interfaceCapacityManagementAsync- 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
public Future<CreateOccCustomerResponse> createOccCustomer(CreateOccCustomerRequest request, AsyncHandler<CreateOccCustomerRequest,CreateOccCustomerResponse> handler)
Description copied from interface:CapacityManagementAsyncCreate customer.- Specified by:
createOccCustomerin interfaceCapacityManagementAsync- 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
public Future<CreateOccCustomerGroupResponse> createOccCustomerGroup(CreateOccCustomerGroupRequest request, AsyncHandler<CreateOccCustomerGroupRequest,CreateOccCustomerGroupResponse> handler)
Description copied from interface:CapacityManagementAsyncCreate customer group.- Specified by:
createOccCustomerGroupin interfaceCapacityManagementAsync- 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
public Future<DeleteOccAvailabilityCatalogResponse> deleteOccAvailabilityCatalog(DeleteOccAvailabilityCatalogRequest request, AsyncHandler<DeleteOccAvailabilityCatalogRequest,DeleteOccAvailabilityCatalogResponse> handler)
Description copied from interface:CapacityManagementAsyncDeletes the availability catalog resource.- Specified by:
deleteOccAvailabilityCatalogin interfaceCapacityManagementAsync- 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
public Future<DeleteOccCapacityRequestResponse> deleteOccCapacityRequest(DeleteOccCapacityRequestRequest request, AsyncHandler<DeleteOccCapacityRequestRequest,DeleteOccCapacityRequestResponse> handler)
Description copied from interface:CapacityManagementAsyncDeletes the capacity request resource.- Specified by:
deleteOccCapacityRequestin interfaceCapacityManagementAsync- 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
public Future<DeleteOccCustomerResponse> deleteOccCustomer(DeleteOccCustomerRequest request, AsyncHandler<DeleteOccCustomerRequest,DeleteOccCustomerResponse> handler)
Description copied from interface:CapacityManagementAsyncDeletes the customer resource.- Specified by:
deleteOccCustomerin interfaceCapacityManagementAsync- 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
public Future<DeleteOccCustomerGroupResponse> deleteOccCustomerGroup(DeleteOccCustomerGroupRequest request, AsyncHandler<DeleteOccCustomerGroupRequest,DeleteOccCustomerGroupResponse> handler)
Description copied from interface:CapacityManagementAsyncDeletes the customer group resource.- Specified by:
deleteOccCustomerGroupin interfaceCapacityManagementAsync- 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
public Future<GetOccAvailabilityCatalogResponse> getOccAvailabilityCatalog(GetOccAvailabilityCatalogRequest request, AsyncHandler<GetOccAvailabilityCatalogRequest,GetOccAvailabilityCatalogResponse> handler)
Description copied from interface:CapacityManagementAsyncGet details about availability catalog.- Specified by:
getOccAvailabilityCatalogin interfaceCapacityManagementAsync- 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
public Future<GetOccAvailabilityCatalogContentResponse> getOccAvailabilityCatalogContent(GetOccAvailabilityCatalogContentRequest request, AsyncHandler<GetOccAvailabilityCatalogContentRequest,GetOccAvailabilityCatalogContentResponse> handler)
Description copied from interface:CapacityManagementAsyncReturns the binary contents of the availability catalog.Can be saved as a csv file.
- Specified by:
getOccAvailabilityCatalogContentin interfaceCapacityManagementAsync- 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
public Future<GetOccCapacityRequestResponse> getOccCapacityRequest(GetOccCapacityRequestRequest request, AsyncHandler<GetOccCapacityRequestRequest,GetOccCapacityRequestResponse> handler)
Description copied from interface:CapacityManagementAsyncGet details about the capacity request.- Specified by:
getOccCapacityRequestin interfaceCapacityManagementAsync- 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
public Future<GetOccCustomerGroupResponse> getOccCustomerGroup(GetOccCustomerGroupRequest request, AsyncHandler<GetOccCustomerGroupRequest,GetOccCustomerGroupResponse> handler)
Description copied from interface:CapacityManagementAsyncGets information about the specified customer group.- Specified by:
getOccCustomerGroupin interfaceCapacityManagementAsync- 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
public Future<ListInternalNamespaceOccOverviewsResponse> listInternalNamespaceOccOverviews(ListInternalNamespaceOccOverviewsRequest request, AsyncHandler<ListInternalNamespaceOccOverviewsRequest,ListInternalNamespaceOccOverviewsResponse> handler)
Description copied from interface:CapacityManagementAsyncLists an overview of all resources in that namespace in a given time interval.- Specified by:
listInternalNamespaceOccOverviewsin interfaceCapacityManagementAsync- 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
public Future<ListInternalOccHandoverResourceBlockDetailsResponse> listInternalOccHandoverResourceBlockDetails(ListInternalOccHandoverResourceBlockDetailsRequest request, AsyncHandler<ListInternalOccHandoverResourceBlockDetailsRequest,ListInternalOccHandoverResourceBlockDetailsResponse> handler)
Description copied from interface:CapacityManagementAsyncList details about a given occHandoverResourceBlock.- Specified by:
listInternalOccHandoverResourceBlockDetailsin interfaceCapacityManagementAsync- 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
public Future<ListInternalOccHandoverResourceBlocksResponse> listInternalOccHandoverResourceBlocks(ListInternalOccHandoverResourceBlocksRequest request, AsyncHandler<ListInternalOccHandoverResourceBlocksRequest,ListInternalOccHandoverResourceBlocksResponse> handler)
Description copied from interface:CapacityManagementAsyncList Occ Handover Resource blocks.- Specified by:
listInternalOccHandoverResourceBlocksin interfaceCapacityManagementAsync- 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
public Future<ListOccAvailabilitiesResponse> listOccAvailabilities(ListOccAvailabilitiesRequest request, AsyncHandler<ListOccAvailabilitiesRequest,ListOccAvailabilitiesResponse> handler)
Description copied from interface:CapacityManagementAsyncLists availabilities for a particular availability catalog.- Specified by:
listOccAvailabilitiesin interfaceCapacityManagementAsync- 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
public Future<ListOccAvailabilityCatalogsResponse> listOccAvailabilityCatalogs(ListOccAvailabilityCatalogsRequest request, AsyncHandler<ListOccAvailabilityCatalogsRequest,ListOccAvailabilityCatalogsResponse> handler)
Description copied from interface:CapacityManagementAsyncLists all availability catalogs.- Specified by:
listOccAvailabilityCatalogsin interfaceCapacityManagementAsync- 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
public Future<ListOccAvailabilityCatalogsInternalResponse> listOccAvailabilityCatalogsInternal(ListOccAvailabilityCatalogsInternalRequest request, AsyncHandler<ListOccAvailabilityCatalogsInternalRequest,ListOccAvailabilityCatalogsInternalResponse> handler)
Description copied from interface:CapacityManagementAsyncAn internal api to list availability catalogs.- Specified by:
listOccAvailabilityCatalogsInternalin interfaceCapacityManagementAsync- 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
public Future<ListOccCapacityRequestsResponse> listOccCapacityRequests(ListOccCapacityRequestsRequest request, AsyncHandler<ListOccCapacityRequestsRequest,ListOccCapacityRequestsResponse> handler)
Description copied from interface:CapacityManagementAsyncLists all capacity requests.- Specified by:
listOccCapacityRequestsin interfaceCapacityManagementAsync- 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
public Future<ListOccCapacityRequestsInternalResponse> listOccCapacityRequestsInternal(ListOccCapacityRequestsInternalRequest request, AsyncHandler<ListOccCapacityRequestsInternalRequest,ListOccCapacityRequestsInternalResponse> handler)
Description copied from interface:CapacityManagementAsyncAn internal api to list all capacity requests.- Specified by:
listOccCapacityRequestsInternalin interfaceCapacityManagementAsync- 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
public Future<ListOccCustomerGroupsResponse> listOccCustomerGroups(ListOccCustomerGroupsRequest request, AsyncHandler<ListOccCustomerGroupsRequest,ListOccCustomerGroupsResponse> handler)
Description copied from interface:CapacityManagementAsyncLists all the customer groups.- Specified by:
listOccCustomerGroupsin interfaceCapacityManagementAsync- 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
public Future<ListOccHandoverResourceBlockDetailsResponse> listOccHandoverResourceBlockDetails(ListOccHandoverResourceBlockDetailsRequest request, AsyncHandler<ListOccHandoverResourceBlockDetailsRequest,ListOccHandoverResourceBlockDetailsResponse> handler)
Description copied from interface:CapacityManagementAsyncList details about a given occHandoverResourceBlock.- Specified by:
listOccHandoverResourceBlockDetailsin interfaceCapacityManagementAsync- 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
public Future<ListOccHandoverResourceBlocksResponse> listOccHandoverResourceBlocks(ListOccHandoverResourceBlocksRequest request, AsyncHandler<ListOccHandoverResourceBlocksRequest,ListOccHandoverResourceBlocksResponse> handler)
Description copied from interface:CapacityManagementAsyncList Occ Handover Resource blocks.- Specified by:
listOccHandoverResourceBlocksin interfaceCapacityManagementAsync- 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
public Future<ListOccOverviewsResponse> listOccOverviews(ListOccOverviewsRequest request, AsyncHandler<ListOccOverviewsRequest,ListOccOverviewsResponse> handler)
Description copied from interface:CapacityManagementAsyncLists an overview of all resources in that namespace in a given time interval.- Specified by:
listOccOverviewsin interfaceCapacityManagementAsync- 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
public Future<PatchInternalOccCapacityRequestResponse> patchInternalOccCapacityRequest(PatchInternalOccCapacityRequestRequest request, AsyncHandler<PatchInternalOccCapacityRequestRequest,PatchInternalOccCapacityRequestResponse> handler)
Description copied from interface:CapacityManagementAsyncUpdates the OccCapacityRequest by evaluating a sequence of instructions.- Specified by:
patchInternalOccCapacityRequestin interfaceCapacityManagementAsync- 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
public Future<PatchOccCapacityRequestResponse> patchOccCapacityRequest(PatchOccCapacityRequestRequest request, AsyncHandler<PatchOccCapacityRequestRequest,PatchOccCapacityRequestResponse> handler)
Description copied from interface:CapacityManagementAsyncUpdates the OccCapacityRequest by evaluating a sequence of instructions.- Specified by:
patchOccCapacityRequestin interfaceCapacityManagementAsync- 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
public Future<PublishOccAvailabilityCatalogResponse> publishOccAvailabilityCatalog(PublishOccAvailabilityCatalogRequest request, AsyncHandler<PublishOccAvailabilityCatalogRequest,PublishOccAvailabilityCatalogResponse> handler)
Description copied from interface:CapacityManagementAsyncPublishes the version of availability catalog specified by the operator.This makes that catalog version visible to customers.
- Specified by:
publishOccAvailabilityCatalogin interfaceCapacityManagementAsync- 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
public Future<UpdateInternalOccCapacityRequestResponse> updateInternalOccCapacityRequest(UpdateInternalOccCapacityRequestRequest request, AsyncHandler<UpdateInternalOccCapacityRequestRequest,UpdateInternalOccCapacityRequestResponse> handler)
Description copied from interface:CapacityManagementAsyncThe 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:
updateInternalOccCapacityRequestin interfaceCapacityManagementAsync- 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
public Future<UpdateOccAvailabilityCatalogResponse> updateOccAvailabilityCatalog(UpdateOccAvailabilityCatalogRequest request, AsyncHandler<UpdateOccAvailabilityCatalogRequest,UpdateOccAvailabilityCatalogResponse> handler)
Description copied from interface:CapacityManagementAsyncThe request to update the availability catalog.Currently only freeform tags can be updated via this api.
- Specified by:
updateOccAvailabilityCatalogin interfaceCapacityManagementAsync- 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
public Future<UpdateOccCapacityRequestResponse> updateOccCapacityRequest(UpdateOccCapacityRequestRequest request, AsyncHandler<UpdateOccCapacityRequestRequest,UpdateOccCapacityRequestResponse> handler)
Description copied from interface:CapacityManagementAsyncThe 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:
updateOccCapacityRequestin interfaceCapacityManagementAsync- 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
public Future<UpdateOccCustomerResponse> updateOccCustomer(UpdateOccCustomerRequest request, AsyncHandler<UpdateOccCustomerRequest,UpdateOccCustomerResponse> handler)
Description copied from interface:CapacityManagementAsyncThe request to update the customer.- Specified by:
updateOccCustomerin interfaceCapacityManagementAsync- 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
public Future<UpdateOccCustomerGroupResponse> updateOccCustomerGroup(UpdateOccCustomerGroupRequest request, AsyncHandler<UpdateOccCustomerGroupRequest,UpdateOccCustomerGroupResponse> handler)
Description copied from interface:CapacityManagementAsyncThe request to update the customer group.- Specified by:
updateOccCustomerGroupin interfaceCapacityManagementAsync- 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.
-
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 userequiredParametersMap- 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 backingHttpClient.This will call
ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.
-
close
public final void close()
- Specified by:
closein interfaceAutoCloseable
-
getClientCommonLibraryVersion
public String getClientCommonLibraryVersion()
-
getMinimumClientCommonLibraryVersionFromClient
public Optional<String> getMinimumClientCommonLibraryVersionFromClient()
-
clientCall
protected <REQ extends BmcRequest<?>,RESP extends BmcResponse,RESP_BUILDER extends BmcResponse.Builder<RESP>> ClientCall<REQ,RESP,RESP_BUILDER> clientCall(REQ request, Supplier<RESP_BUILDER> responseBuilder)
-
-