Package com.oracle.bmc.capacitymanagement

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 class	DemandSignalClient.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
DemandSignalClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)	Deprecated. Use the builder instead.
DemandSignalClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)	Deprecated. Use the builder instead.
DemandSignalClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)	Deprecated. Use the builder instead.
DemandSignalClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)	Deprecated. Use the builder instead.
DemandSignalClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)	Deprecated. Use the builder instead.
DemandSignalClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)	Deprecated. Use the builder instead.
DemandSignalClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)	Deprecated. Use the builder instead.
DemandSignalClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)	Deprecated. Use the builder instead.

Method Summary

Modifier and Type	Method	Description
static DemandSignalClient.Builder	builder()	Create a builder for this client.
BulkCreateOccmDemandSignalItemResponse	bulkCreateOccmDemandSignalItem(BulkCreateOccmDemandSignalItemRequest request)	This API will help in bulk creation of demand signal items.
void	close()
CreateOccmDemandSignalResponse	createOccmDemandSignal(CreateOccmDemandSignalRequest request)	This is a post API to create occm demand signal.
CreateOccmDemandSignalItemResponse	createOccmDemandSignalItem(CreateOccmDemandSignalItemRequest request)	This API will create a demand signal item representing a resource request.
DeleteOccmDemandSignalResponse	deleteOccmDemandSignal(DeleteOccmDemandSignalRequest request)	This is a DELETE API which deletes a demand signal with the provided demand signal ocid.
DeleteOccmDemandSignalItemResponse	deleteOccmDemandSignalItem(DeleteOccmDemandSignalItemRequest request)	This is a DELETE API which deletes a demand signal item with the provided demand signal item ocid.
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
GetOccmDemandSignalResponse	getOccmDemandSignal(GetOccmDemandSignalRequest request)	This is a GET API which gets the detailed information about a specific demand signal.
GetOccmDemandSignalItemResponse	getOccmDemandSignalItem(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.
DemandSignalPaginators	getPaginators()	Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
DemandSignalWaiters	getWaiters()	Gets the pre-configured waiters available for resources for this service.
ListOccmDemandSignalCatalogResourcesResponse	listOccmDemandSignalCatalogResources(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.
ListOccmDemandSignalDeliveriesResponse	listOccmDemandSignalDeliveries(ListOccmDemandSignalDeliveriesRequest request)	This GET call is used to list all demand signals delivery resources within the compartment passed as a query param.
ListOccmDemandSignalItemsResponse	listOccmDemandSignalItems(ListOccmDemandSignalItemsRequest request)	This API will list the detailed information about the resources demanded as part of the demand signal.
ListOccmDemandSignalsResponse	listOccmDemandSignals(ListOccmDemandSignalsRequest request)	This GET call is used to list all demand signals within the compartment passed as a query parameter.
void	populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)	Populate the parameters in the endpoint with its corresponding value and update the base endpoint.
void	refreshClient()	Rebuild the backing HttpClient.
void	setEndpoint(String endpoint)
void	setRegion(Region region)	Sets the region to call (ex, Region.US_PHOENIX_1).
void	setRegion(String regionId)	Sets the region to call (ex, ‘us-phoenix-1’).
void	updateBaseEndpoint(String endpoint)	This method should be used for parameterized endpoint templates only.
UpdateOccmDemandSignalResponse	updateOccmDemandSignal(UpdateOccmDemandSignalRequest request)	This is a PUT API which shall be used to update the metadata of the demand signal.
UpdateOccmDemandSignalItemResponse	updateOccmDemandSignalItem(UpdateOccmDemandSignalItemRequest request)	This is a PUT API which can be used to update the demand signal item resource.
void	useRealmSpecificEndpointTemplate(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

Field Detail

SERVICE

public static final Service SERVICE

Service instance for DemandSignal.

clientCommonLibraryVersion

public final String clientCommonLibraryVersion

Compatible SDK version, provided by the codegen.

minimumClientCommonLibraryVersionFromClient

public final Optional<String> minimumClientCommonLibraryVersionFromClient

Minimum compatible SDK version, maybe provided by the codegen.

Constructor Detail

DemandSignalClient

@Deprecated
public DemandSignalClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see DemandSignalClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

DemandSignalClient

@Deprecated
public DemandSignalClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                          ClientConfiguration configuration)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see DemandSignalClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

DemandSignalClient

@Deprecated
public DemandSignalClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                          ClientConfiguration configuration,
                          ClientConfigurator clientConfigurator)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see DemandSignalClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

