com.oracle.bmc.computecloudatcustomer

Class ComputeCloudAtCustomerClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

com.oracle.bmc.computecloudatcustomer.ComputeCloudAtCustomerClient

All Implemented Interfaces:

ComputeCloudAtCustomer, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20221208")
public class ComputeCloudAtCustomerClient
extends BaseSyncClient
implements ComputeCloudAtCustomer

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static ComputeCloudAtCustomerClient.Builder	builder() Create a builder for this client.
ChangeCccInfrastructureCompartmentResponse	changeCccInfrastructureCompartment(ChangeCccInfrastructureCompartmentRequest request) Moves a Compute Cloud@Customer infrastructure resource from one compartment to another.
ChangeCccUpgradeScheduleCompartmentResponse	changeCccUpgradeScheduleCompartment(ChangeCccUpgradeScheduleCompartmentRequest request) Moves a Compute Cloud@Customer upgrade schedule from one compartment to another using the specified OCID.
void	close()
CreateCccInfrastructureResponse	createCccInfrastructure(CreateCccInfrastructureRequest request) Creates a Compute Cloud@Customer infrastructure.
CreateCccUpgradeScheduleResponse	createCccUpgradeSchedule(CreateCccUpgradeScheduleRequest request) Creates a new Compute Cloud@Customer upgrade schedule.
DeleteCccInfrastructureResponse	deleteCccInfrastructure(DeleteCccInfrastructureRequest request) Deletes a Compute Cloud@Customer infrastructure resource specified by the resource OCID.
DeleteCccUpgradeScheduleResponse	deleteCccUpgradeSchedule(DeleteCccUpgradeScheduleRequest request) Deletes a Compute Cloud@Customer upgrade schedule by the specified OCID.
GetCccInfrastructureResponse	getCccInfrastructure(GetCccInfrastructureRequest request) Gets a Compute Cloud@Customer infrastructure using the infrastructure OCID.
GetCccUpgradeScheduleResponse	getCccUpgradeSchedule(GetCccUpgradeScheduleRequest request) Gets a Compute Cloud@Customer upgrade schedule by the specified OCID.
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
ComputeCloudAtCustomerPaginators	getPaginators() Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
ComputeCloudAtCustomerWaiters	getWaiters() Gets the pre-configured waiters available for resources for this service.
ListCccInfrastructuresResponse	listCccInfrastructures(ListCccInfrastructuresRequest request) Returns a list of Compute Cloud@Customer infrastructures.
ListCccUpgradeSchedulesResponse	listCccUpgradeSchedules(ListCccUpgradeSchedulesRequest request) Returns a list of Compute Cloud@Customer upgrade schedules.
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.
UpdateCccInfrastructureResponse	updateCccInfrastructure(UpdateCccInfrastructureRequest request) Updates Compute Cloud@Customer infrastructure resource.
UpdateCccUpgradeScheduleResponse	updateCccUpgradeSchedule(UpdateCccUpgradeScheduleRequest request) Updates the Compute Cloud@Customer upgrade schedule.
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.computecloudatcustomer.ComputeCloudAtCustomer

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE

public static final Service SERVICE

Service instance for ComputeCloudAtCustomer.

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

ComputeCloudAtCustomerClient

@Deprecated
public ComputeCloudAtCustomerClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

ComputeCloudAtCustomerClient

@Deprecated
public ComputeCloudAtCustomerClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                                ClientConfiguration configuration)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

ComputeCloudAtCustomerClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

ComputeCloudAtCustomerClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

ComputeCloudAtCustomerClient

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

ComputeCloudAtCustomerClient

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

ComputeCloudAtCustomerClient

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

ComputeCloudAtCustomerClient

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

Method Detail

builder

public static ComputeCloudAtCustomerClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: ComputeCloudAtCustomer

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 ComputeCloudAtCustomer

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: ComputeCloudAtCustomer

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 ComputeCloudAtCustomer

Parameters:

regionId - The public region ID.

changeCccInfrastructureCompartment

public ChangeCccInfrastructureCompartmentResponse changeCccInfrastructureCompartment(ChangeCccInfrastructureCompartmentRequest request)

Description copied from interface: ComputeCloudAtCustomer

Moves a Compute Cloud@Customer infrastructure resource from one compartment to another.

Specified by:

changeCccInfrastructureCompartment in interface ComputeCloudAtCustomer

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

changeCccUpgradeScheduleCompartment

