Data Labeling v1beta1 API - Class DataLabelingService.DataLabelingServiceClient (2.0.0-beta05)

public class DataLabelingService.DataLabelingServiceClient : ClientBase<DataLabelingService.DataLabelingServiceClient>

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

Client for DataLabelingService

Inheritance

object > ClientBase > ClientBaseDataLabelingServiceDataLabelingServiceClient > DataLabelingService.DataLabelingServiceClient

Namespace

Google.Cloud.DataLabeling.V1Beta1

Assembly

Google.Cloud.DataLabeling.V1Beta1.dll

Constructors

DataLabelingServiceClient()

protected DataLabelingServiceClient()

Protected parameterless constructor to allow creation of test doubles.

DataLabelingServiceClient(CallInvoker)

public DataLabelingServiceClient(CallInvoker callInvoker)

Creates a new client for DataLabelingService that uses a custom CallInvoker.

Parameter
Name Description
callInvoker CallInvoker

The callInvoker to use to make remote calls.

DataLabelingServiceClient(ChannelBase)

public DataLabelingServiceClient(ChannelBase channel)

Creates a new client for DataLabelingService

Parameter
Name Description
channel ChannelBase

The channel to use to make remote calls.

DataLabelingServiceClient(ClientBaseConfiguration)

protected DataLabelingServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration

The client configuration.

Methods

CreateAnnotationSpecSet(CreateAnnotationSpecSetRequest, CallOptions)

public virtual AnnotationSpecSet CreateAnnotationSpecSet(CreateAnnotationSpecSetRequest request, CallOptions options)

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

Parameters
Name Description
request CreateAnnotationSpecSetRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AnnotationSpecSet

The response received from the server.

CreateAnnotationSpecSet(CreateAnnotationSpecSetRequest, Metadata, DateTime?, CancellationToken)

