Class DemandSignalClient
- java.lang.Object
-
- com.oracle.bmc.http.internal.BaseSyncClient
-
- com.oracle.bmc.capacitymanagement.DemandSignalClient
-
- All Implemented Interfaces:
DemandSignal,AutoCloseable
@Generated(value="OracleSDKGenerator", comments="API Version: 20231107") public class DemandSignalClient extends BaseSyncClient implements DemandSignal
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classDemandSignalClient.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 DemandSignal.
-
Constructor Summary
Constructors Constructor Description DemandSignalClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)Deprecated.Use thebuilderinstead.DemandSignalClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)Deprecated.Use thebuilderinstead.DemandSignalClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.DemandSignalClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.DemandSignalClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)Deprecated.Use thebuilderinstead.DemandSignalClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)Deprecated.Use thebuilderinstead.DemandSignalClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)Deprecated.Use thebuilderinstead.DemandSignalClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)Deprecated.Use thebuilderinstead.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static DemandSignalClient.Builderbuilder()Create a builder for this client.BulkCreateOccmDemandSignalItemResponsebulkCreateOccmDemandSignalItem(BulkCreateOccmDemandSignalItemRequest request)This API will help in bulk creation of demand signal items.voidclose()CreateOccmDemandSignalResponsecreateOccmDemandSignal(CreateOccmDemandSignalRequest request)This is a post API to create occm demand signal.CreateOccmDemandSignalItemResponsecreateOccmDemandSignalItem(CreateOccmDemandSignalItemRequest request)This API will create a demand signal item representing a resource request.DeleteOccmDemandSignalResponsedeleteOccmDemandSignal(DeleteOccmDemandSignalRequest request)This is a DELETE API which deletes a demand signal with the provided demand signal ocid.DeleteOccmDemandSignalItemResponsedeleteOccmDemandSignalItem(DeleteOccmDemandSignalItemRequest request)This is a DELETE API which deletes a demand signal item with the provided demand signal item ocid.voidenableDualStackEndpoints(boolean enableDualStackEndpoints)This method should be used to enable or disable the use of dual-stack endpoints.StringgetClientCommonLibraryVersion()protected ClientConfiguratorgetDefaultConfigurator()StringgetEndpoint()Get the endpoint of the client.Optional<String>getMinimumClientCommonLibraryVersionFromClient()GetOccmDemandSignalResponsegetOccmDemandSignal(GetOccmDemandSignalRequest request)This is a GET API which gets the detailed information about a specific demand signal.GetOccmDemandSignalItemResponsegetOccmDemandSignalItem(GetOccmDemandSignalItemRequest request)This is a GET API to get the details of a demand signal item resource representing the details of the resource demanded by you.Map<String,Boolean>getOptionsMap()Return an immutable snapshot representing the current options set for this client.DemandSignalPaginatorsgetPaginators()Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.StringgetResolvedEndpoint(Map<String,Object> requiredParametersMap)Returns the endpoint after filling in the current options, as determined byBaseClient.getOptionsMap(), and then filling in the required parameters in requiredParametersMap into the placeholders in the endpoint.DemandSignalWaitersgetWaiters()Gets the pre-configured waiters available for resources for this service.ListOccmDemandSignalCatalogResourcesResponselistOccmDemandSignalCatalogResources(ListOccmDemandSignalCatalogResourcesRequest request)This API will list all the resources across all demand signal catalogs for a given namespace and customer group containing the caller compartment.ListOccmDemandSignalDeliveriesResponselistOccmDemandSignalDeliveries(ListOccmDemandSignalDeliveriesRequest request)This GET call is used to list all demand signals delivery resources within the compartment passed as a query param.ListOccmDemandSignalItemsResponselistOccmDemandSignalItems(ListOccmDemandSignalItemsRequest request)This API will list the detailed information about the resources demanded as part of the demand signal.ListOccmDemandSignalsResponselistOccmDemandSignals(ListOccmDemandSignalsRequest request)This GET call is used to list all demand signals within the compartment passed as a query parameter.voidrefreshClient()Rebuild the backingHttpClient.voidsetEndpoint(String endpoint)voidsetRegion(Region region)Sets the region to call (ex, Region.US_PHOENIX_1).voidsetRegion(String regionId)Sets the region to call (ex, ‘us-phoenix-1’).UpdateOccmDemandSignalResponseupdateOccmDemandSignal(UpdateOccmDemandSignalRequest request)This is a PUT API which shall be used to update the metadata of the demand signal.UpdateOccmDemandSignalItemResponseupdateOccmDemandSignalItem(UpdateOccmDemandSignalItemRequest request)This is a PUT API which can be used to update the demand signal item resource.voiduseRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)This method should be used to enable or disable the use of realm-specific endpoint template.-
Methods inherited from class com.oracle.bmc.http.internal.BaseSyncClient
clientCall
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface java.lang.AutoCloseable
close
-
Methods inherited from interface com.oracle.bmc.capacitymanagement.DemandSignal
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
-
-
-
-
Constructor Detail
-
DemandSignalClient
@Deprecated public DemandSignalClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeDemandSignalClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
-
DemandSignalClient
@Deprecated public DemandSignalClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeDemandSignalClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configuration
-
DemandSignalClient
@Deprecated public DemandSignalClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeDemandSignalClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
-
DemandSignalClient
@Deprecated public DemandSignalClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeDemandSignalClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactory
-
DemandSignalClient
@Deprecated public DemandSignalClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeDemandSignalClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfigurators
-
DemandSignalClient
@Deprecated public DemandSignalClient(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 (seeDemandSignalClient.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)
-
DemandSignalClient
@Deprecated public DemandSignalClient(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 (seeDemandSignalClient.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
-
DemandSignalClient
@Deprecated public DemandSignalClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeDemandSignalClient.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.signingStrategyRequestSignerFactoriesexecutorService-DemandSignalClient.Builder.executorService
-
-
Method Detail
-
builder
public static DemandSignalClient.Builder builder()
Create a builder for this client.- Returns:
- builder
-
setRegion
public void setRegion(Region region)
Description copied from interface:DemandSignalSets 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 interfaceDemandSignal- Parameters:
region- The region of the service.
-
setRegion
public void setRegion(String regionId)
Description copied from interface:DemandSignalSets 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 interfaceDemandSignal- Parameters:
regionId- The public region ID.
-
bulkCreateOccmDemandSignalItem
public BulkCreateOccmDemandSignalItemResponse bulkCreateOccmDemandSignalItem(BulkCreateOccmDemandSignalItemRequest request)
Description copied from interface:DemandSignalThis 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:
bulkCreateOccmDemandSignalItemin interfaceDemandSignal- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createOccmDemandSignal
public CreateOccmDemandSignalResponse createOccmDemandSignal(CreateOccmDemandSignalRequest request)
Description copied from interface:DemandSignalThis is a post API to create occm demand signal.- Specified by:
createOccmDemandSignalin interfaceDemandSignal- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createOccmDemandSignalItem
public CreateOccmDemandSignalItemResponse createOccmDemandSignalItem(CreateOccmDemandSignalItemRequest request)
Description copied from interface:DemandSignalThis API will create a demand signal item representing a resource request.This needs to be grouped under a demand signal.
- Specified by:
createOccmDemandSignalItemin interfaceDemandSignal- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteOccmDemandSignal
public DeleteOccmDemandSignalResponse deleteOccmDemandSignal(DeleteOccmDemandSignalRequest request)
Description copied from interface:DemandSignalThis is a DELETE API which deletes a demand signal with the provided demand signal ocid.- Specified by:
deleteOccmDemandSignalin interfaceDemandSignal- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteOccmDemandSignalItem
public DeleteOccmDemandSignalItemResponse deleteOccmDemandSignalItem(DeleteOccmDemandSignalItemRequest request)
Description copied from interface:DemandSignalThis is a DELETE API which deletes a demand signal item with the provided demand signal item ocid.- Specified by:
deleteOccmDemandSignalItemin interfaceDemandSignal- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getOccmDemandSignal
public GetOccmDemandSignalResponse getOccmDemandSignal(GetOccmDemandSignalRequest request)
Description copied from interface:DemandSignalThis is a GET API which gets the detailed information about a specific demand signal.- Specified by:
getOccmDemandSignalin interfaceDemandSignal- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getOccmDemandSignalItem
public GetOccmDemandSignalItemResponse getOccmDemandSignalItem(GetOccmDemandSignalItemRequest request)
Description copied from interface:DemandSignalThis 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:
getOccmDemandSignalItemin interfaceDemandSignal- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listOccmDemandSignalCatalogResources
public ListOccmDemandSignalCatalogResourcesResponse listOccmDemandSignalCatalogResources(ListOccmDemandSignalCatalogResourcesRequest request)
Description copied from interface:DemandSignalThis API will list all the resources across all demand signal catalogs for a given namespace and customer group containing the caller compartment.- Specified by:
listOccmDemandSignalCatalogResourcesin interfaceDemandSignal- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listOccmDemandSignalDeliveries
public ListOccmDemandSignalDeliveriesResponse listOccmDemandSignalDeliveries(ListOccmDemandSignalDeliveriesRequest request)
Description copied from interface:DemandSignalThis GET call is used to list all demand signals delivery resources within the compartment passed as a query param.- Specified by:
listOccmDemandSignalDeliveriesin interfaceDemandSignal- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listOccmDemandSignalItems
public ListOccmDemandSignalItemsResponse listOccmDemandSignalItems(ListOccmDemandSignalItemsRequest request)
Description copied from interface:DemandSignalThis API will list the detailed information about the resources demanded as part of the demand signal.- Specified by:
listOccmDemandSignalItemsin interfaceDemandSignal- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listOccmDemandSignals
public ListOccmDemandSignalsResponse listOccmDemandSignals(ListOccmDemandSignalsRequest request)
Description copied from interface:DemandSignalThis GET call is used to list all demand signals within the compartment passed as a query parameter.- Specified by:
listOccmDemandSignalsin interfaceDemandSignal- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateOccmDemandSignal
public UpdateOccmDemandSignalResponse updateOccmDemandSignal(UpdateOccmDemandSignalRequest request)
Description copied from interface:DemandSignalThis is a PUT API which shall be used to update the metadata of the demand signal.- Specified by:
updateOccmDemandSignalin interfaceDemandSignal- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateOccmDemandSignalItem
public UpdateOccmDemandSignalItemResponse updateOccmDemandSignalItem(UpdateOccmDemandSignalItemRequest request)
Description copied from interface:DemandSignalThis is a PUT API which can be used to update the demand signal item resource.- Specified by:
updateOccmDemandSignalItemin interfaceDemandSignal- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getWaiters
public DemandSignalWaiters getWaiters()
Description copied from interface:DemandSignalGets the pre-configured waiters available for resources for this service.- Specified by:
getWaitersin interfaceDemandSignal- Returns:
- The service waiters.
-
getPaginators
public DemandSignalPaginators getPaginators()
Description copied from interface:DemandSignalGets the pre-configured paginators available for list operations in this service which may return multiple pages of data.These paginators provide an
Iterableinterface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.- Specified by:
getPaginatorsin interfaceDemandSignal- Returns:
- The service paginators.
-
getDefaultConfigurator
protected ClientConfigurator getDefaultConfigurator()
-
enableDualStackEndpoints
public void enableDualStackEndpoints(boolean enableDualStackEndpoints)
This method should be used to enable or disable the use of dual-stack endpoints.The default value is false i.e. dual-stack endpoints are disabled by default.
- Parameters:
enableDualStackEndpoints- This flag can be set to true or false to enable or disable the use of dual-stack endpoints respectively
-
getOptionsMap
public Map<String,Boolean> getOptionsMap()
Return an immutable snapshot representing the current options set for this client.- Returns:
- immutable snapshot representing the current options set for this client
-
getResolvedEndpoint
public String getResolvedEndpoint(Map<String,Object> requiredParametersMap)
Returns the endpoint after filling in the current options, as determined byBaseClient.getOptionsMap(), and then filling in the required parameters in requiredParametersMap into the placeholders in the endpoint.- Parameters:
requiredParametersMap- the map from required parameter name to their values- Returns:
- resolved endpoint, with all options and placeholders filled in
-
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
-
setEndpoint
public final void setEndpoint(String endpoint)
-
getEndpoint
public final String getEndpoint()
Get the endpoint of the client.Note that the endpoint may be parameterized and contain placeholders and options. The region subdomain and realm domain will have been properly replaced already if the endpoint was selected using a
Region.Examples of endpoints this may return:
- Unparameterized endpoints
https://identity.us-phoenix-1.oci.oraclecloud.com https://identity.us-ashburn-1.oci.oraclecloud.com https://test-namespace.objectstorage.us-ashburn-1.oci.customer-oci.com - Parameterized endpoints with placeholders
https://{namespaceName+Dot}objectstorage.us-phoenix-1.oci.customer-oci.com https://{namespaceName+Dot}objectstorage.us-ashburn-1.oci.customer-oci.com - Parameterized endpoints with options
https://{dualStack?ds.:}identity.us-phoenix-1.oci.oraclecloud.com https://{dualStack?ds.:}identity.us-ashburn-1.oci.oraclecloud.com - Parameterized endpoints with placeholders and options
https://{namespaceName+Dot}{dualStack?ds.:}objectstorage.us-phoenix-1.oci.customer-oci.com https://{namespaceName+Dot}{dualStack?ds.:}objectstorage.us-ashburn-1.oci.customer-oci.com
To get the actual endpoint for a parameterized request, you can use
BaseClient.getResolvedEndpoint(Map)orParameterizedEndpointUtil.getEndpointWithPopulatedServiceParameters(String, Map, Map).- Returns:
- the endpoint being used by the client
- Unparameterized endpoints
-
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()
-
-