Class InternalDemandSignalAsyncClient
- java.lang.Object
- 
- com.oracle.bmc.http.internal.BaseAsyncClient
- 
- com.oracle.bmc.capacitymanagement.InternalDemandSignalAsyncClient
 
 
- 
- All Implemented Interfaces:
- InternalDemandSignalAsync,- AutoCloseable
 
 @Generated(value="OracleSDKGenerator", comments="API Version: 20231107") public class InternalDemandSignalAsyncClient extends BaseAsyncClient implements InternalDemandSignalAsyncAsync client implementation for InternalDemandSignal 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 SummaryNested Classes Modifier and Type Class Description static classInternalDemandSignalAsyncClient.BuilderBuilder class for this client.
 - 
Field SummaryFields 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 InternalDemandSignal.
 - 
Constructor SummaryConstructors Constructor Description InternalDemandSignalAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)Deprecated.Use thebuilderinstead.InternalDemandSignalAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)Deprecated.Use thebuilderinstead.InternalDemandSignalAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.InternalDemandSignalAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.InternalDemandSignalAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)Deprecated.Use thebuilderinstead.InternalDemandSignalAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)Deprecated.Use thebuilderinstead.InternalDemandSignalAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)Deprecated.Use thebuilderinstead.
 - 
Method Summary- 
Methods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 - 
Methods inherited from interface java.lang.AutoCloseableclose
 - 
Methods inherited from interface com.oracle.bmc.capacitymanagement.InternalDemandSignalAsyncgetEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
 
- 
 
