Class DistributedDbWorkRequestServiceClient
Service client instance for DistributedDbWorkRequestService.
Implements
Inherited Members
Namespace: Oci.DistributeddatabaseService
Assembly: OCI.DotNetSDK.Distributeddatabase.dll
Syntax
public class DistributedDbWorkRequestServiceClient : RegionalClientBase, IDisposableConstructors
DistributedDbWorkRequestServiceClient(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 DistributedDbWorkRequestServiceClient(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 DistributedDbWorkRequestServicePaginators Paginators { get; }Property Value
| Type | Description | 
|---|---|
| DistributedDbWorkRequestServicePaginators | 
Waiters
Declaration
public DistributedDbWorkRequestServiceWaiters Waiters { get; }Property Value
| Type | Description | 
|---|---|
| DistributedDbWorkRequestServiceWaiters | 
Methods
GetWorkRequest(GetWorkRequestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets details of the work request with the given ID.
Declaration
public Task<GetWorkRequestResponse> GetWorkRequest(GetWorkRequestRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)Parameters
| Type | Name | Description | 
|---|---|---|
| GetWorkRequestRequest | 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<GetWorkRequestResponse> | A response object containing details about the completed operation | 
Examples
Click here to see an example of how to use GetWorkRequest API.
ListWorkRequestErrors(ListWorkRequestErrorsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a (paginated) list of errors for the work request with the given ID.
Declaration
public Task<ListWorkRequestErrorsResponse> ListWorkRequestErrors(ListWorkRequestErrorsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)Parameters
| Type | Name | Description | 
|---|---|---|
| ListWorkRequestErrorsRequest | 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<ListWorkRequestErrorsResponse> | A response object containing details about the completed operation | 
Examples
Click here to see an example of how to use ListWorkRequestErrors API.
ListWorkRequestLogs(ListWorkRequestLogsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a (paginated) list of logs for the work request with the given ID.
Declaration
public Task<ListWorkRequestLogsResponse> ListWorkRequestLogs(ListWorkRequestLogsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)Parameters
| Type | Name | Description | 
|---|---|---|
| ListWorkRequestLogsRequest | 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<ListWorkRequestLogsResponse> | A response object containing details about the completed operation | 
Examples
Click here to see an example of how to use ListWorkRequestLogs API.
ListWorkRequests(ListWorkRequestsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists the work requests in a compartment.
Declaration
public Task<ListWorkRequestsResponse> ListWorkRequests(ListWorkRequestsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)Parameters
| Type | Name | Description | 
|---|---|---|
| ListWorkRequestsRequest | 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<ListWorkRequestsResponse> | A response object containing details about the completed operation | 
Examples
Click here to see an example of how to use ListWorkRequests API.