Package com.oracle.bmc.ocvp

Class DatastoreClusterClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

com.oracle.bmc.ocvp.DatastoreClusterClient

All Implemented Interfaces:

DatastoreCluster, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20230701")
public class DatastoreClusterClient
extends BaseSyncClient
implements DatastoreCluster

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DatastoreClusterClient.Builder	Builder class for this client.

Field Summary

Fields

Modifier and Type	Field	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 DatastoreCluster.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
AddDatastoreToDatastoreClusterResponse	addDatastoreToDatastoreCluster(AddDatastoreToDatastoreClusterRequest request)	Add the specified Datastore to the provided Datastore Cluster.
AttachDatastoreClusterToClusterResponse	attachDatastoreClusterToCluster(AttachDatastoreClusterToClusterRequest request)	Attach the specified Datastore Cluster to the provided Vmware Cluster.
AttachDatastoreClusterToEsxiHostResponse	attachDatastoreClusterToEsxiHost(AttachDatastoreClusterToEsxiHostRequest request)	Attach the specified Datastore Cluster to the provided ESXi Hosts.
static DatastoreClusterClient.Builder	builder()	Create a builder for this client.
ChangeDatastoreClusterCompartmentResponse	changeDatastoreClusterCompartment(ChangeDatastoreClusterCompartmentRequest request)	Moves an Datastore Cluster into a different compartment within the same tenancy.
void	close()
CreateDatastoreClusterResponse	createDatastoreCluster(CreateDatastoreClusterRequest request)	Creates a Oracle Cloud VMware Solution Datastore Cluster.
DeleteDatastoreClusterResponse	deleteDatastoreCluster(DeleteDatastoreClusterRequest request)	Deletes the specified Datastore Cluster.
DetachDatastoreClusterFromClusterResponse	detachDatastoreClusterFromCluster(DetachDatastoreClusterFromClusterRequest request)	Detach the specified Datastore Cluster from the provided Vmware Cluster.
DetachDatastoreClusterFromEsxiHostResponse	detachDatastoreClusterFromEsxiHost(DetachDatastoreClusterFromEsxiHostRequest request)	Detach the specified Datastore Cluster from the provided ESXi Hosts.
String	getClientCommonLibraryVersion()
GetDatastoreClusterResponse	getDatastoreCluster(GetDatastoreClusterRequest request)	Get the specified Datastore Cluster information.
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
DatastoreClusterPaginators	getPaginators()	Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
DatastoreClusterWaiters	getWaiters()	Gets the pre-configured waiters available for resources for this service.
ListDatastoreClustersResponse	listDatastoreClusters(ListDatastoreClustersRequest request)	List the Datastore Clusters in the specified compartment.
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.
RemoveDatastoreFromDatastoreClusterResponse	removeDatastoreFromDatastoreCluster(RemoveDatastoreFromDatastoreClusterRequest request)	Remove the specified Datastore from the provided Datastore Cluster.
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.
UpdateDatastoreClusterResponse	updateDatastoreCluster(UpdateDatastoreClusterRequest request)	Updates the specified Datastore Cluster.
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 java.lang.AutoCloseable

close

Methods inherited from interface com.oracle.bmc.ocvp.DatastoreCluster

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Field Detail

SERVICE

public static final Service SERVICE

Service instance for DatastoreCluster.

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

DatastoreClusterClient

@Deprecated
public DatastoreClusterClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

DatastoreClusterClient

@Deprecated
public DatastoreClusterClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                              ClientConfiguration configuration)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

DatastoreClusterClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

DatastoreClusterClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

DatastoreClusterClient

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

DatastoreClusterClient

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

DatastoreClusterClient

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

DatastoreClusterClient

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

Method Detail

builder

public static DatastoreClusterClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: DatastoreCluster

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 DatastoreCluster

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: DatastoreCluster

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 DatastoreCluster

Parameters:

regionId - The public region ID.

addDatastoreToDatastoreCluster

public AddDatastoreToDatastoreClusterResponse addDatastoreToDatastoreCluster(AddDatastoreToDatastoreClusterRequest request)

Description copied from interface: DatastoreCluster

Add the specified Datastore to the provided Datastore Cluster.

Specified by:

addDatastoreToDatastoreCluster in interface DatastoreCluster

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

attachDatastoreClusterToCluster

public AttachDatastoreClusterToClusterResponse attachDatastoreClusterToCluster(AttachDatastoreClusterToClusterRequest request)

Description copied from interface: DatastoreCluster

