Class DataLabelingServiceClientImpl

DataLabelingService client wrapper implementation, for convenient use.

Inheritance
System.Object
DataLabelingServiceClient
DataLabelingServiceClientImpl
Inherited Members
System.Object.ToString()
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Google.Cloud.DataLabeling.V1Beta1
Assembly: Google.Cloud.DataLabeling.V1Beta1.dll
Syntax
public sealed class DataLabelingServiceClientImpl : DataLabelingServiceClient
Remarks

Service for the AI Platform Data Labeling API.

Constructors

DataLabelingServiceClientImpl(DataLabelingService.DataLabelingServiceClient, DataLabelingServiceSettings)

Constructs a client wrapper for the DataLabelingService service, with the specified gRPC client and settings.

Declaration
public DataLabelingServiceClientImpl(DataLabelingService.DataLabelingServiceClient grpcClient, DataLabelingServiceSettings settings)
Parameters
Type Name Description
DataLabelingService.DataLabelingServiceClient grpcClient

The underlying gRPC client.
DataLabelingServiceSettings settings

The base DataLabelingServiceSettings used within this client.

Properties

CreateInstructionOperationsClient

The long-running operations client for CreateInstruction.

Declaration
public override OperationsClient CreateInstructionOperationsClient { get; }
Property Value
Type Description
OperationsClient
Overrides

ExportDataOperationsClient

The long-running operations client for ExportData.

Declaration
public override OperationsClient ExportDataOperationsClient { get; }
Property Value
Type Description
OperationsClient
Overrides

GrpcClient

The underlying gRPC DataLabelingService client

Declaration
public override DataLabelingService.DataLabelingServiceClient GrpcClient { get; }
Property Value
Type Description
DataLabelingService.DataLabelingServiceClient
Overrides

ImportDataOperationsClient

The long-running operations client for ImportData.

Declaration
public override OperationsClient ImportDataOperationsClient { get; }
Property Value
Type Description
OperationsClient
Overrides

LabelImageOperationsClient

The long-running operations client for LabelImage.

Declaration
public override OperationsClient LabelImageOperationsClient { get; }
Property Value
Type Description
OperationsClient
Overrides

LabelTextOperationsClient

The long-running operations client for LabelText.

Declaration
public override OperationsClient LabelTextOperationsClient { get; }
Property Value
Type Description
OperationsClient
Overrides

LabelVideoOperationsClient

The long-running operations client for LabelVideo.

Declaration
public override OperationsClient LabelVideoOperationsClient { get; }
Property Value
Type Description
OperationsClient
Overrides

Methods

CreateAnnotationSpecSet(CreateAnnotationSpecSetRequest, CallSettings)

Creates an annotation spec set by providing a set of labels.

