ComputeCloudAtCustomer (Oracle Cloud Infrastructure Java SDK

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

ComputeCloudAtCustomerClient
```
@Generated(value="OracleSDKGenerator",
           comments="API Version: 20221208")
public interface ComputeCloudAtCustomer
extends AutoCloseable
```
Use the Compute Cloud@Customer API to manage Compute Cloud@Customer infrastructures and upgrade schedules. For more information see Compute Cloud@Customer documentation.

This service client uses CircuitBreakerUtils.DEFAULT_CIRCUIT_BREAKER for all the operations by default if no circuit breaker configuration is defined by the user.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`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.
`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`	`getEndpoint()` Gets the set endpoint for REST call (ex, https://www.example.com)
`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`	`refreshClient()` Rebuilds the client from scratch.
`void`	`setEndpoint(String endpoint)` Sets the endpoint to call (ex, https://www.example.com).
`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’).
`UpdateCccInfrastructureResponse`	`updateCccInfrastructure(UpdateCccInfrastructureRequest request)` Updates Compute Cloud@Customer infrastructure resource.
`UpdateCccUpgradeScheduleResponse`	`updateCccUpgradeSchedule(UpdateCccUpgradeScheduleRequest request)` Updates the Compute Cloud@Customer upgrade schedule.
`void`	`useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)` Determines whether realm specific endpoint should be used or not.

Methods inherited from interface java.lang.AutoCloseable
close

- Method Detail
  - refreshClient
```
void refreshClient()
```
    Rebuilds the client from scratch. Useful to refresh certificates.
  - setEndpoint
```
void setEndpoint(String endpoint)
```
    Sets the endpoint to call (ex, https://www.example.com).
    
    Parameters:
    
    endpoint - The endpoint of the service.
  - getEndpoint
```
String getEndpoint()
```
    Gets the set endpoint for REST call (ex, https://www.example.com)
  - setRegion
```
void setRegion(Region region)
```
    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.
    
    Parameters:
    
    region - The region of the service.
  - setRegion
```
void setRegion(String regionId)
```
    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.
    
    Parameters:
    
    regionId - The public region ID.
  - useRealmSpecificEndpointTemplate
```
void useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)
```
    Determines whether realm specific endpoint should be used or not. Set realmSpecificEndpointTemplateEnabled to “true” if the user wants to enable use of realm specific endpoint template, otherwise set it to “false”
    
    Parameters:
    
    realmSpecificEndpointTemplateEnabled - flag to enable the use of realm specific endpoint template
  - changeCccInfrastructureCompartment
```
ChangeCccInfrastructureCompartmentResponse changeCccInfrastructureCompartment(ChangeCccInfrastructureCompartmentRequest request)
```
    Moves a Compute Cloud@Customer infrastructure resource from one compartment to another.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use ChangeCccInfrastructureCompartment API.
  - changeCccUpgradeScheduleCompartment
```
ChangeCccUpgradeScheduleCompartmentResponse changeCccUpgradeScheduleCompartment(ChangeCccUpgradeScheduleCompartmentRequest request)
```
    Moves a Compute Cloud@Customer upgrade schedule from one compartment to another using the specified OCID.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use ChangeCccUpgradeScheduleCompartment API.
  - createCccInfrastructure
```
CreateCccInfrastructureResponse createCccInfrastructure(CreateCccInfrastructureRequest request)
```
    Creates a Compute Cloud@Customer infrastructure. Once created, Oracle Services must connect the rack in the data center to this Oracle Cloud Infrastructure resource.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use CreateCccInfrastructure API.
  - createCccUpgradeSchedule
```
CreateCccUpgradeScheduleResponse createCccUpgradeSchedule(CreateCccUpgradeScheduleRequest request)
```
    Creates a new Compute Cloud@Customer upgrade schedule.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use CreateCccUpgradeSchedule API.
  - deleteCccInfrastructure
```
DeleteCccInfrastructureResponse deleteCccInfrastructure(DeleteCccInfrastructureRequest request)
```
    Deletes a Compute Cloud@Customer infrastructure resource specified by the resource OCID.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use DeleteCccInfrastructure API.
  - deleteCccUpgradeSchedule
```
DeleteCccUpgradeScheduleResponse deleteCccUpgradeSchedule(DeleteCccUpgradeScheduleRequest request)
```
    Deletes a Compute Cloud@Customer upgrade schedule by the specified OCID.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use DeleteCccUpgradeSchedule API.
  - getCccInfrastructure
```
GetCccInfrastructureResponse getCccInfrastructure(GetCccInfrastructureRequest request)
```
    Gets a Compute Cloud@Customer infrastructure using the infrastructure OCID.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use GetCccInfrastructure API.
  - getCccUpgradeSchedule
```
GetCccUpgradeScheduleResponse getCccUpgradeSchedule(GetCccUpgradeScheduleRequest request)
```
    Gets a Compute Cloud@Customer upgrade schedule by the specified OCID.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use GetCccUpgradeSchedule API.
  - listCccInfrastructures
```
ListCccInfrastructuresResponse listCccInfrastructures(ListCccInfrastructuresRequest request)
```
    Returns a list of Compute Cloud@Customer infrastructures.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use ListCccInfrastructures API.
  - listCccUpgradeSchedules
```
ListCccUpgradeSchedulesResponse listCccUpgradeSchedules(ListCccUpgradeSchedulesRequest request)
```
    Returns a list of Compute Cloud@Customer upgrade schedules.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use ListCccUpgradeSchedules API.
  - updateCccInfrastructure
```
UpdateCccInfrastructureResponse updateCccInfrastructure(UpdateCccInfrastructureRequest request)
```
    Updates Compute Cloud@Customer infrastructure resource.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use UpdateCccInfrastructure API.
  - updateCccUpgradeSchedule
```
UpdateCccUpgradeScheduleResponse updateCccUpgradeSchedule(UpdateCccUpgradeScheduleRequest request)
```
    Updates the Compute Cloud@Customer upgrade schedule.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use UpdateCccUpgradeSchedule API.
  - getWaiters
```
ComputeCloudAtCustomerWaiters getWaiters()
```
    Gets the pre-configured waiters available for resources for this service.
    
    Returns:
    
    The service waiters.
  - getPaginators
```
ComputeCloudAtCustomerPaginators getPaginators()
```
    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.
    
    Returns:
    
    The service paginators.

Interface ComputeCloudAtCustomer

Method Summary

Methods inherited from interface java.lang.AutoCloseable

Method Detail

refreshClient

setEndpoint

getEndpoint

setRegion

setRegion

useRealmSpecificEndpointTemplate

changeCccInfrastructureCompartment

changeCccUpgradeScheduleCompartment

createCccInfrastructure

createCccUpgradeSchedule

deleteCccInfrastructure

deleteCccUpgradeSchedule

getCccInfrastructure

getCccUpgradeSchedule

listCccInfrastructures

listCccUpgradeSchedules

updateCccInfrastructure

updateCccUpgradeSchedule

getWaiters

getPaginators