Package com.oracle.bmc.capacitymanagement

Class InternalDemandSignalClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

com.oracle.bmc.capacitymanagement.InternalDemandSignalClient

All Implemented Interfaces:

InternalDemandSignal, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20231107")
public class InternalDemandSignalClient
extends BaseSyncClient
implements InternalDemandSignal

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static InternalDemandSignalClient.Builder	builder()	Create a builder for this client.
void	close()
CreateInternalOccmDemandSignalDeliveryResponse	createInternalOccmDemandSignalDelivery(CreateInternalOccmDemandSignalDeliveryRequest request)	This is a post API which is used to create a demand signal delivery resource.
DeleteInternalOccmDemandSignalDeliveryResponse	deleteInternalOccmDemandSignalDelivery(DeleteInternalOccmDemandSignalDeliveryRequest request)	This is an internal DELETE API which is used to delete a demand signal delivery resource.
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
GetInternalOccmDemandSignalResponse	getInternalOccmDemandSignal(GetInternalOccmDemandSignalRequest request)	This is an internal GET API which gets the detailed information about a specific demand signal.
GetInternalOccmDemandSignalCatalogResponse	getInternalOccmDemandSignalCatalog(GetInternalOccmDemandSignalCatalogRequest request)	This API helps in getting the details about a specific occm demand signal catalog.
GetInternalOccmDemandSignalDeliveryResponse	getInternalOccmDemandSignalDelivery(GetInternalOccmDemandSignalDeliveryRequest request)	This is an internal GET API to get the details of a demand signal delivery resource corresponding to a demand signal item.
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
InternalDemandSignalPaginators	getPaginators()	Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
InternalDemandSignalWaiters	getWaiters()	Gets the pre-configured waiters available for resources for this service.
ListInternalOccmDemandSignalCatalogResourcesResponse	listInternalOccmDemandSignalCatalogResources(ListInternalOccmDemandSignalCatalogResourcesRequest request)	This API will list all the resources across all demand signal catalogs for a given namespace and customer group.
ListInternalOccmDemandSignalCatalogsResponse	listInternalOccmDemandSignalCatalogs(ListInternalOccmDemandSignalCatalogsRequest request)	This API will list demand signal catalogs for a given customer group.
ListInternalOccmDemandSignalDeliveriesResponse	listInternalOccmDemandSignalDeliveries(ListInternalOccmDemandSignalDeliveriesRequest request)	This GET call is used to list all demand signal delivery resources within the customer group passed as a query parameter.
ListInternalOccmDemandSignalItemsResponse	listInternalOccmDemandSignalItems(ListInternalOccmDemandSignalItemsRequest request)	This internal API will list the detailed information about the resources demanded as part of the demand signal.
ListInternalOccmDemandSignalsResponse	listInternalOccmDemandSignals(ListInternalOccmDemandSignalsRequest request)	This is an internal 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.
UpdateInternalOccmDemandSignalResponse	updateInternalOccmDemandSignal(UpdateInternalOccmDemandSignalRequest request)	This is a internal PUT API which shall be used to update the metadata of the demand signal.
UpdateInternalOccmDemandSignalDeliveryResponse	updateInternalOccmDemandSignalDelivery(UpdateInternalOccmDemandSignalDeliveryRequest request)	This is an internal PUT API which is used to update the demand signal delivery 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.InternalDemandSignal

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Field Detail

SERVICE

public static final Service SERVICE

Service instance for InternalDemandSignal.

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

InternalDemandSignalClient

@Deprecated
public InternalDemandSignalClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

InternalDemandSignalClient

@Deprecated
public InternalDemandSignalClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                  ClientConfiguration configuration)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

InternalDemandSignalClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

InternalDemandSignalClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

InternalDemandSignalClient

