Class ClusterClient

Service client instance for Cluster.

Inheritance

object

ClientBase

RegionalClientBase

ClusterClient

Implements

IDisposable

Inherited Members

RegionalClientBase.logger

RegionalClientBase.SetRegion(Region)

RegionalClientBase.SetRegion(string)

RegionalClientBase.UseRealmSpecificEndpointTemplate(bool)

RegionalClientBase.PopulateServiceParametersInEndpointTemplate(RestClient, Dictionary<string, object>)

RegionalClientBase.parseEndpointForParameters(string)

ClientBase.restClient

ClientBase.service

ClientBase.userAgent

ClientBase.Dispose()

ClientBase.Dispose(bool)

ClientBase.SetEndpoint(string)

ClientBase.GetEndpoint()

ClientBase.GetUserAgent()

ClientBase.SetRealmSpecificEndpointTemplate(string)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.OcvpService

Assembly: OCI.DotNetSDK.Ocvp.dll

Syntax

public class ClusterClient : RegionalClientBase, IDisposable

Constructors

ClusterClient(IBasicAuthenticationDetailsProvider, ClientConfiguration, string)

Creates a new service instance using the given authentication provider and/or client configuration and/or endpoint. A client configuration can also be provided optionally to adjust REST client behaviors.

Declaration

public ClusterClient(IBasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration clientConfiguration = null, string endpoint = null)

Parameters

Type	Name	Description
IBasicAuthenticationDetailsProvider	authenticationDetailsProvider	The authentication details provider. Required.
ClientConfiguration	clientConfiguration	The client configuration that contains settings to adjust REST client behaviors. Optional.
string	endpoint	The endpoint of the service. If not provided and the client is a regional client, the endpoint will be constructed based on region information. Optional.

Properties

Paginators

Declaration

public ClusterPaginators Paginators { get; }

Property Value

Type	Description
ClusterPaginators

Waiters

Declaration

public ClusterWaiters Waiters { get; }

Property Value

Type	Description
ClusterWaiters

Methods

CreateCluster(CreateClusterRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Create a vSphere Cluster in software-defined data center (SDDC). <br/> Use the {@link WorkRequest} operations to track the creation of the Cluster. <br/> Important: You must configure the Cluster's networking resources with the security rules detailed in Security Rules for Oracle Cloud VMware Solution SDDCs. Otherwise, provisioning the SDDC will fail. The rules are based on the requirements set by VMware.

Declaration

public Task<CreateClusterResponse> CreateCluster(CreateClusterRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateClusterRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateClusterResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateCluster API.

DeleteCluster(DeleteClusterRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes the specified Cluster, along with the other resources that were created with the Cluster. For example: the Compute instances, DNS records, and so on. <br/> Use the {@link WorkRequest} operations to track the deletion of the Cluster.

Declaration

public Task<DeleteClusterResponse> DeleteCluster(DeleteClusterRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteClusterRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteClusterResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteCluster API.

GetCluster(GetClusterRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the specified Cluster's information.

Declaration

public Task<GetClusterResponse> GetCluster(GetClusterRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetClusterRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetClusterResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetCluster API.

ListClusters(ListClustersRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the Clusters in the specified compartment.

Declaration

public Task<ListClustersResponse> ListClusters(ListClustersRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListClustersRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListClustersResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListClusters API.

UpdateCluster(UpdateClusterRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the specified Cluster. <br/> Important: Updating a Cluster affects only certain attributes in the Cluster object and does not affect the VMware environment currently running in the Cluster.

Declaration

public Task<UpdateClusterResponse> UpdateCluster(UpdateClusterRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateClusterRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<UpdateClusterResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateCluster API.

Implements

IDisposable