Data Labeling v1beta1 API - Class DataLabelingServiceClientImpl (2.0.0-beta03) 

public sealed class DataLabelingServiceClientImpl : DataLabelingServiceClient

Reference documentation and code samples for the Data Labeling v1beta1 API class DataLabelingServiceClientImpl.

DataLabelingService client wrapper implementation, for convenient use.

Inheritance

object > DataLabelingServiceClient > DataLabelingServiceClientImpl

Namespace

Google.Cloud.DataLabeling.V1Beta1

Assembly

Google.Cloud.DataLabeling.V1Beta1.dll

Remarks

Service for the AI Platform Data Labeling API.

Constructors

DataLabelingServiceClientImpl(DataLabelingServiceClient, DataLabelingServiceSettings, ILogger)

public DataLabelingServiceClientImpl(DataLabelingService.DataLabelingServiceClient grpcClient, DataLabelingServiceSettings settings, ILogger logger)

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

Parameters
Name Description
grpcClient DataLabelingServiceDataLabelingServiceClient

The underlying gRPC client.
settings DataLabelingServiceSettings

The base DataLabelingServiceSettings used within this client.
logger ILogger

Optional ILogger to use within this client.

Properties

CreateInstructionOperationsClient

public override OperationsClient CreateInstructionOperationsClient { get; }

The long-running operations client for CreateInstruction.

Property Value
Type Description
OperationsClient
Overrides

ExportDataOperationsClient

public override OperationsClient ExportDataOperationsClient { get; }

The long-running operations client for ExportData.

Property Value
Type Description
OperationsClient
Overrides

GrpcClient

public override DataLabelingService.DataLabelingServiceClient GrpcClient { get; }

The underlying gRPC DataLabelingService client

Property Value
Type Description
DataLabelingServiceDataLabelingServiceClient
Overrides

ImportDataOperationsClient

public override OperationsClient ImportDataOperationsClient { get; }

The long-running operations client for ImportData.

Property Value
Type Description
OperationsClient
Overrides

LabelImageOperationsClient

public override OperationsClient LabelImageOperationsClient { get; }

The long-running operations client for LabelImage.

Property Value
Type Description
OperationsClient
Overrides

LabelTextOperationsClient

public override OperationsClient LabelTextOperationsClient { get; }

The long-running operations client for LabelText.

Property Value
Type Description
OperationsClient
Overrides

LabelVideoOperationsClient

public override OperationsClient LabelVideoOperationsClient { get; }

The long-running operations client for LabelVideo.

Property Value
Type Description
OperationsClient
Overrides

Methods

CreateAnnotationSpecSet(CreateAnnotationSpecSetRequest, CallSettings)

public override AnnotationSpecSet CreateAnnotationSpecSet(CreateAnnotationSpecSetRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request CreateAnnotationSpecSetRequest

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)

public override Task<AnnotationSpecSet> CreateAnnotationSpecSetAsync(CreateAnnotationSpecSetRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request CreateAnnotationSpecSetRequest

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
TaskAnnotationSpecSet

A Task containing the RPC response.
Overrides

CreateDataset(CreateDatasetRequest, CallSettings)

public override Dataset CreateDataset(CreateDatasetRequest request, CallSettings callSettings = null)

Creates dataset. If success return a Dataset resource.

Parameters
Name Description
request CreateDatasetRequest

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)

public override Task<Dataset> CreateDatasetAsync(CreateDatasetRequest request, CallSettings callSettings = null)

Creates dataset. If success return a Dataset resource.

Parameters
Name Description
request CreateDatasetRequest

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
TaskDataset

A Task containing the RPC response.
Overrides

CreateEvaluationJob(CreateEvaluationJobRequest, CallSettings)

public override EvaluationJob CreateEvaluationJob(CreateEvaluationJobRequest request, CallSettings callSettings = null)

Creates an evaluation job.

Parameters
Name Description
request CreateEvaluationJobRequest

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)

public override Task<EvaluationJob> CreateEvaluationJobAsync(CreateEvaluationJobRequest request, CallSettings callSettings = null)

Creates an evaluation job.

Parameters
Name Description
request CreateEvaluationJobRequest

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
TaskEvaluationJob

