Package com.oracle.bmc.ccdoffers

Class CcdCommitmentsClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

com.oracle.bmc.ccdoffers.CcdCommitmentsClient

All Implemented Interfaces:

CcdCommitments, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20240601")
public class CcdCommitmentsClient
extends BaseSyncClient
implements CcdCommitments

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CcdCommitmentsClient.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 CcdCommitments.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static CcdCommitmentsClient.Builder	builder()	Create a builder for this client.
void	close()
CreateCcdCommitmentResponse	createCcdCommitment(CreateCcdCommitmentRequest request)	Request to create a new CCD commitment.
DeleteCcdCommitmentResponse	deleteCcdCommitment(DeleteCcdCommitmentRequest request)	Terminates the CCD commitment.
void	enableDualStackEndpoints(boolean enableDualStackEndpoints)	This method should be used to enable or disable the use of dual-stack endpoints.
GetCcdCommitmentResponse	getCcdCommitment(GetCcdCommitmentRequest request)	Gets the CCD commitment using the CCD commitment ID.
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()	Get the endpoint of the client.
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
Map<String,Boolean>	getOptionsMap()	Return an immutable snapshot representing the current options set for this client.
CcdCommitmentsPaginators	getPaginators()	Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
String	getResolvedEndpoint(Map<String,Object> requiredParametersMap)	Returns the endpoint after filling in the current options, as determined by BaseClient.getOptionsMap(), and then filling in the required parameters in requiredParametersMap into the placeholders in the endpoint.
CcdCommitmentsWaiters	getWaiters()	Gets the pre-configured waiters available for resources for this service.
ListCcdCommitmentsResponse	listCcdCommitments(ListCcdCommitmentsRequest request)	Lists the CCD commitments.
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’).
UpdateCcdCommitmentResponse	updateCcdCommitment(UpdateCcdCommitmentRequest request)	Updates the free-form tags, defined tags, or both on a CCD commitment.
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.ccdoffers.CcdCommitments

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Field Detail

SERVICE

public static final Service SERVICE

Service instance for CcdCommitments.

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

CcdCommitmentsClient

@Deprecated
public CcdCommitmentsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

CcdCommitmentsClient

@Deprecated
public CcdCommitmentsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                            ClientConfiguration configuration)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

CcdCommitmentsClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

CcdCommitmentsClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

CcdCommitmentsClient

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

CcdCommitmentsClient

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

CcdCommitmentsClient

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

CcdCommitmentsClient

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

Method Detail

builder

public static CcdCommitmentsClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: CcdCommitments

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 CcdCommitments

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: CcdCommitments

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 CcdCommitments

Parameters:

regionId - The public region ID.

createCcdCommitment

public CreateCcdCommitmentResponse createCcdCommitment(CreateCcdCommitmentRequest request)

Description copied from interface: CcdCommitments

Request to create a new CCD commitment.

Specified by:

createCcdCommitment in interface CcdCommitments

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteCcdCommitment

public DeleteCcdCommitmentResponse deleteCcdCommitment(DeleteCcdCommitmentRequest request)

Description copied from interface: CcdCommitments

Terminates the CCD commitment.

You can’t terminate an already canceled or ended commitment. If the CCD commitment has already started based on timeCcdCommitmentStarts, then you can only terminate within a week of its effective timeCcdCommitmentStarts time.

Specified by:

deleteCcdCommitment in interface CcdCommitments

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getCcdCommitment

public GetCcdCommitmentResponse getCcdCommitment(GetCcdCommitmentRequest request)

Description copied from interface: CcdCommitments

Gets the CCD commitment using the CCD commitment ID.

Specified by:

getCcdCommitment in interface CcdCommitments

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listCcdCommitments

public ListCcdCommitmentsResponse listCcdCommitments(ListCcdCommitmentsRequest request)

Description copied from interface: CcdCommitments

Lists the CCD commitments.

Specified by:

listCcdCommitments in interface CcdCommitments

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateCcdCommitment

public UpdateCcdCommitmentResponse updateCcdCommitment(UpdateCcdCommitmentRequest request)

Description copied from interface: CcdCommitments

Updates the free-form tags, defined tags, or both on a CCD commitment.

Commercial commitment attributes are immutable.

Specified by:

updateCcdCommitment in interface CcdCommitments

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWaiters

public CcdCommitmentsWaiters getWaiters()

Description copied from interface: CcdCommitments

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

Specified by:

getWaiters in interface CcdCommitments

Returns:

The service waiters.

getPaginators

public CcdCommitmentsPaginators getPaginators()

Description copied from interface: CcdCommitments

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 CcdCommitments

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 by BaseClient.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) or ParameterizedEndpointUtil.getEndpointWithPopulatedServiceParameters(String, Map, Map).

Returns:

the endpoint being used by the client

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