Class DemandSignalAsyncClient
- java.lang.Object
-
- com.oracle.bmc.http.internal.BaseAsyncClient
-
- com.oracle.bmc.capacitymanagement.DemandSignalAsyncClient
-
- All Implemented Interfaces:
DemandSignalAsync
,AutoCloseable
@Generated(value="OracleSDKGenerator", comments="API Version: 20231107") public class DemandSignalAsyncClient extends BaseAsyncClient implements DemandSignalAsync
Async client implementation for DemandSignal 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 class
DemandSignalAsyncClient.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 DemandSignal.
-
Constructor Summary
Constructors Constructor Description DemandSignalAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilder
instead.DemandSignalAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilder
instead.DemandSignalAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.DemandSignalAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.DemandSignalAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilder
instead.DemandSignalAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilder
instead.DemandSignalAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilder
instead.
-
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.DemandSignalAsync
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
-
-
-
-
Constructor Detail
-
DemandSignalAsyncClient
@Deprecated public DemandSignalAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeDemandSignalAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)
-
DemandSignalAsyncClient
@Deprecated public DemandSignalAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeDemandSignalAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
-
DemandSignalAsyncClient
@Deprecated public DemandSignalAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeDemandSignalAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
-
DemandSignalAsyncClient
@Deprecated public DemandSignalAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeDemandSignalAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
-
DemandSignalAsyncClient
@Deprecated public DemandSignalAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeDemandSignalAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
-ClientBuilderBase.additionalClientConfigurators
-
DemandSignalAsyncClient
@Deprecated public DemandSignalAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeDemandSignalAsyncClient.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)
-
DemandSignalAsyncClient
@Deprecated public DemandSignalAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeDemandSignalAsyncClient.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
-
-
Method Detail
-
builder
public static DemandSignalAsyncClient.Builder builder()
Create a builder for this client.- Returns:
- builder
-
setRegion
public void setRegion(Region region)
Description copied from interface:DemandSignalAsync
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 interfaceDemandSignalAsync
- Parameters:
region
- The region of the service.
-
setRegion
public void setRegion(String regionId)
Description copied from interface:DemandSignalAsync
Sets the region to call (ex, ‘us-phoenix-1’).Note, this will first try to map the region ID to a known Region and call
setRegion
.If no known Region could be determined, it will create an endpoint based on the default endpoint format (
Region.formatDefaultRegionEndpoint(Service, String)
and then callsetEndpoint
.- Specified by:
setRegion
in interfaceDemandSignalAsync
- Parameters:
regionId
- The public region ID.
-
bulkCreateOccmDemandSignalItem
public Future<BulkCreateOccmDemandSignalItemResponse> bulkCreateOccmDemandSignalItem(BulkCreateOccmDemandSignalItemRequest request, AsyncHandler<BulkCreateOccmDemandSignalItemRequest,BulkCreateOccmDemandSignalItemResponse> handler)
Description copied from interface:DemandSignalAsync
This API will help in bulk creation of demand signal items.This API is atomic i.e either all the demand signal item resources will be created or none will be created.
- Specified by:
bulkCreateOccmDemandSignalItem
in interfaceDemandSignalAsync
- 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.
-
createOccmDemandSignal
public Future<CreateOccmDemandSignalResponse> createOccmDemandSignal(CreateOccmDemandSignalRequest request, AsyncHandler<CreateOccmDemandSignalRequest,CreateOccmDemandSignalResponse> handler)
Description copied from interface:DemandSignalAsync
This is a post API to create occm demand signal.- Specified by:
createOccmDemandSignal
in interfaceDemandSignalAsync
- 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.
-
createOccmDemandSignalItem
public Future<CreateOccmDemandSignalItemResponse> createOccmDemandSignalItem(CreateOccmDemandSignalItemRequest request, AsyncHandler<CreateOccmDemandSignalItemRequest,CreateOccmDemandSignalItemResponse> handler)
Description copied from interface:DemandSignalAsync
This API will create a demand signal item representing a resource request.This needs to be grouped under a demand signal.
- Specified by:
createOccmDemandSignalItem
in interfaceDemandSignalAsync
- 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.
-
deleteOccmDemandSignal
public Future<DeleteOccmDemandSignalResponse> deleteOccmDemandSignal(DeleteOccmDemandSignalRequest request, AsyncHandler<DeleteOccmDemandSignalRequest,DeleteOccmDemandSignalResponse> handler)
Description copied from interface:DemandSignalAsync
This is a DELETE API which deletes a demand signal with the provided demand signal ocid.- Specified by:
deleteOccmDemandSignal
in interfaceDemandSignalAsync
- 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.
-
deleteOccmDemandSignalItem
public Future<DeleteOccmDemandSignalItemResponse> deleteOccmDemandSignalItem(DeleteOccmDemandSignalItemRequest request, AsyncHandler<DeleteOccmDemandSignalItemRequest,DeleteOccmDemandSignalItemResponse> handler)
Description copied from interface:DemandSignalAsync
This is a DELETE API which deletes a demand signal item with the provided demand signal item ocid.- Specified by:
deleteOccmDemandSignalItem
in interfaceDemandSignalAsync
- 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.
-
getOccmDemandSignal
public Future<GetOccmDemandSignalResponse> getOccmDemandSignal(GetOccmDemandSignalRequest request, AsyncHandler<GetOccmDemandSignalRequest,GetOccmDemandSignalResponse> handler)
Description copied from interface:DemandSignalAsync
This is a GET API which gets the detailed information about a specific demand signal.- Specified by:
getOccmDemandSignal
in interfaceDemandSignalAsync
- 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.
-
getOccmDemandSignalItem
public Future<GetOccmDemandSignalItemResponse> getOccmDemandSignalItem(GetOccmDemandSignalItemRequest request, AsyncHandler<GetOccmDemandSignalItemRequest,GetOccmDemandSignalItemResponse> handler)
Description copied from interface:DemandSignalAsync
This is a GET API to get the details of a demand signal item resource representing the details of the resource demanded by you.- Specified by:
getOccmDemandSignalItem
in interfaceDemandSignalAsync
- 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.
-
listOccmDemandSignalCatalogResources
public Future<ListOccmDemandSignalCatalogResourcesResponse> listOccmDemandSignalCatalogResources(ListOccmDemandSignalCatalogResourcesRequest request, AsyncHandler<ListOccmDemandSignalCatalogResourcesRequest,ListOccmDemandSignalCatalogResourcesResponse> handler)
Description copied from interface:DemandSignalAsync
This API will list all the resources across all demand signal catalogs for a given namespace and customer group containing the caller compartment.- Specified by:
listOccmDemandSignalCatalogResources
in interfaceDemandSignalAsync
- 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.
-
listOccmDemandSignalDeliveries
public Future<ListOccmDemandSignalDeliveriesResponse> listOccmDemandSignalDeliveries(ListOccmDemandSignalDeliveriesRequest request, AsyncHandler<ListOccmDemandSignalDeliveriesRequest,ListOccmDemandSignalDeliveriesResponse> handler)
Description copied from interface:DemandSignalAsync
This GET call is used to list all demand signals delivery resources within the compartment passed as a query param.- Specified by:
listOccmDemandSignalDeliveries
in interfaceDemandSignalAsync
- 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.
-
listOccmDemandSignalItems
public Future<ListOccmDemandSignalItemsResponse> listOccmDemandSignalItems(ListOccmDemandSignalItemsRequest request, AsyncHandler<ListOccmDemandSignalItemsRequest,ListOccmDemandSignalItemsResponse> handler)
Description copied from interface:DemandSignalAsync
This API will list the detailed information about the resources demanded as part of the demand signal.- Specified by:
listOccmDemandSignalItems
in interfaceDemandSignalAsync
- 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.
-
listOccmDemandSignals
public Future<ListOccmDemandSignalsResponse> listOccmDemandSignals(ListOccmDemandSignalsRequest request, AsyncHandler<ListOccmDemandSignalsRequest,ListOccmDemandSignalsResponse> handler)
Description copied from interface:DemandSignalAsync
This GET call is used to list all demand signals within the compartment passed as a query parameter.- Specified by:
listOccmDemandSignals
in interfaceDemandSignalAsync
- 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.
-
updateOccmDemandSignal
public Future<UpdateOccmDemandSignalResponse> updateOccmDemandSignal(UpdateOccmDemandSignalRequest request, AsyncHandler<UpdateOccmDemandSignalRequest,UpdateOccmDemandSignalResponse> handler)
Description copied from interface:DemandSignalAsync
This is a PUT API which shall be used to update the metadata of the demand signal.- Specified by:
updateOccmDemandSignal
in interfaceDemandSignalAsync
- 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.
-
updateOccmDemandSignalItem
public Future<UpdateOccmDemandSignalItemResponse> updateOccmDemandSignalItem(UpdateOccmDemandSignalItemRequest request, AsyncHandler<UpdateOccmDemandSignalItemRequest,UpdateOccmDemandSignalItemResponse> handler)
Description copied from interface:DemandSignalAsync
This is a PUT API which can be used to update the demand signal item resource.- Specified by:
updateOccmDemandSignalItem
in interfaceDemandSignalAsync
- 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
ClientConfigurator
s again, and can be used to e.g. refresh the SSL certificate.
-
close
public final void close()
- Specified by:
close
in 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)
-
-