A Task containing the RPC response.
Overrides

CreateInstruction(CreateInstructionRequest, CallSettings)

public override Operation<Instruction, CreateInstructionMetadata> CreateInstruction(CreateInstructionRequest request, CallSettings callSettings = null)

Creates an instruction for how data should be labeled.

Parameters
Name Description
request CreateInstructionRequest

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
OperationInstructionCreateInstructionMetadata

The RPC response.
Overrides

CreateInstructionAsync(CreateInstructionRequest, CallSettings)

public override Task<Operation<Instruction, CreateInstructionMetadata>> CreateInstructionAsync(CreateInstructionRequest request, CallSettings callSettings = null)

Creates an instruction for how data should be labeled.

Parameters
Name Description
request CreateInstructionRequest

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
TaskOperationInstructionCreateInstructionMetadata

A Task containing the RPC response.
Overrides

DeleteAnnotatedDataset(DeleteAnnotatedDatasetRequest, CallSettings)

public override void DeleteAnnotatedDataset(DeleteAnnotatedDatasetRequest request, CallSettings callSettings = null)

Deletes an annotated dataset by resource name.

Parameters
Name Description
request DeleteAnnotatedDatasetRequest

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)

public override Task DeleteAnnotatedDatasetAsync(DeleteAnnotatedDatasetRequest request, CallSettings callSettings = null)

Deletes an annotated dataset by resource name.

Parameters
Name Description
request DeleteAnnotatedDatasetRequest

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
Task

A Task containing the RPC response.
Overrides

DeleteAnnotationSpecSet(DeleteAnnotationSpecSetRequest, CallSettings)

public override void DeleteAnnotationSpecSet(DeleteAnnotationSpecSetRequest request, CallSettings callSettings = null)

Deletes an annotation spec set by resource name.

Parameters
Name Description
request DeleteAnnotationSpecSetRequest

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)

public override Task DeleteAnnotationSpecSetAsync(DeleteAnnotationSpecSetRequest request, CallSettings callSettings = null)

Deletes an annotation spec set by resource name.

Parameters
Name Description
request DeleteAnnotationSpecSetRequest

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
Task

A Task containing the RPC response.
Overrides

DeleteDataset(DeleteDatasetRequest, CallSettings)

public override void DeleteDataset(DeleteDatasetRequest request, CallSettings callSettings = null)

Deletes a dataset by resource name.

Parameters
Name Description
request DeleteDatasetRequest

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)

public override Task DeleteDatasetAsync(DeleteDatasetRequest request, CallSettings callSettings = null)

Deletes a dataset by resource name.

Parameters
Name Description
request DeleteDatasetRequest

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
Task

A Task containing the RPC response.
Overrides

DeleteEvaluationJob(DeleteEvaluationJobRequest, CallSettings)

public override void DeleteEvaluationJob(DeleteEvaluationJobRequest request, CallSettings callSettings = null)

Stops and deletes an evaluation job.

Parameters
Name Description
request DeleteEvaluationJobRequest

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)

public override Task DeleteEvaluationJobAsync(DeleteEvaluationJobRequest request, CallSettings callSettings = null)

Stops and deletes an evaluation job.

Parameters
Name Description
request DeleteEvaluationJobRequest

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
Task

A Task containing the RPC response.
Overrides

DeleteInstruction(DeleteInstructionRequest, CallSettings)

public override void DeleteInstruction(DeleteInstructionRequest request, CallSettings callSettings = null)

Deletes an instruction object by resource name.

Parameters
Name Description
request DeleteInstructionRequest

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)

public override Task DeleteInstructionAsync(DeleteInstructionRequest request, CallSettings callSettings = null)

Deletes an instruction object by resource name.

Parameters
Name Description
request DeleteInstructionRequest

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
Task

A Task containing the RPC response.
Overrides

ExportData(ExportDataRequest, CallSettings)

public override Operation<ExportDataOperationResponse, ExportDataOperationMetadata> ExportData(ExportDataRequest request, CallSettings callSettings = null)

Exports data and annotations from dataset.

Parameters
Name Description
request ExportDataRequest

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
OperationExportDataOperationResponseExportDataOperationMetadata

