Class RoverNodeClient

Service client instance for RoverNode.

Inheritance

object

ClientBase

RegionalClientBase

RoverNodeClient

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 RoverNodeClient : RegionalClientBase, IDisposable

Constructors

RoverNodeClient(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 RoverNodeClient(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 RoverNodePaginators Paginators { get; }

Property Value

Type	Description
RoverNodePaginators

Waiters

Declaration

public RoverNodeWaiters Waiters { get; }

Property Value

Type	Description
RoverNodeWaiters

Methods

ChangeRoverNodeCompartment(ChangeRoverNodeCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves a rover node into a different compartment.

Declaration

public Task<ChangeRoverNodeCompartmentResponse> ChangeRoverNodeCompartment(ChangeRoverNodeCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

CreateRoverNode(CreateRoverNodeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new RoverNode.

Declaration

public Task<CreateRoverNodeResponse> CreateRoverNode(CreateRoverNodeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

DeleteRoverNode(DeleteRoverNodeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes a RoverNode resource by identifier

Declaration

public Task<DeleteRoverNodeResponse> DeleteRoverNode(DeleteRoverNodeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

GetRoverNode(GetRoverNodeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a RoverNode by identifier.

Declaration

public Task<GetRoverNodeResponse> GetRoverNode(GetRoverNodeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

GetRoverNodeCertificate(GetRoverNodeCertificateRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get the certificate for a rover node

Declaration

public Task<GetRoverNodeCertificateResponse> GetRoverNodeCertificate(GetRoverNodeCertificateRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

GetRoverNodeEncryptionKey(GetRoverNodeEncryptionKeyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get the data encryption key for a rover node.

Declaration

public Task<GetRoverNodeEncryptionKeyResponse> GetRoverNodeEncryptionKey(GetRoverNodeEncryptionKeyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

GetRoverNodeGetRpt(GetRoverNodeGetRptRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get the resource principal token for a rover node

Declaration

public Task<GetRoverNodeGetRptResponse> GetRoverNodeGetRpt(GetRoverNodeGetRptRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

ListRoverNodes(ListRoverNodesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns a list of RoverNodes.

Declaration

public Task<ListRoverNodesResponse> ListRoverNodes(ListRoverNodesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

RoverNodeActionRetrieveCaBundle(RoverNodeActionRetrieveCaBundleRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieve Ca Bundle for a rover node

Declaration

public Task<RoverNodeActionRetrieveCaBundleResponse> RoverNodeActionRetrieveCaBundle(RoverNodeActionRetrieveCaBundleRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

RoverNodeActionSetKey(RoverNodeActionSetKeyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get the resource principal public key for a rover node

Declaration

public Task<RoverNodeActionSetKeyResponse> RoverNodeActionSetKey(RoverNodeActionSetKeyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

RoverNodeGenerateCertificate(RoverNodeGenerateCertificateRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Request to generate certificate for a roverNode.

Declaration

public Task<RoverNodeGenerateCertificateResponse> RoverNodeGenerateCertificate(RoverNodeGenerateCertificateRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

RoverNodeRenewCertificate(RoverNodeRenewCertificateRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Request to renew certificate for a roverNode.

Declaration

public Task<RoverNodeRenewCertificateResponse> RoverNodeRenewCertificate(RoverNodeRenewCertificateRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

RoverNodeReplaceCertificateAuthority(RoverNodeReplaceCertificateAuthorityRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Request to replace certificate authority for a roverNode.

Declaration

public Task<RoverNodeReplaceCertificateAuthorityResponse> RoverNodeReplaceCertificateAuthority(RoverNodeReplaceCertificateAuthorityRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

RoverNodeRetrieveLeafCertificate(RoverNodeRetrieveLeafCertificateRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieve the leaf certificate info for a rover node

Declaration

public Task<RoverNodeRetrieveLeafCertificateResponse> RoverNodeRetrieveLeafCertificate(RoverNodeRetrieveLeafCertificateRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

UpdateRoverNode(UpdateRoverNodeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the RoverNode

Declaration

public Task<UpdateRoverNodeResponse> UpdateRoverNode(UpdateRoverNodeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

Implements

IDisposable