@Deprecated
public InternalDemandSignalClient(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 InternalDemandSignalClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

InternalDemandSignalClient

@Deprecated
public InternalDemandSignalClient(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 InternalDemandSignalClient.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)

InternalDemandSignalClient

@Deprecated
public InternalDemandSignalClient(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 InternalDemandSignalClient.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

InternalDemandSignalClient

@Deprecated
public InternalDemandSignalClient(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 InternalDemandSignalClient.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 - InternalDemandSignalClient.Builder.executorService

Method Detail

builder

public static InternalDemandSignalClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: InternalDemandSignal

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 InternalDemandSignal

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: InternalDemandSignal

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 InternalDemandSignal

Parameters:

regionId - The public region ID.

createInternalOccmDemandSignalDelivery

public CreateInternalOccmDemandSignalDeliveryResponse createInternalOccmDemandSignalDelivery(CreateInternalOccmDemandSignalDeliveryRequest request)

Description copied from interface: InternalDemandSignal

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

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteInternalOccmDemandSignalDelivery

public DeleteInternalOccmDemandSignalDeliveryResponse deleteInternalOccmDemandSignalDelivery(DeleteInternalOccmDemandSignalDeliveryRequest request)

Description copied from interface: InternalDemandSignal

This is an internal DELETE API which is used to delete a demand signal delivery resource.

Specified by:

deleteInternalOccmDemandSignalDelivery in interface InternalDemandSignal

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getInternalOccmDemandSignal

public GetInternalOccmDemandSignalResponse getInternalOccmDemandSignal(GetInternalOccmDemandSignalRequest request)

Description copied from interface: InternalDemandSignal

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

Specified by:

getInternalOccmDemandSignal in interface InternalDemandSignal

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getInternalOccmDemandSignalCatalog

public GetInternalOccmDemandSignalCatalogResponse getInternalOccmDemandSignalCatalog(GetInternalOccmDemandSignalCatalogRequest request)

Description copied from interface: InternalDemandSignal

This API helps in getting the details about a specific occm demand signal catalog.

Specified by:

getInternalOccmDemandSignalCatalog in interface InternalDemandSignal

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getInternalOccmDemandSignalDelivery

public GetInternalOccmDemandSignalDeliveryResponse getInternalOccmDemandSignalDelivery(GetInternalOccmDemandSignalDeliveryRequest request)

Description copied from interface: InternalDemandSignal

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

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listInternalOccmDemandSignalCatalogResources

public ListInternalOccmDemandSignalCatalogResourcesResponse listInternalOccmDemandSignalCatalogResources(ListInternalOccmDemandSignalCatalogResourcesRequest request)

Description copied from interface: InternalDemandSignal

This API will list all the resources across all demand signal catalogs for a given namespace and customer group.

Specified by:

listInternalOccmDemandSignalCatalogResources in interface InternalDemandSignal

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listInternalOccmDemandSignalCatalogs

public ListInternalOccmDemandSignalCatalogsResponse listInternalOccmDemandSignalCatalogs(ListInternalOccmDemandSignalCatalogsRequest request)

Description copied from interface: InternalDemandSignal

This API will list demand signal catalogs for a given customer group.

Specified by:

listInternalOccmDemandSignalCatalogs in interface InternalDemandSignal

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listInternalOccmDemandSignalDeliveries

public ListInternalOccmDemandSignalDeliveriesResponse listInternalOccmDemandSignalDeliveries(ListInternalOccmDemandSignalDeliveriesRequest request)

Description copied from interface: InternalDemandSignal

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

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listInternalOccmDemandSignalItems

public ListInternalOccmDemandSignalItemsResponse listInternalOccmDemandSignalItems(ListInternalOccmDemandSignalItemsRequest request)

Description copied from interface: InternalDemandSignal

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

Specified by:

listInternalOccmDemandSignalItems in interface InternalDemandSignal

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listInternalOccmDemandSignals

public ListInternalOccmDemandSignalsResponse listInternalOccmDemandSignals(ListInternalOccmDemandSignalsRequest request)

Description copied from interface: InternalDemandSignal

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

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateInternalOccmDemandSignal

public UpdateInternalOccmDemandSignalResponse updateInternalOccmDemandSignal(UpdateInternalOccmDemandSignalRequest request)

Description copied from interface: InternalDemandSignal

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

Specified by:

updateInternalOccmDemandSignal in interface InternalDemandSignal

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateInternalOccmDemandSignalDelivery

public UpdateInternalOccmDemandSignalDeliveryResponse updateInternalOccmDemandSignalDelivery(UpdateInternalOccmDemandSignalDeliveryRequest request)

Description copied from interface: InternalDemandSignal

This is an internal PUT API which is used to update the demand signal delivery resource.

Specified by:

updateInternalOccmDemandSignalDelivery in interface InternalDemandSignal

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWaiters

public InternalDemandSignalWaiters getWaiters()

Description copied from interface: InternalDemandSignal

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

Specified by:

getWaiters in interface InternalDemandSignal

Returns:

The service waiters.

getPaginators

public InternalDemandSignalPaginators getPaginators()

Description copied from interface: InternalDemandSignal

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 InternalDemandSignal

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()