The RPC response.
Overrides

ExportDataAsync(ExportDataRequest, CallSettings)

public override Task<Operation<ExportDataOperationResponse, ExportDataOperationMetadata>> ExportDataAsync(ExportDataRequest request, CallSettings callSettings = null)

Exports data and annotations from dataset.

Parameters
Name Description
request ExportDataRequest

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
TaskOperationExportDataOperationResponseExportDataOperationMetadata

A Task containing the RPC response.
Overrides

GetAnnotatedDataset(GetAnnotatedDatasetRequest, CallSettings)

public override AnnotatedDataset GetAnnotatedDataset(GetAnnotatedDatasetRequest request, CallSettings callSettings = null)

Gets an annotated dataset by resource name.

Parameters
Name Description
request GetAnnotatedDatasetRequest

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)

public override Task<AnnotatedDataset> GetAnnotatedDatasetAsync(GetAnnotatedDatasetRequest request, CallSettings callSettings = null)

Gets an annotated dataset by resource name.

Parameters
Name Description
request GetAnnotatedDatasetRequest

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
TaskAnnotatedDataset

A Task containing the RPC response.
Overrides

GetAnnotationSpecSet(GetAnnotationSpecSetRequest, CallSettings)

public override AnnotationSpecSet GetAnnotationSpecSet(GetAnnotationSpecSetRequest request, CallSettings callSettings = null)

Gets an annotation spec set by resource name.

Parameters
Name Description
request GetAnnotationSpecSetRequest

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)

public override Task<AnnotationSpecSet> GetAnnotationSpecSetAsync(GetAnnotationSpecSetRequest request, CallSettings callSettings = null)

Gets an annotation spec set by resource name.

Parameters
Name Description
request GetAnnotationSpecSetRequest

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
TaskAnnotationSpecSet

A Task containing the RPC response.
Overrides

GetDataItem(GetDataItemRequest, CallSettings)

public override DataItem GetDataItem(GetDataItemRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request GetDataItemRequest

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)

public override Task<DataItem> GetDataItemAsync(GetDataItemRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request GetDataItemRequest

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
TaskDataItem

A Task containing the RPC response.
Overrides

GetDataset(GetDatasetRequest, CallSettings)

public override Dataset GetDataset(GetDatasetRequest request, CallSettings callSettings = null)

Gets dataset by resource name.

Parameters
Name Description
request GetDatasetRequest

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)

public override Task<Dataset> GetDatasetAsync(GetDatasetRequest request, CallSettings callSettings = null)

Gets dataset by resource name.

Parameters
Name Description
request GetDatasetRequest

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
TaskDataset

A Task containing the RPC response.
Overrides

GetEvaluation(GetEvaluationRequest, CallSettings)

public override Evaluation GetEvaluation(GetEvaluationRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request GetEvaluationRequest

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)

public override Task<Evaluation> GetEvaluationAsync(GetEvaluationRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request GetEvaluationRequest

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
TaskEvaluation

A Task containing the RPC response.
Overrides

GetEvaluationJob(GetEvaluationJobRequest, CallSettings)

public override EvaluationJob GetEvaluationJob(GetEvaluationJobRequest request, CallSettings callSettings = null)

Gets an evaluation job by resource name.

Parameters
Name Description
request GetEvaluationJobRequest

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)

public override Task<EvaluationJob> GetEvaluationJobAsync(GetEvaluationJobRequest request, CallSettings callSettings = null)

Gets an evaluation job by resource name.

Parameters
Name Description
request GetEvaluationJobRequest

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
TaskEvaluationJob

A Task containing the RPC response.
Overrides

GetExample(GetExampleRequest, CallSettings)

public override Example GetExample(GetExampleRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request GetExampleRequest

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)

public override Task<Example> GetExampleAsync(GetExampleRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request GetExampleRequest

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
TaskExample

A Task containing the RPC response.
Overrides

GetInstruction(GetInstructionRequest, CallSettings)

public override Instruction GetInstruction(GetInstructionRequest request, CallSettings callSettings = null)

Gets an instruction by resource name.

Parameters
Name Description
request GetInstructionRequest

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)

