EsxiHostClient (Oracle Cloud Infrastructure Java SDK

java.lang.Object
- com.oracle.bmc.ocvp.EsxiHostClient

All Implemented Interfaces:: EsxiHost, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20200501")
public class EsxiHostClient
extends Object
implements EsxiHost

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class EsxiHostClient.Builder
Builder class for this client.

Nested Classes
Modifier and Type	Class and Description
`static class`	`EsxiHostClient.Builder` Builder class for this client.

Field Summary

Fields
Modifier and Type Field and Description

static Service SERVICE
Service instance for EsxiHost.

Fields
Modifier and Type	Field and Description
`static Service`	`SERVICE` Service instance for EsxiHost.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`EsxiHostClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)` Creates a new service instance using the given authentication provider and client configuration.
	`EsxiHostClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)` Creates a new service instance using the given authentication provider and client configuration.
	`EsxiHostClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)` Creates a new service instance using the given authentication provider and client configuration.
	`EsxiHostClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)` Creates a new service instance using the given authentication provider and client configuration.
	`EsxiHostClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)` Creates a new service instance using the given authentication provider and client configuration.
`protected`	`EsxiHostClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService, com.oracle.bmc.http.internal.RestClientFactoryBuilder restClientFactoryBuilder)` Creates a new service instance using the given authentication provider and client configuration.
	`EsxiHostClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)` Creates a new service instance using the given authentication provider.
	`EsxiHostClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)` Creates a new service instance using the given authentication provider and client configuration.
	`EsxiHostClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)` Creates a new service instance using the given authentication provider and client configuration.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static EsxiHostClient.Builder`	`builder()` Create a builder for this client.
`void`	`close()`
`CreateEsxiHostResponse`	`createEsxiHost(CreateEsxiHostRequest request)` Adds another ESXi host to an existing SDDC.
`DeleteEsxiHostResponse`	`deleteEsxiHost(DeleteEsxiHostRequest request)` Deletes the specified ESXi host.
`String`	`getEndpoint()` Gets the set endpoint for REST call (ex, https://www.example.com)
`GetEsxiHostResponse`	`getEsxiHost(GetEsxiHostRequest request)` Gets the specified ESXi host’s information.
`EsxiHostPaginators`	`getPaginators()` Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
`EsxiHostWaiters`	`getWaiters()` Gets the pre-configured waiters available for resources for this service.
`ListEsxiHostsResponse`	`listEsxiHosts(ListEsxiHostsRequest request)` Lists the ESXi hosts in the specified SDDC.
`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’).
`UpdateEsxiHostResponse`	`updateEsxiHost(UpdateEsxiHostRequest request)` Updates the specified ESXi host.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - SERVICE
```
public static final Service SERVICE
```
    Service instance for EsxiHost.
- Constructor Detail
  - EsxiHostClient
```
public EsxiHostClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
```
    Creates a new service instance using the given authentication provider.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
  - EsxiHostClient
```
public EsxiHostClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                      ClientConfiguration configuration)
```
    Creates a new service instance using the given authentication provider and client configuration.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
  - EsxiHostClient
```
public EsxiHostClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                      ClientConfiguration configuration,
                      ClientConfigurator clientConfigurator)
```
    Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
    
    clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.
  - EsxiHostClient
```
public EsxiHostClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                      ClientConfiguration configuration,
                      ClientConfigurator clientConfigurator,
                      RequestSignerFactory defaultRequestSignerFactory)
```
    Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
    
    This is an advanced constructor for clients that want to take control over how requests are signed.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
    
    clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.
    
    defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.
  - EsxiHostClient
```
public EsxiHostClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                      ClientConfiguration configuration,
                      ClientConfigurator clientConfigurator,
                      RequestSignerFactory defaultRequestSignerFactory,
                      List<ClientConfigurator> additionalClientConfigurators)
```
    Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
    
    This is an advanced constructor for clients that want to take control over how requests are signed.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
    
    clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.
    
    defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.
    
    additionalClientConfigurators - Additional client configurators to be run after the primary configurator.
  - EsxiHostClient
```
public EsxiHostClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                      ClientConfiguration configuration,
                      ClientConfigurator clientConfigurator,
                      RequestSignerFactory defaultRequestSignerFactory,
                      List<ClientConfigurator> additionalClientConfigurators,
                      String endpoint)
```
    Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
    
    This is an advanced constructor for clients that want to take control over how requests are signed.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
    
    clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.
    
    defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.
    
    additionalClientConfigurators - Additional client configurators to be run after the primary configurator.
    
    endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)
  - EsxiHostClient
```
public EsxiHostClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                      ClientConfiguration configuration,
                      ClientConfigurator clientConfigurator,
                      RequestSignerFactory defaultRequestSignerFactory,
                      Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                      List<ClientConfigurator> additionalClientConfigurators,
                      String endpoint)
```
    Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
    
    This is an advanced constructor for clients that want to take control over how requests are signed.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
    
    clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.
    
    defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.
    
    signingStrategyRequestSignerFactories - The request signer factories for each signing strategy used to create the request signer
    
    additionalClientConfigurators - Additional client configurators to be run after the primary configurator.
    
    endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)
  - EsxiHostClient
