Class DataLabelingManagementClient
Service client instance for DataLabelingManagement.
Implements
Inherited Members
Namespace: Oci.DatalabelingService
Assembly: OCI.DotNetSDK.Datalabelingservice.dll
Syntax
public class DataLabelingManagementClient : RegionalClientBase, IDisposable
Constructors
DataLabelingManagementClient(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 DataLabelingManagementClient(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 DataLabelingManagementPaginators Paginators { get; }
Property Value
Type | Description |
---|---|
DataLabelingManagementPaginators |
Waiters
Declaration
public DataLabelingManagementWaiters Waiters { get; }
Property Value
Type | Description |
---|---|
DataLabelingManagementWaiters |
Methods
AddDatasetLabels(AddDatasetLabelsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Add Labels to the Dataset LabelSet until the maximum number of Labels has been reached.
Declaration
public Task<AddDatasetLabelsResponse> AddDatasetLabels(AddDatasetLabelsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
AddDatasetLabelsRequest | 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<AddDatasetLabelsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use AddDatasetLabels API.
ChangeDatasetCompartment(ChangeDatasetCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Moves a Dataset resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.
Declaration
public Task<ChangeDatasetCompartmentResponse> ChangeDatasetCompartment(ChangeDatasetCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ChangeDatasetCompartmentRequest | 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<ChangeDatasetCompartmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ChangeDatasetCompartment API.
CreateDataset(CreateDatasetRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new Dataset.
Declaration
public Task<CreateDatasetResponse> CreateDataset(CreateDatasetRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateDatasetRequest | 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<CreateDatasetResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateDataset API.
DeleteDataset(DeleteDatasetRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes a Dataset resource by identifier
Declaration
public Task<DeleteDatasetResponse> DeleteDataset(DeleteDatasetRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteDatasetRequest | 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<DeleteDatasetResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteDataset API.
GenerateDatasetRecords(GenerateDatasetRecordsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Generates Record resources from the Dataset's data source
Declaration
public Task<GenerateDatasetRecordsResponse> GenerateDatasetRecords(GenerateDatasetRecordsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GenerateDatasetRecordsRequest | 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<GenerateDatasetRecordsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GenerateDatasetRecords API.
GetDataset(GetDatasetRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets a Dataset by identifier
Declaration
public Task<GetDatasetResponse> GetDataset(GetDatasetRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetDatasetRequest | 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<GetDatasetResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetDataset API.
GetWorkRequest(GetWorkRequestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the status 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.
ImportPreAnnotatedData(ImportPreAnnotatedDataRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Imports records and annotations from dataset files into existing Dataset.
Declaration
public Task<ImportPreAnnotatedDataResponse> ImportPreAnnotatedData(ImportPreAnnotatedDataRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ImportPreAnnotatedDataRequest | 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<ImportPreAnnotatedDataResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ImportPreAnnotatedData API.
ListAnnotationFormats(ListAnnotationFormatsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
These are a static list in a given region.
Declaration
public Task<ListAnnotationFormatsResponse> ListAnnotationFormats(ListAnnotationFormatsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListAnnotationFormatsRequest | 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<ListAnnotationFormatsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListAnnotationFormats API.
ListDatasets(ListDatasetsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of Datasets.
Declaration
public Task<ListDatasetsResponse> ListDatasets(ListDatasetsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListDatasetsRequest | 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<ListDatasetsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListDatasets API.
ListWorkRequestErrors(ListWorkRequestErrorsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Return a (paginated) list of errors for a given work request.
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)
Return a (paginated) list of logs for a given work request.
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.
RemoveDatasetLabels(RemoveDatasetLabelsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Removes the labels from the Dataset Labelset. Labels can only be removed if there are no Annotations associated with the Dataset that reference the Label names.
Declaration
public Task<RemoveDatasetLabelsResponse> RemoveDatasetLabels(RemoveDatasetLabelsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
RemoveDatasetLabelsRequest | 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<RemoveDatasetLabelsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use RemoveDatasetLabels API.
RenameDatasetLabels(RenameDatasetLabelsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Renames the labels from the Dataset Labelset. Labels that are renamed will be reflected in Annotations associated with the Dataset that reference the Label names.
Declaration
public Task<RenameDatasetLabelsResponse> RenameDatasetLabels(RenameDatasetLabelsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
RenameDatasetLabelsRequest | 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<RenameDatasetLabelsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use RenameDatasetLabels API.
SnapshotDataset(SnapshotDatasetRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Writes the dataset records and annotations in a consolidated format out to an object storage reference for consumption. While the snapshot takes place, there may be a time while records and annotations cannot be created to ensure the snapshot is a point in time.
Declaration
public Task<SnapshotDatasetResponse> SnapshotDataset(SnapshotDatasetRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
SnapshotDatasetRequest | 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<SnapshotDatasetResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use SnapshotDataset API.
UpdateDataset(UpdateDatasetRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the Dataset
Declaration
public Task<UpdateDatasetResponse> UpdateDataset(UpdateDatasetRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateDatasetRequest | 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<UpdateDatasetResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateDataset API.