com.oracle.bmc.demandsignal

Class OccDemandSignalClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

com.oracle.bmc.demandsignal.OccDemandSignalClient

All Implemented Interfaces:

OccDemandSignal, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20240430")
public class OccDemandSignalClient
extends BaseSyncClient
implements OccDemandSignal

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OccDemandSignalClient.Builder Builder class for this client.

Field Summary

Fields

Modifier and Type	Field and 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 OccDemandSignal.

Constructor Summary

Constructors

Constructor and Description
OccDemandSignalClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory) Deprecated. Use the builder instead.
OccDemandSignalClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators) Deprecated. Use the builder instead.
OccDemandSignalClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Deprecated. Use the builder instead.
OccDemandSignalClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Deprecated. Use the builder instead.
OccDemandSignalClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService) Deprecated. Use the builder instead.
OccDemandSignalClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider) Deprecated. Use the builder instead.
OccDemandSignalClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration) Deprecated. Use the builder instead.
OccDemandSignalClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator) Deprecated. Use the builder instead.

Method Summary

Modifier and Type	Method and Description
static OccDemandSignalClient.Builder	builder() Create a builder for this client.
ChangeOccDemandSignalCompartmentResponse	changeOccDemandSignalCompartment(ChangeOccDemandSignalCompartmentRequest request) Moves a OccDemandSignal into a different compartment within the same tenancy.
void	close()
CreateOccDemandSignalResponse	createOccDemandSignal(CreateOccDemandSignalRequest request) Creates a OccDemandSignal.
DeleteOccDemandSignalResponse	deleteOccDemandSignal(DeleteOccDemandSignalRequest request) Deletes a OccDemandSignal.
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
GetOccDemandSignalResponse	getOccDemandSignal(GetOccDemandSignalRequest request) Gets information about a OccDemandSignal.
OccDemandSignalPaginators	getPaginators() Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
OccDemandSignalWaiters	getWaiters() Gets the pre-configured waiters available for resources for this service.
ListOccDemandSignalsResponse	listOccDemandSignals(ListOccDemandSignalsRequest request) Gets a list of OccDemandSignals.
PatchOccDemandSignalResponse	patchOccDemandSignal(PatchOccDemandSignalRequest request) Updates the data of an OccDemandSignal.
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.
UpdateOccDemandSignalResponse	updateOccDemandSignal(UpdateOccDemandSignalRequest request) Updates a OccDemandSignal.
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 com.oracle.bmc.demandsignal.OccDemandSignal

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE

public static final Service SERVICE

Service instance for OccDemandSignal.

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

OccDemandSignalClient

@Deprecated
public OccDemandSignalClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

OccDemandSignalClient

@Deprecated
public OccDemandSignalClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                         ClientConfiguration configuration)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

OccDemandSignalClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

OccDemandSignalClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

OccDemandSignalClient

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

OccDemandSignalClient

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

OccDemandSignalClient

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

OccDemandSignalClient

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

Method Detail

builder

public static OccDemandSignalClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: OccDemandSignal

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 OccDemandSignal

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: OccDemandSignal

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 OccDemandSignal

Parameters:

regionId - The public region ID.

changeOccDemandSignalCompartment

public ChangeOccDemandSignalCompartmentResponse changeOccDemandSignalCompartment(ChangeOccDemandSignalCompartmentRequest request)

Description copied from interface: OccDemandSignal

Moves a OccDemandSignal into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Specified by:

changeOccDemandSignalCompartment in interface OccDemandSignal

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createOccDemandSignal

public CreateOccDemandSignalResponse createOccDemandSignal(CreateOccDemandSignalRequest request)

Description copied from interface: OccDemandSignal

Creates a OccDemandSignal.

Specified by:

createOccDemandSignal in interface OccDemandSignal

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteOccDemandSignal

public DeleteOccDemandSignalResponse deleteOccDemandSignal(DeleteOccDemandSignalRequest request)

Description copied from interface: OccDemandSignal

Deletes a OccDemandSignal.

Specified by:

deleteOccDemandSignal in interface OccDemandSignal

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getOccDemandSignal

public GetOccDemandSignalResponse getOccDemandSignal(GetOccDemandSignalRequest request)

Description copied from interface: OccDemandSignal

Gets information about a OccDemandSignal.

Specified by:

getOccDemandSignal in interface OccDemandSignal

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listOccDemandSignals

public ListOccDemandSignalsResponse listOccDemandSignals(ListOccDemandSignalsRequest request)

Description copied from interface: OccDemandSignal

Gets a list of OccDemandSignals.

Specified by:

listOccDemandSignals in interface OccDemandSignal

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

patchOccDemandSignal

public PatchOccDemandSignalResponse patchOccDemandSignal(PatchOccDemandSignalRequest request)

Description copied from interface: OccDemandSignal

Updates the data of an OccDemandSignal.

Specified by:

patchOccDemandSignal in interface OccDemandSignal

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateOccDemandSignal

public UpdateOccDemandSignalResponse updateOccDemandSignal(UpdateOccDemandSignalRequest request)

Description copied from interface: OccDemandSignal

Updates a OccDemandSignal.

Specified by:

updateOccDemandSignal in interface OccDemandSignal

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWaiters

public OccDemandSignalWaiters getWaiters()

Description copied from interface: OccDemandSignal

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

Specified by:

getWaiters in interface OccDemandSignal

Returns:

The service waiters.

getPaginators

public OccDemandSignalPaginators getPaginators()

Description copied from interface: OccDemandSignal

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 OccDemandSignal

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