DemandSignalClient

@Deprecated
public DemandSignalClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                          ClientConfiguration configuration,
                          ClientConfigurator clientConfigurator,
                          RequestSignerFactory defaultRequestSignerFactory)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see DemandSignalClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - 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 the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see DemandSignalClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

DemandSignalClient

@Deprecated
public DemandSignalClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                          ClientConfiguration configuration,
                          ClientConfigurator clientConfigurator,
                          RequestSignerFactory defaultRequestSignerFactory,
                          List<ClientConfigurator> additionalClientConfigurators,
                          String endpoint)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see DemandSignalClient.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)

DemandSignalClient

@Deprecated
public DemandSignalClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                          ClientConfiguration configuration,
                          ClientConfigurator clientConfigurator,
                          RequestSignerFactory defaultRequestSignerFactory,
                          Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                          List<ClientConfigurator> additionalClientConfigurators,
                          String endpoint)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see DemandSignalClient.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

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 the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see DemandSignalClient.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

executorService - 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: DemandSignal

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 interface DemandSignal

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: DemandSignal

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 call setEndpoint.

Specified by:

setRegion in interface DemandSignal

Parameters:

regionId - The public region ID.

bulkCreateOccmDemandSignalItem

public BulkCreateOccmDemandSignalItemResponse bulkCreateOccmDemandSignalItem(BulkCreateOccmDemandSignalItemRequest request)

Description copied from interface: DemandSignal

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 interface DemandSignal

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: DemandSignal

This is a post API to create occm demand signal.

Specified by:

createOccmDemandSignal in interface DemandSignal

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: DemandSignal

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 interface DemandSignal

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: DemandSignal

This is a DELETE API which deletes a demand signal with the provided demand signal ocid.

Specified by:

deleteOccmDemandSignal in interface DemandSignal

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: DemandSignal

This is a DELETE API which deletes a demand signal item with the provided demand signal item ocid.

Specified by:

deleteOccmDemandSignalItem in interface DemandSignal

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: DemandSignal

This is a GET API which gets the detailed information about a specific demand signal.

Specified by:

getOccmDemandSignal in interface DemandSignal

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: DemandSignal

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 interface DemandSignal

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: DemandSignal

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 interface DemandSignal

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: DemandSignal

This GET call is used to list all demand signals delivery resources within the compartment passed as a query param.

Specified by:

listOccmDemandSignalDeliveries in interface DemandSignal

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: DemandSignal

This API will list the detailed information about the resources demanded as part of the demand signal.

Specified by:

listOccmDemandSignalItems in interface DemandSignal

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: DemandSignal

This GET call is used to list all demand signals within the compartment passed as a query parameter.

Specified by:

listOccmDemandSignals in interface DemandSignal

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: DemandSignal

This is a PUT API which shall be used to update the metadata of the demand signal.

Specified by:

updateOccmDemandSignal in interface DemandSignal

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: DemandSignal

This is a PUT API which can be used to update the demand signal item resource.

Specified by:

updateOccmDemandSignalItem in interface DemandSignal

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: DemandSignal

Gets the pre-configured waiters available for resources for this service.

Specified by:

getWaiters in interface DemandSignal

Returns:

The service waiters.

getPaginators

public DemandSignalPaginators getPaginators()

Description copied from interface: DemandSignal

Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.

These paginators provide an Iterable interface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.

Specified by:

getPaginators in interface DemandSignal

Returns:

The service paginators.

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 use

requiredParametersMap - 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 backing HttpClient.

This will call ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.

close

public final void close()

Specified by:

close in interface AutoCloseable

getClientCommonLibraryVersion

public String getClientCommonLibraryVersion()

getMinimumClientCommonLibraryVersionFromClient

public Optional<String> getMinimumClientCommonLibraryVersionFromClient()