Class RoverBundleClient
Service client instance for RoverBundle.
Implements
Inherited Members
Namespace: Oci.RoverService
Assembly: OCI.DotNetSDK.Rover.dll
Syntax
public class RoverBundleClient : RegionalClientBase, IDisposable
Constructors
RoverBundleClient(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 RoverBundleClient(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 RoverBundlePaginators Paginators { get; }
Property Value
Type | Description |
---|---|
RoverBundlePaginators |
Methods
ListRoverClusterRoverBundleRequests(ListRoverClusterRoverBundleRequestsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
List all the roverBundleRequests for a given roverClusterId.
Declaration
public Task<ListRoverClusterRoverBundleRequestsResponse> ListRoverClusterRoverBundleRequests(ListRoverClusterRoverBundleRequestsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListRoverClusterRoverBundleRequestsRequest | 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<ListRoverClusterRoverBundleRequestsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListRoverClusterRoverBundleRequests API.
ListRoverNodeRoverBundleRequests(ListRoverNodeRoverBundleRequestsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
List all the roverBundleRequests for a given roverNodeId.
Declaration
public Task<ListRoverNodeRoverBundleRequestsResponse> ListRoverNodeRoverBundleRequests(ListRoverNodeRoverBundleRequestsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListRoverNodeRoverBundleRequestsRequest | 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<ListRoverNodeRoverBundleRequestsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListRoverNodeRoverBundleRequests API.
RequestBundleRoverCluster(RequestBundleRoverClusterRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Request to get rover bundle to the bucket in customer's tenancy.
Declaration
public Task<RequestBundleRoverClusterResponse> RequestBundleRoverCluster(RequestBundleRoverClusterRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
RequestBundleRoverClusterRequest | 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<RequestBundleRoverClusterResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use RequestBundleRoverCluster API.
RequestBundleRoverNode(RequestBundleRoverNodeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Request to get rover bundle to the bucket in customer's tenancy.
Declaration
public Task<RequestBundleRoverNodeResponse> RequestBundleRoverNode(RequestBundleRoverNodeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
RequestBundleRoverNodeRequest | 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<RequestBundleRoverNodeResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use RequestBundleRoverNode API.
RetrieveAvailableBundleVersionsRoverCluster(RetrieveAvailableBundleVersionsRoverClusterRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Retrieve the latest available rover bundle version that can be upgraded to based on current bundle version.
Declaration
public Task<RetrieveAvailableBundleVersionsRoverClusterResponse> RetrieveAvailableBundleVersionsRoverCluster(RetrieveAvailableBundleVersionsRoverClusterRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
RetrieveAvailableBundleVersionsRoverClusterRequest | 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<RetrieveAvailableBundleVersionsRoverClusterResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use RetrieveAvailableBundleVersionsRoverCluster API.
RetrieveAvailableBundleVersionsRoverNode(RetrieveAvailableBundleVersionsRoverNodeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Retrieve the latest available rover bundle version that can be upgraded to based on current bundle version.
Declaration
public Task<RetrieveAvailableBundleVersionsRoverNodeResponse> RetrieveAvailableBundleVersionsRoverNode(RetrieveAvailableBundleVersionsRoverNodeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
RetrieveAvailableBundleVersionsRoverNodeRequest | 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<RetrieveAvailableBundleVersionsRoverNodeResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use RetrieveAvailableBundleVersionsRoverNode API.
RetrieveBundleStatusRoverCluster(RetrieveBundleStatusRoverClusterRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Retrieve the status and progress of a rover bundle copy request.
Declaration
public Task<RetrieveBundleStatusRoverClusterResponse> RetrieveBundleStatusRoverCluster(RetrieveBundleStatusRoverClusterRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
RetrieveBundleStatusRoverClusterRequest | 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<RetrieveBundleStatusRoverClusterResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use RetrieveBundleStatusRoverCluster API.
RetrieveBundleStatusRoverNode(RetrieveBundleStatusRoverNodeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Retrieve the status and progress of a rover bundle copy request.
Declaration
public Task<RetrieveBundleStatusRoverNodeResponse> RetrieveBundleStatusRoverNode(RetrieveBundleStatusRoverNodeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
RetrieveBundleStatusRoverNodeRequest | 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<RetrieveBundleStatusRoverNodeResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use RetrieveBundleStatusRoverNode API.