Class RoverClusterClient

Service client instance for RoverCluster.

Inheritance

object

ClientBase

RegionalClientBase

RoverClusterClient

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

Assembly: OCI.DotNetSDK.Rover.dll

Syntax

public class RoverClusterClient : RegionalClientBase, IDisposable

Constructors

RoverClusterClient(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 RoverClusterClient(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 RoverClusterPaginators Paginators { get; }

Property Value

Type	Description
RoverClusterPaginators

Waiters

Declaration

public RoverClusterWaiters Waiters { get; }

Property Value

Type	Description
RoverClusterWaiters

Methods

ChangeRoverClusterCompartment(ChangeRoverClusterCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves a cluster into a different compartment.

Declaration

public Task<ChangeRoverClusterCompartmentResponse> ChangeRoverClusterCompartment(ChangeRoverClusterCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ChangeRoverClusterCompartmentRequest	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<ChangeRoverClusterCompartmentResponse>	A response object containing details about the completed operation

Examples

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

CreateRoverCluster(CreateRoverClusterRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new RoverCluster.

Declaration

public Task<CreateRoverClusterResponse> CreateRoverCluster(CreateRoverClusterRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateRoverClusterRequest	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<CreateRoverClusterResponse>	A response object containing details about the completed operation

Examples

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

DeleteRoverCluster(DeleteRoverClusterRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes a RoverCluster resource by identifier

Declaration

public Task<DeleteRoverClusterResponse> DeleteRoverCluster(DeleteRoverClusterRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteRoverClusterRequest	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<DeleteRoverClusterResponse>	A response object containing details about the completed operation

Examples

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

GetRoverCluster(GetRoverClusterRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a RoverCluster by identifier

Declaration

public Task<GetRoverClusterResponse> GetRoverCluster(GetRoverClusterRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetRoverClusterRequest	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<GetRoverClusterResponse>	A response object containing details about the completed operation

Examples

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

GetRoverClusterCertificate(GetRoverClusterCertificateRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get the certificate for a rover cluster

Declaration

public Task<GetRoverClusterCertificateResponse> GetRoverClusterCertificate(GetRoverClusterCertificateRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetRoverClusterCertificateRequest	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<GetRoverClusterCertificateResponse>	A response object containing details about the completed operation

Examples

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

ListRoverClusters(ListRoverClustersRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns a list of RoverClusters.

Declaration

public Task<ListRoverClustersResponse> ListRoverClusters(ListRoverClustersRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListRoverClustersRequest	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<ListRoverClustersResponse>	A response object containing details about the completed operation

Examples

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

RequestAdditionalNodes(RequestAdditionalNodesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Submit additional nodes request for a roverCluster.

Declaration

public Task<RequestAdditionalNodesResponse> RequestAdditionalNodes(RequestAdditionalNodesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
RequestAdditionalNodesRequest	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<RequestAdditionalNodesResponse>	A response object containing details about the completed operation

Examples

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

UpdateRoverCluster(UpdateRoverClusterRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the RoverCluster

Declaration

public Task<UpdateRoverClusterResponse> UpdateRoverCluster(UpdateRoverClusterRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateRoverClusterRequest	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<UpdateRoverClusterResponse>	A response object containing details about the completed operation

Examples

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

Implements

IDisposable