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 classDatastoreClusterClient.BuilderBuilder class for this client.
-
Field Summary
Fields Modifier and Type Field Description StringclientCommonLibraryVersionCompatible SDK version, provided by the codegen.Optional<String>minimumClientCommonLibraryVersionFromClientMinimum compatible SDK version, maybe provided by the codegen.static ServiceSERVICEService instance for DatastoreCluster.
-
Constructor Summary
Constructors Constructor Description DatastoreClusterClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)Deprecated.Use thebuilderinstead.DatastoreClusterClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)Deprecated.Use thebuilderinstead.DatastoreClusterClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.DatastoreClusterClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.DatastoreClusterClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)Deprecated.Use thebuilderinstead.DatastoreClusterClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)Deprecated.Use thebuilderinstead.DatastoreClusterClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)Deprecated.Use thebuilderinstead.DatastoreClusterClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)Deprecated.Use thebuilderinstead.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description AddDatastoreToDatastoreClusterResponseaddDatastoreToDatastoreCluster(AddDatastoreToDatastoreClusterRequest request)Add the specified Datastore to the provided Datastore Cluster.AttachDatastoreClusterToClusterResponseattachDatastoreClusterToCluster(AttachDatastoreClusterToClusterRequest request)Attach the specified Datastore Cluster to the provided Vmware Cluster.AttachDatastoreClusterToEsxiHostResponseattachDatastoreClusterToEsxiHost(AttachDatastoreClusterToEsxiHostRequest request)Attach the specified Datastore Cluster to the provided ESXi Hosts.static DatastoreClusterClient.Builderbuilder()Create a builder for this client.ChangeDatastoreClusterCompartmentResponsechangeDatastoreClusterCompartment(ChangeDatastoreClusterCompartmentRequest request)Moves an Datastore Cluster into a different compartment within the same tenancy.voidclose()CreateDatastoreClusterResponsecreateDatastoreCluster(CreateDatastoreClusterRequest request)Creates a Oracle Cloud VMware Solution Datastore Cluster.DeleteDatastoreClusterResponsedeleteDatastoreCluster(DeleteDatastoreClusterRequest request)Deletes the specified Datastore Cluster.DetachDatastoreClusterFromClusterResponsedetachDatastoreClusterFromCluster(DetachDatastoreClusterFromClusterRequest request)Detach the specified Datastore Cluster from the provided Vmware Cluster.DetachDatastoreClusterFromEsxiHostResponsedetachDatastoreClusterFromEsxiHost(DetachDatastoreClusterFromEsxiHostRequest request)Detach the specified Datastore Cluster from the provided ESXi Hosts.voidenableDualStackEndpoints(boolean enableDualStackEndpoints)This method should be used to enable or disable the use of dual-stack endpoints.StringgetClientCommonLibraryVersion()GetDatastoreClusterResponsegetDatastoreCluster(GetDatastoreClusterRequest request)Get the specified Datastore Cluster information.protected ClientConfiguratorgetDefaultConfigurator()StringgetEndpoint()Get the endpoint of the client.Optional<String>getMinimumClientCommonLibraryVersionFromClient()Map<String,Boolean>getOptionsMap()Return an immutable snapshot representing the current options set for this client.DatastoreClusterPaginatorsgetPaginators()Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.StringgetResolvedEndpoint(Map<String,Object> requiredParametersMap)Returns the endpoint after filling in the current options, as determined byBaseClient.getOptionsMap(), and then filling in the required parameters in requiredParametersMap into the placeholders in the endpoint.DatastoreClusterWaitersgetWaiters()Gets the pre-configured waiters available for resources for this service.ListDatastoreClustersResponselistDatastoreClusters(ListDatastoreClustersRequest request)List the Datastore Clusters in the specified compartment.voidrefreshClient()Rebuild the backingHttpClient.RemoveDatastoreFromDatastoreClusterResponseremoveDatastoreFromDatastoreCluster(RemoveDatastoreFromDatastoreClusterRequest request)Remove the specified Datastore from the provided Datastore Cluster.voidsetEndpoint(String endpoint)voidsetRegion(Region region)Sets the region to call (ex, Region.US_PHOENIX_1).voidsetRegion(String regionId)Sets the region to call (ex, ‘us-phoenix-1’).UpdateDatastoreClusterResponseupdateDatastoreCluster(UpdateDatastoreClusterRequest request)Updates the specified Datastore Cluster.voiduseRealmSpecificEndpointTemplate(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
-
-
-
-
Constructor Detail
-
DatastoreClusterClient
@Deprecated public DatastoreClusterClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeDatastoreClusterClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
-
DatastoreClusterClient
@Deprecated public DatastoreClusterClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeDatastoreClusterClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configuration
-
DatastoreClusterClient
@Deprecated public DatastoreClusterClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeDatastoreClusterClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
-
DatastoreClusterClient
@Deprecated public DatastoreClusterClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeDatastoreClusterClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-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 thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeDatastoreClusterClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfigurators
-
DatastoreClusterClient
@Deprecated public DatastoreClusterClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeDatastoreClusterClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfiguratorsendpoint-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 thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeDatastoreClusterClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfiguratorsendpoint-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 thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeDatastoreClusterClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfiguratorsendpoint-ClientBuilderBase.endpoint(java.lang.String)signingStrategyRequestSignerFactories-ClientBuilderBase.signingStrategyRequestSignerFactoriesexecutorService-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:DatastoreClusterSets the region to call (ex, Region.US_PHOENIX_1).Note, this will call
setEndpointafter resolving the endpoint. If the service is not available in this Region, however, an IllegalArgumentException will be raised.- Specified by:
setRegionin interfaceDatastoreCluster- Parameters:
region- The region of the service.
-
setRegion
public void setRegion(String regionId)
Description copied from interface:DatastoreClusterSets 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 callsetEndpoint.- Specified by:
setRegionin interfaceDatastoreCluster- Parameters:
regionId- The public region ID.
-
addDatastoreToDatastoreCluster
public AddDatastoreToDatastoreClusterResponse addDatastoreToDatastoreCluster(AddDatastoreToDatastoreClusterRequest request)
Description copied from interface:DatastoreClusterAdd the specified Datastore to the provided Datastore Cluster.- Specified by:
addDatastoreToDatastoreClusterin interfaceDatastoreCluster- 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:DatastoreClusterAttach the specified Datastore Cluster to the provided Vmware Cluster.Use the
WorkRequestoperations to track the attachment of the Datastore.- Specified by:
attachDatastoreClusterToClusterin interfaceDatastoreCluster- 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:DatastoreClusterAttach the specified Datastore Cluster to the provided ESXi Hosts.Use the
WorkRequestoperations to track the attachment of the Datastore.- Specified by:
attachDatastoreClusterToEsxiHostin interfaceDatastoreCluster- 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:DatastoreClusterMoves 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:
changeDatastoreClusterCompartmentin interfaceDatastoreCluster- 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:DatastoreClusterCreates a Oracle Cloud VMware Solution Datastore Cluster.- Specified by:
createDatastoreClusterin interfaceDatastoreCluster- 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:DatastoreClusterDeletes the specified Datastore Cluster.- Specified by:
deleteDatastoreClusterin interfaceDatastoreCluster- 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:DatastoreClusterDetach the specified Datastore Cluster from the provided Vmware Cluster.Use the
WorkRequestoperations to track the detachment of the Datastore.- Specified by:
detachDatastoreClusterFromClusterin interfaceDatastoreCluster- 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:DatastoreClusterDetach the specified Datastore Cluster from the provided ESXi Hosts.Use the
WorkRequestoperations to track the detachment of the Datastore.- Specified by:
detachDatastoreClusterFromEsxiHostin interfaceDatastoreCluster- 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:DatastoreClusterGet the specified Datastore Cluster information.- Specified by:
getDatastoreClusterin interfaceDatastoreCluster- 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:DatastoreClusterList the Datastore Clusters in the specified compartment.The list can be filtered by compartment, Datastore Cluster, Display name and Lifecycle state
- Specified by:
listDatastoreClustersin interfaceDatastoreCluster- 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:DatastoreClusterRemove the specified Datastore from the provided Datastore Cluster.- Specified by:
removeDatastoreFromDatastoreClusterin interfaceDatastoreCluster- 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:DatastoreClusterUpdates 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:
updateDatastoreClusterin interfaceDatastoreCluster- 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:DatastoreClusterGets the pre-configured waiters available for resources for this service.- Specified by:
getWaitersin interfaceDatastoreCluster- Returns:
- The service waiters.
-
getPaginators
public DatastoreClusterPaginators getPaginators()
Description copied from interface:DatastoreClusterGets the pre-configured paginators available for list operations in this service which may return multiple pages of data.These paginators provide an
Iterableinterface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.- Specified by:
getPaginatorsin interfaceDatastoreCluster- Returns:
- The service paginators.
-
getDefaultConfigurator
protected ClientConfigurator getDefaultConfigurator()
-
enableDualStackEndpoints
public void enableDualStackEndpoints(boolean enableDualStackEndpoints)
This method should be used to enable or disable the use of dual-stack endpoints.The default value is false i.e. dual-stack endpoints are disabled by default.
- Parameters:
enableDualStackEndpoints- This flag can be set to true or false to enable or disable the use of dual-stack endpoints respectively
-
getOptionsMap
public Map<String,Boolean> getOptionsMap()
Return an immutable snapshot representing the current options set for this client.- Returns:
- immutable snapshot representing the current options set for this client
-
getResolvedEndpoint
public String getResolvedEndpoint(Map<String,Object> requiredParametersMap)
Returns the endpoint after filling in the current options, as determined byBaseClient.getOptionsMap(), and then filling in the required parameters in requiredParametersMap into the placeholders in the endpoint.- Parameters:
requiredParametersMap- the map from required parameter name to their values- Returns:
- resolved endpoint, with all options and placeholders filled in
-
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
-
setEndpoint
public final void setEndpoint(String endpoint)
-
getEndpoint
public final String getEndpoint()
Get the endpoint of the client.Note that the endpoint may be parameterized and contain placeholders and options. The region subdomain and realm domain will have been properly replaced already if the endpoint was selected using a
Region.Examples of endpoints this may return:
- Unparameterized endpoints
https://identity.us-phoenix-1.oci.oraclecloud.com https://identity.us-ashburn-1.oci.oraclecloud.com https://test-namespace.objectstorage.us-ashburn-1.oci.customer-oci.com - Parameterized endpoints with placeholders
https://{namespaceName+Dot}objectstorage.us-phoenix-1.oci.customer-oci.com https://{namespaceName+Dot}objectstorage.us-ashburn-1.oci.customer-oci.com - Parameterized endpoints with options
https://{dualStack?ds.:}identity.us-phoenix-1.oci.oraclecloud.com https://{dualStack?ds.:}identity.us-ashburn-1.oci.oraclecloud.com - Parameterized endpoints with placeholders and options
https://{namespaceName+Dot}{dualStack?ds.:}objectstorage.us-phoenix-1.oci.customer-oci.com https://{namespaceName+Dot}{dualStack?ds.:}objectstorage.us-ashburn-1.oci.customer-oci.com
To get the actual endpoint for a parameterized request, you can use
BaseClient.getResolvedEndpoint(Map)orParameterizedEndpointUtil.getEndpointWithPopulatedServiceParameters(String, Map, Map).- Returns:
- the endpoint being used by the client
- Unparameterized endpoints
-
refreshClient
public final void refreshClient()
Rebuild the backingHttpClient.This will call
ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.
-
close
public final void close()
- Specified by:
closein interfaceAutoCloseable
-
getClientCommonLibraryVersion
public String getClientCommonLibraryVersion()
-
-