```
public EsxiHostClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                      ClientConfiguration configuration,
                      ClientConfigurator clientConfigurator,
                      RequestSignerFactory defaultRequestSignerFactory,
                      Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                      List<ClientConfigurator> additionalClientConfigurators,
                      String endpoint,
                      ExecutorService executorService)
```
    Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
    
    This is an advanced constructor for clients that want to take control over how requests are signed.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
    
    clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.
    
    defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.
    
    signingStrategyRequestSignerFactories - The request signer factories for each signing strategy used to create the request signer
    
    additionalClientConfigurators - Additional client configurators to be run after the primary configurator.
    
    endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)
    
    executorService - ExecutorService used by the client, or null to use the default configured ThreadPoolExecutor
  - EsxiHostClient
```
protected EsxiHostClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                         ClientConfiguration configuration,
                         ClientConfigurator clientConfigurator,
                         RequestSignerFactory defaultRequestSignerFactory,
                         Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                         List<ClientConfigurator> additionalClientConfigurators,
                         String endpoint,
                         ExecutorService executorService,
                         com.oracle.bmc.http.internal.RestClientFactoryBuilder restClientFactoryBuilder)
```
    Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
    
    This is an advanced constructor for clients that want to take control over how requests are signed. Use the EsxiHostClient.Builder to get access to all these parameters.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
    
    clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.
    
    defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.
    
    signingStrategyRequestSignerFactories - The request signer factories for each signing strategy used to create the request signer
    
    additionalClientConfigurators - Additional client configurators to be run after the primary configurator.
    
    endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)
    
    executorService - ExecutorService used by the client, or null to use the default configured ThreadPoolExecutor
    
    restClientFactoryBuilder - the builder for the RestClientFactory
- Method Detail
  - builder
```
public static EsxiHostClient.Builder builder()
```
    Create a builder for this client.
    
    Returns:
    
    builder
  - setEndpoint
```
public void setEndpoint(String endpoint)
```
    Description copied from interface: EsxiHost
    
    Sets the endpoint to call (ex, https://www.example.com).
    
    Specified by:
    
    setEndpoint in interface EsxiHost
    
    Parameters:
    
    endpoint - The endpoint of the service.
  - getEndpoint
```
public String getEndpoint()
```
    Description copied from interface: EsxiHost
    
    Gets the set endpoint for REST call (ex, https://www.example.com)
    
    Specified by:
    
    getEndpoint in interface EsxiHost
  - setRegion
```
public void setRegion(Region region)
```
    Description copied from interface: EsxiHost
    
    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 EsxiHost
    
    Parameters:
    
    region - The region of the service.
  - setRegion
```
public void setRegion(String regionId)
```
    Description copied from interface: EsxiHost
    
    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 EsxiHost
    
    Parameters:
    
    regionId - The public region ID.
  - close
```
public void close()
```
    Specified by:
    
    close in interface AutoCloseable
  - createEsxiHost
```
public CreateEsxiHostResponse createEsxiHost(CreateEsxiHostRequest request)
```
    Description copied from interface: EsxiHost
    
    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 WorkRequest operations to track the creation of the ESXi host.
    
    Specified by:
    
    createEsxiHost in interface EsxiHost
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - deleteEsxiHost
```
public DeleteEsxiHostResponse deleteEsxiHost(DeleteEsxiHostRequest request)
```
    Description copied from interface: EsxiHost
    
    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 WorkRequest operations to track the deletion of the ESXi host.
    
    Specified by:
    
    deleteEsxiHost in interface EsxiHost
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getEsxiHost
```
public GetEsxiHostResponse getEsxiHost(GetEsxiHostRequest request)
```
    Description copied from interface: EsxiHost
    
    Gets the specified ESXi host’s information.
    
    Specified by:
    
    getEsxiHost in interface EsxiHost
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listEsxiHosts
```
public ListEsxiHostsResponse listEsxiHosts(ListEsxiHostsRequest request)
```
    Description copied from interface: EsxiHost
    
    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.
    
    Specified by:
    
    listEsxiHosts in interface EsxiHost
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - updateEsxiHost
```
public UpdateEsxiHostResponse updateEsxiHost(UpdateEsxiHostRequest request)
```
    Description copied from interface: EsxiHost
    
    Updates the specified ESXi host.
    
    Specified by:
    
    updateEsxiHost in interface EsxiHost
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getWaiters
```
public EsxiHostWaiters getWaiters()
```
    Description copied from interface: EsxiHost
    
    Gets the pre-configured waiters available for resources for this service.
    
    Specified by:
    
    getWaiters in interface EsxiHost
    
    Returns:
    
    The service waiters.
  - getPaginators
```
public EsxiHostPaginators getPaginators()
```
    Description copied from interface: EsxiHost
    
    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 EsxiHost
    
    Returns:
    
    The service paginators.

Class EsxiHostClient

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERVICE

Constructor Detail

EsxiHostClient

EsxiHostClient

EsxiHostClient

EsxiHostClient

EsxiHostClient

EsxiHostClient

EsxiHostClient

EsxiHostClient

EsxiHostClient

Method Detail

builder

setEndpoint

getEndpoint

setRegion

setRegion

close

createEsxiHost

deleteEsxiHost

getEsxiHost

listEsxiHosts

updateEsxiHost

getWaiters

getPaginators