Class RoverEntitlementClient
Service client instance for RoverEntitlement.
Implements
Inherited Members
Namespace: Oci.RoverService
Assembly: OCI.DotNetSDK.Rover.dll
Syntax
public class RoverEntitlementClient : RegionalClientBase, IDisposable
Constructors
RoverEntitlementClient(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 RoverEntitlementClient(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 RoverEntitlementPaginators Paginators { get; }
Property Value
Type | Description |
---|---|
RoverEntitlementPaginators |
Waiters
Declaration
public RoverEntitlementWaiters Waiters { get; }
Property Value
Type | Description |
---|---|
RoverEntitlementWaiters |
Methods
ChangeRoverEntitlementCompartment(ChangeRoverEntitlementCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Moves an entitlement into a different compartment.
Declaration
public Task<ChangeRoverEntitlementCompartmentResponse> ChangeRoverEntitlementCompartment(ChangeRoverEntitlementCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ChangeRoverEntitlementCompartmentRequest | 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<ChangeRoverEntitlementCompartmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ChangeRoverEntitlementCompartment API.
CreateRoverEntitlement(CreateRoverEntitlementRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Create the Entitlement to use a Rover Device. It requires some offline process of review and signatures before request is granted.
Declaration
public Task<CreateRoverEntitlementResponse> CreateRoverEntitlement(CreateRoverEntitlementRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateRoverEntitlementRequest | 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<CreateRoverEntitlementResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateRoverEntitlement API.
DeleteRoverEntitlement(DeleteRoverEntitlementRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes a rover entitlement
Declaration
public Task<DeleteRoverEntitlementResponse> DeleteRoverEntitlement(DeleteRoverEntitlementRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteRoverEntitlementRequest | 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<DeleteRoverEntitlementResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteRoverEntitlement API.
GetRoverEntitlement(GetRoverEntitlementRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Describes the Rover Device Entitlement in detail
Declaration
public Task<GetRoverEntitlementResponse> GetRoverEntitlement(GetRoverEntitlementRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetRoverEntitlementRequest | 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<GetRoverEntitlementResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetRoverEntitlement API.
ListRoverEntitlements(ListRoverEntitlementsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of RoverEntitlements.
Declaration
public Task<ListRoverEntitlementsResponse> ListRoverEntitlements(ListRoverEntitlementsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListRoverEntitlementsRequest | 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<ListRoverEntitlementsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListRoverEntitlements API.
UpdateRoverEntitlement(UpdateRoverEntitlementRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the RoverEntitlement
Declaration
public Task<UpdateRoverEntitlementResponse> UpdateRoverEntitlement(UpdateRoverEntitlementRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateRoverEntitlementRequest | 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<UpdateRoverEntitlementResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateRoverEntitlement API.