com.oracle.bmc.ocvp.EsxiHostAsync Maven / Gradle / Ivy
Show all versions of oci-java-sdk-shaded-full Show documentation
/**
* Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved.
* This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
*/
package com.oracle.bmc.ocvp;
import com.oracle.bmc.ocvp.requests.*;
import com.oracle.bmc.ocvp.responses.*;
/**
* Use the Oracle Cloud VMware API to create SDDCs and manage ESXi hosts and software. For more
* information, see [Oracle Cloud VMware
* Solution](https://docs.cloud.oracle.com/iaas/Content/VMware/Concepts/ocvsoverview.htm).
*/
@jakarta.annotation.Generated(value = "OracleSDKGenerator", comments = "API Version: 20230701")
public interface EsxiHostAsync extends AutoCloseable {
/** Rebuilds the client from scratch. Useful to refresh certificates. */
void refreshClient();
/**
* Sets the endpoint to call (ex, https://www.example.com).
*
* @param endpoint The endpoint of the serice.
*/
void setEndpoint(String endpoint);
/** Gets the set endpoint for REST call (ex, https://www.example.com) */
String getEndpoint();
/**
* Sets the region to call (ex, Region.US_PHOENIX_1).
*
* Note, this will call {@link #setEndpoint(String) setEndpoint} after resolving the
* endpoint. If the service is not available in this region, however, an
* IllegalArgumentException will be raised.
*
* @param region The region of the service.
*/
void setRegion(com.oracle.bmc.Region region);
/**
* 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 {@link
* #setRegion(Region) setRegion}.
*
*
If no known Region could be determined, it will create an endpoint based on the default
* endpoint format ({@link com.oracle.bmc.Region#formatDefaultRegionEndpoint(Service, String)}
* and then call {@link #setEndpoint(String) setEndpoint}.
*
* @param regionId The public region ID.
*/
void setRegion(String regionId);
/**
* 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"
*
* @param realmSpecificEndpointTemplateEnabled flag to enable the use of realm specific endpoint
* template
*/
void useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled);
/**
* Adds another ESXi host to an existing SDDC. The attributes of the specified `Sddc` determine
* the VMware software and other configuration settings used by the ESXi host.
*
*
Use the {@link WorkRequest} operations to track the creation of the ESXi host.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return A Future that can be used to get the response if no AsyncHandler was provided. Note,
* if you provide an AsyncHandler and use the Future, some types of responses (like
* java.io.InputStream) may not be able to be read in both places as the underlying stream
* may only be consumed once.
*/
java.util.concurrent.Future createEsxiHost(
CreateEsxiHostRequest request,
com.oracle.bmc.responses.AsyncHandler
handler);
/**
* Deletes the specified ESXi host. Before deleting the host, back up or migrate any VMware
* workloads running on it.
*
* When you delete an ESXi host, Oracle does not remove the node configuration within the
* VMware environment itself. That is your responsibility.
*
*
*Note:** If you delete EXSi hosts from the SDDC to total less than 3, you are still billed
* for the 3 minimum recommended EXSi hosts. Also, you cannot add more VMware workloads to the
* SDDC until it again has at least 3 ESXi hosts.
*
*
Use the {@link WorkRequest} operations to track the deletion of the ESXi host.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return A Future that can be used to get the response if no AsyncHandler was provided. Note,
* if you provide an AsyncHandler and use the Future, some types of responses (like
* java.io.InputStream) may not be able to be read in both places as the underlying stream
* may only be consumed once.
*/
java.util.concurrent.Future deleteEsxiHost(
DeleteEsxiHostRequest request,
com.oracle.bmc.responses.AsyncHandler
handler);
/**
* Gets the specified ESXi host's information.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return A Future that can be used to get the response if no AsyncHandler was provided. Note,
* if you provide an AsyncHandler and use the Future, some types of responses (like
* java.io.InputStream) may not be able to be read in both places as the underlying stream
* may only be consumed once.
*/
java.util.concurrent.Future getEsxiHost(
GetEsxiHostRequest request,
com.oracle.bmc.responses.AsyncHandler handler);
/**
* In-place upgrade a ESXi host.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return A Future that can be used to get the response if no AsyncHandler was provided. Note,
* if you provide an AsyncHandler and use the Future, some types of responses (like
* java.io.InputStream) may not be able to be read in both places as the underlying stream
* may only be consumed once.
*/
java.util.concurrent.Future inplaceUpgrade(
InplaceUpgradeRequest request,
com.oracle.bmc.responses.AsyncHandler
handler);
/**
* Lists the ESXi hosts in the specified SDDC. The list can be filtered by Compute instance OCID
* or ESXi display name.
*
* Remember that in terms of implementation, an ESXi host is a Compute instance that is
* configured with the chosen bundle of VMware software. Each `EsxiHost` object has its own OCID
* (`id`), and a separate attribute for the OCID of the Compute instance (`computeInstanceId`).
* When filtering the list of ESXi hosts, you can specify the OCID of the Compute instance, not
* the ESXi host OCID.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return A Future that can be used to get the response if no AsyncHandler was provided. Note,
* if you provide an AsyncHandler and use the Future, some types of responses (like
* java.io.InputStream) may not be able to be read in both places as the underlying stream
* may only be consumed once.
*/
java.util.concurrent.Future listEsxiHosts(
ListEsxiHostsRequest request,
com.oracle.bmc.responses.AsyncHandler
handler);
/**
* Replace a faulty ESXi host whose underlying bare metal is broken
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return A Future that can be used to get the response if no AsyncHandler was provided. Note,
* if you provide an AsyncHandler and use the Future, some types of responses (like
* java.io.InputStream) may not be able to be read in both places as the underlying stream
* may only be consumed once.
*/
java.util.concurrent.Future replaceHost(
ReplaceHostRequest request,
com.oracle.bmc.responses.AsyncHandler handler);
/**
* Swap billing between two Active ESXi hosts.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return A Future that can be used to get the response if no AsyncHandler was provided. Note,
* if you provide an AsyncHandler and use the Future, some types of responses (like
* java.io.InputStream) may not be able to be read in both places as the underlying stream
* may only be consumed once.
*/
java.util.concurrent.Future swapBilling(
SwapBillingRequest request,
com.oracle.bmc.responses.AsyncHandler handler);
/**
* Updates the specified ESXi host.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return A Future that can be used to get the response if no AsyncHandler was provided. Note,
* if you provide an AsyncHandler and use the Future, some types of responses (like
* java.io.InputStream) may not be able to be read in both places as the underlying stream
* may only be consumed once.
*/
java.util.concurrent.Future updateEsxiHost(
UpdateEsxiHostRequest request,
com.oracle.bmc.responses.AsyncHandler
handler);
}