Package com.oracle.bmc.ocvp

Interface DatastoreCluster

  • All Superinterfaces:
    AutoCloseable
    All Known Implementing Classes:
    DatastoreClusterClient
    @Generated(value="OracleSDKGenerator",
           comments="API Version: 20230701")
public interface DatastoreCluster
extends AutoCloseable
    Use the Oracle Cloud VMware API to create SDDCs and manage ESXi hosts and software.

    For more information, see Oracle Cloud VMware Solution.

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

      • addDatastoreToDatastoreCluster

        AddDatastoreToDatastoreClusterResponse addDatastoreToDatastoreCluster​(AddDatastoreToDatastoreClusterRequest request)
        Add the specified Datastore to the provided Datastore Cluster.
        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 <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/ocvp/AddDatastoreToDatastoreClusterExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use AddDatastoreToDatastoreCluster API.

      • attachDatastoreClusterToCluster

        AttachDatastoreClusterToClusterResponse attachDatastoreClusterToCluster​(AttachDatastoreClusterToClusterRequest request)
        Attach the specified Datastore Cluster to the provided Vmware Cluster.

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

        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 <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/ocvp/AttachDatastoreClusterToClusterExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use AttachDatastoreClusterToCluster API.

      • attachDatastoreClusterToEsxiHost

        AttachDatastoreClusterToEsxiHostResponse attachDatastoreClusterToEsxiHost​(AttachDatastoreClusterToEsxiHostRequest request)
        Attach the specified Datastore Cluster to the provided ESXi Hosts.

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

        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 <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/ocvp/AttachDatastoreClusterToEsxiHostExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use AttachDatastoreClusterToEsxiHost API.

      • changeDatastoreClusterCompartment

        ChangeDatastoreClusterCompartmentResponse changeDatastoreClusterCompartment​(ChangeDatastoreClusterCompartmentRequest request)
        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.

        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 <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/ocvp/ChangeDatastoreClusterCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeDatastoreClusterCompartment API.

      • createDatastoreCluster

        CreateDatastoreClusterResponse createDatastoreCluster​(CreateDatastoreClusterRequest request)
        Creates a Oracle Cloud VMware Solution Datastore Cluster.
        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 <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/ocvp/CreateDatastoreClusterExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateDatastoreCluster API.

      • deleteDatastoreCluster

        DeleteDatastoreClusterResponse deleteDatastoreCluster​(DeleteDatastoreClusterRequest request)
        Deletes the specified Datastore Cluster.
        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 <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/ocvp/DeleteDatastoreClusterExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteDatastoreCluster API.

      • detachDatastoreClusterFromCluster

        DetachDatastoreClusterFromClusterResponse detachDatastoreClusterFromCluster​(DetachDatastoreClusterFromClusterRequest request)
        Detach the specified Datastore Cluster from the provided Vmware Cluster.

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

        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 <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/ocvp/DetachDatastoreClusterFromClusterExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DetachDatastoreClusterFromCluster API.

      • detachDatastoreClusterFromEsxiHost

        DetachDatastoreClusterFromEsxiHostResponse detachDatastoreClusterFromEsxiHost​(DetachDatastoreClusterFromEsxiHostRequest request)
        Detach the specified Datastore Cluster from the provided ESXi Hosts.

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

        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 <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/ocvp/DetachDatastoreClusterFromEsxiHostExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DetachDatastoreClusterFromEsxiHost API.

      • getDatastoreCluster

        GetDatastoreClusterResponse getDatastoreCluster​(GetDatastoreClusterRequest request)
        Get the specified Datastore Cluster 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. 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 <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/ocvp/GetDatastoreClusterExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetDatastoreCluster API.

      • listDatastoreClusters

        ListDatastoreClustersResponse listDatastoreClusters​(ListDatastoreClustersRequest request)
        List the Datastore Clusters in the specified compartment.

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

        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 <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/ocvp/ListDatastoreClustersExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListDatastoreClusters API.

      • removeDatastoreFromDatastoreCluster

        RemoveDatastoreFromDatastoreClusterResponse removeDatastoreFromDatastoreCluster​(RemoveDatastoreFromDatastoreClusterRequest request)
        Remove the specified Datastore from the provided Datastore Cluster.
        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 <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/ocvp/RemoveDatastoreFromDatastoreClusterExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use RemoveDatastoreFromDatastoreCluster API.

      • updateDatastoreCluster

        UpdateDatastoreClusterResponse updateDatastoreCluster​(UpdateDatastoreClusterRequest request)
        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.

        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 <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/ocvp/UpdateDatastoreClusterExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateDatastoreCluster API.

      • getWaiters

        DatastoreClusterWaiters getWaiters()
        Gets the pre-configured waiters available for resources for this service.
        Returns:
        The service waiters.

      • getPaginators

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