public override Task<Instruction> GetInstructionAsync(GetInstructionRequest request, CallSettings callSettings = null)

Gets an instruction by resource name.

Parameters
Name Description
request GetInstructionRequest

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
TaskInstruction

A Task containing the RPC response.
Overrides

ImportData(ImportDataRequest, CallSettings)

public override Operation<ImportDataOperationResponse, ImportDataOperationMetadata> ImportData(ImportDataRequest request, CallSettings callSettings = null)

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.

Parameters
Name Description
request ImportDataRequest

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
OperationImportDataOperationResponseImportDataOperationMetadata

The RPC response.
Overrides

ImportDataAsync(ImportDataRequest, CallSettings)

public override Task<Operation<ImportDataOperationResponse, ImportDataOperationMetadata>> ImportDataAsync(ImportDataRequest request, CallSettings callSettings = null)

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.

Parameters
Name Description
request ImportDataRequest

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
TaskOperationImportDataOperationResponseImportDataOperationMetadata

A Task containing the RPC response.
Overrides

LabelImage(LabelImageRequest, CallSettings)

public override Operation<AnnotatedDataset, LabelOperationMetadata> LabelImage(LabelImageRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request LabelImageRequest

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
OperationAnnotatedDatasetLabelOperationMetadata

The RPC response.
Overrides

LabelImageAsync(LabelImageRequest, CallSettings)

public override Task<Operation<AnnotatedDataset, LabelOperationMetadata>> LabelImageAsync(LabelImageRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request LabelImageRequest

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
TaskOperationAnnotatedDatasetLabelOperationMetadata

A Task containing the RPC response.
Overrides

LabelText(LabelTextRequest, CallSettings)

public override Operation<AnnotatedDataset, LabelOperationMetadata> LabelText(LabelTextRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request LabelTextRequest

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
OperationAnnotatedDatasetLabelOperationMetadata

The RPC response.
Overrides

LabelTextAsync(LabelTextRequest, CallSettings)

public override Task<Operation<AnnotatedDataset, LabelOperationMetadata>> LabelTextAsync(LabelTextRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request LabelTextRequest

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
TaskOperationAnnotatedDatasetLabelOperationMetadata

A Task containing the RPC response.
Overrides

LabelVideo(LabelVideoRequest, CallSettings)

public override Operation<AnnotatedDataset, LabelOperationMetadata> LabelVideo(LabelVideoRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request LabelVideoRequest

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
OperationAnnotatedDatasetLabelOperationMetadata

The RPC response.
Overrides

LabelVideoAsync(LabelVideoRequest, CallSettings)

public override Task<Operation<AnnotatedDataset, LabelOperationMetadata>> LabelVideoAsync(LabelVideoRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request LabelVideoRequest

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
TaskOperationAnnotatedDatasetLabelOperationMetadata

A Task containing the RPC response.
Overrides

ListAnnotatedDatasets(ListAnnotatedDatasetsRequest, CallSettings)

public override PagedEnumerable<ListAnnotatedDatasetsResponse, AnnotatedDataset> ListAnnotatedDatasets(ListAnnotatedDatasetsRequest request, CallSettings callSettings = null)

Lists annotated datasets for a dataset. Pagination is supported.

Parameters
Name Description
request ListAnnotatedDatasetsRequest

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
PagedEnumerableListAnnotatedDatasetsResponseAnnotatedDataset

A pageable sequence of AnnotatedDataset resources.
Overrides

ListAnnotatedDatasetsAsync(ListAnnotatedDatasetsRequest, CallSettings)

public override PagedAsyncEnumerable<ListAnnotatedDatasetsResponse, AnnotatedDataset> ListAnnotatedDatasetsAsync(ListAnnotatedDatasetsRequest request, CallSettings callSettings = null)

Lists annotated datasets for a dataset. Pagination is supported.

Parameters
Name Description
request ListAnnotatedDatasetsRequest

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
PagedAsyncEnumerableListAnnotatedDatasetsResponseAnnotatedDataset

A pageable asynchronous sequence of AnnotatedDataset resources.
Overrides

ListAnnotationSpecSets(ListAnnotationSpecSetsRequest, CallSettings)

public override PagedEnumerable<ListAnnotationSpecSetsResponse, AnnotationSpecSet> ListAnnotationSpecSets(ListAnnotationSpecSetsRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request ListAnnotationSpecSetsRequest

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
PagedEnumerableListAnnotationSpecSetsResponseAnnotationSpecSet

A pageable sequence of AnnotationSpecSet resources.
Overrides

ListAnnotationSpecSetsAsync(ListAnnotationSpecSetsRequest, CallSettings)

public override PagedAsyncEnumerable<ListAnnotationSpecSetsResponse, AnnotationSpecSet> ListAnnotationSpecSetsAsync(ListAnnotationSpecSetsRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request ListAnnotationSpecSetsRequest

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
PagedAsyncEnumerableListAnnotationSpecSetsResponseAnnotationSpecSet

A pageable asynchronous sequence of AnnotationSpecSet resources.
Overrides

ListDataItems(ListDataItemsRequest, CallSettings)

public override PagedEnumerable<ListDataItemsResponse, DataItem> ListDataItems(ListDataItemsRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request ListDataItemsRequest

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
PagedEnumerableListDataItemsResponseDataItem

A pageable sequence of DataItem resources.
Overrides

ListDataItemsAsync(ListDataItemsRequest, CallSettings)

public override PagedAsyncEnumerable<ListDataItemsResponse, DataItem> ListDataItemsAsync(ListDataItemsRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request ListDataItemsRequest

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
PagedAsyncEnumerableListDataItemsResponseDataItem

A pageable asynchronous sequence of DataItem resources.
Overrides

ListDatasets(ListDatasetsRequest, CallSettings)

public override PagedEnumerable<ListDatasetsResponse, Dataset> ListDatasets(ListDatasetsRequest request, CallSettings callSettings = null)

Lists datasets under a project. Pagination is supported.

Parameters
Name Description
request ListDatasetsRequest

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
PagedEnumerableListDatasetsResponseDataset

A pageable sequence of Dataset resources.
Overrides

ListDatasetsAsync(ListDatasetsRequest, CallSettings)

public override PagedAsyncEnumerable<ListDatasetsResponse, Dataset> ListDatasetsAsync(ListDatasetsRequest request, CallSettings callSettings = null)

Lists datasets under a project. Pagination is supported.

Parameters
Name Description
request ListDatasetsRequest

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
PagedAsyncEnumerableListDatasetsResponseDataset

A pageable asynchronous sequence of Dataset resources.
Overrides

ListEvaluationJobs(ListEvaluationJobsRequest, CallSettings)

public override PagedEnumerable<ListEvaluationJobsResponse, EvaluationJob> ListEvaluationJobs(ListEvaluationJobsRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request ListEvaluationJobsRequest

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
PagedEnumerableListEvaluationJobsResponseEvaluationJob

A pageable sequence of EvaluationJob resources.
Overrides

ListEvaluationJobsAsync(ListEvaluationJobsRequest, CallSettings)

public override PagedAsyncEnumerable<ListEvaluationJobsResponse, EvaluationJob> ListEvaluationJobsAsync(ListEvaluationJobsRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request ListEvaluationJobsRequest

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
PagedAsyncEnumerableListEvaluationJobsResponseEvaluationJob

A pageable asynchronous sequence of EvaluationJob resources.
Overrides

ListExamples(ListExamplesRequest, CallSettings)

public override PagedEnumerable<ListExamplesResponse, Example> ListExamples(ListExamplesRequest request, CallSettings callSettings = null)

Lists examples in an annotated dataset. Pagination is supported.

Parameters
Name Description
request ListExamplesRequest

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
PagedEnumerableListExamplesResponseExample

A pageable sequence of Example resources.
Overrides

ListExamplesAsync(ListExamplesRequest, CallSettings)

public override PagedAsyncEnumerable<ListExamplesResponse, Example> ListExamplesAsync(ListExamplesRequest request, CallSettings callSettings = null)

Lists examples in an annotated dataset. Pagination is supported.

Parameters
Name Description
request ListExamplesRequest

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
PagedAsyncEnumerableListExamplesResponseExample

A pageable asynchronous sequence of Example resources.
Overrides

ListInstructions(ListInstructionsRequest, CallSettings)

public override PagedEnumerable<ListInstructionsResponse, Instruction> ListInstructions(ListInstructionsRequest request, CallSettings callSettings = null)

Lists instructions for a project. Pagination is supported.

Parameters
Name Description
request ListInstructionsRequest

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
PagedEnumerableListInstructionsResponseInstruction

A pageable sequence of Instruction resources.
Overrides

ListInstructionsAsync(ListInstructionsRequest, CallSettings)

public override PagedAsyncEnumerable<ListInstructionsResponse, Instruction> ListInstructionsAsync(ListInstructionsRequest request, CallSettings callSettings = null)

Lists instructions for a project. Pagination is supported.

Parameters
Name Description
request ListInstructionsRequest

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
PagedAsyncEnumerableListInstructionsResponseInstruction

A pageable asynchronous sequence of Instruction resources.
Overrides

PauseEvaluationJob(PauseEvaluationJobRequest, CallSettings)

public override void PauseEvaluationJob(PauseEvaluationJobRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request PauseEvaluationJobRequest

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)

public override Task PauseEvaluationJobAsync(PauseEvaluationJobRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request PauseEvaluationJobRequest

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
Task

A Task containing the RPC response.
Overrides

ResumeEvaluationJob(ResumeEvaluationJobRequest, CallSettings)

public override void ResumeEvaluationJob(ResumeEvaluationJobRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request ResumeEvaluationJobRequest

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)

public override Task ResumeEvaluationJobAsync(ResumeEvaluationJobRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request ResumeEvaluationJobRequest

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
Task

A Task containing the RPC response.
Overrides

SearchEvaluations(SearchEvaluationsRequest, CallSettings)

public override PagedEnumerable<SearchEvaluationsResponse, Evaluation> SearchEvaluations(SearchEvaluationsRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request SearchEvaluationsRequest

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
PagedEnumerableSearchEvaluationsResponseEvaluation

A pageable sequence of Evaluation resources.
Overrides

SearchEvaluationsAsync(SearchEvaluationsRequest, CallSettings)

public override PagedAsyncEnumerable<SearchEvaluationsResponse, Evaluation> SearchEvaluationsAsync(SearchEvaluationsRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request SearchEvaluationsRequest

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
PagedAsyncEnumerableSearchEvaluationsResponseEvaluation

A pageable asynchronous sequence of Evaluation resources.
Overrides

SearchExampleComparisons(SearchExampleComparisonsRequest, CallSettings)

public override PagedEnumerable<SearchExampleComparisonsResponse, SearchExampleComparisonsResponse.Types.ExampleComparison> SearchExampleComparisons(SearchExampleComparisonsRequest request, CallSettings callSettings = null)

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.

Parameters
Name Description
request SearchExampleComparisonsRequest

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
PagedEnumerableSearchExampleComparisonsResponseSearchExampleComparisonsResponseTypesExampleComparison

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

SearchExampleComparisonsAsync(SearchExampleComparisonsRequest, CallSettings)

public override PagedAsyncEnumerable<SearchExampleComparisonsResponse, SearchExampleComparisonsResponse.Types.ExampleComparison> SearchExampleComparisonsAsync(SearchExampleComparisonsRequest request, CallSettings callSettings = null)

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.

Parameters
Name Description
request SearchExampleComparisonsRequest

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
PagedAsyncEnumerableSearchExampleComparisonsResponseSearchExampleComparisonsResponseTypesExampleComparison

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

UpdateEvaluationJob(UpdateEvaluationJobRequest, CallSettings)

public override EvaluationJob UpdateEvaluationJob(UpdateEvaluationJobRequest request, CallSettings callSettings = null)

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.

Parameters
Name Description
request UpdateEvaluationJobRequest

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)

public override Task<EvaluationJob> UpdateEvaluationJobAsync(UpdateEvaluationJobRequest request, CallSettings callSettings = null)

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.

Parameters
Name Description
request UpdateEvaluationJobRequest

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
TaskEvaluationJob

A Task containing the RPC response.
Overrides