Declaration
public override AnnotationSpecSet CreateAnnotationSpecSet(CreateAnnotationSpecSetRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
CreateAnnotationSpecSetRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
AnnotationSpecSet

The RPC response.
Overrides

CreateAnnotationSpecSetAsync(CreateAnnotationSpecSetRequest, CallSettings)

Creates an annotation spec set by providing a set of labels.

Declaration
public override Task<AnnotationSpecSet> CreateAnnotationSpecSetAsync(CreateAnnotationSpecSetRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
CreateAnnotationSpecSetRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
System.Threading.Tasks.Task<AnnotationSpecSet>

A Task containing the RPC response.
Overrides

CreateDataset(CreateDatasetRequest, CallSettings)

Creates dataset. If success return a Dataset resource.

Declaration
public override Dataset CreateDataset(CreateDatasetRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
CreateDatasetRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Dataset

The RPC response.
Overrides

CreateDatasetAsync(CreateDatasetRequest, CallSettings)

Creates dataset. If success return a Dataset resource.

Declaration
public override Task<Dataset> CreateDatasetAsync(CreateDatasetRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
CreateDatasetRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
System.Threading.Tasks.Task<Dataset>

A Task containing the RPC response.
Overrides

CreateEvaluationJob(CreateEvaluationJobRequest, CallSettings)

Creates an evaluation job.

Declaration
public override EvaluationJob CreateEvaluationJob(CreateEvaluationJobRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
CreateEvaluationJobRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
EvaluationJob

The RPC response.
Overrides

CreateEvaluationJobAsync(CreateEvaluationJobRequest, CallSettings)

Creates an evaluation job.

Declaration
public override Task<EvaluationJob> CreateEvaluationJobAsync(CreateEvaluationJobRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
CreateEvaluationJobRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
System.Threading.Tasks.Task<EvaluationJob>

A Task containing the RPC response.
Overrides

CreateInstruction(CreateInstructionRequest, CallSettings)

Creates an instruction for how data should be labeled.

Declaration
public override Operation<Instruction, CreateInstructionMetadata> CreateInstruction(CreateInstructionRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
CreateInstructionRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Operation<Instruction, CreateInstructionMetadata>

The RPC response.
Overrides

CreateInstructionAsync(CreateInstructionRequest, CallSettings)

Creates an instruction for how data should be labeled.

Declaration
public override Task<Operation<Instruction, CreateInstructionMetadata>> CreateInstructionAsync(CreateInstructionRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
CreateInstructionRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
System.Threading.Tasks.Task<Operation<Instruction, CreateInstructionMetadata>>

A Task containing the RPC response.
Overrides

DeleteAnnotatedDataset(DeleteAnnotatedDatasetRequest, CallSettings)

Deletes an annotated dataset by resource name.

Declaration
public override void DeleteAnnotatedDataset(DeleteAnnotatedDatasetRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
DeleteAnnotatedDatasetRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Overrides

DeleteAnnotatedDatasetAsync(DeleteAnnotatedDatasetRequest, CallSettings)

Deletes an annotated dataset by resource name.

Declaration
public override Task DeleteAnnotatedDatasetAsync(DeleteAnnotatedDatasetRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
DeleteAnnotatedDatasetRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
System.Threading.Tasks.Task

A Task containing the RPC response.
Overrides

DeleteAnnotationSpecSet(DeleteAnnotationSpecSetRequest, CallSettings)

Deletes an annotation spec set by resource name.

Declaration
public override void DeleteAnnotationSpecSet(DeleteAnnotationSpecSetRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
DeleteAnnotationSpecSetRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Overrides

DeleteAnnotationSpecSetAsync(DeleteAnnotationSpecSetRequest, CallSettings)

Deletes an annotation spec set by resource name.

Declaration
public override Task DeleteAnnotationSpecSetAsync(DeleteAnnotationSpecSetRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
DeleteAnnotationSpecSetRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
System.Threading.Tasks.Task

A Task containing the RPC response.
Overrides

DeleteDataset(DeleteDatasetRequest, CallSettings)

Deletes a dataset by resource name.

Declaration
public override void DeleteDataset(DeleteDatasetRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
DeleteDatasetRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Overrides

DeleteDatasetAsync(DeleteDatasetRequest, CallSettings)

Deletes a dataset by resource name.

Declaration
public override Task DeleteDatasetAsync(DeleteDatasetRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
DeleteDatasetRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
System.Threading.Tasks.Task

A Task containing the RPC response.
Overrides

DeleteEvaluationJob(DeleteEvaluationJobRequest, CallSettings)

Stops and deletes an evaluation job.

Declaration
public override void DeleteEvaluationJob(DeleteEvaluationJobRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
DeleteEvaluationJobRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Overrides

DeleteEvaluationJobAsync(DeleteEvaluationJobRequest, CallSettings)

Stops and deletes an evaluation job.

Declaration
public override Task DeleteEvaluationJobAsync(DeleteEvaluationJobRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
DeleteEvaluationJobRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
System.Threading.Tasks.Task

A Task containing the RPC response.
Overrides

DeleteInstruction(DeleteInstructionRequest, CallSettings)

Deletes an instruction object by resource name.

Declaration
public override void DeleteInstruction(DeleteInstructionRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
DeleteInstructionRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Overrides

DeleteInstructionAsync(DeleteInstructionRequest, CallSettings)

Deletes an instruction object by resource name.

Declaration
public override Task DeleteInstructionAsync(DeleteInstructionRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
DeleteInstructionRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
System.Threading.Tasks.Task

A Task containing the RPC response.
Overrides

ExportData(ExportDataRequest, CallSettings)

Exports data and annotations from dataset.

Declaration
public override Operation<ExportDataOperationResponse, ExportDataOperationMetadata> ExportData(ExportDataRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ExportDataRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Operation<ExportDataOperationResponse, ExportDataOperationMetadata>

The RPC response.
Overrides

ExportDataAsync(ExportDataRequest, CallSettings)

Exports data and annotations from dataset.

Declaration
public override Task<Operation<ExportDataOperationResponse, ExportDataOperationMetadata>> ExportDataAsync(ExportDataRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ExportDataRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
System.Threading.Tasks.Task<Operation<ExportDataOperationResponse, ExportDataOperationMetadata>>

A Task containing the RPC response.
Overrides

GetAnnotatedDataset(GetAnnotatedDatasetRequest, CallSettings)

Gets an annotated dataset by resource name.

Declaration
public override AnnotatedDataset GetAnnotatedDataset(GetAnnotatedDatasetRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
GetAnnotatedDatasetRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
AnnotatedDataset

The RPC response.
Overrides

GetAnnotatedDatasetAsync(GetAnnotatedDatasetRequest, CallSettings)

Gets an annotated dataset by resource name.

Declaration
public override Task<AnnotatedDataset> GetAnnotatedDatasetAsync(GetAnnotatedDatasetRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
GetAnnotatedDatasetRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
System.Threading.Tasks.Task<AnnotatedDataset>

A Task containing the RPC response.
Overrides

GetAnnotationSpecSet(GetAnnotationSpecSetRequest, CallSettings)

Gets an annotation spec set by resource name.

Declaration
public override AnnotationSpecSet GetAnnotationSpecSet(GetAnnotationSpecSetRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
GetAnnotationSpecSetRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
AnnotationSpecSet

The RPC response.
Overrides

GetAnnotationSpecSetAsync(GetAnnotationSpecSetRequest, CallSettings)

Gets an annotation spec set by resource name.

Declaration
public override Task<AnnotationSpecSet> GetAnnotationSpecSetAsync(GetAnnotationSpecSetRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
GetAnnotationSpecSetRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
System.Threading.Tasks.Task<AnnotationSpecSet>

A Task containing the RPC response.
Overrides

GetDataItem(GetDataItemRequest, CallSettings)

Gets a data item in a dataset by resource name. This API can be called after data are imported into dataset.

Declaration
public override DataItem GetDataItem(GetDataItemRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
GetDataItemRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
DataItem

The RPC response.
Overrides

GetDataItemAsync(GetDataItemRequest, CallSettings)

Gets a data item in a dataset by resource name. This API can be called after data are imported into dataset.

Declaration
public override Task<DataItem> GetDataItemAsync(GetDataItemRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
GetDataItemRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
System.Threading.Tasks.Task<DataItem>

A Task containing the RPC response.
Overrides

GetDataset(GetDatasetRequest, CallSettings)

Gets dataset by resource name.

Declaration
public override Dataset GetDataset(GetDatasetRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
GetDatasetRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Dataset

The RPC response.
Overrides

GetDatasetAsync(GetDatasetRequest, CallSettings)

Gets dataset by resource name.

Declaration
public override Task<Dataset> GetDatasetAsync(GetDatasetRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
GetDatasetRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
System.Threading.Tasks.Task<Dataset>

A Task containing the RPC response.
Overrides

GetEvaluation(GetEvaluationRequest, CallSettings)

Gets an evaluation by resource name (to search, use [projects.evaluations.search][google.cloud.datalabeling.v1beta1.DataLabelingService.SearchEvaluations]).

Declaration
public override Evaluation GetEvaluation(GetEvaluationRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
GetEvaluationRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Evaluation

The RPC response.
Overrides

GetEvaluationAsync(GetEvaluationRequest, CallSettings)

Gets an evaluation by resource name (to search, use [projects.evaluations.search][google.cloud.datalabeling.v1beta1.DataLabelingService.SearchEvaluations]).

Declaration
public override Task<Evaluation> GetEvaluationAsync(GetEvaluationRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
GetEvaluationRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
System.Threading.Tasks.Task<Evaluation>

A Task containing the RPC response.
Overrides

GetEvaluationJob(GetEvaluationJobRequest, CallSettings)

Gets an evaluation job by resource name.

Declaration
public override EvaluationJob GetEvaluationJob(GetEvaluationJobRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
GetEvaluationJobRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
EvaluationJob

The RPC response.
Overrides

GetEvaluationJobAsync(GetEvaluationJobRequest, CallSettings)

Gets an evaluation job by resource name.

Declaration
public override Task<EvaluationJob> GetEvaluationJobAsync(GetEvaluationJobRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
GetEvaluationJobRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
System.Threading.Tasks.Task<EvaluationJob>

A Task containing the RPC response.
Overrides

GetExample(GetExampleRequest, CallSettings)

Gets an example by resource name, including both data and annotation.

Declaration
public override Example GetExample(GetExampleRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
GetExampleRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Example

The RPC response.
Overrides

GetExampleAsync(GetExampleRequest, CallSettings)

Gets an example by resource name, including both data and annotation.

Declaration
public override Task<Example> GetExampleAsync(GetExampleRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
GetExampleRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
System.Threading.Tasks.Task<Example>

A Task containing the RPC response.
Overrides

GetInstruction(GetInstructionRequest, CallSettings)

Gets an instruction by resource name.

Declaration
public override Instruction GetInstruction(GetInstructionRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
GetInstructionRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Instruction

The RPC response.
Overrides

GetInstructionAsync(GetInstructionRequest, CallSettings)

Gets an instruction by resource name.

Declaration
public override Task<Instruction> GetInstructionAsync(GetInstructionRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
GetInstructionRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
System.Threading.Tasks.Task<Instruction>

A Task containing the RPC response.
Overrides

ImportData(ImportDataRequest, CallSettings)

Imports data into dataset based on source locations defined in request. It can be called multiple times for the same dataset. Each dataset can only have one long running operation running on it. For example, no labeling task (also long running operation) can be started while importing is still ongoing. Vice versa.

Declaration
public override Operation<ImportDataOperationResponse, ImportDataOperationMetadata> ImportData(ImportDataRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ImportDataRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Operation<ImportDataOperationResponse, ImportDataOperationMetadata>

The RPC response.
Overrides

ImportDataAsync(ImportDataRequest, CallSettings)

Imports data into dataset based on source locations defined in request. It can be called multiple times for the same dataset. Each dataset can only have one long running operation running on it. For example, no labeling task (also long running operation) can be started while importing is still ongoing. Vice versa.

Declaration
public override Task<Operation<ImportDataOperationResponse, ImportDataOperationMetadata>> ImportDataAsync(ImportDataRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ImportDataRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
System.Threading.Tasks.Task<Operation<ImportDataOperationResponse, ImportDataOperationMetadata>>

A Task containing the RPC response.
Overrides

LabelImage(LabelImageRequest, CallSettings)

Starts a labeling task for image. The type of image labeling task is configured by feature in the request.

Declaration
public override Operation<AnnotatedDataset, LabelOperationMetadata> LabelImage(LabelImageRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
LabelImageRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Operation<AnnotatedDataset, LabelOperationMetadata>

The RPC response.
Overrides

LabelImageAsync(LabelImageRequest, CallSettings)

Starts a labeling task for image. The type of image labeling task is configured by feature in the request.

Declaration
public override Task<Operation<AnnotatedDataset, LabelOperationMetadata>> LabelImageAsync(LabelImageRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
LabelImageRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
System.Threading.Tasks.Task<Operation<AnnotatedDataset, LabelOperationMetadata>>

A Task containing the RPC response.
Overrides

LabelText(LabelTextRequest, CallSettings)

Starts a labeling task for text. The type of text labeling task is configured by feature in the request.

Declaration
public override Operation<AnnotatedDataset, LabelOperationMetadata> LabelText(LabelTextRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
LabelTextRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Operation<AnnotatedDataset, LabelOperationMetadata>

The RPC response.
Overrides

LabelTextAsync(LabelTextRequest, CallSettings)

Starts a labeling task for text. The type of text labeling task is configured by feature in the request.

Declaration
public override Task<Operation<AnnotatedDataset, LabelOperationMetadata>> LabelTextAsync(LabelTextRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
LabelTextRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
System.Threading.Tasks.Task<Operation<AnnotatedDataset, LabelOperationMetadata>>

A Task containing the RPC response.
Overrides

LabelVideo(LabelVideoRequest, CallSettings)

Starts a labeling task for video. The type of video labeling task is configured by feature in the request.

Declaration
public override Operation<AnnotatedDataset, LabelOperationMetadata> LabelVideo(LabelVideoRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
LabelVideoRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Operation<AnnotatedDataset, LabelOperationMetadata>

The RPC response.
Overrides

LabelVideoAsync(LabelVideoRequest, CallSettings)

Starts a labeling task for video. The type of video labeling task is configured by feature in the request.

Declaration
public override Task<Operation<AnnotatedDataset, LabelOperationMetadata>> LabelVideoAsync(LabelVideoRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
LabelVideoRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
System.Threading.Tasks.Task<Operation<AnnotatedDataset, LabelOperationMetadata>>

A Task containing the RPC response.
Overrides

ListAnnotatedDatasets(ListAnnotatedDatasetsRequest, CallSettings)

Lists annotated datasets for a dataset. Pagination is supported.

Declaration
public override PagedEnumerable<ListAnnotatedDatasetsResponse, AnnotatedDataset> ListAnnotatedDatasets(ListAnnotatedDatasetsRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ListAnnotatedDatasetsRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerable<ListAnnotatedDatasetsResponse, AnnotatedDataset>

A pageable sequence of AnnotatedDataset resources.
Overrides

ListAnnotatedDatasetsAsync(ListAnnotatedDatasetsRequest, CallSettings)

Lists annotated datasets for a dataset. Pagination is supported.

Declaration
public override PagedAsyncEnumerable<ListAnnotatedDatasetsResponse, AnnotatedDataset> ListAnnotatedDatasetsAsync(ListAnnotatedDatasetsRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ListAnnotatedDatasetsRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerable<ListAnnotatedDatasetsResponse, AnnotatedDataset>

A pageable asynchronous sequence of AnnotatedDataset resources.
Overrides

ListAnnotationSpecSets(ListAnnotationSpecSetsRequest, CallSettings)

Lists annotation spec sets for a project. Pagination is supported.

Declaration
public override PagedEnumerable<ListAnnotationSpecSetsResponse, AnnotationSpecSet> ListAnnotationSpecSets(ListAnnotationSpecSetsRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ListAnnotationSpecSetsRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerable<ListAnnotationSpecSetsResponse, AnnotationSpecSet>

A pageable sequence of AnnotationSpecSet resources.
Overrides

ListAnnotationSpecSetsAsync(ListAnnotationSpecSetsRequest, CallSettings)

Lists annotation spec sets for a project. Pagination is supported.

Declaration
public override PagedAsyncEnumerable<ListAnnotationSpecSetsResponse, AnnotationSpecSet> ListAnnotationSpecSetsAsync(ListAnnotationSpecSetsRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ListAnnotationSpecSetsRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerable<ListAnnotationSpecSetsResponse, AnnotationSpecSet>

A pageable asynchronous sequence of AnnotationSpecSet resources.
Overrides

ListDataItems(ListDataItemsRequest, CallSettings)

Lists data items in a dataset. This API can be called after data are imported into dataset. Pagination is supported.

Declaration
public override PagedEnumerable<ListDataItemsResponse, DataItem> ListDataItems(ListDataItemsRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ListDataItemsRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerable<ListDataItemsResponse, DataItem>

A pageable sequence of DataItem resources.
Overrides

ListDataItemsAsync(ListDataItemsRequest, CallSettings)

Lists data items in a dataset. This API can be called after data are imported into dataset. Pagination is supported.

Declaration
public override PagedAsyncEnumerable<ListDataItemsResponse, DataItem> ListDataItemsAsync(ListDataItemsRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ListDataItemsRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerable<ListDataItemsResponse, DataItem>

A pageable asynchronous sequence of DataItem resources.
Overrides

ListDatasets(ListDatasetsRequest, CallSettings)

Lists datasets under a project. Pagination is supported.

Declaration
public override PagedEnumerable<ListDatasetsResponse, Dataset> ListDatasets(ListDatasetsRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ListDatasetsRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerable<ListDatasetsResponse, Dataset>

A pageable sequence of Dataset resources.
Overrides

ListDatasetsAsync(ListDatasetsRequest, CallSettings)

Lists datasets under a project. Pagination is supported.

Declaration
public override PagedAsyncEnumerable<ListDatasetsResponse, Dataset> ListDatasetsAsync(ListDatasetsRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ListDatasetsRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerable<ListDatasetsResponse, Dataset>

A pageable asynchronous sequence of Dataset resources.
Overrides

ListEvaluationJobs(ListEvaluationJobsRequest, CallSettings)

Lists all evaluation jobs within a project with possible filters. Pagination is supported.

Declaration
public override PagedEnumerable<ListEvaluationJobsResponse, EvaluationJob> ListEvaluationJobs(ListEvaluationJobsRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ListEvaluationJobsRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerable<ListEvaluationJobsResponse, EvaluationJob>

A pageable sequence of EvaluationJob resources.
Overrides

ListEvaluationJobsAsync(ListEvaluationJobsRequest, CallSettings)

Lists all evaluation jobs within a project with possible filters. Pagination is supported.

Declaration
public override PagedAsyncEnumerable<ListEvaluationJobsResponse, EvaluationJob> ListEvaluationJobsAsync(ListEvaluationJobsRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ListEvaluationJobsRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerable<ListEvaluationJobsResponse, EvaluationJob>

A pageable asynchronous sequence of EvaluationJob resources.
Overrides

ListExamples(ListExamplesRequest, CallSettings)

Lists examples in an annotated dataset. Pagination is supported.

Declaration
public override PagedEnumerable<ListExamplesResponse, Example> ListExamples(ListExamplesRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ListExamplesRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerable<ListExamplesResponse, Example>

A pageable sequence of Example resources.
Overrides

ListExamplesAsync(ListExamplesRequest, CallSettings)

Lists examples in an annotated dataset. Pagination is supported.

Declaration
public override PagedAsyncEnumerable<ListExamplesResponse, Example> ListExamplesAsync(ListExamplesRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ListExamplesRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerable<ListExamplesResponse, Example>

A pageable asynchronous sequence of Example resources.
Overrides

ListInstructions(ListInstructionsRequest, CallSettings)

Lists instructions for a project. Pagination is supported.

Declaration
public override PagedEnumerable<ListInstructionsResponse, Instruction> ListInstructions(ListInstructionsRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ListInstructionsRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerable<ListInstructionsResponse, Instruction>

A pageable sequence of Instruction resources.
Overrides

ListInstructionsAsync(ListInstructionsRequest, CallSettings)

Lists instructions for a project. Pagination is supported.

Declaration
public override PagedAsyncEnumerable<ListInstructionsResponse, Instruction> ListInstructionsAsync(ListInstructionsRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ListInstructionsRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerable<ListInstructionsResponse, Instruction>

A pageable asynchronous sequence of Instruction resources.
Overrides

PauseEvaluationJob(PauseEvaluationJobRequest, CallSettings)

Pauses an evaluation job. Pausing an evaluation job that is already in a PAUSED state is a no-op.

Declaration
public override void PauseEvaluationJob(PauseEvaluationJobRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
PauseEvaluationJobRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Overrides

PauseEvaluationJobAsync(PauseEvaluationJobRequest, CallSettings)

Pauses an evaluation job. Pausing an evaluation job that is already in a PAUSED state is a no-op.

Declaration
public override Task PauseEvaluationJobAsync(PauseEvaluationJobRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
PauseEvaluationJobRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
System.Threading.Tasks.Task

A Task containing the RPC response.
Overrides

ResumeEvaluationJob(ResumeEvaluationJobRequest, CallSettings)

Resumes a paused evaluation job. A deleted evaluation job can't be resumed. Resuming a running or scheduled evaluation job is a no-op.

Declaration
public override void ResumeEvaluationJob(ResumeEvaluationJobRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ResumeEvaluationJobRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Overrides

ResumeEvaluationJobAsync(ResumeEvaluationJobRequest, CallSettings)

Resumes a paused evaluation job. A deleted evaluation job can't be resumed. Resuming a running or scheduled evaluation job is a no-op.

Declaration
public override Task ResumeEvaluationJobAsync(ResumeEvaluationJobRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
ResumeEvaluationJobRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
System.Threading.Tasks.Task

A Task containing the RPC response.
Overrides

SearchEvaluations(SearchEvaluationsRequest, CallSettings)

Searches [evaluations][google.cloud.datalabeling.v1beta1.Evaluation] within a project.

Declaration
public override PagedEnumerable<SearchEvaluationsResponse, Evaluation> SearchEvaluations(SearchEvaluationsRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
SearchEvaluationsRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerable<SearchEvaluationsResponse, Evaluation>

A pageable sequence of Evaluation resources.
Overrides

SearchEvaluationsAsync(SearchEvaluationsRequest, CallSettings)

Searches [evaluations][google.cloud.datalabeling.v1beta1.Evaluation] within a project.

Declaration
public override PagedAsyncEnumerable<SearchEvaluationsResponse, Evaluation> SearchEvaluationsAsync(SearchEvaluationsRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
SearchEvaluationsRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerable<SearchEvaluationsResponse, Evaluation>

A pageable asynchronous sequence of Evaluation resources.
Overrides

SearchExampleComparisons(SearchExampleComparisonsRequest, CallSettings)

Searches example comparisons from an evaluation. The return format is a list of example comparisons that show ground truth and prediction(s) for a single input. Search by providing an evaluation ID.

Declaration
public override PagedEnumerable<SearchExampleComparisonsResponse, SearchExampleComparisonsResponse.Types.ExampleComparison> SearchExampleComparisons(SearchExampleComparisonsRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
SearchExampleComparisonsRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerable<SearchExampleComparisonsResponse, SearchExampleComparisonsResponse.Types.ExampleComparison>

A pageable sequence of SearchExampleComparisonsResponse.Types.ExampleComparison resources.
Overrides

SearchExampleComparisonsAsync(SearchExampleComparisonsRequest, CallSettings)

Searches example comparisons from an evaluation. The return format is a list of example comparisons that show ground truth and prediction(s) for a single input. Search by providing an evaluation ID.

Declaration
public override PagedAsyncEnumerable<SearchExampleComparisonsResponse, SearchExampleComparisonsResponse.Types.ExampleComparison> SearchExampleComparisonsAsync(SearchExampleComparisonsRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
SearchExampleComparisonsRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerable<SearchExampleComparisonsResponse, SearchExampleComparisonsResponse.Types.ExampleComparison>

A pageable asynchronous sequence of SearchExampleComparisonsResponse.Types.ExampleComparison resources.
Overrides

UpdateEvaluationJob(UpdateEvaluationJobRequest, CallSettings)

Updates an evaluation job. You can only update certain fields of the job's [EvaluationJobConfig][google.cloud.datalabeling.v1beta1.EvaluationJobConfig]: humanAnnotationConfig.instruction, exampleCount, and exampleSamplePercentage.

If you want to change any other aspect of the evaluation job, you must delete the job and create a new one.

Declaration
public override EvaluationJob UpdateEvaluationJob(UpdateEvaluationJobRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
UpdateEvaluationJobRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
EvaluationJob

The RPC response.
Overrides

UpdateEvaluationJobAsync(UpdateEvaluationJobRequest, CallSettings)

Updates an evaluation job. You can only update certain fields of the job's [EvaluationJobConfig][google.cloud.datalabeling.v1beta1.EvaluationJobConfig]: humanAnnotationConfig.instruction, exampleCount, and exampleSamplePercentage.

If you want to change any other aspect of the evaluation job, you must delete the job and create a new one.

Declaration
public override Task<EvaluationJob> UpdateEvaluationJobAsync(UpdateEvaluationJobRequest request, CallSettings callSettings = null)
Parameters
Type Name Description
UpdateEvaluationJobRequest request

The request object containing all of the parameters for the API call.
CallSettings callSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
System.Threading.Tasks.Task<EvaluationJob>

A Task containing the RPC response.
Overrides