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 InternalDemandSignalAsync
Async 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 Summary
Nested Classes Modifier and Type Class Description static class
InternalDemandSignalAsyncClient.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 InternalDemandSignal.
-
Constructor Summary
Constructors Constructor Description InternalDemandSignalAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilder
instead.InternalDemandSignalAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilder
instead.InternalDemandSignalAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.InternalDemandSignalAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.InternalDemandSignalAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilder
instead.InternalDemandSignalAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilder
instead.InternalDemandSignalAsyncClient(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.InternalDemandSignalAsync
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
-
-
-
-
Constructor Detail
-
InternalDemandSignalAsyncClient
@Deprecated public InternalDemandSignalAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeInternalDemandSignalAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)
-
InternalDemandSignalAsyncClient
@Deprecated public InternalDemandSignalAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeInternalDemandSignalAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
-
InternalDemandSignalAsyncClient
@Deprecated public InternalDemandSignalAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeInternalDemandSignalAsyncClient.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 thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeInternalDemandSignalAsyncClient.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 thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeInternalDemandSignalAsyncClient.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 thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeInternalDemandSignalAsyncClient.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 thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeInternalDemandSignalAsyncClient.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 InternalDemandSignalAsyncClient.Builder builder()
Create a builder for this client.- Returns:
- builder
-
setRegion
public void setRegion(Region region)
Description copied from interface:InternalDemandSignalAsync
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 interfaceInternalDemandSignalAsync
- Parameters:
region
- The region of the service.
-
setRegion
public void setRegion(String regionId)
Description copied from interface:InternalDemandSignalAsync
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 interfaceInternalDemandSignalAsync
- Parameters:
regionId
- The public region ID.
-
createInternalOccmDemandSignalDelivery
public Future<CreateInternalOccmDemandSignalDeliveryResponse> createInternalOccmDemandSignalDelivery(CreateInternalOccmDemandSignalDeliveryRequest request, AsyncHandler<CreateInternalOccmDemandSignalDeliveryRequest,CreateInternalOccmDemandSignalDeliveryResponse> handler)
Description copied from interface:InternalDemandSignalAsync
This 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:
createInternalOccmDemandSignalDelivery
in interfaceInternalDemandSignalAsync
- 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.
-
deleteInternalOccmDemandSignalDelivery
public Future<DeleteInternalOccmDemandSignalDeliveryResponse> deleteInternalOccmDemandSignalDelivery(DeleteInternalOccmDemandSignalDeliveryRequest request, AsyncHandler<DeleteInternalOccmDemandSignalDeliveryRequest,DeleteInternalOccmDemandSignalDeliveryResponse> handler)
Description copied from interface:InternalDemandSignalAsync
This is an internal DELETE API which is used to delete a demand signal delivery resource.- Specified by:
deleteInternalOccmDemandSignalDelivery
in interfaceInternalDemandSignalAsync
- 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.
-
getInternalOccmDemandSignal
public Future<GetInternalOccmDemandSignalResponse> getInternalOccmDemandSignal(GetInternalOccmDemandSignalRequest request, AsyncHandler<GetInternalOccmDemandSignalRequest,GetInternalOccmDemandSignalResponse> handler)
Description copied from interface:InternalDemandSignalAsync
This is an internal GET API which gets the detailed information about a specific demand signal.- Specified by:
getInternalOccmDemandSignal
in interfaceInternalDemandSignalAsync
- 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.
-
getInternalOccmDemandSignalCatalog
public Future<GetInternalOccmDemandSignalCatalogResponse> getInternalOccmDemandSignalCatalog(GetInternalOccmDemandSignalCatalogRequest request, AsyncHandler<GetInternalOccmDemandSignalCatalogRequest,GetInternalOccmDemandSignalCatalogResponse> handler)
Description copied from interface:InternalDemandSignalAsync
This API helps in getting the details about a specific occm demand signal catalog.- Specified by:
getInternalOccmDemandSignalCatalog
in interfaceInternalDemandSignalAsync
- 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.
-
getInternalOccmDemandSignalDelivery
public Future<GetInternalOccmDemandSignalDeliveryResponse> getInternalOccmDemandSignalDelivery(GetInternalOccmDemandSignalDeliveryRequest request, AsyncHandler<GetInternalOccmDemandSignalDeliveryRequest,GetInternalOccmDemandSignalDeliveryResponse> handler)
Description copied from interface:InternalDemandSignalAsync
This is an internal GET API to get the details of a demand signal delivery resource corresponding to a demand signal item.- Specified by:
getInternalOccmDemandSignalDelivery
in interfaceInternalDemandSignalAsync
- 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.
-
listInternalOccmDemandSignalCatalogResources
public Future<ListInternalOccmDemandSignalCatalogResourcesResponse> listInternalOccmDemandSignalCatalogResources(ListInternalOccmDemandSignalCatalogResourcesRequest request, AsyncHandler<ListInternalOccmDemandSignalCatalogResourcesRequest,ListInternalOccmDemandSignalCatalogResourcesResponse> handler)
Description copied from interface:InternalDemandSignalAsync
This API will list all the resources across all demand signal catalogs for a given namespace and customer group.- Specified by:
listInternalOccmDemandSignalCatalogResources
in interfaceInternalDemandSignalAsync
- 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.
-
listInternalOccmDemandSignalCatalogs
public Future<ListInternalOccmDemandSignalCatalogsResponse> listInternalOccmDemandSignalCatalogs(ListInternalOccmDemandSignalCatalogsRequest request, AsyncHandler<ListInternalOccmDemandSignalCatalogsRequest,ListInternalOccmDemandSignalCatalogsResponse> handler)
Description copied from interface:InternalDemandSignalAsync
This API will list demand signal catalogs for a given customer group.- Specified by:
listInternalOccmDemandSignalCatalogs
in interfaceInternalDemandSignalAsync
- 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.
-
listInternalOccmDemandSignalDeliveries
public Future<ListInternalOccmDemandSignalDeliveriesResponse> listInternalOccmDemandSignalDeliveries(ListInternalOccmDemandSignalDeliveriesRequest request, AsyncHandler<ListInternalOccmDemandSignalDeliveriesRequest,ListInternalOccmDemandSignalDeliveriesResponse> handler)
Description copied from interface:InternalDemandSignalAsync
This GET call is used to list all demand signal delivery resources within the customer group passed as a query parameter.- Specified by:
listInternalOccmDemandSignalDeliveries
in interfaceInternalDemandSignalAsync
- 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.
-
listInternalOccmDemandSignalItems
public Future<ListInternalOccmDemandSignalItemsResponse> listInternalOccmDemandSignalItems(ListInternalOccmDemandSignalItemsRequest request, AsyncHandler<ListInternalOccmDemandSignalItemsRequest,ListInternalOccmDemandSignalItemsResponse> handler)
Description copied from interface:InternalDemandSignalAsync
This internal API will list the detailed information about the resources demanded as part of the demand signal.- Specified by:
listInternalOccmDemandSignalItems
in interfaceInternalDemandSignalAsync
- 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.
-
listInternalOccmDemandSignals
public Future<ListInternalOccmDemandSignalsResponse> listInternalOccmDemandSignals(ListInternalOccmDemandSignalsRequest request, AsyncHandler<ListInternalOccmDemandSignalsRequest,ListInternalOccmDemandSignalsResponse> handler)
Description copied from interface:InternalDemandSignalAsync
This is an internal GET call is used to list all demand signals within the compartment passed as a query parameter.- Specified by:
listInternalOccmDemandSignals
in interfaceInternalDemandSignalAsync
- 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.
-
updateInternalOccmDemandSignal
public Future<UpdateInternalOccmDemandSignalResponse> updateInternalOccmDemandSignal(UpdateInternalOccmDemandSignalRequest request, AsyncHandler<UpdateInternalOccmDemandSignalRequest,UpdateInternalOccmDemandSignalResponse> handler)
Description copied from interface:InternalDemandSignalAsync
This is a internal PUT API which shall be used to update the metadata of the demand signal.- Specified by:
updateInternalOccmDemandSignal
in interfaceInternalDemandSignalAsync
- 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.
-
updateInternalOccmDemandSignalDelivery
public Future<UpdateInternalOccmDemandSignalDeliveryResponse> updateInternalOccmDemandSignalDelivery(UpdateInternalOccmDemandSignalDeliveryRequest request, AsyncHandler<UpdateInternalOccmDemandSignalDeliveryRequest,UpdateInternalOccmDemandSignalDeliveryResponse> handler)
Description copied from interface:InternalDemandSignalAsync
This is an internal PUT API which is used to update the demand signal delivery resource.- Specified by:
updateInternalOccmDemandSignalDelivery
in interfaceInternalDemandSignalAsync
- 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)
-
-