public virtual AnnotationSpecSet CreateAnnotationSpecSet(CreateAnnotationSpecSetRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name Description
request CreateAnnotationSpecSetRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AnnotationSpecSet

The response received from the server.

CreateAnnotationSpecSetAsync(CreateAnnotationSpecSetRequest, CallOptions)

public virtual AsyncUnaryCall<AnnotationSpecSet> CreateAnnotationSpecSetAsync(CreateAnnotationSpecSetRequest request, CallOptions options)

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

Parameters
Name Description
request CreateAnnotationSpecSetRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallAnnotationSpecSet

The call object.

CreateAnnotationSpecSetAsync(CreateAnnotationSpecSetRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<AnnotationSpecSet> CreateAnnotationSpecSetAsync(CreateAnnotationSpecSetRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name Description
request CreateAnnotationSpecSetRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallAnnotationSpecSet

The call object.

CreateDataset(CreateDatasetRequest, CallOptions)

public virtual Dataset CreateDataset(CreateDatasetRequest request, CallOptions options)

Creates dataset. If success return a Dataset resource.

Parameters
Name Description
request CreateDatasetRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Dataset

The response received from the server.

CreateDataset(CreateDatasetRequest, Metadata, DateTime?, CancellationToken)

public virtual Dataset CreateDataset(CreateDatasetRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates dataset. If success return a Dataset resource.

Parameters
Name Description
request CreateDatasetRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Dataset

The response received from the server.

CreateDatasetAsync(CreateDatasetRequest, CallOptions)

public virtual AsyncUnaryCall<Dataset> CreateDatasetAsync(CreateDatasetRequest request, CallOptions options)

Creates dataset. If success return a Dataset resource.

Parameters
Name Description
request CreateDatasetRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallDataset

The call object.

CreateDatasetAsync(CreateDatasetRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Dataset> CreateDatasetAsync(CreateDatasetRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates dataset. If success return a Dataset resource.

Parameters
Name Description
request CreateDatasetRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallDataset

The call object.

CreateEvaluationJob(CreateEvaluationJobRequest, CallOptions)

public virtual EvaluationJob CreateEvaluationJob(CreateEvaluationJobRequest request, CallOptions options)

Creates an evaluation job.

Parameters
Name Description
request CreateEvaluationJobRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
EvaluationJob

The response received from the server.

CreateEvaluationJob(CreateEvaluationJobRequest, Metadata, DateTime?, CancellationToken)

public virtual EvaluationJob CreateEvaluationJob(CreateEvaluationJobRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates an evaluation job.

Parameters
Name Description
request CreateEvaluationJobRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
EvaluationJob

The response received from the server.

CreateEvaluationJobAsync(CreateEvaluationJobRequest, CallOptions)

public virtual AsyncUnaryCall<EvaluationJob> CreateEvaluationJobAsync(CreateEvaluationJobRequest request, CallOptions options)

Creates an evaluation job.

Parameters
Name Description
request CreateEvaluationJobRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallEvaluationJob

The call object.

CreateEvaluationJobAsync(CreateEvaluationJobRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<EvaluationJob> CreateEvaluationJobAsync(CreateEvaluationJobRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates an evaluation job.

Parameters
Name Description
request CreateEvaluationJobRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallEvaluationJob

The call object.

CreateInstruction(CreateInstructionRequest, CallOptions)

public virtual Operation CreateInstruction(CreateInstructionRequest request, CallOptions options)

Creates an instruction for how data should be labeled.

Parameters
Name Description
request CreateInstructionRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

CreateInstruction(CreateInstructionRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation CreateInstruction(CreateInstructionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates an instruction for how data should be labeled.

Parameters
Name Description
request CreateInstructionRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Operation

The response received from the server.

CreateInstructionAsync(CreateInstructionRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateInstructionAsync(CreateInstructionRequest request, CallOptions options)

Creates an instruction for how data should be labeled.

Parameters
Name Description
request CreateInstructionRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

CreateInstructionAsync(CreateInstructionRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> CreateInstructionAsync(CreateInstructionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates an instruction for how data should be labeled.

Parameters
Name Description
request CreateInstructionRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

CreateOperationsClient()

public virtual Operations.OperationsClient CreateOperationsClient()

Creates a new instance of Operations.OperationsClient using the same call invoker as this client.

Returns
Type Description
OperationsOperationsClient

A new Operations client for the same target as this client.

DeleteAnnotatedDataset(DeleteAnnotatedDatasetRequest, CallOptions)

public virtual Empty DeleteAnnotatedDataset(DeleteAnnotatedDatasetRequest request, CallOptions options)

Deletes an annotated dataset by resource name.

Parameters
Name Description
request DeleteAnnotatedDatasetRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Empty

The response received from the server.

DeleteAnnotatedDataset(DeleteAnnotatedDatasetRequest, Metadata, DateTime?, CancellationToken)

public virtual Empty DeleteAnnotatedDataset(DeleteAnnotatedDatasetRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes an annotated dataset by resource name.

Parameters
Name Description
request DeleteAnnotatedDatasetRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Empty

The response received from the server.

DeleteAnnotatedDatasetAsync(DeleteAnnotatedDatasetRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> DeleteAnnotatedDatasetAsync(DeleteAnnotatedDatasetRequest request, CallOptions options)

Deletes an annotated dataset by resource name.

Parameters
Name Description
request DeleteAnnotatedDatasetRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallEmpty

The call object.

DeleteAnnotatedDatasetAsync(DeleteAnnotatedDatasetRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Empty> DeleteAnnotatedDatasetAsync(DeleteAnnotatedDatasetRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes an annotated dataset by resource name.

Parameters
Name Description
request DeleteAnnotatedDatasetRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallEmpty

The call object.

DeleteAnnotationSpecSet(DeleteAnnotationSpecSetRequest, CallOptions)

public virtual Empty DeleteAnnotationSpecSet(DeleteAnnotationSpecSetRequest request, CallOptions options)

Deletes an annotation spec set by resource name.

Parameters
Name Description
request DeleteAnnotationSpecSetRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Empty

The response received from the server.

DeleteAnnotationSpecSet(DeleteAnnotationSpecSetRequest, Metadata, DateTime?, CancellationToken)

public virtual Empty DeleteAnnotationSpecSet(DeleteAnnotationSpecSetRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes an annotation spec set by resource name.

Parameters
Name Description
request DeleteAnnotationSpecSetRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Empty

The response received from the server.

DeleteAnnotationSpecSetAsync(DeleteAnnotationSpecSetRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> DeleteAnnotationSpecSetAsync(DeleteAnnotationSpecSetRequest request, CallOptions options)

Deletes an annotation spec set by resource name.

Parameters
Name Description
request DeleteAnnotationSpecSetRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallEmpty

The call object.

DeleteAnnotationSpecSetAsync(DeleteAnnotationSpecSetRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Empty> DeleteAnnotationSpecSetAsync(DeleteAnnotationSpecSetRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes an annotation spec set by resource name.

Parameters
Name Description
request DeleteAnnotationSpecSetRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallEmpty

The call object.

DeleteDataset(DeleteDatasetRequest, CallOptions)

public virtual Empty DeleteDataset(DeleteDatasetRequest request, CallOptions options)

Deletes a dataset by resource name.

Parameters
Name Description
request DeleteDatasetRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Empty

The response received from the server.

DeleteDataset(DeleteDatasetRequest, Metadata, DateTime?, CancellationToken)

public virtual Empty DeleteDataset(DeleteDatasetRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a dataset by resource name.

Parameters
Name Description
request DeleteDatasetRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Empty

The response received from the server.

DeleteDatasetAsync(DeleteDatasetRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> DeleteDatasetAsync(DeleteDatasetRequest request, CallOptions options)

Deletes a dataset by resource name.

Parameters
Name Description
request DeleteDatasetRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallEmpty

The call object.

DeleteDatasetAsync(DeleteDatasetRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Empty> DeleteDatasetAsync(DeleteDatasetRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a dataset by resource name.

Parameters
Name Description
request DeleteDatasetRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallEmpty

The call object.

DeleteEvaluationJob(DeleteEvaluationJobRequest, CallOptions)

public virtual Empty DeleteEvaluationJob(DeleteEvaluationJobRequest request, CallOptions options)

Stops and deletes an evaluation job.

Parameters
Name Description
request DeleteEvaluationJobRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Empty

The response received from the server.

DeleteEvaluationJob(DeleteEvaluationJobRequest, Metadata, DateTime?, CancellationToken)

public virtual Empty DeleteEvaluationJob(DeleteEvaluationJobRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Stops and deletes an evaluation job.

Parameters
Name Description
request DeleteEvaluationJobRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Empty

The response received from the server.

DeleteEvaluationJobAsync(DeleteEvaluationJobRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> DeleteEvaluationJobAsync(DeleteEvaluationJobRequest request, CallOptions options)

Stops and deletes an evaluation job.

Parameters
Name Description
request DeleteEvaluationJobRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallEmpty

The call object.

DeleteEvaluationJobAsync(DeleteEvaluationJobRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Empty> DeleteEvaluationJobAsync(DeleteEvaluationJobRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Stops and deletes an evaluation job.

Parameters
Name Description
request DeleteEvaluationJobRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallEmpty

The call object.

DeleteInstruction(DeleteInstructionRequest, CallOptions)

public virtual Empty DeleteInstruction(DeleteInstructionRequest request, CallOptions options)

Deletes an instruction object by resource name.

Parameters
Name Description
request DeleteInstructionRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Empty

The response received from the server.

DeleteInstruction(DeleteInstructionRequest, Metadata, DateTime?, CancellationToken)

public virtual Empty DeleteInstruction(DeleteInstructionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes an instruction object by resource name.

Parameters
Name Description
request DeleteInstructionRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Empty

The response received from the server.

DeleteInstructionAsync(DeleteInstructionRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> DeleteInstructionAsync(DeleteInstructionRequest request, CallOptions options)

Deletes an instruction object by resource name.

Parameters
Name Description
request DeleteInstructionRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallEmpty

The call object.

DeleteInstructionAsync(DeleteInstructionRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Empty> DeleteInstructionAsync(DeleteInstructionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes an instruction object by resource name.

Parameters
Name Description
request DeleteInstructionRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallEmpty

The call object.

ExportData(ExportDataRequest, CallOptions)

public virtual Operation ExportData(ExportDataRequest request, CallOptions options)

Exports data and annotations from dataset.

Parameters
Name Description
request ExportDataRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

ExportData(ExportDataRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation ExportData(ExportDataRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Exports data and annotations from dataset.

Parameters
Name Description
request ExportDataRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Operation

The response received from the server.

ExportDataAsync(ExportDataRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> ExportDataAsync(ExportDataRequest request, CallOptions options)

Exports data and annotations from dataset.

Parameters
Name Description
request ExportDataRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

ExportDataAsync(ExportDataRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> ExportDataAsync(ExportDataRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Exports data and annotations from dataset.

Parameters
Name Description
request ExportDataRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

GetAnnotatedDataset(GetAnnotatedDatasetRequest, CallOptions)

public virtual AnnotatedDataset GetAnnotatedDataset(GetAnnotatedDatasetRequest request, CallOptions options)

Gets an annotated dataset by resource name.

Parameters
Name Description
request GetAnnotatedDatasetRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AnnotatedDataset

The response received from the server.

GetAnnotatedDataset(GetAnnotatedDatasetRequest, Metadata, DateTime?, CancellationToken)

public virtual AnnotatedDataset GetAnnotatedDataset(GetAnnotatedDatasetRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets an annotated dataset by resource name.

Parameters
Name Description
request GetAnnotatedDatasetRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AnnotatedDataset

The response received from the server.

GetAnnotatedDatasetAsync(GetAnnotatedDatasetRequest, CallOptions)

public virtual AsyncUnaryCall<AnnotatedDataset> GetAnnotatedDatasetAsync(GetAnnotatedDatasetRequest request, CallOptions options)

Gets an annotated dataset by resource name.

Parameters
Name Description
request GetAnnotatedDatasetRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallAnnotatedDataset

The call object.

GetAnnotatedDatasetAsync(GetAnnotatedDatasetRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<AnnotatedDataset> GetAnnotatedDatasetAsync(GetAnnotatedDatasetRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets an annotated dataset by resource name.

Parameters
Name Description
request GetAnnotatedDatasetRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallAnnotatedDataset

The call object.

GetAnnotationSpecSet(GetAnnotationSpecSetRequest, CallOptions)

public virtual AnnotationSpecSet GetAnnotationSpecSet(GetAnnotationSpecSetRequest request, CallOptions options)

Gets an annotation spec set by resource name.

Parameters
Name Description
request GetAnnotationSpecSetRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AnnotationSpecSet

The response received from the server.

GetAnnotationSpecSet(GetAnnotationSpecSetRequest, Metadata, DateTime?, CancellationToken)

public virtual AnnotationSpecSet GetAnnotationSpecSet(GetAnnotationSpecSetRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets an annotation spec set by resource name.

Parameters
Name Description
request GetAnnotationSpecSetRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AnnotationSpecSet

The response received from the server.

GetAnnotationSpecSetAsync(GetAnnotationSpecSetRequest, CallOptions)

public virtual AsyncUnaryCall<AnnotationSpecSet> GetAnnotationSpecSetAsync(GetAnnotationSpecSetRequest request, CallOptions options)

Gets an annotation spec set by resource name.

Parameters
Name Description
request GetAnnotationSpecSetRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallAnnotationSpecSet

The call object.

GetAnnotationSpecSetAsync(GetAnnotationSpecSetRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<AnnotationSpecSet> GetAnnotationSpecSetAsync(GetAnnotationSpecSetRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets an annotation spec set by resource name.

Parameters
Name Description
request GetAnnotationSpecSetRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallAnnotationSpecSet

The call object.

GetDataItem(GetDataItemRequest, CallOptions)

public virtual DataItem GetDataItem(GetDataItemRequest request, CallOptions options)

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 to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
DataItem

The response received from the server.

GetDataItem(GetDataItemRequest, Metadata, DateTime?, CancellationToken)

public virtual DataItem GetDataItem(GetDataItemRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
DataItem

The response received from the server.

GetDataItemAsync(GetDataItemRequest, CallOptions)

public virtual AsyncUnaryCall<DataItem> GetDataItemAsync(GetDataItemRequest request, CallOptions options)

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 to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallDataItem

The call object.

GetDataItemAsync(GetDataItemRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<DataItem> GetDataItemAsync(GetDataItemRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallDataItem

The call object.

GetDataset(GetDatasetRequest, CallOptions)

public virtual Dataset GetDataset(GetDatasetRequest request, CallOptions options)

Gets dataset by resource name.

Parameters
Name Description
request GetDatasetRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Dataset

The response received from the server.

GetDataset(GetDatasetRequest, Metadata, DateTime?, CancellationToken)

public virtual Dataset GetDataset(GetDatasetRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets dataset by resource name.

Parameters
Name Description
request GetDatasetRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Dataset

The response received from the server.

GetDatasetAsync(GetDatasetRequest, CallOptions)

public virtual AsyncUnaryCall<Dataset> GetDatasetAsync(GetDatasetRequest request, CallOptions options)

Gets dataset by resource name.

Parameters
Name Description
request GetDatasetRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallDataset

The call object.

GetDatasetAsync(GetDatasetRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Dataset> GetDatasetAsync(GetDatasetRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets dataset by resource name.

Parameters
Name Description
request GetDatasetRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallDataset

The call object.

GetEvaluation(GetEvaluationRequest, CallOptions)

public virtual Evaluation GetEvaluation(GetEvaluationRequest request, CallOptions options)

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 to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Evaluation

The response received from the server.

GetEvaluation(GetEvaluationRequest, Metadata, DateTime?, CancellationToken)

public virtual Evaluation GetEvaluation(GetEvaluationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Evaluation

The response received from the server.

GetEvaluationAsync(GetEvaluationRequest, CallOptions)

public virtual AsyncUnaryCall<Evaluation> GetEvaluationAsync(GetEvaluationRequest request, CallOptions options)

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 to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallEvaluation

The call object.

GetEvaluationAsync(GetEvaluationRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Evaluation> GetEvaluationAsync(GetEvaluationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallEvaluation

The call object.

GetEvaluationJob(GetEvaluationJobRequest, CallOptions)

public virtual EvaluationJob GetEvaluationJob(GetEvaluationJobRequest request, CallOptions options)

Gets an evaluation job by resource name.

Parameters
Name Description
request GetEvaluationJobRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
EvaluationJob

The response received from the server.

GetEvaluationJob(GetEvaluationJobRequest, Metadata, DateTime?, CancellationToken)

public virtual EvaluationJob GetEvaluationJob(GetEvaluationJobRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets an evaluation job by resource name.

Parameters
Name Description
request GetEvaluationJobRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
EvaluationJob

The response received from the server.

GetEvaluationJobAsync(GetEvaluationJobRequest, CallOptions)

public virtual AsyncUnaryCall<EvaluationJob> GetEvaluationJobAsync(GetEvaluationJobRequest request, CallOptions options)

Gets an evaluation job by resource name.

Parameters
Name Description
request GetEvaluationJobRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallEvaluationJob

The call object.

GetEvaluationJobAsync(GetEvaluationJobRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<EvaluationJob> GetEvaluationJobAsync(GetEvaluationJobRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets an evaluation job by resource name.

Parameters
Name Description
request GetEvaluationJobRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallEvaluationJob

The call object.

GetExample(GetExampleRequest, CallOptions)

public virtual Example GetExample(GetExampleRequest request, CallOptions options)

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

Parameters
Name Description
request GetExampleRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Example

The response received from the server.

GetExample(GetExampleRequest, Metadata, DateTime?, CancellationToken)

public virtual Example GetExample(GetExampleRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name Description
request GetExampleRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Example

The response received from the server.

GetExampleAsync(GetExampleRequest, CallOptions)

public virtual AsyncUnaryCall<Example> GetExampleAsync(GetExampleRequest request, CallOptions options)

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

Parameters
Name Description
request GetExampleRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallExample

The call object.

GetExampleAsync(GetExampleRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Example> GetExampleAsync(GetExampleRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name Description
request GetExampleRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallExample

The call object.

GetInstruction(GetInstructionRequest, CallOptions)

public virtual Instruction GetInstruction(GetInstructionRequest request, CallOptions options)

Gets an instruction by resource name.

Parameters
Name Description
request GetInstructionRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Instruction

The response received from the server.

GetInstruction(GetInstructionRequest, Metadata, DateTime?, CancellationToken)

public virtual Instruction GetInstruction(GetInstructionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets an instruction by resource name.

Parameters
Name Description
request GetInstructionRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Instruction

The response received from the server.

GetInstructionAsync(GetInstructionRequest, CallOptions)

public virtual AsyncUnaryCall<Instruction> GetInstructionAsync(GetInstructionRequest request, CallOptions options)

Gets an instruction by resource name.

Parameters
Name Description
request GetInstructionRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallInstruction

The call object.

GetInstructionAsync(GetInstructionRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Instruction> GetInstructionAsync(GetInstructionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets an instruction by resource name.

Parameters
Name Description
request GetInstructionRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallInstruction

The call object.

ImportData(ImportDataRequest, CallOptions)

public virtual Operation ImportData(ImportDataRequest request, CallOptions options)

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 to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

ImportData(ImportDataRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation ImportData(ImportDataRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Operation

The response received from the server.

ImportDataAsync(ImportDataRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> ImportDataAsync(ImportDataRequest request, CallOptions options)

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 to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

ImportDataAsync(ImportDataRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> ImportDataAsync(ImportDataRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

LabelImage(LabelImageRequest, CallOptions)

public virtual Operation LabelImage(LabelImageRequest request, CallOptions options)

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 to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

LabelImage(LabelImageRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation LabelImage(LabelImageRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Operation

The response received from the server.

LabelImageAsync(LabelImageRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> LabelImageAsync(LabelImageRequest request, CallOptions options)

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 to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

LabelImageAsync(LabelImageRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> LabelImageAsync(LabelImageRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

LabelText(LabelTextRequest, CallOptions)

public virtual Operation LabelText(LabelTextRequest request, CallOptions options)

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 to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

LabelText(LabelTextRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation LabelText(LabelTextRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Operation

The response received from the server.

LabelTextAsync(LabelTextRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> LabelTextAsync(LabelTextRequest request, CallOptions options)

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 to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

LabelTextAsync(LabelTextRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> LabelTextAsync(LabelTextRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

LabelVideo(LabelVideoRequest, CallOptions)

public virtual Operation LabelVideo(LabelVideoRequest request, CallOptions options)

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 to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

LabelVideo(LabelVideoRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation LabelVideo(LabelVideoRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Operation

The response received from the server.

LabelVideoAsync(LabelVideoRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> LabelVideoAsync(LabelVideoRequest request, CallOptions options)

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 to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

LabelVideoAsync(LabelVideoRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> LabelVideoAsync(LabelVideoRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

ListAnnotatedDatasets(ListAnnotatedDatasetsRequest, CallOptions)

public virtual ListAnnotatedDatasetsResponse ListAnnotatedDatasets(ListAnnotatedDatasetsRequest request, CallOptions options)

Lists annotated datasets for a dataset. Pagination is supported.

Parameters
Name Description
request ListAnnotatedDatasetsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
ListAnnotatedDatasetsResponse

The response received from the server.

ListAnnotatedDatasets(ListAnnotatedDatasetsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListAnnotatedDatasetsResponse ListAnnotatedDatasets(ListAnnotatedDatasetsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists annotated datasets for a dataset. Pagination is supported.

Parameters
Name Description
request ListAnnotatedDatasetsRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
ListAnnotatedDatasetsResponse

The response received from the server.

ListAnnotatedDatasetsAsync(ListAnnotatedDatasetsRequest, CallOptions)

public virtual AsyncUnaryCall<ListAnnotatedDatasetsResponse> ListAnnotatedDatasetsAsync(ListAnnotatedDatasetsRequest request, CallOptions options)

Lists annotated datasets for a dataset. Pagination is supported.

Parameters
Name Description
request ListAnnotatedDatasetsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallListAnnotatedDatasetsResponse

The call object.

ListAnnotatedDatasetsAsync(ListAnnotatedDatasetsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListAnnotatedDatasetsResponse> ListAnnotatedDatasetsAsync(ListAnnotatedDatasetsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists annotated datasets for a dataset. Pagination is supported.

Parameters
Name Description
request ListAnnotatedDatasetsRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallListAnnotatedDatasetsResponse

The call object.

ListAnnotationSpecSets(ListAnnotationSpecSetsRequest, CallOptions)

public virtual ListAnnotationSpecSetsResponse ListAnnotationSpecSets(ListAnnotationSpecSetsRequest request, CallOptions options)

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

Parameters
Name Description
request ListAnnotationSpecSetsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
ListAnnotationSpecSetsResponse

The response received from the server.

ListAnnotationSpecSets(ListAnnotationSpecSetsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListAnnotationSpecSetsResponse ListAnnotationSpecSets(ListAnnotationSpecSetsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name Description
request ListAnnotationSpecSetsRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
ListAnnotationSpecSetsResponse

The response received from the server.

ListAnnotationSpecSetsAsync(ListAnnotationSpecSetsRequest, CallOptions)

public virtual AsyncUnaryCall<ListAnnotationSpecSetsResponse> ListAnnotationSpecSetsAsync(ListAnnotationSpecSetsRequest request, CallOptions options)

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

Parameters
Name Description
request ListAnnotationSpecSetsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallListAnnotationSpecSetsResponse

The call object.

ListAnnotationSpecSetsAsync(ListAnnotationSpecSetsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListAnnotationSpecSetsResponse> ListAnnotationSpecSetsAsync(ListAnnotationSpecSetsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name Description
request ListAnnotationSpecSetsRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallListAnnotationSpecSetsResponse

The call object.

ListDataItems(ListDataItemsRequest, CallOptions)

public virtual ListDataItemsResponse ListDataItems(ListDataItemsRequest request, CallOptions options)

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 to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
ListDataItemsResponse

The response received from the server.

ListDataItems(ListDataItemsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListDataItemsResponse ListDataItems(ListDataItemsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
ListDataItemsResponse

The response received from the server.

ListDataItemsAsync(ListDataItemsRequest, CallOptions)

public virtual AsyncUnaryCall<ListDataItemsResponse> ListDataItemsAsync(ListDataItemsRequest request, CallOptions options)

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 to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallListDataItemsResponse

The call object.

ListDataItemsAsync(ListDataItemsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListDataItemsResponse> ListDataItemsAsync(ListDataItemsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallListDataItemsResponse

The call object.

ListDatasets(ListDatasetsRequest, CallOptions)

public virtual ListDatasetsResponse ListDatasets(ListDatasetsRequest request, CallOptions options)

Lists datasets under a project. Pagination is supported.

Parameters
Name Description
request ListDatasetsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
ListDatasetsResponse

The response received from the server.

ListDatasets(ListDatasetsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListDatasetsResponse ListDatasets(ListDatasetsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists datasets under a project. Pagination is supported.

Parameters
Name Description
request ListDatasetsRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
ListDatasetsResponse

The response received from the server.

ListDatasetsAsync(ListDatasetsRequest, CallOptions)

public virtual AsyncUnaryCall<ListDatasetsResponse> ListDatasetsAsync(ListDatasetsRequest request, CallOptions options)

Lists datasets under a project. Pagination is supported.

Parameters
Name Description
request ListDatasetsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallListDatasetsResponse

The call object.

ListDatasetsAsync(ListDatasetsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListDatasetsResponse> ListDatasetsAsync(ListDatasetsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists datasets under a project. Pagination is supported.

Parameters
Name Description
request ListDatasetsRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallListDatasetsResponse

The call object.

ListEvaluationJobs(ListEvaluationJobsRequest, CallOptions)

public virtual ListEvaluationJobsResponse ListEvaluationJobs(ListEvaluationJobsRequest request, CallOptions options)

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

Parameters
Name Description
request ListEvaluationJobsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
ListEvaluationJobsResponse

The response received from the server.

ListEvaluationJobs(ListEvaluationJobsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListEvaluationJobsResponse ListEvaluationJobs(ListEvaluationJobsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name Description
request ListEvaluationJobsRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
ListEvaluationJobsResponse

The response received from the server.

ListEvaluationJobsAsync(ListEvaluationJobsRequest, CallOptions)

public virtual AsyncUnaryCall<ListEvaluationJobsResponse> ListEvaluationJobsAsync(ListEvaluationJobsRequest request, CallOptions options)

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

Parameters
Name Description
request ListEvaluationJobsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallListEvaluationJobsResponse

The call object.

ListEvaluationJobsAsync(ListEvaluationJobsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListEvaluationJobsResponse> ListEvaluationJobsAsync(ListEvaluationJobsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name Description
request ListEvaluationJobsRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallListEvaluationJobsResponse

The call object.

ListExamples(ListExamplesRequest, CallOptions)

public virtual ListExamplesResponse ListExamples(ListExamplesRequest request, CallOptions options)

Lists examples in an annotated dataset. Pagination is supported.

Parameters
Name Description
request ListExamplesRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
ListExamplesResponse

The response received from the server.

ListExamples(ListExamplesRequest, Metadata, DateTime?, CancellationToken)

public virtual ListExamplesResponse ListExamples(ListExamplesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists examples in an annotated dataset. Pagination is supported.

Parameters
Name Description
request ListExamplesRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
ListExamplesResponse

The response received from the server.

ListExamplesAsync(ListExamplesRequest, CallOptions)

public virtual AsyncUnaryCall<ListExamplesResponse> ListExamplesAsync(ListExamplesRequest request, CallOptions options)

Lists examples in an annotated dataset. Pagination is supported.

Parameters
Name Description
request ListExamplesRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallListExamplesResponse

The call object.

ListExamplesAsync(ListExamplesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListExamplesResponse> ListExamplesAsync(ListExamplesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists examples in an annotated dataset. Pagination is supported.

Parameters
Name Description
request ListExamplesRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallListExamplesResponse

The call object.

ListInstructions(ListInstructionsRequest, CallOptions)

public virtual ListInstructionsResponse ListInstructions(ListInstructionsRequest request, CallOptions options)

Lists instructions for a project. Pagination is supported.

Parameters
Name Description
request ListInstructionsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
ListInstructionsResponse

The response received from the server.

ListInstructions(ListInstructionsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListInstructionsResponse ListInstructions(ListInstructionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists instructions for a project. Pagination is supported.

Parameters
Name Description
request ListInstructionsRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
ListInstructionsResponse

The response received from the server.

ListInstructionsAsync(ListInstructionsRequest, CallOptions)

public virtual AsyncUnaryCall<ListInstructionsResponse> ListInstructionsAsync(ListInstructionsRequest request, CallOptions options)

Lists instructions for a project. Pagination is supported.

Parameters
Name Description
request ListInstructionsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallListInstructionsResponse

The call object.

ListInstructionsAsync(ListInstructionsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListInstructionsResponse> ListInstructionsAsync(ListInstructionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists instructions for a project. Pagination is supported.

Parameters
Name Description
request ListInstructionsRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallListInstructionsResponse

The call object.

NewInstance(ClientBaseConfiguration)

protected override DataLabelingService.DataLabelingServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration
Returns
Type Description
DataLabelingServiceDataLabelingServiceClient
Overrides

PauseEvaluationJob(PauseEvaluationJobRequest, CallOptions)

public virtual Empty PauseEvaluationJob(PauseEvaluationJobRequest request, CallOptions options)

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 to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Empty

The response received from the server.

PauseEvaluationJob(PauseEvaluationJobRequest, Metadata, DateTime?, CancellationToken)

public virtual Empty PauseEvaluationJob(PauseEvaluationJobRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Empty

The response received from the server.

PauseEvaluationJobAsync(PauseEvaluationJobRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> PauseEvaluationJobAsync(PauseEvaluationJobRequest request, CallOptions options)

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 to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallEmpty

The call object.

PauseEvaluationJobAsync(PauseEvaluationJobRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Empty> PauseEvaluationJobAsync(PauseEvaluationJobRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallEmpty

The call object.

ResumeEvaluationJob(ResumeEvaluationJobRequest, CallOptions)

public virtual Empty ResumeEvaluationJob(ResumeEvaluationJobRequest request, CallOptions options)

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 to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Empty

The response received from the server.

ResumeEvaluationJob(ResumeEvaluationJobRequest, Metadata, DateTime?, CancellationToken)

public virtual Empty ResumeEvaluationJob(ResumeEvaluationJobRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Empty

The response received from the server.

ResumeEvaluationJobAsync(ResumeEvaluationJobRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> ResumeEvaluationJobAsync(ResumeEvaluationJobRequest request, CallOptions options)

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 to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallEmpty

The call object.

ResumeEvaluationJobAsync(ResumeEvaluationJobRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Empty> ResumeEvaluationJobAsync(ResumeEvaluationJobRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallEmpty

The call object.

SearchEvaluations(SearchEvaluationsRequest, CallOptions)

public virtual SearchEvaluationsResponse SearchEvaluations(SearchEvaluationsRequest request, CallOptions options)

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

Parameters
Name Description
request SearchEvaluationsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
SearchEvaluationsResponse

The response received from the server.

SearchEvaluations(SearchEvaluationsRequest, Metadata, DateTime?, CancellationToken)

public virtual SearchEvaluationsResponse SearchEvaluations(SearchEvaluationsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name Description
request SearchEvaluationsRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
SearchEvaluationsResponse

The response received from the server.

SearchEvaluationsAsync(SearchEvaluationsRequest, CallOptions)

public virtual AsyncUnaryCall<SearchEvaluationsResponse> SearchEvaluationsAsync(SearchEvaluationsRequest request, CallOptions options)

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

Parameters
Name Description
request SearchEvaluationsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallSearchEvaluationsResponse

The call object.

SearchEvaluationsAsync(SearchEvaluationsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<SearchEvaluationsResponse> SearchEvaluationsAsync(SearchEvaluationsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name Description
request SearchEvaluationsRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallSearchEvaluationsResponse

The call object.

SearchExampleComparisons(SearchExampleComparisonsRequest, CallOptions)

public virtual SearchExampleComparisonsResponse SearchExampleComparisons(SearchExampleComparisonsRequest request, CallOptions options)

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 to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
SearchExampleComparisonsResponse

The response received from the server.

SearchExampleComparisons(SearchExampleComparisonsRequest, Metadata, DateTime?, CancellationToken)

public virtual SearchExampleComparisonsResponse SearchExampleComparisons(SearchExampleComparisonsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
SearchExampleComparisonsResponse

The response received from the server.

SearchExampleComparisonsAsync(SearchExampleComparisonsRequest, CallOptions)

public virtual AsyncUnaryCall<SearchExampleComparisonsResponse> SearchExampleComparisonsAsync(SearchExampleComparisonsRequest request, CallOptions options)

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 to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallSearchExampleComparisonsResponse

The call object.

SearchExampleComparisonsAsync(SearchExampleComparisonsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<SearchExampleComparisonsResponse> SearchExampleComparisonsAsync(SearchExampleComparisonsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallSearchExampleComparisonsResponse

The call object.

UpdateEvaluationJob(UpdateEvaluationJobRequest, CallOptions)

public virtual EvaluationJob UpdateEvaluationJob(UpdateEvaluationJobRequest request, CallOptions options)

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 to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
EvaluationJob

The response received from the server.

UpdateEvaluationJob(UpdateEvaluationJobRequest, Metadata, DateTime?, CancellationToken)

public virtual EvaluationJob UpdateEvaluationJob(UpdateEvaluationJobRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
EvaluationJob

The response received from the server.

UpdateEvaluationJobAsync(UpdateEvaluationJobRequest, CallOptions)

public virtual AsyncUnaryCall<EvaluationJob> UpdateEvaluationJobAsync(UpdateEvaluationJobRequest request, CallOptions options)

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 to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallEvaluationJob

The call object.

UpdateEvaluationJobAsync(UpdateEvaluationJobRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<EvaluationJob> UpdateEvaluationJobAsync(UpdateEvaluationJobRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallEvaluationJob

The call object.