public ChangeCccUpgradeScheduleCompartmentResponse changeCccUpgradeScheduleCompartment(ChangeCccUpgradeScheduleCompartmentRequest request)

Description copied from interface: ComputeCloudAtCustomer

Moves a Compute Cloud@Customer upgrade schedule from one compartment to another using the specified OCID.

Specified by:

changeCccUpgradeScheduleCompartment in interface ComputeCloudAtCustomer

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createCccInfrastructure

public CreateCccInfrastructureResponse createCccInfrastructure(CreateCccInfrastructureRequest request)

Description copied from interface: ComputeCloudAtCustomer

Creates a Compute Cloud@Customer infrastructure. Once created, Oracle Services must connect the rack in the data center to this Oracle Cloud Infrastructure resource.

Specified by:

createCccInfrastructure in interface ComputeCloudAtCustomer

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createCccUpgradeSchedule

public CreateCccUpgradeScheduleResponse createCccUpgradeSchedule(CreateCccUpgradeScheduleRequest request)

Description copied from interface: ComputeCloudAtCustomer

Creates a new Compute Cloud@Customer upgrade schedule.

Specified by:

createCccUpgradeSchedule in interface ComputeCloudAtCustomer

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteCccInfrastructure

public DeleteCccInfrastructureResponse deleteCccInfrastructure(DeleteCccInfrastructureRequest request)

Description copied from interface: ComputeCloudAtCustomer

Deletes a Compute Cloud@Customer infrastructure resource specified by the resource OCID.

Specified by:

deleteCccInfrastructure in interface ComputeCloudAtCustomer

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteCccUpgradeSchedule

public DeleteCccUpgradeScheduleResponse deleteCccUpgradeSchedule(DeleteCccUpgradeScheduleRequest request)

Description copied from interface: ComputeCloudAtCustomer

Deletes a Compute Cloud@Customer upgrade schedule by the specified OCID.

Specified by:

deleteCccUpgradeSchedule in interface ComputeCloudAtCustomer

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getCccInfrastructure

public GetCccInfrastructureResponse getCccInfrastructure(GetCccInfrastructureRequest request)

Description copied from interface: ComputeCloudAtCustomer

Gets a Compute Cloud@Customer infrastructure using the infrastructure OCID.

Specified by:

getCccInfrastructure in interface ComputeCloudAtCustomer

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getCccUpgradeSchedule

public GetCccUpgradeScheduleResponse getCccUpgradeSchedule(GetCccUpgradeScheduleRequest request)

Description copied from interface: ComputeCloudAtCustomer

Gets a Compute Cloud@Customer upgrade schedule by the specified OCID.

Specified by:

getCccUpgradeSchedule in interface ComputeCloudAtCustomer

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listCccInfrastructures

public ListCccInfrastructuresResponse listCccInfrastructures(ListCccInfrastructuresRequest request)

Description copied from interface: ComputeCloudAtCustomer

Returns a list of Compute Cloud@Customer infrastructures.

Specified by:

listCccInfrastructures in interface ComputeCloudAtCustomer

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listCccUpgradeSchedules

public ListCccUpgradeSchedulesResponse listCccUpgradeSchedules(ListCccUpgradeSchedulesRequest request)

Description copied from interface: ComputeCloudAtCustomer

Returns a list of Compute Cloud@Customer upgrade schedules.

Specified by:

listCccUpgradeSchedules in interface ComputeCloudAtCustomer

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateCccInfrastructure

public UpdateCccInfrastructureResponse updateCccInfrastructure(UpdateCccInfrastructureRequest request)

Description copied from interface: ComputeCloudAtCustomer

Updates Compute Cloud@Customer infrastructure resource.

Specified by:

updateCccInfrastructure in interface ComputeCloudAtCustomer

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateCccUpgradeSchedule

public UpdateCccUpgradeScheduleResponse updateCccUpgradeSchedule(UpdateCccUpgradeScheduleRequest request)

Description copied from interface: ComputeCloudAtCustomer

Updates the Compute Cloud@Customer upgrade schedule.

Specified by:

updateCccUpgradeSchedule in interface ComputeCloudAtCustomer

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWaiters

public ComputeCloudAtCustomerWaiters getWaiters()

Description copied from interface: ComputeCloudAtCustomer

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

Specified by:

getWaiters in interface ComputeCloudAtCustomer

Returns:

The service waiters.

getPaginators

public ComputeCloudAtCustomerPaginators getPaginators()

Description copied from interface: ComputeCloudAtCustomer

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 ComputeCloudAtCustomer

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