com.oracle.bmc.ocvp

Interface Sddc

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

SddcClient

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20200501")
public interface Sddc
extends AutoCloseable

Use this API to manage the Oracle Cloud VMware Solution.

Method Summary

Modifier and Type	Method and Description
ChangeSddcCompartmentResponse	changeSddcCompartment(ChangeSddcCompartmentRequest request) Moves an SDDC into a different compartment within the same tenancy.
CreateSddcResponse	createSddc(CreateSddcRequest request) Creates a software-defined data center (SDDC).
DeleteSddcResponse	deleteSddc(DeleteSddcRequest request) Deletes the specified SDDC, along with the other resources that were created with the SDDC.
String	getEndpoint() Gets the set endpoint for REST call (ex, https://www.example.com)
SddcPaginators	getPaginators() Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
GetSddcResponse	getSddc(GetSddcRequest request) Gets the specified SDDC’s information.
SddcWaiters	getWaiters() Gets the pre-configured waiters available for resources for this service.
ListSddcsResponse	listSddcs(ListSddcsRequest request) Lists the SDDCs in the specified compartment.
ListSupportedVmwareSoftwareVersionsResponse	listSupportedVmwareSoftwareVersions(ListSupportedVmwareSoftwareVersionsRequest request) Lists the versions of bundled VMware software supported by the Oracle Cloud VMware Solution.
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’).
UpdateSddcResponse	updateSddc(UpdateSddcRequest request) Updates the specified SDDC.

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

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.

changeSddcCompartment

ChangeSddcCompartmentResponse changeSddcCompartment(ChangeSddcCompartmentRequest request)

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

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.

Example: Click here to see how to use ChangeSddcCompartment API.

createSddc

CreateSddcResponse createSddc(CreateSddcRequest request)

Creates a software-defined data center (SDDC).

Use the WorkRequest operations to track the creation of the SDDC.

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.

Example: Click here to see how to use CreateSddc API.

deleteSddc

DeleteSddcResponse deleteSddc(DeleteSddcRequest request)

Deletes the specified SDDC, along with the other resources that were created with the SDDC. For example: the Compute instances, DNS records, and so on.

Use the WorkRequest operations to track the deletion of the SDDC.

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.

Example: Click here to see how to use DeleteSddc API.

getSddc

GetSddcResponse getSddc(GetSddcRequest request)

Gets the specified SDDC’s information.

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.

Example: Click here to see how to use GetSddc API.

listSddcs

ListSddcsResponse listSddcs(ListSddcsRequest request)

Lists the SDDCs in the specified compartment. The list can be filtered by display name or availability domain.

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.

Example: Click here to see how to use ListSddcs API.

listSupportedVmwareSoftwareVersions

ListSupportedVmwareSoftwareVersionsResponse listSupportedVmwareSoftwareVersions(ListSupportedVmwareSoftwareVersionsRequest request)

Lists the versions of bundled VMware software supported by the Oracle Cloud VMware Solution.

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.

Example: Click here to see how to use ListSupportedVmwareSoftwareVersions API.

updateSddc

UpdateSddcResponse updateSddc(UpdateSddcRequest request)

Updates the specified SDDC.

Important:** Updating an SDDC affects only certain attributes in the `Sddc` object and does not affect the VMware environment currently running in the SDDC. For more information, see updateSddcDetails.

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.

Example: Click here to see how to use UpdateSddc API.

getWaiters

SddcWaiters getWaiters()

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

Returns:

The service waiters.

getPaginators

SddcPaginators 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.