- 
- 
- 
Constructor Detail- 
InternalDemandSignalAsyncClient@Deprecated public InternalDemandSignalAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider) Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
- authenticationDetailsProvider- The authentication details (see- InternalDemandSignalAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
 
 - 
InternalDemandSignalAsyncClient@Deprecated public InternalDemandSignalAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration) Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
- authenticationDetailsProvider- The authentication details (see- InternalDemandSignalAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
- configuration-- ClientBuilderBase.configuration
 
 - 
InternalDemandSignalAsyncClient@Deprecated public InternalDemandSignalAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator) Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
- authenticationDetailsProvider- The authentication details (see- InternalDemandSignalAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
- configuration-- ClientBuilderBase.configuration
- clientConfigurator-- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
 
 - 
InternalDemandSignalAsyncClient@Deprecated public InternalDemandSignalAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory) Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
- authenticationDetailsProvider- The authentication details (see- InternalDemandSignalAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
- configuration-- ClientBuilderBase.configuration
- clientConfigurator-- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
- defaultRequestSignerFactory-- ClientBuilderBase.requestSignerFactory
 
 - 
InternalDemandSignalAsyncClient@Deprecated public InternalDemandSignalAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators) Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
- authenticationDetailsProvider- The authentication details (see- InternalDemandSignalAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
- configuration-- ClientBuilderBase.configuration
- clientConfigurator-- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
- defaultRequestSignerFactory-- ClientBuilderBase.requestSignerFactory
- additionalClientConfigurators-- ClientBuilderBase.additionalClientConfigurators
 
 - 
InternalDemandSignalAsyncClient@Deprecated public InternalDemandSignalAsyncClient(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 (see- InternalDemandSignalAsyncClient.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)
 
 - 
InternalDemandSignalAsyncClient@Deprecated public InternalDemandSignalAsyncClient(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 (see- InternalDemandSignalAsyncClient.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- 
builderpublic static InternalDemandSignalAsyncClient.Builder builder() Create a builder for this client.- Returns:
- builder
 
 - 
setRegionpublic void setRegion(Region region) Description copied from interface:InternalDemandSignalAsyncSets 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 interface- InternalDemandSignalAsync
- Parameters:
- region- The region of the service.
 
 - 
setRegionpublic void setRegion(String regionId) Description copied from interface:InternalDemandSignalAsyncSets 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 interface- InternalDemandSignalAsync
- Parameters:
- regionId- The public region ID.
 
 - 
createInternalOccmDemandSignalDeliverypublic Future<CreateInternalOccmDemandSignalDeliveryResponse> createInternalOccmDemandSignalDelivery(CreateInternalOccmDemandSignalDeliveryRequest request, AsyncHandler<CreateInternalOccmDemandSignalDeliveryRequest,CreateInternalOccmDemandSignalDeliveryResponse> handler) Description copied from interface:InternalDemandSignalAsyncThis is a post API which is used to create a demand signal delivery resource.operationId: CreateInternalOccmDemandSignalDelivery summary: A post call to create a demand signal delivery. - Specified by:
- createInternalOccmDemandSignalDeliveryin interface- InternalDemandSignalAsync
- Parameters:
- request- The request object containing the details to send
- handler- 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.
 
 - 
deleteInternalOccmDemandSignalDeliverypublic Future<DeleteInternalOccmDemandSignalDeliveryResponse> deleteInternalOccmDemandSignalDelivery(DeleteInternalOccmDemandSignalDeliveryRequest request, AsyncHandler<DeleteInternalOccmDemandSignalDeliveryRequest,DeleteInternalOccmDemandSignalDeliveryResponse> handler) Description copied from interface:InternalDemandSignalAsyncThis is an internal DELETE API which is used to delete a demand signal delivery resource.- Specified by:
- deleteInternalOccmDemandSignalDeliveryin interface- InternalDemandSignalAsync
- Parameters:
- request- The request object containing the details to send
- handler- 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.
 
 - 
getInternalOccmDemandSignalpublic Future<GetInternalOccmDemandSignalResponse> getInternalOccmDemandSignal(GetInternalOccmDemandSignalRequest request, AsyncHandler<GetInternalOccmDemandSignalRequest,GetInternalOccmDemandSignalResponse> handler) Description copied from interface:InternalDemandSignalAsyncThis is an internal GET API which gets the detailed information about a specific demand signal.- Specified by:
- getInternalOccmDemandSignalin interface- InternalDemandSignalAsync
- Parameters:
- request- The request object containing the details to send
- handler- 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.
 
 - 
getInternalOccmDemandSignalCatalogpublic Future<GetInternalOccmDemandSignalCatalogResponse> getInternalOccmDemandSignalCatalog(GetInternalOccmDemandSignalCatalogRequest request, AsyncHandler<GetInternalOccmDemandSignalCatalogRequest,GetInternalOccmDemandSignalCatalogResponse> handler) Description copied from interface:InternalDemandSignalAsyncThis API helps in getting the details about a specific occm demand signal catalog.- Specified by:
- getInternalOccmDemandSignalCatalogin interface- InternalDemandSignalAsync
- Parameters:
- request- The request object containing the details to send
- handler- 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.
 
 - 
getInternalOccmDemandSignalDeliverypublic Future<GetInternalOccmDemandSignalDeliveryResponse> getInternalOccmDemandSignalDelivery(GetInternalOccmDemandSignalDeliveryRequest request, AsyncHandler<GetInternalOccmDemandSignalDeliveryRequest,GetInternalOccmDemandSignalDeliveryResponse> handler) Description copied from interface:InternalDemandSignalAsyncThis is an internal GET API to get the details of a demand signal delivery resource corresponding to a demand signal item.- Specified by:
- getInternalOccmDemandSignalDeliveryin interface- InternalDemandSignalAsync
- Parameters:
- request- The request object containing the details to send
- handler- 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.
 
 - 
listInternalOccmDemandSignalCatalogResourcespublic Future<ListInternalOccmDemandSignalCatalogResourcesResponse> listInternalOccmDemandSignalCatalogResources(ListInternalOccmDemandSignalCatalogResourcesRequest request, AsyncHandler<ListInternalOccmDemandSignalCatalogResourcesRequest,ListInternalOccmDemandSignalCatalogResourcesResponse> handler) Description copied from interface:InternalDemandSignalAsyncThis API will list all the resources across all demand signal catalogs for a given namespace and customer group.- Specified by:
- listInternalOccmDemandSignalCatalogResourcesin interface- InternalDemandSignalAsync
- Parameters:
- request- The request object containing the details to send
- handler- 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.
 
 - 
listInternalOccmDemandSignalCatalogspublic Future<ListInternalOccmDemandSignalCatalogsResponse> listInternalOccmDemandSignalCatalogs(ListInternalOccmDemandSignalCatalogsRequest request, AsyncHandler<ListInternalOccmDemandSignalCatalogsRequest,ListInternalOccmDemandSignalCatalogsResponse> handler) Description copied from interface:InternalDemandSignalAsyncThis API will list demand signal catalogs for a given customer group.- Specified by:
- listInternalOccmDemandSignalCatalogsin interface- InternalDemandSignalAsync
- Parameters:
- request- The request object containing the details to send
- handler- 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.
 
 - 
listInternalOccmDemandSignalDeliveriespublic Future<ListInternalOccmDemandSignalDeliveriesResponse> listInternalOccmDemandSignalDeliveries(ListInternalOccmDemandSignalDeliveriesRequest request, AsyncHandler<ListInternalOccmDemandSignalDeliveriesRequest,ListInternalOccmDemandSignalDeliveriesResponse> handler) Description copied from interface:InternalDemandSignalAsyncThis GET call is used to list all demand signal delivery resources within the customer group passed as a query parameter.- Specified by:
- listInternalOccmDemandSignalDeliveriesin interface- InternalDemandSignalAsync
- Parameters:
- request- The request object containing the details to send
- handler- 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.
 
 - 
listInternalOccmDemandSignalItemspublic Future<ListInternalOccmDemandSignalItemsResponse> listInternalOccmDemandSignalItems(ListInternalOccmDemandSignalItemsRequest request, AsyncHandler<ListInternalOccmDemandSignalItemsRequest,ListInternalOccmDemandSignalItemsResponse> handler) Description copied from interface:InternalDemandSignalAsyncThis internal API will list the detailed information about the resources demanded as part of the demand signal.- Specified by:
- listInternalOccmDemandSignalItemsin interface- InternalDemandSignalAsync
- Parameters:
- request- The request object containing the details to send
- handler- 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.
 
 - 
listInternalOccmDemandSignalspublic Future<ListInternalOccmDemandSignalsResponse> listInternalOccmDemandSignals(ListInternalOccmDemandSignalsRequest request, AsyncHandler<ListInternalOccmDemandSignalsRequest,ListInternalOccmDemandSignalsResponse> handler) Description copied from interface:InternalDemandSignalAsyncThis is an internal GET call is used to list all demand signals within the compartment passed as a query parameter.- Specified by:
- listInternalOccmDemandSignalsin interface- InternalDemandSignalAsync
- Parameters:
- request- The request object containing the details to send
- handler- 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.
 
 - 
updateInternalOccmDemandSignalpublic Future<UpdateInternalOccmDemandSignalResponse> updateInternalOccmDemandSignal(UpdateInternalOccmDemandSignalRequest request, AsyncHandler<UpdateInternalOccmDemandSignalRequest,UpdateInternalOccmDemandSignalResponse> handler) Description copied from interface:InternalDemandSignalAsyncThis is a internal PUT API which shall be used to update the metadata of the demand signal.- Specified by:
- updateInternalOccmDemandSignalin interface- InternalDemandSignalAsync
- Parameters:
- request- The request object containing the details to send
- handler- 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.
 
 - 
updateInternalOccmDemandSignalDeliverypublic Future<UpdateInternalOccmDemandSignalDeliveryResponse> updateInternalOccmDemandSignalDelivery(UpdateInternalOccmDemandSignalDeliveryRequest request, AsyncHandler<UpdateInternalOccmDemandSignalDeliveryRequest,UpdateInternalOccmDemandSignalDeliveryResponse> handler) Description copied from interface:InternalDemandSignalAsyncThis is an internal PUT API which is used to update the demand signal delivery resource.- Specified by:
- updateInternalOccmDemandSignalDeliveryin interface- InternalDemandSignalAsync
- Parameters:
- request- The request object containing the details to send
- handler- 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.
 
 - 
getDefaultConfiguratorprotected ClientConfigurator getDefaultConfigurator() 
 - 
useRealmSpecificEndpointTemplatepublic 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
 
 - 
populateServiceParametersInEndpointpublic 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
 
 - 
updateBaseEndpointpublic 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
 
 - 
setEndpointpublic final void setEndpoint(String endpoint) 
 - 
getEndpointpublic final String getEndpoint() 
 - 
refreshClientpublic final void refreshClient() Rebuild the backingHttpClient.This will call ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.
 - 
closepublic final void close() - Specified by:
- closein interface- AutoCloseable
 
 - 
getClientCommonLibraryVersionpublic String getClientCommonLibraryVersion() 
 - 
getMinimumClientCommonLibraryVersionFromClientpublic Optional<String> getMinimumClientCommonLibraryVersionFromClient() 
 - 
clientCallprotected <REQ extends BmcRequest<?>,RESP extends BmcResponse,RESP_BUILDER extends BmcResponse.Builder<RESP>> ClientCall<REQ,RESP,RESP_BUILDER> clientCall(REQ request, Supplier<RESP_BUILDER> responseBuilder) 
 
- 
 
-