Attach the specified Datastore Cluster to the provided Vmware Cluster.

Use the WorkRequest operations to track the attachment of the Datastore.

Specified by:

attachDatastoreClusterToCluster in interface DatastoreCluster

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

attachDatastoreClusterToEsxiHost

public AttachDatastoreClusterToEsxiHostResponse attachDatastoreClusterToEsxiHost(AttachDatastoreClusterToEsxiHostRequest request)

Description copied from interface: DatastoreCluster

Attach the specified Datastore Cluster to the provided ESXi Hosts.

Use the WorkRequest operations to track the attachment of the Datastore.

Specified by:

attachDatastoreClusterToEsxiHost in interface DatastoreCluster

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

changeDatastoreClusterCompartment

public ChangeDatastoreClusterCompartmentResponse changeDatastoreClusterCompartment(ChangeDatastoreClusterCompartmentRequest request)

Description copied from interface: DatastoreCluster

Moves an Datastore Cluster into a different compartment within the same tenancy.

For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Specified by:

changeDatastoreClusterCompartment in interface DatastoreCluster

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createDatastoreCluster

public CreateDatastoreClusterResponse createDatastoreCluster(CreateDatastoreClusterRequest request)

Description copied from interface: DatastoreCluster

Creates a Oracle Cloud VMware Solution Datastore Cluster.

Specified by:

createDatastoreCluster in interface DatastoreCluster

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteDatastoreCluster

public DeleteDatastoreClusterResponse deleteDatastoreCluster(DeleteDatastoreClusterRequest request)

Description copied from interface: DatastoreCluster

Deletes the specified Datastore Cluster.

Specified by:

deleteDatastoreCluster in interface DatastoreCluster

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

detachDatastoreClusterFromCluster

public DetachDatastoreClusterFromClusterResponse detachDatastoreClusterFromCluster(DetachDatastoreClusterFromClusterRequest request)

Description copied from interface: DatastoreCluster

Detach the specified Datastore Cluster from the provided Vmware Cluster.

Use the WorkRequest operations to track the detachment of the Datastore.

Specified by:

detachDatastoreClusterFromCluster in interface DatastoreCluster

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

detachDatastoreClusterFromEsxiHost

public DetachDatastoreClusterFromEsxiHostResponse detachDatastoreClusterFromEsxiHost(DetachDatastoreClusterFromEsxiHostRequest request)

Description copied from interface: DatastoreCluster

Detach the specified Datastore Cluster from the provided ESXi Hosts.

Use the WorkRequest operations to track the detachment of the Datastore.

Specified by:

detachDatastoreClusterFromEsxiHost in interface DatastoreCluster

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getDatastoreCluster

public GetDatastoreClusterResponse getDatastoreCluster(GetDatastoreClusterRequest request)

Description copied from interface: DatastoreCluster

Get the specified Datastore Cluster information.

Specified by:

getDatastoreCluster in interface DatastoreCluster

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listDatastoreClusters

public ListDatastoreClustersResponse listDatastoreClusters(ListDatastoreClustersRequest request)

Description copied from interface: DatastoreCluster

List the Datastore Clusters in the specified compartment.

The list can be filtered by compartment, Datastore Cluster, Display name and Lifecycle state

Specified by:

listDatastoreClusters in interface DatastoreCluster

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

removeDatastoreFromDatastoreCluster

public RemoveDatastoreFromDatastoreClusterResponse removeDatastoreFromDatastoreCluster(RemoveDatastoreFromDatastoreClusterRequest request)

Description copied from interface: DatastoreCluster

Remove the specified Datastore from the provided Datastore Cluster.

Specified by:

removeDatastoreFromDatastoreCluster in interface DatastoreCluster

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateDatastoreCluster

public UpdateDatastoreClusterResponse updateDatastoreCluster(UpdateDatastoreClusterRequest request)

Description copied from interface: DatastoreCluster

Updates the specified Datastore Cluster.

*Important:** Updating a Datastore Cluster affects only certain attributes in the `Datastore Cluster` object and does not affect the VMware environment currently running.

Specified by:

updateDatastoreCluster in interface DatastoreCluster

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWaiters

public DatastoreClusterWaiters getWaiters()

Description copied from interface: DatastoreCluster

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

Specified by:

getWaiters in interface DatastoreCluster

Returns:

The service waiters.

getPaginators

public DatastoreClusterPaginators getPaginators()

Description copied from interface: DatastoreCluster

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 DatastoreCluster

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