Show / Hide Table of Contents

Class DataLabelingServiceClient

DataLabelingService client wrapper, for convenient use.

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

Service for the AI Platform Data Labeling API.

Properties

CreateInstructionOperationsClient

The long-running operations client for CreateInstruction.

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

DefaultEndpoint

The default endpoint for the DataLabelingService service, which is a host of "datalabeling.googleapis.com" and a port of 443.

Declaration
public static string DefaultEndpoint { get; }
Property Value
Type Description
System.String

DefaultScopes

The default DataLabelingService scopes.

Declaration
public static IReadOnlyList<string> DefaultScopes { get; }
Property Value
Type Description
System.Collections.Generic.IReadOnlyList<System.String>
Remarks

The default DataLabelingService scopes are:

  • https://www.googleapis.com/auth/cloud-platform

ExportDataOperationsClient

The long-running operations client for ExportData.

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

GrpcClient

The underlying gRPC DataLabelingService client

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

ImportDataOperationsClient

The long-running operations client for ImportData.

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

LabelImageOperationsClient

The long-running operations client for LabelImage.

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

LabelTextOperationsClient

The long-running operations client for LabelText.

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

LabelVideoOperationsClient

The long-running operations client for LabelVideo.

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

Methods

Create()

Synchronously creates a DataLabelingServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use DataLabelingServiceClientBuilder.

Declaration
public static DataLabelingServiceClient Create()
Returns
Type Description
DataLabelingServiceClient

The created DataLabelingServiceClient.

CreateAnnotationSpecSet(ProjectName, AnnotationSpecSet, CallSettings)

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

Declaration
public virtual AnnotationSpecSet CreateAnnotationSpecSet(ProjectName parent, AnnotationSpecSet annotationSpecSet, CallSettings callSettings = null)
Parameters
Type Name Description
ProjectName parent

Required. AnnotationSpecSet resource parent, format: projects/{project_id}

AnnotationSpecSet annotationSpecSet

Required. Annotation spec set to create. Annotation specs must be included. Only one annotation spec will be accepted for annotation specs with same display_name.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
AnnotationSpecSet

The RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.Create();
// Initialize request argument(s)
ProjectName parent = ProjectName.FromProject("[PROJECT]");
AnnotationSpecSet annotationSpecSet = new AnnotationSpecSet();
// Make the request
AnnotationSpecSet response = dataLabelingServiceClient.CreateAnnotationSpecSet(parent, annotationSpecSet);

CreateAnnotationSpecSet(CreateAnnotationSpecSetRequest, CallSettings)

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

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

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

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
AnnotationSpecSet

The RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.Create();
// Initialize request argument(s)
CreateAnnotationSpecSetRequest request = new CreateAnnotationSpecSetRequest
{
    ParentAsProjectName = ProjectName.FromProject("[PROJECT]"),
    AnnotationSpecSet = new AnnotationSpecSet(),
};
// Make the request
AnnotationSpecSet response = dataLabelingServiceClient.CreateAnnotationSpecSet(request);

CreateAnnotationSpecSet(String, AnnotationSpecSet, CallSettings)

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

Declaration
public virtual AnnotationSpecSet CreateAnnotationSpecSet(string parent, AnnotationSpecSet annotationSpecSet, CallSettings callSettings = null)
Parameters
Type Name Description
System.String parent

Required. AnnotationSpecSet resource parent, format: projects/{project_id}

AnnotationSpecSet annotationSpecSet

Required. Annotation spec set to create. Annotation specs must be included. Only one annotation spec will be accepted for annotation specs with same display_name.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
AnnotationSpecSet

The RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]";
AnnotationSpecSet annotationSpecSet = new AnnotationSpecSet();
// Make the request
AnnotationSpecSet response = dataLabelingServiceClient.CreateAnnotationSpecSet(parent, annotationSpecSet);

CreateAnnotationSpecSetAsync(ProjectName, AnnotationSpecSet, CallSettings)

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

Declaration
public virtual Task<AnnotationSpecSet> CreateAnnotationSpecSetAsync(ProjectName parent, AnnotationSpecSet annotationSpecSet, CallSettings callSettings = null)
Parameters
Type Name Description
ProjectName parent

Required. AnnotationSpecSet resource parent, format: projects/{project_id}

AnnotationSpecSet annotationSpecSet

Required. Annotation spec set to create. Annotation specs must be included. Only one annotation spec will be accepted for annotation specs with same display_name.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task<AnnotationSpecSet>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
ProjectName parent = ProjectName.FromProject("[PROJECT]");
AnnotationSpecSet annotationSpecSet = new AnnotationSpecSet();
// Make the request
AnnotationSpecSet response = await dataLabelingServiceClient.CreateAnnotationSpecSetAsync(parent, annotationSpecSet);

CreateAnnotationSpecSetAsync(ProjectName, AnnotationSpecSet, CancellationToken)

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

Declaration
public virtual Task<AnnotationSpecSet> CreateAnnotationSpecSetAsync(ProjectName parent, AnnotationSpecSet annotationSpecSet, CancellationToken cancellationToken)
Parameters
Type Name Description
ProjectName parent

Required. AnnotationSpecSet resource parent, format: projects/{project_id}

AnnotationSpecSet annotationSpecSet

Required. Annotation spec set to create. Annotation specs must be included. Only one annotation spec will be accepted for annotation specs with same display_name.

System.Threading.CancellationToken cancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
Type Description
System.Threading.Tasks.Task<AnnotationSpecSet>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
ProjectName parent = ProjectName.FromProject("[PROJECT]");
AnnotationSpecSet annotationSpecSet = new AnnotationSpecSet();
// Make the request
AnnotationSpecSet response = await dataLabelingServiceClient.CreateAnnotationSpecSetAsync(parent, annotationSpecSet);

CreateAnnotationSpecSetAsync(CreateAnnotationSpecSetRequest, CallSettings)

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

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

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

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task<AnnotationSpecSet>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
CreateAnnotationSpecSetRequest request = new CreateAnnotationSpecSetRequest
{
    ParentAsProjectName = ProjectName.FromProject("[PROJECT]"),
    AnnotationSpecSet = new AnnotationSpecSet(),
};
// Make the request
AnnotationSpecSet response = await dataLabelingServiceClient.CreateAnnotationSpecSetAsync(request);

CreateAnnotationSpecSetAsync(CreateAnnotationSpecSetRequest, CancellationToken)

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

Declaration
public virtual Task<AnnotationSpecSet> CreateAnnotationSpecSetAsync(CreateAnnotationSpecSetRequest request, CancellationToken cancellationToken)
Parameters
Type Name Description
CreateAnnotationSpecSetRequest request

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

System.Threading.CancellationToken cancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
Type Description
System.Threading.Tasks.Task<AnnotationSpecSet>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
CreateAnnotationSpecSetRequest request = new CreateAnnotationSpecSetRequest
{
    ParentAsProjectName = ProjectName.FromProject("[PROJECT]"),
    AnnotationSpecSet = new AnnotationSpecSet(),
};
// Make the request
AnnotationSpecSet response = await dataLabelingServiceClient.CreateAnnotationSpecSetAsync(request);

CreateAnnotationSpecSetAsync(String, AnnotationSpecSet, CallSettings)

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

Declaration
public virtual Task<AnnotationSpecSet> CreateAnnotationSpecSetAsync(string parent, AnnotationSpecSet annotationSpecSet, CallSettings callSettings = null)
Parameters
Type Name Description
System.String parent

Required. AnnotationSpecSet resource parent, format: projects/{project_id}

AnnotationSpecSet annotationSpecSet

Required. Annotation spec set to create. Annotation specs must be included. Only one annotation spec will be accepted for annotation specs with same display_name.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task<AnnotationSpecSet>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]";
AnnotationSpecSet annotationSpecSet = new AnnotationSpecSet();
// Make the request
AnnotationSpecSet response = await dataLabelingServiceClient.CreateAnnotationSpecSetAsync(parent, annotationSpecSet);

CreateAnnotationSpecSetAsync(String, AnnotationSpecSet, CancellationToken)

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

Declaration
public virtual Task<AnnotationSpecSet> CreateAnnotationSpecSetAsync(string parent, AnnotationSpecSet annotationSpecSet, CancellationToken cancellationToken)
Parameters
Type Name Description
System.String parent

Required. AnnotationSpecSet resource parent, format: projects/{project_id}

AnnotationSpecSet annotationSpecSet

Required. Annotation spec set to create. Annotation specs must be included. Only one annotation spec will be accepted for annotation specs with same display_name.

System.Threading.CancellationToken cancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
Type Description
System.Threading.Tasks.Task<AnnotationSpecSet>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]";
AnnotationSpecSet annotationSpecSet = new AnnotationSpecSet();
// Make the request
AnnotationSpecSet response = await dataLabelingServiceClient.CreateAnnotationSpecSetAsync(parent, annotationSpecSet);

CreateAsync(CancellationToken)

Asynchronously creates a DataLabelingServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use DataLabelingServiceClientBuilder.

Declaration
public static Task<DataLabelingServiceClient> CreateAsync(CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken

The System.Threading.CancellationToken to use while creating the client.

Returns
Type Description
System.Threading.Tasks.Task<DataLabelingServiceClient>

The task representing the created DataLabelingServiceClient.

CreateDataset(ProjectName, Dataset, CallSettings)

Creates dataset. If success return a Dataset resource.

Declaration
public virtual Dataset CreateDataset(ProjectName parent, Dataset dataset, CallSettings callSettings = null)
Parameters
Type Name Description
ProjectName parent

Required. Dataset resource parent, format: projects/{project_id}

Dataset dataset

Required. The dataset to be created.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Dataset

The RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.Create();
// Initialize request argument(s)
ProjectName parent = ProjectName.FromProject("[PROJECT]");
Dataset dataset = new Dataset();
// Make the request
Dataset response = dataLabelingServiceClient.CreateDataset(parent, dataset);

CreateDataset(CreateDatasetRequest, CallSettings)

Creates dataset. If success return a Dataset resource.

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

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

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Dataset

The RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.Create();
// Initialize request argument(s)
CreateDatasetRequest request = new CreateDatasetRequest
{
    ParentAsProjectName = ProjectName.FromProject("[PROJECT]"),
    Dataset = new Dataset(),
};
// Make the request
Dataset response = dataLabelingServiceClient.CreateDataset(request);

CreateDataset(String, Dataset, CallSettings)

Creates dataset. If success return a Dataset resource.

Declaration
public virtual Dataset CreateDataset(string parent, Dataset dataset, CallSettings callSettings = null)
Parameters
Type Name Description
System.String parent

Required. Dataset resource parent, format: projects/{project_id}

Dataset dataset

Required. The dataset to be created.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Dataset

The RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]";
Dataset dataset = new Dataset();
// Make the request
Dataset response = dataLabelingServiceClient.CreateDataset(parent, dataset);

CreateDatasetAsync(ProjectName, Dataset, CallSettings)

Creates dataset. If success return a Dataset resource.

Declaration
public virtual Task<Dataset> CreateDatasetAsync(ProjectName parent, Dataset dataset, CallSettings callSettings = null)
Parameters
Type Name Description
ProjectName parent

Required. Dataset resource parent, format: projects/{project_id}

Dataset dataset

Required. The dataset to be created.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task<Dataset>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
ProjectName parent = ProjectName.FromProject("[PROJECT]");
Dataset dataset = new Dataset();
// Make the request
Dataset response = await dataLabelingServiceClient.CreateDatasetAsync(parent, dataset);

CreateDatasetAsync(ProjectName, Dataset, CancellationToken)

Creates dataset. If success return a Dataset resource.

Declaration
public virtual Task<Dataset> CreateDatasetAsync(ProjectName parent, Dataset dataset, CancellationToken cancellationToken)
Parameters
Type Name Description
ProjectName parent

Required. Dataset resource parent, format: projects/{project_id}

Dataset dataset

Required. The dataset to be created.

System.Threading.CancellationToken cancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
Type Description
System.Threading.Tasks.Task<Dataset>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
ProjectName parent = ProjectName.FromProject("[PROJECT]");
Dataset dataset = new Dataset();
// Make the request
Dataset response = await dataLabelingServiceClient.CreateDatasetAsync(parent, dataset);

CreateDatasetAsync(CreateDatasetRequest, CallSettings)

Creates dataset. If success return a Dataset resource.

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

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

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task<Dataset>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
CreateDatasetRequest request = new CreateDatasetRequest
{
    ParentAsProjectName = ProjectName.FromProject("[PROJECT]"),
    Dataset = new Dataset(),
};
// Make the request
Dataset response = await dataLabelingServiceClient.CreateDatasetAsync(request);

CreateDatasetAsync(CreateDatasetRequest, CancellationToken)

Creates dataset. If success return a Dataset resource.

Declaration
public virtual Task<Dataset> CreateDatasetAsync(CreateDatasetRequest request, CancellationToken cancellationToken)
Parameters
Type Name Description
CreateDatasetRequest request

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

System.Threading.CancellationToken cancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
Type Description
System.Threading.Tasks.Task<Dataset>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
CreateDatasetRequest request = new CreateDatasetRequest
{
    ParentAsProjectName = ProjectName.FromProject("[PROJECT]"),
    Dataset = new Dataset(),
};
// Make the request
Dataset response = await dataLabelingServiceClient.CreateDatasetAsync(request);

CreateDatasetAsync(String, Dataset, CallSettings)

Creates dataset. If success return a Dataset resource.

Declaration
public virtual Task<Dataset> CreateDatasetAsync(string parent, Dataset dataset, CallSettings callSettings = null)
Parameters
Type Name Description
System.String parent

Required. Dataset resource parent, format: projects/{project_id}

Dataset dataset

Required. The dataset to be created.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task<Dataset>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]";
Dataset dataset = new Dataset();
// Make the request
Dataset response = await dataLabelingServiceClient.CreateDatasetAsync(parent, dataset);

CreateDatasetAsync(String, Dataset, CancellationToken)

Creates dataset. If success return a Dataset resource.

Declaration
public virtual Task<Dataset> CreateDatasetAsync(string parent, Dataset dataset, CancellationToken cancellationToken)
Parameters
Type Name Description
System.String parent

Required. Dataset resource parent, format: projects/{project_id}

Dataset dataset

Required. The dataset to be created.

System.Threading.CancellationToken cancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
Type Description
System.Threading.Tasks.Task<Dataset>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]";
Dataset dataset = new Dataset();
// Make the request
Dataset response = await dataLabelingServiceClient.CreateDatasetAsync(parent, dataset);

CreateEvaluationJob(ProjectName, EvaluationJob, CallSettings)

Creates an evaluation job.

Declaration
public virtual EvaluationJob CreateEvaluationJob(ProjectName parent, EvaluationJob job, CallSettings callSettings = null)
Parameters
Type Name Description
ProjectName parent

Required. Evaluation job resource parent. Format: "projects/&lt;var&gt;{project_id}&lt;/var&gt;"

EvaluationJob job

Required. The evaluation job to create.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
EvaluationJob

The RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.Create();
// Initialize request argument(s)
ProjectName parent = ProjectName.FromProject("[PROJECT]");
EvaluationJob job = new EvaluationJob();
// Make the request
EvaluationJob response = dataLabelingServiceClient.CreateEvaluationJob(parent, job);

CreateEvaluationJob(CreateEvaluationJobRequest, CallSettings)

Creates an evaluation job.

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

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

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
EvaluationJob

The RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.Create();
// Initialize request argument(s)
CreateEvaluationJobRequest request = new CreateEvaluationJobRequest
{
    ParentAsProjectName = ProjectName.FromProject("[PROJECT]"),
    Job = new EvaluationJob(),
};
// Make the request
EvaluationJob response = dataLabelingServiceClient.CreateEvaluationJob(request);

CreateEvaluationJob(String, EvaluationJob, CallSettings)

Creates an evaluation job.

Declaration
public virtual EvaluationJob CreateEvaluationJob(string parent, EvaluationJob job, CallSettings callSettings = null)
Parameters
Type Name Description
System.String parent

Required. Evaluation job resource parent. Format: "projects/&lt;var&gt;{project_id}&lt;/var&gt;"

EvaluationJob job

Required. The evaluation job to create.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
EvaluationJob

The RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]";
EvaluationJob job = new EvaluationJob();
// Make the request
EvaluationJob response = dataLabelingServiceClient.CreateEvaluationJob(parent, job);

CreateEvaluationJobAsync(ProjectName, EvaluationJob, CallSettings)

Creates an evaluation job.

Declaration
public virtual Task<EvaluationJob> CreateEvaluationJobAsync(ProjectName parent, EvaluationJob job, CallSettings callSettings = null)
Parameters
Type Name Description
ProjectName parent

Required. Evaluation job resource parent. Format: "projects/&lt;var&gt;{project_id}&lt;/var&gt;"

EvaluationJob job

Required. The evaluation job to create.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task<EvaluationJob>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
ProjectName parent = ProjectName.FromProject("[PROJECT]");
EvaluationJob job = new EvaluationJob();
// Make the request
EvaluationJob response = await dataLabelingServiceClient.CreateEvaluationJobAsync(parent, job);

CreateEvaluationJobAsync(ProjectName, EvaluationJob, CancellationToken)

Creates an evaluation job.

Declaration
public virtual Task<EvaluationJob> CreateEvaluationJobAsync(ProjectName parent, EvaluationJob job, CancellationToken cancellationToken)
Parameters
Type Name Description
ProjectName parent

Required. Evaluation job resource parent. Format: "projects/&lt;var&gt;{project_id}&lt;/var&gt;"

EvaluationJob job

Required. The evaluation job to create.

System.Threading.CancellationToken cancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
Type Description
System.Threading.Tasks.Task<EvaluationJob>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
ProjectName parent = ProjectName.FromProject("[PROJECT]");
EvaluationJob job = new EvaluationJob();
// Make the request
EvaluationJob response = await dataLabelingServiceClient.CreateEvaluationJobAsync(parent, job);

CreateEvaluationJobAsync(CreateEvaluationJobRequest, CallSettings)

Creates an evaluation job.

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

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

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task<EvaluationJob>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
CreateEvaluationJobRequest request = new CreateEvaluationJobRequest
{
    ParentAsProjectName = ProjectName.FromProject("[PROJECT]"),
    Job = new EvaluationJob(),
};
// Make the request
EvaluationJob response = await dataLabelingServiceClient.CreateEvaluationJobAsync(request);

CreateEvaluationJobAsync(CreateEvaluationJobRequest, CancellationToken)

Creates an evaluation job.

Declaration
public virtual Task<EvaluationJob> CreateEvaluationJobAsync(CreateEvaluationJobRequest request, CancellationToken cancellationToken)
Parameters
Type Name Description
CreateEvaluationJobRequest request

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

System.Threading.CancellationToken cancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
Type Description
System.Threading.Tasks.Task<EvaluationJob>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
CreateEvaluationJobRequest request = new CreateEvaluationJobRequest
{
    ParentAsProjectName = ProjectName.FromProject("[PROJECT]"),
    Job = new EvaluationJob(),
};
// Make the request
EvaluationJob response = await dataLabelingServiceClient.CreateEvaluationJobAsync(request);

CreateEvaluationJobAsync(String, EvaluationJob, CallSettings)

Creates an evaluation job.

Declaration
public virtual Task<EvaluationJob> CreateEvaluationJobAsync(string parent, EvaluationJob job, CallSettings callSettings = null)
Parameters
Type Name Description
System.String parent

Required. Evaluation job resource parent. Format: "projects/&lt;var&gt;{project_id}&lt;/var&gt;"

EvaluationJob job

Required. The evaluation job to create.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task<EvaluationJob>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]";
EvaluationJob job = new EvaluationJob();
// Make the request
EvaluationJob response = await dataLabelingServiceClient.CreateEvaluationJobAsync(parent, job);

CreateEvaluationJobAsync(String, EvaluationJob, CancellationToken)

Creates an evaluation job.

Declaration
public virtual Task<EvaluationJob> CreateEvaluationJobAsync(string parent, EvaluationJob job, CancellationToken cancellationToken)
Parameters
Type Name Description
System.String parent

Required. Evaluation job resource parent. Format: "projects/&lt;var&gt;{project_id}&lt;/var&gt;"

EvaluationJob job

Required. The evaluation job to create.

System.Threading.CancellationToken cancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
Type Description
System.Threading.Tasks.Task<EvaluationJob>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]";
EvaluationJob job = new EvaluationJob();
// Make the request
EvaluationJob response = await dataLabelingServiceClient.CreateEvaluationJobAsync(parent, job);

CreateInstruction(ProjectName, Instruction, CallSettings)

Creates an instruction for how data should be labeled.

Declaration
public virtual Operation<Instruction, CreateInstructionMetadata> CreateInstruction(ProjectName parent, Instruction instruction, CallSettings callSettings = null)
Parameters
Type Name Description
ProjectName parent

Required. Instruction resource parent, format: projects/{project_id}

Instruction instruction

Required. Instruction of how to perform the labeling task.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Operation<Instruction, CreateInstructionMetadata>

The RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.Create();
// Initialize request argument(s)
ProjectName parent = ProjectName.FromProject("[PROJECT]");
Instruction instruction = new Instruction();
// Make the request
Operation<Instruction, CreateInstructionMetadata> response = dataLabelingServiceClient.CreateInstruction(parent, instruction);

// Poll until the returned long-running operation is complete
Operation<Instruction, CreateInstructionMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Instruction result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Instruction, CreateInstructionMetadata> retrievedResponse = dataLabelingServiceClient.PollOnceCreateInstruction(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Instruction retrievedResult = retrievedResponse.Result;
}

CreateInstruction(CreateInstructionRequest, CallSettings)

Creates an instruction for how data should be labeled.

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

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

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Operation<Instruction, CreateInstructionMetadata>

The RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.Create();
// Initialize request argument(s)
CreateInstructionRequest request = new CreateInstructionRequest
{
    ParentAsProjectName = ProjectName.FromProject("[PROJECT]"),
    Instruction = new Instruction(),
};
// Make the request
Operation<Instruction, CreateInstructionMetadata> response = dataLabelingServiceClient.CreateInstruction(request);

// Poll until the returned long-running operation is complete
Operation<Instruction, CreateInstructionMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Instruction result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Instruction, CreateInstructionMetadata> retrievedResponse = dataLabelingServiceClient.PollOnceCreateInstruction(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Instruction retrievedResult = retrievedResponse.Result;
}

CreateInstruction(String, Instruction, CallSettings)

Creates an instruction for how data should be labeled.

Declaration
public virtual Operation<Instruction, CreateInstructionMetadata> CreateInstruction(string parent, Instruction instruction, CallSettings callSettings = null)
Parameters
Type Name Description
System.String parent

Required. Instruction resource parent, format: projects/{project_id}

Instruction instruction

Required. Instruction of how to perform the labeling task.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Operation<Instruction, CreateInstructionMetadata>

The RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]";
Instruction instruction = new Instruction();
// Make the request
Operation<Instruction, CreateInstructionMetadata> response = dataLabelingServiceClient.CreateInstruction(parent, instruction);

// Poll until the returned long-running operation is complete
Operation<Instruction, CreateInstructionMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Instruction result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Instruction, CreateInstructionMetadata> retrievedResponse = dataLabelingServiceClient.PollOnceCreateInstruction(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Instruction retrievedResult = retrievedResponse.Result;
}

CreateInstructionAsync(ProjectName, Instruction, CallSettings)

Creates an instruction for how data should be labeled.

Declaration
public virtual Task<Operation<Instruction, CreateInstructionMetadata>> CreateInstructionAsync(ProjectName parent, Instruction instruction, CallSettings callSettings = null)
Parameters
Type Name Description
ProjectName parent

Required. Instruction resource parent, format: projects/{project_id}

Instruction instruction

Required. Instruction of how to perform the labeling task.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task<Operation<Instruction, CreateInstructionMetadata>>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
ProjectName parent = ProjectName.FromProject("[PROJECT]");
Instruction instruction = new Instruction();
// Make the request
Operation<Instruction, CreateInstructionMetadata> response = await dataLabelingServiceClient.CreateInstructionAsync(parent, instruction);

// Poll until the returned long-running operation is complete
Operation<Instruction, CreateInstructionMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Instruction result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Instruction, CreateInstructionMetadata> retrievedResponse = await dataLabelingServiceClient.PollOnceCreateInstructionAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Instruction retrievedResult = retrievedResponse.Result;
}

CreateInstructionAsync(ProjectName, Instruction, CancellationToken)

Creates an instruction for how data should be labeled.

Declaration
public virtual Task<Operation<Instruction, CreateInstructionMetadata>> CreateInstructionAsync(ProjectName parent, Instruction instruction, CancellationToken cancellationToken)
Parameters
Type Name Description
ProjectName parent

Required. Instruction resource parent, format: projects/{project_id}

Instruction instruction

Required. Instruction of how to perform the labeling task.

System.Threading.CancellationToken cancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
Type Description
System.Threading.Tasks.Task<Operation<Instruction, CreateInstructionMetadata>>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
ProjectName parent = ProjectName.FromProject("[PROJECT]");
Instruction instruction = new Instruction();
// Make the request
Operation<Instruction, CreateInstructionMetadata> response = await dataLabelingServiceClient.CreateInstructionAsync(parent, instruction);

// Poll until the returned long-running operation is complete
Operation<Instruction, CreateInstructionMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Instruction result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Instruction, CreateInstructionMetadata> retrievedResponse = await dataLabelingServiceClient.PollOnceCreateInstructionAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Instruction retrievedResult = retrievedResponse.Result;
}

CreateInstructionAsync(CreateInstructionRequest, CallSettings)

Creates an instruction for how data should be labeled.

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

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

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task<Operation<Instruction, CreateInstructionMetadata>>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
CreateInstructionRequest request = new CreateInstructionRequest
{
    ParentAsProjectName = ProjectName.FromProject("[PROJECT]"),
    Instruction = new Instruction(),
};
// Make the request
Operation<Instruction, CreateInstructionMetadata> response = await dataLabelingServiceClient.CreateInstructionAsync(request);

// Poll until the returned long-running operation is complete
Operation<Instruction, CreateInstructionMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Instruction result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Instruction, CreateInstructionMetadata> retrievedResponse = await dataLabelingServiceClient.PollOnceCreateInstructionAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Instruction retrievedResult = retrievedResponse.Result;
}

CreateInstructionAsync(CreateInstructionRequest, CancellationToken)

Creates an instruction for how data should be labeled.

Declaration
public virtual Task<Operation<Instruction, CreateInstructionMetadata>> CreateInstructionAsync(CreateInstructionRequest request, CancellationToken cancellationToken)
Parameters
Type Name Description
CreateInstructionRequest request

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

System.Threading.CancellationToken cancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
Type Description
System.Threading.Tasks.Task<Operation<Instruction, CreateInstructionMetadata>>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
CreateInstructionRequest request = new CreateInstructionRequest
{
    ParentAsProjectName = ProjectName.FromProject("[PROJECT]"),
    Instruction = new Instruction(),
};
// Make the request
Operation<Instruction, CreateInstructionMetadata> response = await dataLabelingServiceClient.CreateInstructionAsync(request);

// Poll until the returned long-running operation is complete
Operation<Instruction, CreateInstructionMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Instruction result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Instruction, CreateInstructionMetadata> retrievedResponse = await dataLabelingServiceClient.PollOnceCreateInstructionAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Instruction retrievedResult = retrievedResponse.Result;
}

CreateInstructionAsync(String, Instruction, CallSettings)

Creates an instruction for how data should be labeled.

Declaration
public virtual Task<Operation<Instruction, CreateInstructionMetadata>> CreateInstructionAsync(string parent, Instruction instruction, CallSettings callSettings = null)
Parameters
Type Name Description
System.String parent

Required. Instruction resource parent, format: projects/{project_id}

Instruction instruction

Required. Instruction of how to perform the labeling task.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task<Operation<Instruction, CreateInstructionMetadata>>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]";
Instruction instruction = new Instruction();
// Make the request
Operation<Instruction, CreateInstructionMetadata> response = await dataLabelingServiceClient.CreateInstructionAsync(parent, instruction);

// Poll until the returned long-running operation is complete
Operation<Instruction, CreateInstructionMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Instruction result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Instruction, CreateInstructionMetadata> retrievedResponse = await dataLabelingServiceClient.PollOnceCreateInstructionAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Instruction retrievedResult = retrievedResponse.Result;
}

CreateInstructionAsync(String, Instruction, CancellationToken)

Creates an instruction for how data should be labeled.

Declaration
public virtual Task<Operation<Instruction, CreateInstructionMetadata>> CreateInstructionAsync(string parent, Instruction instruction, CancellationToken cancellationToken)
Parameters
Type Name Description
System.String parent

Required. Instruction resource parent, format: projects/{project_id}

Instruction instruction

Required. Instruction of how to perform the labeling task.

System.Threading.CancellationToken cancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
Type Description
System.Threading.Tasks.Task<Operation<Instruction, CreateInstructionMetadata>>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]";
Instruction instruction = new Instruction();
// Make the request
Operation<Instruction, CreateInstructionMetadata> response = await dataLabelingServiceClient.CreateInstructionAsync(parent, instruction);

// Poll until the returned long-running operation is complete
Operation<Instruction, CreateInstructionMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Instruction result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Instruction, CreateInstructionMetadata> retrievedResponse = await dataLabelingServiceClient.PollOnceCreateInstructionAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Instruction retrievedResult = retrievedResponse.Result;
}

DeleteAnnotatedDataset(DeleteAnnotatedDatasetRequest, CallSettings)

Deletes an annotated dataset by resource name.

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

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

CallSettings callSettings

If not null, applies overrides to this RPC call.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.Create();
// Initialize request argument(s)
DeleteAnnotatedDatasetRequest request = new DeleteAnnotatedDatasetRequest
{
    AnnotatedDatasetName = AnnotatedDatasetName.FromProjectDatasetAnnotatedDataset("[PROJECT]", "[DATASET]", "[ANNOTATED_DATASET]"),
};
// Make the request
dataLabelingServiceClient.DeleteAnnotatedDataset(request);

DeleteAnnotatedDatasetAsync(DeleteAnnotatedDatasetRequest, CallSettings)

Deletes an annotated dataset by resource name.

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

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

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteAnnotatedDatasetRequest request = new DeleteAnnotatedDatasetRequest
{
    AnnotatedDatasetName = AnnotatedDatasetName.FromProjectDatasetAnnotatedDataset("[PROJECT]", "[DATASET]", "[ANNOTATED_DATASET]"),
};
// Make the request
await dataLabelingServiceClient.DeleteAnnotatedDatasetAsync(request);

DeleteAnnotatedDatasetAsync(DeleteAnnotatedDatasetRequest, CancellationToken)

Deletes an annotated dataset by resource name.

Declaration
public virtual Task DeleteAnnotatedDatasetAsync(DeleteAnnotatedDatasetRequest request, CancellationToken cancellationToken)
Parameters
Type Name Description
DeleteAnnotatedDatasetRequest request

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

System.Threading.CancellationToken cancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
Type Description
System.Threading.Tasks.Task

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteAnnotatedDatasetRequest request = new DeleteAnnotatedDatasetRequest
{
    AnnotatedDatasetName = AnnotatedDatasetName.FromProjectDatasetAnnotatedDataset("[PROJECT]", "[DATASET]", "[ANNOTATED_DATASET]"),
};
// Make the request
await dataLabelingServiceClient.DeleteAnnotatedDatasetAsync(request);

DeleteAnnotationSpecSet(AnnotationSpecSetName, CallSettings)

Deletes an annotation spec set by resource name.

Declaration
public virtual void DeleteAnnotationSpecSet(AnnotationSpecSetName name, CallSettings callSettings = null)
Parameters
Type Name Description
AnnotationSpecSetName name

Required. AnnotationSpec resource name, format: projects/{project_id}/annotationSpecSets/{annotation_spec_set_id}.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.Create();
// Initialize request argument(s)
AnnotationSpecSetName name = AnnotationSpecSetName.FromProjectAnnotationSpecSet("[PROJECT]", "[ANNOTATION_SPEC_SET]");
// Make the request
dataLabelingServiceClient.DeleteAnnotationSpecSet(name);

DeleteAnnotationSpecSet(DeleteAnnotationSpecSetRequest, CallSettings)

Deletes an annotation spec set by resource name.

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

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

CallSettings callSettings

If not null, applies overrides to this RPC call.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.Create();
// Initialize request argument(s)
DeleteAnnotationSpecSetRequest request = new DeleteAnnotationSpecSetRequest
{
    AnnotationSpecSetName = AnnotationSpecSetName.FromProjectAnnotationSpecSet("[PROJECT]", "[ANNOTATION_SPEC_SET]"),
};
// Make the request
dataLabelingServiceClient.DeleteAnnotationSpecSet(request);

DeleteAnnotationSpecSet(String, CallSettings)

Deletes an annotation spec set by resource name.

Declaration
public virtual void DeleteAnnotationSpecSet(string name, CallSettings callSettings = null)
Parameters
Type Name Description
System.String name

Required. AnnotationSpec resource name, format: projects/{project_id}/annotationSpecSets/{annotation_spec_set_id}.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/annotationSpecSets/[ANNOTATION_SPEC_SET]";
// Make the request
dataLabelingServiceClient.DeleteAnnotationSpecSet(name);

DeleteAnnotationSpecSetAsync(AnnotationSpecSetName, CallSettings)

Deletes an annotation spec set by resource name.

Declaration
public virtual Task DeleteAnnotationSpecSetAsync(AnnotationSpecSetName name, CallSettings callSettings = null)
Parameters
Type Name Description
AnnotationSpecSetName name

Required. AnnotationSpec resource name, format: projects/{project_id}/annotationSpecSets/{annotation_spec_set_id}.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
AnnotationSpecSetName name = AnnotationSpecSetName.FromProjectAnnotationSpecSet("[PROJECT]", "[ANNOTATION_SPEC_SET]");
// Make the request
await dataLabelingServiceClient.DeleteAnnotationSpecSetAsync(name);

DeleteAnnotationSpecSetAsync(AnnotationSpecSetName, CancellationToken)

Deletes an annotation spec set by resource name.

Declaration
public virtual Task DeleteAnnotationSpecSetAsync(AnnotationSpecSetName name, CancellationToken cancellationToken)
Parameters
Type Name Description
AnnotationSpecSetName name

Required. AnnotationSpec resource name, format: projects/{project_id}/annotationSpecSets/{annotation_spec_set_id}.

System.Threading.CancellationToken cancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
Type Description
System.Threading.Tasks.Task

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
AnnotationSpecSetName name = AnnotationSpecSetName.FromProjectAnnotationSpecSet("[PROJECT]", "[ANNOTATION_SPEC_SET]");
// Make the request
await dataLabelingServiceClient.DeleteAnnotationSpecSetAsync(name);

DeleteAnnotationSpecSetAsync(DeleteAnnotationSpecSetRequest, CallSettings)

Deletes an annotation spec set by resource name.

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

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

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteAnnotationSpecSetRequest request = new DeleteAnnotationSpecSetRequest
{
    AnnotationSpecSetName = AnnotationSpecSetName.FromProjectAnnotationSpecSet("[PROJECT]", "[ANNOTATION_SPEC_SET]"),
};
// Make the request
await dataLabelingServiceClient.DeleteAnnotationSpecSetAsync(request);

DeleteAnnotationSpecSetAsync(DeleteAnnotationSpecSetRequest, CancellationToken)

Deletes an annotation spec set by resource name.

Declaration
public virtual Task DeleteAnnotationSpecSetAsync(DeleteAnnotationSpecSetRequest request, CancellationToken cancellationToken)
Parameters
Type Name Description
DeleteAnnotationSpecSetRequest request

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

System.Threading.CancellationToken cancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
Type Description
System.Threading.Tasks.Task

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteAnnotationSpecSetRequest request = new DeleteAnnotationSpecSetRequest
{
    AnnotationSpecSetName = AnnotationSpecSetName.FromProjectAnnotationSpecSet("[PROJECT]", "[ANNOTATION_SPEC_SET]"),
};
// Make the request
await dataLabelingServiceClient.DeleteAnnotationSpecSetAsync(request);

DeleteAnnotationSpecSetAsync(String, CallSettings)

Deletes an annotation spec set by resource name.

Declaration
public virtual Task DeleteAnnotationSpecSetAsync(string name, CallSettings callSettings = null)
Parameters
Type Name Description
System.String name

Required. AnnotationSpec resource name, format: projects/{project_id}/annotationSpecSets/{annotation_spec_set_id}.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/annotationSpecSets/[ANNOTATION_SPEC_SET]";
// Make the request
await dataLabelingServiceClient.DeleteAnnotationSpecSetAsync(name);

DeleteAnnotationSpecSetAsync(String, CancellationToken)

Deletes an annotation spec set by resource name.

Declaration
public virtual Task DeleteAnnotationSpecSetAsync(string name, CancellationToken cancellationToken)
Parameters
Type Name Description
System.String name

Required. AnnotationSpec resource name, format: projects/{project_id}/annotationSpecSets/{annotation_spec_set_id}.

System.Threading.CancellationToken cancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
Type Description
System.Threading.Tasks.Task

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/annotationSpecSets/[ANNOTATION_SPEC_SET]";
// Make the request
await dataLabelingServiceClient.DeleteAnnotationSpecSetAsync(name);

DeleteDataset(DatasetName, CallSettings)

Deletes a dataset by resource name.

Declaration
public virtual void DeleteDataset(DatasetName name, CallSettings callSettings = null)
Parameters
Type Name Description
DatasetName name

Required. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id}

CallSettings callSettings

If not null, applies overrides to this RPC call.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.Create();
// Initialize request argument(s)
DatasetName name = DatasetName.FromProjectDataset("[PROJECT]", "[DATASET]");
// Make the request
dataLabelingServiceClient.DeleteDataset(name);

DeleteDataset(DeleteDatasetRequest, CallSettings)

Deletes a dataset by resource name.

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

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

CallSettings callSettings

If not null, applies overrides to this RPC call.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.Create();
// Initialize request argument(s)
DeleteDatasetRequest request = new DeleteDatasetRequest
{
    DatasetName = DatasetName.FromProjectDataset("[PROJECT]", "[DATASET]"),
};
// Make the request
dataLabelingServiceClient.DeleteDataset(request);

DeleteDataset(String, CallSettings)

Deletes a dataset by resource name.

Declaration
public virtual void DeleteDataset(string name, CallSettings callSettings = null)
Parameters
Type Name Description
System.String name

Required. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id}

CallSettings callSettings

If not null, applies overrides to this RPC call.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/datasets/[DATASET]";
// Make the request
dataLabelingServiceClient.DeleteDataset(name);

DeleteDatasetAsync(DatasetName, CallSettings)

Deletes a dataset by resource name.

Declaration
public virtual Task DeleteDatasetAsync(DatasetName name, CallSettings callSettings = null)
Parameters
Type Name Description
DatasetName name

Required. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id}

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
DatasetName name = DatasetName.FromProjectDataset("[PROJECT]", "[DATASET]");
// Make the request
await dataLabelingServiceClient.DeleteDatasetAsync(name);

DeleteDatasetAsync(DatasetName, CancellationToken)

Deletes a dataset by resource name.

Declaration
public virtual Task DeleteDatasetAsync(DatasetName name, CancellationToken cancellationToken)
Parameters
Type Name Description
DatasetName name

Required. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id}

System.Threading.CancellationToken cancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
Type Description
System.Threading.Tasks.Task

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
DatasetName name = DatasetName.FromProjectDataset("[PROJECT]", "[DATASET]");
// Make the request
await dataLabelingServiceClient.DeleteDatasetAsync(name);

DeleteDatasetAsync(DeleteDatasetRequest, CallSettings)

Deletes a dataset by resource name.

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

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

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteDatasetRequest request = new DeleteDatasetRequest
{
    DatasetName = DatasetName.FromProjectDataset("[PROJECT]", "[DATASET]"),
};
// Make the request
await dataLabelingServiceClient.DeleteDatasetAsync(request);

DeleteDatasetAsync(DeleteDatasetRequest, CancellationToken)

Deletes a dataset by resource name.

Declaration
public virtual Task DeleteDatasetAsync(DeleteDatasetRequest request, CancellationToken cancellationToken)
Parameters
Type Name Description
DeleteDatasetRequest request

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

System.Threading.CancellationToken cancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
Type Description
System.Threading.Tasks.Task

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteDatasetRequest request = new DeleteDatasetRequest
{
    DatasetName = DatasetName.FromProjectDataset("[PROJECT]", "[DATASET]"),
};
// Make the request
await dataLabelingServiceClient.DeleteDatasetAsync(request);

DeleteDatasetAsync(String, CallSettings)

Deletes a dataset by resource name.

Declaration
public virtual Task DeleteDatasetAsync(string name, CallSettings callSettings = null)
Parameters
Type Name Description
System.String name

Required. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id}

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/datasets/[DATASET]";
// Make the request
await dataLabelingServiceClient.DeleteDatasetAsync(name);

DeleteDatasetAsync(String, CancellationToken)

Deletes a dataset by resource name.

Declaration
public virtual Task DeleteDatasetAsync(string name, CancellationToken cancellationToken)
Parameters
Type Name Description
System.String name

Required. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id}

System.Threading.CancellationToken cancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
Type Description
System.Threading.Tasks.Task

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/datasets/[DATASET]";
// Make the request
await dataLabelingServiceClient.DeleteDatasetAsync(name);

DeleteEvaluationJob(DeleteEvaluationJobRequest, CallSettings)

Stops and deletes an evaluation job.

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

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

CallSettings callSettings

If not null, applies overrides to this RPC call.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.Create();
// Initialize request argument(s)
DeleteEvaluationJobRequest request = new DeleteEvaluationJobRequest
{
    EvaluationJobName = EvaluationJobName.FromProjectEvaluationJob("[PROJECT]", "[EVALUATION_JOB]"),
};
// Make the request
dataLabelingServiceClient.DeleteEvaluationJob(request);

DeleteEvaluationJob(EvaluationJobName, CallSettings)

Stops and deletes an evaluation job.

Declaration
public virtual void DeleteEvaluationJob(EvaluationJobName name, CallSettings callSettings = null)
Parameters
Type Name Description
EvaluationJobName name

Required. Name of the evaluation job that is going to be deleted. Format:

"projects/&lt;var&gt;{project_id}&lt;/var&gt;/evaluationJobs/&lt;var&gt;{evaluation_job_id}&lt;/var&gt;"

CallSettings callSettings

If not null, applies overrides to this RPC call.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.Create();
// Initialize request argument(s)
EvaluationJobName name = EvaluationJobName.FromProjectEvaluationJob("[PROJECT]", "[EVALUATION_JOB]");
// Make the request
dataLabelingServiceClient.DeleteEvaluationJob(name);

DeleteEvaluationJob(String, CallSettings)

Stops and deletes an evaluation job.

Declaration
public virtual void DeleteEvaluationJob(string name, CallSettings callSettings = null)
Parameters
Type Name Description
System.String name

Required. Name of the evaluation job that is going to be deleted. Format:

"projects/&lt;var&gt;{project_id}&lt;/var&gt;/evaluationJobs/&lt;var&gt;{evaluation_job_id}&lt;/var&gt;"

CallSettings callSettings

If not null, applies overrides to this RPC call.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/evaluationJobs/[EVALUATION_JOB]";
// Make the request
dataLabelingServiceClient.DeleteEvaluationJob(name);

DeleteEvaluationJobAsync(DeleteEvaluationJobRequest, CallSettings)

Stops and deletes an evaluation job.

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

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

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteEvaluationJobRequest request = new DeleteEvaluationJobRequest
{
    EvaluationJobName = EvaluationJobName.FromProjectEvaluationJob("[PROJECT]", "[EVALUATION_JOB]"),
};
// Make the request
await dataLabelingServiceClient.DeleteEvaluationJobAsync(request);

DeleteEvaluationJobAsync(DeleteEvaluationJobRequest, CancellationToken)

Stops and deletes an evaluation job.

Declaration
public virtual Task DeleteEvaluationJobAsync(DeleteEvaluationJobRequest request, CancellationToken cancellationToken)
Parameters
Type Name Description
DeleteEvaluationJobRequest request

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

System.Threading.CancellationToken cancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
Type Description
System.Threading.Tasks.Task

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteEvaluationJobRequest request = new DeleteEvaluationJobRequest
{
    EvaluationJobName = EvaluationJobName.FromProjectEvaluationJob("[PROJECT]", "[EVALUATION_JOB]"),
};
// Make the request
await dataLabelingServiceClient.DeleteEvaluationJobAsync(request);

DeleteEvaluationJobAsync(EvaluationJobName, CallSettings)

Stops and deletes an evaluation job.

Declaration
public virtual Task DeleteEvaluationJobAsync(EvaluationJobName name, CallSettings callSettings = null)
Parameters
Type Name Description
EvaluationJobName name

Required. Name of the evaluation job that is going to be deleted. Format:

"projects/&lt;var&gt;{project_id}&lt;/var&gt;/evaluationJobs/&lt;var&gt;{evaluation_job_id}&lt;/var&gt;"

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
EvaluationJobName name = EvaluationJobName.FromProjectEvaluationJob("[PROJECT]", "[EVALUATION_JOB]");
// Make the request
await dataLabelingServiceClient.DeleteEvaluationJobAsync(name);

DeleteEvaluationJobAsync(EvaluationJobName, CancellationToken)

Stops and deletes an evaluation job.

Declaration
public virtual Task DeleteEvaluationJobAsync(EvaluationJobName name, CancellationToken cancellationToken)
Parameters
Type Name Description
EvaluationJobName name

Required. Name of the evaluation job that is going to be deleted. Format:

"projects/&lt;var&gt;{project_id}&lt;/var&gt;/evaluationJobs/&lt;var&gt;{evaluation_job_id}&lt;/var&gt;"

System.Threading.CancellationToken cancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
Type Description
System.Threading.Tasks.Task

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
EvaluationJobName name = EvaluationJobName.FromProjectEvaluationJob("[PROJECT]", "[EVALUATION_JOB]");
// Make the request
await dataLabelingServiceClient.DeleteEvaluationJobAsync(name);

DeleteEvaluationJobAsync(String, CallSettings)

Stops and deletes an evaluation job.

Declaration
public virtual Task DeleteEvaluationJobAsync(string name, CallSettings callSettings = null)
Parameters
Type Name Description
System.String name

Required. Name of the evaluation job that is going to be deleted. Format:

"projects/&lt;var&gt;{project_id}&lt;/var&gt;/evaluationJobs/&lt;var&gt;{evaluation_job_id}&lt;/var&gt;"

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/evaluationJobs/[EVALUATION_JOB]";
// Make the request
await dataLabelingServiceClient.DeleteEvaluationJobAsync(name);

DeleteEvaluationJobAsync(String, CancellationToken)

Stops and deletes an evaluation job.

Declaration
public virtual Task DeleteEvaluationJobAsync(string name, CancellationToken cancellationToken)
Parameters
Type Name Description
System.String name

Required. Name of the evaluation job that is going to be deleted. Format:

"projects/&lt;var&gt;{project_id}&lt;/var&gt;/evaluationJobs/&lt;var&gt;{evaluation_job_id}&lt;/var&gt;"

System.Threading.CancellationToken cancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
Type Description
System.Threading.Tasks.Task

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/evaluationJobs/[EVALUATION_JOB]";
// Make the request
await dataLabelingServiceClient.DeleteEvaluationJobAsync(name);

DeleteInstruction(DeleteInstructionRequest, CallSettings)

Deletes an instruction object by resource name.

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

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

CallSettings callSettings

If not null, applies overrides to this RPC call.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.Create();
// Initialize request argument(s)
DeleteInstructionRequest request = new DeleteInstructionRequest
{
    InstructionName = InstructionName.FromProjectInstruction("[PROJECT]", "[INSTRUCTION]"),
};
// Make the request
dataLabelingServiceClient.DeleteInstruction(request);

DeleteInstruction(InstructionName, CallSettings)

Deletes an instruction object by resource name.

Declaration
public virtual void DeleteInstruction(InstructionName name, CallSettings callSettings = null)
Parameters
Type Name Description
InstructionName name

Required. Instruction resource name, format: projects/{project_id}/instructions/{instruction_id}

CallSettings callSettings

If not null, applies overrides to this RPC call.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.Create();
// Initialize request argument(s)
InstructionName name = InstructionName.FromProjectInstruction("[PROJECT]", "[INSTRUCTION]");
// Make the request
dataLabelingServiceClient.DeleteInstruction(name);

DeleteInstruction(String, CallSettings)

Deletes an instruction object by resource name.

Declaration
public virtual void DeleteInstruction(string name, CallSettings callSettings = null)
Parameters
Type Name Description
System.String name

Required. Instruction resource name, format: projects/{project_id}/instructions/{instruction_id}

CallSettings callSettings

If not null, applies overrides to this RPC call.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/instructions/[INSTRUCTION]";
// Make the request
dataLabelingServiceClient.DeleteInstruction(name);

DeleteInstructionAsync(DeleteInstructionRequest, CallSettings)

Deletes an instruction object by resource name.

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

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

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteInstructionRequest request = new DeleteInstructionRequest
{
    InstructionName = InstructionName.FromProjectInstruction("[PROJECT]", "[INSTRUCTION]"),
};
// Make the request
await dataLabelingServiceClient.DeleteInstructionAsync(request);

DeleteInstructionAsync(DeleteInstructionRequest, CancellationToken)

Deletes an instruction object by resource name.

Declaration
public virtual Task DeleteInstructionAsync(DeleteInstructionRequest request, CancellationToken cancellationToken)
Parameters
Type Name Description
DeleteInstructionRequest request

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

System.Threading.CancellationToken cancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
Type Description
System.Threading.Tasks.Task

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteInstructionRequest request = new DeleteInstructionRequest
{
    InstructionName = InstructionName.FromProjectInstruction("[PROJECT]", "[INSTRUCTION]"),
};
// Make the request
await dataLabelingServiceClient.DeleteInstructionAsync(request);

DeleteInstructionAsync(InstructionName, CallSettings)

Deletes an instruction object by resource name.

Declaration
public virtual Task DeleteInstructionAsync(InstructionName name, CallSettings callSettings = null)
Parameters
Type Name Description
InstructionName name

Required. Instruction resource name, format: projects/{project_id}/instructions/{instruction_id}

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
InstructionName name = InstructionName.FromProjectInstruction("[PROJECT]", "[INSTRUCTION]");
// Make the request
await dataLabelingServiceClient.DeleteInstructionAsync(name);

DeleteInstructionAsync(InstructionName, CancellationToken)

Deletes an instruction object by resource name.

Declaration
public virtual Task DeleteInstructionAsync(InstructionName name, CancellationToken cancellationToken)
Parameters
Type Name Description
InstructionName name

Required. Instruction resource name, format: projects/{project_id}/instructions/{instruction_id}

System.Threading.CancellationToken cancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
Type Description
System.Threading.Tasks.Task

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
InstructionName name = InstructionName.FromProjectInstruction("[PROJECT]", "[INSTRUCTION]");
// Make the request
await dataLabelingServiceClient.DeleteInstructionAsync(name);

DeleteInstructionAsync(String, CallSettings)

Deletes an instruction object by resource name.

Declaration
public virtual Task DeleteInstructionAsync(string name, CallSettings callSettings = null)
Parameters
Type Name Description
System.String name

Required. Instruction resource name, format: projects/{project_id}/instructions/{instruction_id}

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/instructions/[INSTRUCTION]";
// Make the request
await dataLabelingServiceClient.DeleteInstructionAsync(name);

DeleteInstructionAsync(String, CancellationToken)

Deletes an instruction object by resource name.

Declaration
public virtual Task DeleteInstructionAsync(string name, CancellationToken cancellationToken)
Parameters
Type Name Description
System.String name

Required. Instruction resource name, format: projects/{project_id}/instructions/{instruction_id}

System.Threading.CancellationToken cancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
Type Description
System.Threading.Tasks.Task

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/instructions/[INSTRUCTION]";
// Make the request
await dataLabelingServiceClient.DeleteInstructionAsync(name);

ExportData(DatasetName, AnnotatedDatasetName, String, OutputConfig, CallSettings)

Exports data and annotations from dataset.

Declaration
public virtual Operation<ExportDataOperationResponse, ExportDataOperationMetadata> ExportData(DatasetName name, AnnotatedDatasetName annotatedDataset, string filter, OutputConfig outputConfig, CallSettings callSettings = null)
Parameters
Type Name Description
DatasetName name

Required. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id}

AnnotatedDatasetName annotatedDataset

Required. Annotated dataset resource name. DataItem in Dataset and their annotations in specified annotated dataset will be exported. It's in format of projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}

System.String filter

Optional. Filter is not supported at this moment.

OutputConfig outputConfig

Required. Specify the output destination.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Operation<ExportDataOperationResponse, ExportDataOperationMetadata>

The RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.Create();
// Initialize request argument(s)
DatasetName name = DatasetName.FromProjectDataset("[PROJECT]", "[DATASET]");
AnnotatedDatasetName annotatedDataset = AnnotatedDatasetName.FromProjectDatasetAnnotatedDataset("[PROJECT]", "[DATASET]", "[ANNOTATED_DATASET]");
string filter = "";
OutputConfig outputConfig = new OutputConfig();
// Make the request
Operation<ExportDataOperationResponse, ExportDataOperationMetadata> response = dataLabelingServiceClient.ExportData(name, annotatedDataset, filter, outputConfig);

// Poll until the returned long-running operation is complete
Operation<ExportDataOperationResponse, ExportDataOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
ExportDataOperationResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<ExportDataOperationResponse, ExportDataOperationMetadata> retrievedResponse = dataLabelingServiceClient.PollOnceExportData(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    ExportDataOperationResponse retrievedResult = retrievedResponse.Result;
}

ExportData(ExportDataRequest, CallSettings)

Exports data and annotations from dataset.

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

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

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Operation<ExportDataOperationResponse, ExportDataOperationMetadata>

The RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.Create();
// Initialize request argument(s)
ExportDataRequest request = new ExportDataRequest
{
    DatasetName = DatasetName.FromProjectDataset("[PROJECT]", "[DATASET]"),
    AnnotatedDatasetAsAnnotatedDatasetName = AnnotatedDatasetName.FromProjectDatasetAnnotatedDataset("[PROJECT]", "[DATASET]", "[ANNOTATED_DATASET]"),
    Filter = "",
    OutputConfig = new OutputConfig(),
    UserEmailAddress = "",
};
// Make the request
Operation<ExportDataOperationResponse, ExportDataOperationMetadata> response = dataLabelingServiceClient.ExportData(request);

// Poll until the returned long-running operation is complete
Operation<ExportDataOperationResponse, ExportDataOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
ExportDataOperationResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<ExportDataOperationResponse, ExportDataOperationMetadata> retrievedResponse = dataLabelingServiceClient.PollOnceExportData(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    ExportDataOperationResponse retrievedResult = retrievedResponse.Result;
}

ExportData(String, String, String, OutputConfig, CallSettings)

Exports data and annotations from dataset.

Declaration
public virtual Operation<ExportDataOperationResponse, ExportDataOperationMetadata> ExportData(string name, string annotatedDataset, string filter, OutputConfig outputConfig, CallSettings callSettings = null)
Parameters
Type Name Description
System.String name

Required. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id}

System.String annotatedDataset

Required. Annotated dataset resource name. DataItem in Dataset and their annotations in specified annotated dataset will be exported. It's in format of projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}

System.String filter

Optional. Filter is not supported at this moment.

OutputConfig outputConfig

Required. Specify the output destination.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Operation<ExportDataOperationResponse, ExportDataOperationMetadata>

The RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/datasets/[DATASET]";
string annotatedDataset = "projects/[PROJECT]/datasets/[DATASET]/annotatedDatasets/[ANNOTATED_DATASET]";
string filter = "";
OutputConfig outputConfig = new OutputConfig();
// Make the request
Operation<ExportDataOperationResponse, ExportDataOperationMetadata> response = dataLabelingServiceClient.ExportData(name, annotatedDataset, filter, outputConfig);

// Poll until the returned long-running operation is complete
Operation<ExportDataOperationResponse, ExportDataOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
ExportDataOperationResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<ExportDataOperationResponse, ExportDataOperationMetadata> retrievedResponse = dataLabelingServiceClient.PollOnceExportData(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    ExportDataOperationResponse retrievedResult = retrievedResponse.Result;
}

ExportDataAsync(DatasetName, AnnotatedDatasetName, String, OutputConfig, CallSettings)

Exports data and annotations from dataset.

Declaration
public virtual Task<Operation<ExportDataOperationResponse, ExportDataOperationMetadata>> ExportDataAsync(DatasetName name, AnnotatedDatasetName annotatedDataset, string filter, OutputConfig outputConfig, CallSettings callSettings = null)
Parameters
Type Name Description
DatasetName name

Required. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id}

AnnotatedDatasetName annotatedDataset

Required. Annotated dataset resource name. DataItem in Dataset and their annotations in specified annotated dataset will be exported. It's in format of projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}

System.String filter

Optional. Filter is not supported at this moment.

OutputConfig outputConfig

Required. Specify the output destination.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task<Operation<ExportDataOperationResponse, ExportDataOperationMetadata>>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
DatasetName name = DatasetName.FromProjectDataset("[PROJECT]", "[DATASET]");
AnnotatedDatasetName annotatedDataset = AnnotatedDatasetName.FromProjectDatasetAnnotatedDataset("[PROJECT]", "[DATASET]", "[ANNOTATED_DATASET]");
string filter = "";
OutputConfig outputConfig = new OutputConfig();
// Make the request
Operation<ExportDataOperationResponse, ExportDataOperationMetadata> response = await dataLabelingServiceClient.ExportDataAsync(name, annotatedDataset, filter, outputConfig);

// Poll until the returned long-running operation is complete
Operation<ExportDataOperationResponse, ExportDataOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
ExportDataOperationResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<ExportDataOperationResponse, ExportDataOperationMetadata> retrievedResponse = await dataLabelingServiceClient.PollOnceExportDataAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    ExportDataOperationResponse retrievedResult = retrievedResponse.Result;
}

ExportDataAsync(DatasetName, AnnotatedDatasetName, String, OutputConfig, CancellationToken)

Exports data and annotations from dataset.

Declaration
public virtual Task<Operation<ExportDataOperationResponse, ExportDataOperationMetadata>> ExportDataAsync(DatasetName name, AnnotatedDatasetName annotatedDataset, string filter, OutputConfig outputConfig, CancellationToken cancellationToken)
Parameters
Type Name Description
DatasetName name

Required. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id}

AnnotatedDatasetName annotatedDataset

Required. Annotated dataset resource name. DataItem in Dataset and their annotations in specified annotated dataset will be exported. It's in format of projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}

System.String filter

Optional. Filter is not supported at this moment.

OutputConfig outputConfig

Required. Specify the output destination.

System.Threading.CancellationToken cancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
Type Description
System.Threading.Tasks.Task<Operation<ExportDataOperationResponse, ExportDataOperationMetadata>>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
DatasetName name = DatasetName.FromProjectDataset("[PROJECT]", "[DATASET]");
AnnotatedDatasetName annotatedDataset = AnnotatedDatasetName.FromProjectDatasetAnnotatedDataset("[PROJECT]", "[DATASET]", "[ANNOTATED_DATASET]");
string filter = "";
OutputConfig outputConfig = new OutputConfig();
// Make the request
Operation<ExportDataOperationResponse, ExportDataOperationMetadata> response = await dataLabelingServiceClient.ExportDataAsync(name, annotatedDataset, filter, outputConfig);

// Poll until the returned long-running operation is complete
Operation<ExportDataOperationResponse, ExportDataOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
ExportDataOperationResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<ExportDataOperationResponse, ExportDataOperationMetadata> retrievedResponse = await dataLabelingServiceClient.PollOnceExportDataAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    ExportDataOperationResponse retrievedResult = retrievedResponse.Result;
}

ExportDataAsync(ExportDataRequest, CallSettings)

Exports data and annotations from dataset.

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

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

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task<Operation<ExportDataOperationResponse, ExportDataOperationMetadata>>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
ExportDataRequest request = new ExportDataRequest
{
    DatasetName = DatasetName.FromProjectDataset("[PROJECT]", "[DATASET]"),
    AnnotatedDatasetAsAnnotatedDatasetName = AnnotatedDatasetName.FromProjectDatasetAnnotatedDataset("[PROJECT]", "[DATASET]", "[ANNOTATED_DATASET]"),
    Filter = "",
    OutputConfig = new OutputConfig(),
    UserEmailAddress = "",
};
// Make the request
Operation<ExportDataOperationResponse, ExportDataOperationMetadata> response = await dataLabelingServiceClient.ExportDataAsync(request);

// Poll until the returned long-running operation is complete
Operation<ExportDataOperationResponse, ExportDataOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
ExportDataOperationResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<ExportDataOperationResponse, ExportDataOperationMetadata> retrievedResponse = await dataLabelingServiceClient.PollOnceExportDataAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    ExportDataOperationResponse retrievedResult = retrievedResponse.Result;
}

ExportDataAsync(ExportDataRequest, CancellationToken)

Exports data and annotations from dataset.

Declaration
public virtual Task<Operation<ExportDataOperationResponse, ExportDataOperationMetadata>> ExportDataAsync(ExportDataRequest request, CancellationToken cancellationToken)
Parameters
Type Name Description
ExportDataRequest request

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

System.Threading.CancellationToken cancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
Type Description
System.Threading.Tasks.Task<Operation<ExportDataOperationResponse, ExportDataOperationMetadata>>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
ExportDataRequest request = new ExportDataRequest
{
    DatasetName = DatasetName.FromProjectDataset("[PROJECT]", "[DATASET]"),
    AnnotatedDatasetAsAnnotatedDatasetName = AnnotatedDatasetName.FromProjectDatasetAnnotatedDataset("[PROJECT]", "[DATASET]", "[ANNOTATED_DATASET]"),
    Filter = "",
    OutputConfig = new OutputConfig(),
    UserEmailAddress = "",
};
// Make the request
Operation<ExportDataOperationResponse, ExportDataOperationMetadata> response = await dataLabelingServiceClient.ExportDataAsync(request);

// Poll until the returned long-running operation is complete
Operation<ExportDataOperationResponse, ExportDataOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
ExportDataOperationResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<ExportDataOperationResponse, ExportDataOperationMetadata> retrievedResponse = await dataLabelingServiceClient.PollOnceExportDataAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    ExportDataOperationResponse retrievedResult = retrievedResponse.Result;
}

ExportDataAsync(String, String, String, OutputConfig, CallSettings)

Exports data and annotations from dataset.

Declaration
public virtual Task<Operation<ExportDataOperationResponse, ExportDataOperationMetadata>> ExportDataAsync(string name, string annotatedDataset, string filter, OutputConfig outputConfig, CallSettings callSettings = null)
Parameters
Type Name Description
System.String name

Required. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id}

System.String annotatedDataset

Required. Annotated dataset resource name. DataItem in Dataset and their annotations in specified annotated dataset will be exported. It's in format of projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}

System.String filter

Optional. Filter is not supported at this moment.

OutputConfig outputConfig

Required. Specify the output destination.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task<Operation<ExportDataOperationResponse, ExportDataOperationMetadata>>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/datasets/[DATASET]";
string annotatedDataset = "projects/[PROJECT]/datasets/[DATASET]/annotatedDatasets/[ANNOTATED_DATASET]";
string filter = "";
OutputConfig outputConfig = new OutputConfig();
// Make the request
Operation<ExportDataOperationResponse, ExportDataOperationMetadata> response = await dataLabelingServiceClient.ExportDataAsync(name, annotatedDataset, filter, outputConfig);

// Poll until the returned long-running operation is complete
Operation<ExportDataOperationResponse, ExportDataOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
ExportDataOperationResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<ExportDataOperationResponse, ExportDataOperationMetadata> retrievedResponse = await dataLabelingServiceClient.PollOnceExportDataAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    ExportDataOperationResponse retrievedResult = retrievedResponse.Result;
}

ExportDataAsync(String, String, String, OutputConfig, CancellationToken)

Exports data and annotations from dataset.

Declaration
public virtual Task<Operation<ExportDataOperationResponse, ExportDataOperationMetadata>> ExportDataAsync(string name, string annotatedDataset, string filter, OutputConfig outputConfig, CancellationToken cancellationToken)
Parameters
Type Name Description
System.String name

Required. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id}

System.String annotatedDataset

Required. Annotated dataset resource name. DataItem in Dataset and their annotations in specified annotated dataset will be exported. It's in format of projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}

System.String filter

Optional. Filter is not supported at this moment.

OutputConfig outputConfig

Required. Specify the output destination.

System.Threading.CancellationToken cancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
Type Description
System.Threading.Tasks.Task<Operation<ExportDataOperationResponse, ExportDataOperationMetadata>>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/datasets/[DATASET]";
string annotatedDataset = "projects/[PROJECT]/datasets/[DATASET]/annotatedDatasets/[ANNOTATED_DATASET]";
string filter = "";
OutputConfig outputConfig = new OutputConfig();
// Make the request
Operation<ExportDataOperationResponse, ExportDataOperationMetadata> response = await dataLabelingServiceClient.ExportDataAsync(name, annotatedDataset, filter, outputConfig);

// Poll until the returned long-running operation is complete
Operation<ExportDataOperationResponse, ExportDataOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
ExportDataOperationResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<ExportDataOperationResponse, ExportDataOperationMetadata> retrievedResponse = await dataLabelingServiceClient.PollOnceExportDataAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    ExportDataOperationResponse retrievedResult = retrievedResponse.Result;
}

GetAnnotatedDataset(AnnotatedDatasetName, CallSettings)

Gets an annotated dataset by resource name.

Declaration
public virtual AnnotatedDataset GetAnnotatedDataset(AnnotatedDatasetName name, CallSettings callSettings = null)
Parameters
Type Name Description
AnnotatedDatasetName name

Required. Name of the annotated dataset to get, format: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
AnnotatedDataset

The RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.Create();
// Initialize request argument(s)
AnnotatedDatasetName name = AnnotatedDatasetName.FromProjectDatasetAnnotatedDataset("[PROJECT]", "[DATASET]", "[ANNOTATED_DATASET]");
// Make the request
AnnotatedDataset response = dataLabelingServiceClient.GetAnnotatedDataset(name);

GetAnnotatedDataset(GetAnnotatedDatasetRequest, CallSettings)

Gets an annotated dataset by resource name.

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

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

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
AnnotatedDataset

The RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.Create();
// Initialize request argument(s)
GetAnnotatedDatasetRequest request = new GetAnnotatedDatasetRequest
{
    AnnotatedDatasetName = AnnotatedDatasetName.FromProjectDatasetAnnotatedDataset("[PROJECT]", "[DATASET]", "[ANNOTATED_DATASET]"),
};
// Make the request
AnnotatedDataset response = dataLabelingServiceClient.GetAnnotatedDataset(request);

GetAnnotatedDataset(String, CallSettings)

Gets an annotated dataset by resource name.

Declaration
public virtual AnnotatedDataset GetAnnotatedDataset(string name, CallSettings callSettings = null)
Parameters
Type Name Description
System.String name

Required. Name of the annotated dataset to get, format: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
AnnotatedDataset

The RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/datasets/[DATASET]/annotatedDatasets/[ANNOTATED_DATASET]";
// Make the request
AnnotatedDataset response = dataLabelingServiceClient.GetAnnotatedDataset(name);

GetAnnotatedDatasetAsync(AnnotatedDatasetName, CallSettings)

Gets an annotated dataset by resource name.

Declaration
public virtual Task<AnnotatedDataset> GetAnnotatedDatasetAsync(AnnotatedDatasetName name, CallSettings callSettings = null)
Parameters
Type Name Description
AnnotatedDatasetName name

Required. Name of the annotated dataset to get, format: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task<AnnotatedDataset>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
AnnotatedDatasetName name = AnnotatedDatasetName.FromProjectDatasetAnnotatedDataset("[PROJECT]", "[DATASET]", "[ANNOTATED_DATASET]");
// Make the request
AnnotatedDataset response = await dataLabelingServiceClient.GetAnnotatedDatasetAsync(name);

GetAnnotatedDatasetAsync(AnnotatedDatasetName, CancellationToken)

Gets an annotated dataset by resource name.

Declaration
public virtual Task<AnnotatedDataset> GetAnnotatedDatasetAsync(AnnotatedDatasetName name, CancellationToken cancellationToken)
Parameters
Type Name Description
AnnotatedDatasetName name

Required. Name of the annotated dataset to get, format: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}

System.Threading.CancellationToken cancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
Type Description
System.Threading.Tasks.Task<AnnotatedDataset>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
AnnotatedDatasetName name = AnnotatedDatasetName.FromProjectDatasetAnnotatedDataset("[PROJECT]", "[DATASET]", "[ANNOTATED_DATASET]");
// Make the request
AnnotatedDataset response = await dataLabelingServiceClient.GetAnnotatedDatasetAsync(name);

GetAnnotatedDatasetAsync(GetAnnotatedDatasetRequest, CallSettings)

Gets an annotated dataset by resource name.

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

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

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task<AnnotatedDataset>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
GetAnnotatedDatasetRequest request = new GetAnnotatedDatasetRequest
{
    AnnotatedDatasetName = AnnotatedDatasetName.FromProjectDatasetAnnotatedDataset("[PROJECT]", "[DATASET]", "[ANNOTATED_DATASET]"),
};
// Make the request
AnnotatedDataset response = await dataLabelingServiceClient.GetAnnotatedDatasetAsync(request);

GetAnnotatedDatasetAsync(GetAnnotatedDatasetRequest, CancellationToken)

Gets an annotated dataset by resource name.

Declaration
public virtual Task<AnnotatedDataset> GetAnnotatedDatasetAsync(GetAnnotatedDatasetRequest request, CancellationToken cancellationToken)
Parameters
Type Name Description
GetAnnotatedDatasetRequest request

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

System.Threading.CancellationToken cancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
Type Description
System.Threading.Tasks.Task<AnnotatedDataset>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
GetAnnotatedDatasetRequest request = new GetAnnotatedDatasetRequest
{
    AnnotatedDatasetName = AnnotatedDatasetName.FromProjectDatasetAnnotatedDataset("[PROJECT]", "[DATASET]", "[ANNOTATED_DATASET]"),
};
// Make the request
AnnotatedDataset response = await dataLabelingServiceClient.GetAnnotatedDatasetAsync(request);

GetAnnotatedDatasetAsync(String, CallSettings)

Gets an annotated dataset by resource name.

Declaration
public virtual Task<AnnotatedDataset> GetAnnotatedDatasetAsync(string name, CallSettings callSettings = null)
Parameters
Type Name Description
System.String name

Required. Name of the annotated dataset to get, format: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task<AnnotatedDataset>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/datasets/[DATASET]/annotatedDatasets/[ANNOTATED_DATASET]";
// Make the request
AnnotatedDataset response = await dataLabelingServiceClient.GetAnnotatedDatasetAsync(name);

GetAnnotatedDatasetAsync(String, CancellationToken)

Gets an annotated dataset by resource name.

Declaration
public virtual Task<AnnotatedDataset> GetAnnotatedDatasetAsync(string name, CancellationToken cancellationToken)
Parameters
Type Name Description
System.String name

Required. Name of the annotated dataset to get, format: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}

System.Threading.CancellationToken cancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
Type Description
System.Threading.Tasks.Task<AnnotatedDataset>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/datasets/[DATASET]/annotatedDatasets/[ANNOTATED_DATASET]";
// Make the request
AnnotatedDataset response = await dataLabelingServiceClient.GetAnnotatedDatasetAsync(name);

GetAnnotationSpecSet(AnnotationSpecSetName, CallSettings)

Gets an annotation spec set by resource name.

Declaration
public virtual AnnotationSpecSet GetAnnotationSpecSet(AnnotationSpecSetName name, CallSettings callSettings = null)
Parameters
Type Name Description
AnnotationSpecSetName name

Required. AnnotationSpecSet resource name, format: projects/{project_id}/annotationSpecSets/{annotation_spec_set_id}

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
AnnotationSpecSet

The RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.Create();
// Initialize request argument(s)
AnnotationSpecSetName name = AnnotationSpecSetName.FromProjectAnnotationSpecSet("[PROJECT]", "[ANNOTATION_SPEC_SET]");
// Make the request
AnnotationSpecSet response = dataLabelingServiceClient.GetAnnotationSpecSet(name);

GetAnnotationSpecSet(GetAnnotationSpecSetRequest, CallSettings)

Gets an annotation spec set by resource name.

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

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

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
AnnotationSpecSet

The RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.Create();
// Initialize request argument(s)
GetAnnotationSpecSetRequest request = new GetAnnotationSpecSetRequest
{
    AnnotationSpecSetName = AnnotationSpecSetName.FromProjectAnnotationSpecSet("[PROJECT]", "[ANNOTATION_SPEC_SET]"),
};
// Make the request
AnnotationSpecSet response = dataLabelingServiceClient.GetAnnotationSpecSet(request);

GetAnnotationSpecSet(String, CallSettings)

Gets an annotation spec set by resource name.

Declaration
public virtual AnnotationSpecSet GetAnnotationSpecSet(string name, CallSettings callSettings = null)
Parameters
Type Name Description
System.String name

Required. AnnotationSpecSet resource name, format: projects/{project_id}/annotationSpecSets/{annotation_spec_set_id}

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
AnnotationSpecSet

The RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/annotationSpecSets/[ANNOTATION_SPEC_SET]";
// Make the request
AnnotationSpecSet response = dataLabelingServiceClient.GetAnnotationSpecSet(name);

GetAnnotationSpecSetAsync(AnnotationSpecSetName, CallSettings)

Gets an annotation spec set by resource name.

Declaration
public virtual Task<AnnotationSpecSet> GetAnnotationSpecSetAsync(AnnotationSpecSetName name, CallSettings callSettings = null)
Parameters
Type Name Description
AnnotationSpecSetName name

Required. AnnotationSpecSet resource name, format: projects/{project_id}/annotationSpecSets/{annotation_spec_set_id}

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task<AnnotationSpecSet>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
AnnotationSpecSetName name = AnnotationSpecSetName.FromProjectAnnotationSpecSet("[PROJECT]", "[ANNOTATION_SPEC_SET]");
// Make the request
AnnotationSpecSet response = await dataLabelingServiceClient.GetAnnotationSpecSetAsync(name);

GetAnnotationSpecSetAsync(AnnotationSpecSetName, CancellationToken)

Gets an annotation spec set by resource name.

Declaration
public virtual Task<AnnotationSpecSet> GetAnnotationSpecSetAsync(AnnotationSpecSetName name, CancellationToken cancellationToken)
Parameters
Type Name Description
AnnotationSpecSetName name

Required. AnnotationSpecSet resource name, format: projects/{project_id}/annotationSpecSets/{annotation_spec_set_id}

System.Threading.CancellationToken cancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
Type Description
System.Threading.Tasks.Task<AnnotationSpecSet>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
AnnotationSpecSetName name = AnnotationSpecSetName.FromProjectAnnotationSpecSet("[PROJECT]", "[ANNOTATION_SPEC_SET]");
// Make the request
AnnotationSpecSet response = await dataLabelingServiceClient.GetAnnotationSpecSetAsync(name);

GetAnnotationSpecSetAsync(GetAnnotationSpecSetRequest, CallSettings)

Gets an annotation spec set by resource name.

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

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

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task<AnnotationSpecSet>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
GetAnnotationSpecSetRequest request = new GetAnnotationSpecSetRequest
{
    AnnotationSpecSetName = AnnotationSpecSetName.FromProjectAnnotationSpecSet("[PROJECT]", "[ANNOTATION_SPEC_SET]"),
};
// Make the request
AnnotationSpecSet response = await dataLabelingServiceClient.GetAnnotationSpecSetAsync(request);

GetAnnotationSpecSetAsync(GetAnnotationSpecSetRequest, CancellationToken)

Gets an annotation spec set by resource name.

Declaration
public virtual Task<AnnotationSpecSet> GetAnnotationSpecSetAsync(GetAnnotationSpecSetRequest request, CancellationToken cancellationToken)
Parameters
Type Name Description
GetAnnotationSpecSetRequest request

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

System.Threading.CancellationToken cancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
Type Description
System.Threading.Tasks.Task<AnnotationSpecSet>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
GetAnnotationSpecSetRequest request = new GetAnnotationSpecSetRequest
{
    AnnotationSpecSetName = AnnotationSpecSetName.FromProjectAnnotationSpecSet("[PROJECT]", "[ANNOTATION_SPEC_SET]"),
};
// Make the request
AnnotationSpecSet response = await dataLabelingServiceClient.GetAnnotationSpecSetAsync(request);

GetAnnotationSpecSetAsync(String, CallSettings)

Gets an annotation spec set by resource name.

Declaration
public virtual Task<AnnotationSpecSet> GetAnnotationSpecSetAsync(string name, CallSettings callSettings = null)
Parameters
Type Name Description
System.String name

Required. AnnotationSpecSet resource name, format: projects/{project_id}/annotationSpecSets/{annotation_spec_set_id}

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task<AnnotationSpecSet>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/annotationSpecSets/[ANNOTATION_SPEC_SET]";
// Make the request
AnnotationSpecSet response = await dataLabelingServiceClient.GetAnnotationSpecSetAsync(name);

GetAnnotationSpecSetAsync(String, CancellationToken)

Gets an annotation spec set by resource name.

Declaration
public virtual Task<AnnotationSpecSet> GetAnnotationSpecSetAsync(string name, CancellationToken cancellationToken)
Parameters
Type Name Description
System.String name

Required. AnnotationSpecSet resource name, format: projects/{project_id}/annotationSpecSets/{annotation_spec_set_id}

System.Threading.CancellationToken cancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
Type Description
System.Threading.Tasks.Task<AnnotationSpecSet>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/annotationSpecSets/[ANNOTATION_SPEC_SET]";
// Make the request
AnnotationSpecSet response = await dataLabelingServiceClient.GetAnnotationSpecSetAsync(name);

GetDataItem(DataItemName, CallSettings)

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

Declaration
public virtual DataItem GetDataItem(DataItemName name, CallSettings callSettings = null)
Parameters
Type Name Description
DataItemName name

Required. The name of the data item to get, format: projects/{project_id}/datasets/{dataset_id}/dataItems/{data_item_id}

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
DataItem

The RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.Create();
// Initialize request argument(s)
DataItemName name = DataItemName.FromProjectDatasetDataItem("[PROJECT]", "[DATASET]", "[DATA_ITEM]");
// Make the request
DataItem response = dataLabelingServiceClient.GetDataItem(name);

GetDataItem(GetDataItemRequest, CallSettings)

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

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

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

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
DataItem

The RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.Create();
// Initialize request argument(s)
GetDataItemRequest request = new GetDataItemRequest
{
    DataItemName = DataItemName.FromProjectDatasetDataItem("[PROJECT]", "[DATASET]", "[DATA_ITEM]"),
};
// Make the request
DataItem response = dataLabelingServiceClient.GetDataItem(request);

GetDataItem(String, CallSettings)

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

Declaration
public virtual DataItem GetDataItem(string name, CallSettings callSettings = null)
Parameters
Type Name Description
System.String name

Required. The name of the data item to get, format: projects/{project_id}/datasets/{dataset_id}/dataItems/{data_item_id}

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
DataItem

The RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/datasets/[DATASET]/dataItems/[DATA_ITEM]";
// Make the request
DataItem response = dataLabelingServiceClient.GetDataItem(name);

GetDataItemAsync(DataItemName, CallSettings)

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

Declaration
public virtual Task<DataItem> GetDataItemAsync(DataItemName name, CallSettings callSettings = null)
Parameters
Type Name Description
DataItemName name

Required. The name of the data item to get, format: projects/{project_id}/datasets/{dataset_id}/dataItems/{data_item_id}

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task<DataItem>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
DataItemName name = DataItemName.FromProjectDatasetDataItem("[PROJECT]", "[DATASET]", "[DATA_ITEM]");
// Make the request
DataItem response = await dataLabelingServiceClient.GetDataItemAsync(name);

GetDataItemAsync(DataItemName, CancellationToken)

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

Declaration
public virtual Task<DataItem> GetDataItemAsync(DataItemName name, CancellationToken cancellationToken)
Parameters
Type Name Description
DataItemName name

Required. The name of the data item to get, format: projects/{project_id}/datasets/{dataset_id}/dataItems/{data_item_id}

System.Threading.CancellationToken cancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
Type Description
System.Threading.Tasks.Task<DataItem>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
DataItemName name = DataItemName.FromProjectDatasetDataItem("[PROJECT]", "[DATASET]", "[DATA_ITEM]");
// Make the request
DataItem response = await dataLabelingServiceClient.GetDataItemAsync(name);

GetDataItemAsync(GetDataItemRequest, CallSettings)

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

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

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

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task<DataItem>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
GetDataItemRequest request = new GetDataItemRequest
{
    DataItemName = DataItemName.FromProjectDatasetDataItem("[PROJECT]", "[DATASET]", "[DATA_ITEM]"),
};
// Make the request
DataItem response = await dataLabelingServiceClient.GetDataItemAsync(request);

GetDataItemAsync(GetDataItemRequest, CancellationToken)

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

Declaration
public virtual Task<DataItem> GetDataItemAsync(GetDataItemRequest request, CancellationToken cancellationToken)
Parameters
Type Name Description
GetDataItemRequest request

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

System.Threading.CancellationToken cancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
Type Description
System.Threading.Tasks.Task<DataItem>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
GetDataItemRequest request = new GetDataItemRequest
{
    DataItemName = DataItemName.FromProjectDatasetDataItem("[PROJECT]", "[DATASET]", "[DATA_ITEM]"),
};
// Make the request
DataItem response = await dataLabelingServiceClient.GetDataItemAsync(request);

GetDataItemAsync(String, CallSettings)

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

Declaration
public virtual Task<DataItem> GetDataItemAsync(string name, CallSettings callSettings = null)
Parameters
Type Name Description
System.String name

Required. The name of the data item to get, format: projects/{project_id}/datasets/{dataset_id}/dataItems/{data_item_id}

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task<DataItem>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/datasets/[DATASET]/dataItems/[DATA_ITEM]";
// Make the request
DataItem response = await dataLabelingServiceClient.GetDataItemAsync(name);

GetDataItemAsync(String, CancellationToken)

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

Declaration
public virtual Task<DataItem> GetDataItemAsync(string name, CancellationToken cancellationToken)
Parameters
Type Name Description
System.String name

Required. The name of the data item to get, format: projects/{project_id}/datasets/{dataset_id}/dataItems/{data_item_id}

System.Threading.CancellationToken cancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
Type Description
System.Threading.Tasks.Task<DataItem>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/datasets/[DATASET]/dataItems/[DATA_ITEM]";
// Make the request
DataItem response = await dataLabelingServiceClient.GetDataItemAsync(name);

GetDataset(DatasetName, CallSettings)

Gets dataset by resource name.

Declaration
public virtual Dataset GetDataset(DatasetName name, CallSettings callSettings = null)
Parameters
Type Name Description
DatasetName name

Required. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id}

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Dataset

The RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.Create();
// Initialize request argument(s)
DatasetName name = DatasetName.FromProjectDataset("[PROJECT]", "[DATASET]");
// Make the request
Dataset response = dataLabelingServiceClient.GetDataset(name);

GetDataset(GetDatasetRequest, CallSettings)

Gets dataset by resource name.

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

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

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Dataset

The RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.Create();
// Initialize request argument(s)
GetDatasetRequest request = new GetDatasetRequest
{
    DatasetName = DatasetName.FromProjectDataset("[PROJECT]", "[DATASET]"),
};
// Make the request
Dataset response = dataLabelingServiceClient.GetDataset(request);

GetDataset(String, CallSettings)

Gets dataset by resource name.

Declaration
public virtual Dataset GetDataset(string name, CallSettings callSettings = null)
Parameters
Type Name Description
System.String name

Required. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id}

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Dataset

The RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/datasets/[DATASET]";
// Make the request
Dataset response = dataLabelingServiceClient.GetDataset(name);

GetDatasetAsync(DatasetName, CallSettings)

Gets dataset by resource name.

Declaration
public virtual Task<Dataset> GetDatasetAsync(DatasetName name, CallSettings callSettings = null)
Parameters
Type Name Description
DatasetName name

Required. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id}

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task<Dataset>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
DatasetName name = DatasetName.FromProjectDataset("[PROJECT]", "[DATASET]");
// Make the request
Dataset response = await dataLabelingServiceClient.GetDatasetAsync(name);

GetDatasetAsync(DatasetName, CancellationToken)

Gets dataset by resource name.

Declaration
public virtual Task<Dataset> GetDatasetAsync(DatasetName name, CancellationToken cancellationToken)
Parameters
Type Name Description
DatasetName name

Required. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id}

System.Threading.CancellationToken cancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
Type Description
System.Threading.Tasks.Task<Dataset>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
DatasetName name = DatasetName.FromProjectDataset("[PROJECT]", "[DATASET]");
// Make the request
Dataset response = await dataLabelingServiceClient.GetDatasetAsync(name);

GetDatasetAsync(GetDatasetRequest, CallSettings)

Gets dataset by resource name.

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

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

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task<Dataset>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
GetDatasetRequest request = new GetDatasetRequest
{
    DatasetName = DatasetName.FromProjectDataset("[PROJECT]", "[DATASET]"),
};
// Make the request
Dataset response = await dataLabelingServiceClient.GetDatasetAsync(request);

GetDatasetAsync(GetDatasetRequest, CancellationToken)

Gets dataset by resource name.

Declaration
public virtual Task<Dataset> GetDatasetAsync(GetDatasetRequest request, CancellationToken cancellationToken)
Parameters
Type Name Description
GetDatasetRequest request

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

System.Threading.CancellationToken cancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
Type Description
System.Threading.Tasks.Task<Dataset>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
GetDatasetRequest request = new GetDatasetRequest
{
    DatasetName = DatasetName.FromProjectDataset("[PROJECT]", "[DATASET]"),
};
// Make the request
Dataset response = await dataLabelingServiceClient.GetDatasetAsync(request);

GetDatasetAsync(String, CallSettings)

Gets dataset by resource name.

Declaration
public virtual Task<Dataset> GetDatasetAsync(string name, CallSettings callSettings = null)
Parameters
Type Name Description
System.String name

Required. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id}

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task<Dataset>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/datasets/[DATASET]";
// Make the request
Dataset response = await dataLabelingServiceClient.GetDatasetAsync(name);

GetDatasetAsync(String, CancellationToken)

Gets dataset by resource name.

Declaration
public virtual Task<Dataset> GetDatasetAsync(string name, CancellationToken cancellationToken)
Parameters
Type Name Description
System.String name

Required. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id}

System.Threading.CancellationToken cancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
Type Description
System.Threading.Tasks.Task<Dataset>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/datasets/[DATASET]";
// Make the request
Dataset response = await dataLabelingServiceClient.GetDatasetAsync(name);

GetEvaluation(EvaluationName, CallSettings)

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

Declaration
public virtual Evaluation GetEvaluation(EvaluationName name, CallSettings callSettings = null)
Parameters
Type Name Description
EvaluationName name

Required. Name of the evaluation. Format:

"projects/&lt;var&gt;{project_id}&lt;/var&gt;/datasets/&lt;var&gt;{dataset_id}&lt;/var&gt;/evaluations/&lt;var&gt;{evaluation_id}&lt;/var&gt;'

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Evaluation

The RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.Create();
// Initialize request argument(s)
EvaluationName name = EvaluationName.FromProjectDatasetEvaluation("[PROJECT]", "[DATASET]", "[EVALUATION]");
// Make the request
Evaluation response = dataLabelingServiceClient.GetEvaluation(name);

GetEvaluation(GetEvaluationRequest, CallSettings)

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

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

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

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Evaluation

The RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.Create();
// Initialize request argument(s)
GetEvaluationRequest request = new GetEvaluationRequest
{
    EvaluationName = EvaluationName.FromProjectDatasetEvaluation("[PROJECT]", "[DATASET]", "[EVALUATION]"),
};
// Make the request
Evaluation response = dataLabelingServiceClient.GetEvaluation(request);

GetEvaluation(String, CallSettings)

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

Declaration
public virtual Evaluation GetEvaluation(string name, CallSettings callSettings = null)
Parameters
Type Name Description
System.String name

Required. Name of the evaluation. Format:

"projects/&lt;var&gt;{project_id}&lt;/var&gt;/datasets/&lt;var&gt;{dataset_id}&lt;/var&gt;/evaluations/&lt;var&gt;{evaluation_id}&lt;/var&gt;'

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Evaluation

The RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/datasets/[DATASET]/evaluations/[EVALUATION]";
// Make the request
Evaluation response = dataLabelingServiceClient.GetEvaluation(name);

GetEvaluationAsync(EvaluationName, CallSettings)

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

Declaration
public virtual Task<Evaluation> GetEvaluationAsync(EvaluationName name, CallSettings callSettings = null)
Parameters
Type Name Description
EvaluationName name

Required. Name of the evaluation. Format:

"projects/&lt;var&gt;{project_id}&lt;/var&gt;/datasets/&lt;var&gt;{dataset_id}&lt;/var&gt;/evaluations/&lt;var&gt;{evaluation_id}&lt;/var&gt;'

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task<Evaluation>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
EvaluationName name = EvaluationName.FromProjectDatasetEvaluation("[PROJECT]", "[DATASET]", "[EVALUATION]");
// Make the request
Evaluation response = await dataLabelingServiceClient.GetEvaluationAsync(name);

GetEvaluationAsync(EvaluationName, CancellationToken)

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

Declaration
public virtual Task<Evaluation> GetEvaluationAsync(EvaluationName name, CancellationToken cancellationToken)
Parameters
Type Name Description
EvaluationName name

Required. Name of the evaluation. Format:

"projects/&lt;var&gt;{project_id}&lt;/var&gt;/datasets/&lt;var&gt;{dataset_id}&lt;/var&gt;/evaluations/&lt;var&gt;{evaluation_id}&lt;/var&gt;'

System.Threading.CancellationToken cancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
Type Description
System.Threading.Tasks.Task<Evaluation>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
EvaluationName name = EvaluationName.FromProjectDatasetEvaluation("[PROJECT]", "[DATASET]", "[EVALUATION]");
// Make the request
Evaluation response = await dataLabelingServiceClient.GetEvaluationAsync(name);

GetEvaluationAsync(GetEvaluationRequest, CallSettings)

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

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

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

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task<Evaluation>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
GetEvaluationRequest request = new GetEvaluationRequest
{
    EvaluationName = EvaluationName.FromProjectDatasetEvaluation("[PROJECT]", "[DATASET]", "[EVALUATION]"),
};
// Make the request
Evaluation response = await dataLabelingServiceClient.GetEvaluationAsync(request);

GetEvaluationAsync(GetEvaluationRequest, CancellationToken)

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

Declaration
public virtual Task<Evaluation> GetEvaluationAsync(GetEvaluationRequest request, CancellationToken cancellationToken)
Parameters
Type Name Description
GetEvaluationRequest request

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

System.Threading.CancellationToken cancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
Type Description
System.Threading.Tasks.Task<Evaluation>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
GetEvaluationRequest request = new GetEvaluationRequest
{
    EvaluationName = EvaluationName.FromProjectDatasetEvaluation("[PROJECT]", "[DATASET]", "[EVALUATION]"),
};
// Make the request
Evaluation response = await dataLabelingServiceClient.GetEvaluationAsync(request);

GetEvaluationAsync(String, CallSettings)

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

Declaration
public virtual Task<Evaluation> GetEvaluationAsync(string name, CallSettings callSettings = null)
Parameters
Type Name Description
System.String name

Required. Name of the evaluation. Format:

"projects/&lt;var&gt;{project_id}&lt;/var&gt;/datasets/&lt;var&gt;{dataset_id}&lt;/var&gt;/evaluations/&lt;var&gt;{evaluation_id}&lt;/var&gt;'

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task<Evaluation>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/datasets/[DATASET]/evaluations/[EVALUATION]";
// Make the request
Evaluation response = await dataLabelingServiceClient.GetEvaluationAsync(name);

GetEvaluationAsync(String, CancellationToken)

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

Declaration
public virtual Task<Evaluation> GetEvaluationAsync(string name, CancellationToken cancellationToken)
Parameters
Type Name Description
System.String name

Required. Name of the evaluation. Format:

"projects/&lt;var&gt;{project_id}&lt;/var&gt;/datasets/&lt;var&gt;{dataset_id}&lt;/var&gt;/evaluations/&lt;var&gt;{evaluation_id}&lt;/var&gt;'

System.Threading.CancellationToken cancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
Type Description
System.Threading.Tasks.Task<Evaluation>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/datasets/[DATASET]/evaluations/[EVALUATION]";
// Make the request
Evaluation response = await dataLabelingServiceClient.GetEvaluationAsync(name);

GetEvaluationJob(EvaluationJobName, CallSettings)

Gets an evaluation job by resource name.

Declaration
public virtual EvaluationJob GetEvaluationJob(EvaluationJobName name, CallSettings callSettings = null)
Parameters
Type Name Description
EvaluationJobName name

Required. Name of the evaluation job. Format:

"projects/&lt;var&gt;{project_id}&lt;/var&gt;/evaluationJobs/&lt;var&gt;{evaluation_job_id}&lt;/var&gt;"

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
EvaluationJob

The RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.Create();
// Initialize request argument(s)
EvaluationJobName name = EvaluationJobName.FromProjectEvaluationJob("[PROJECT]", "[EVALUATION_JOB]");
// Make the request
EvaluationJob response = dataLabelingServiceClient.GetEvaluationJob(name);

GetEvaluationJob(GetEvaluationJobRequest, CallSettings)

Gets an evaluation job by resource name.

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

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

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
EvaluationJob

The RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.Create();
// Initialize request argument(s)
GetEvaluationJobRequest request = new GetEvaluationJobRequest
{
    EvaluationJobName = EvaluationJobName.FromProjectEvaluationJob("[PROJECT]", "[EVALUATION_JOB]"),
};
// Make the request
EvaluationJob response = dataLabelingServiceClient.GetEvaluationJob(request);

GetEvaluationJob(String, CallSettings)

Gets an evaluation job by resource name.

Declaration
public virtual EvaluationJob GetEvaluationJob(string name, CallSettings callSettings = null)
Parameters
Type Name Description
System.String name

Required. Name of the evaluation job. Format:

"projects/&lt;var&gt;{project_id}&lt;/var&gt;/evaluationJobs/&lt;var&gt;{evaluation_job_id}&lt;/var&gt;"

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
EvaluationJob

The RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/evaluationJobs/[EVALUATION_JOB]";
// Make the request
EvaluationJob response = dataLabelingServiceClient.GetEvaluationJob(name);

GetEvaluationJobAsync(EvaluationJobName, CallSettings)

Gets an evaluation job by resource name.

Declaration
public virtual Task<EvaluationJob> GetEvaluationJobAsync(EvaluationJobName name, CallSettings callSettings = null)
Parameters
Type Name Description
EvaluationJobName name

Required. Name of the evaluation job. Format:

"projects/&lt;var&gt;{project_id}&lt;/var&gt;/evaluationJobs/&lt;var&gt;{evaluation_job_id}&lt;/var&gt;"

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task<EvaluationJob>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
EvaluationJobName name = EvaluationJobName.FromProjectEvaluationJob("[PROJECT]", "[EVALUATION_JOB]");
// Make the request
EvaluationJob response = await dataLabelingServiceClient.GetEvaluationJobAsync(name);

GetEvaluationJobAsync(EvaluationJobName, CancellationToken)

Gets an evaluation job by resource name.

Declaration
public virtual Task<EvaluationJob> GetEvaluationJobAsync(EvaluationJobName name, CancellationToken cancellationToken)
Parameters
Type Name Description
EvaluationJobName name

Required. Name of the evaluation job. Format:

"projects/&lt;var&gt;{project_id}&lt;/var&gt;/evaluationJobs/&lt;var&gt;{evaluation_job_id}&lt;/var&gt;"

System.Threading.CancellationToken cancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
Type Description
System.Threading.Tasks.Task<EvaluationJob>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
EvaluationJobName name = EvaluationJobName.FromProjectEvaluationJob("[PROJECT]", "[EVALUATION_JOB]");
// Make the request
EvaluationJob response = await dataLabelingServiceClient.GetEvaluationJobAsync(name);

GetEvaluationJobAsync(GetEvaluationJobRequest, CallSettings)

Gets an evaluation job by resource name.

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

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

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task<EvaluationJob>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
GetEvaluationJobRequest request = new GetEvaluationJobRequest
{
    EvaluationJobName = EvaluationJobName.FromProjectEvaluationJob("[PROJECT]", "[EVALUATION_JOB]"),
};
// Make the request
EvaluationJob response = await dataLabelingServiceClient.GetEvaluationJobAsync(request);

GetEvaluationJobAsync(GetEvaluationJobRequest, CancellationToken)

Gets an evaluation job by resource name.

Declaration
public virtual Task<EvaluationJob> GetEvaluationJobAsync(GetEvaluationJobRequest request, CancellationToken cancellationToken)
Parameters
Type Name Description
GetEvaluationJobRequest request

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

System.Threading.CancellationToken cancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
Type Description
System.Threading.Tasks.Task<EvaluationJob>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
GetEvaluationJobRequest request = new GetEvaluationJobRequest
{
    EvaluationJobName = EvaluationJobName.FromProjectEvaluationJob("[PROJECT]", "[EVALUATION_JOB]"),
};
// Make the request
EvaluationJob response = await dataLabelingServiceClient.GetEvaluationJobAsync(request);

GetEvaluationJobAsync(String, CallSettings)

Gets an evaluation job by resource name.

Declaration
public virtual Task<EvaluationJob> GetEvaluationJobAsync(string name, CallSettings callSettings = null)
Parameters
Type Name Description
System.String name

Required. Name of the evaluation job. Format:

"projects/&lt;var&gt;{project_id}&lt;/var&gt;/evaluationJobs/&lt;var&gt;{evaluation_job_id}&lt;/var&gt;"

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task<EvaluationJob>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/evaluationJobs/[EVALUATION_JOB]";
// Make the request
EvaluationJob response = await dataLabelingServiceClient.GetEvaluationJobAsync(name);

GetEvaluationJobAsync(String, CancellationToken)

Gets an evaluation job by resource name.

Declaration
public virtual Task<EvaluationJob> GetEvaluationJobAsync(string name, CancellationToken cancellationToken)
Parameters
Type Name Description
System.String name

Required. Name of the evaluation job. Format:

"projects/&lt;var&gt;{project_id}&lt;/var&gt;/evaluationJobs/&lt;var&gt;{evaluation_job_id}&lt;/var&gt;"

System.Threading.CancellationToken cancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
Type Description
System.Threading.Tasks.Task<EvaluationJob>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/evaluationJobs/[EVALUATION_JOB]";
// Make the request
EvaluationJob response = await dataLabelingServiceClient.GetEvaluationJobAsync(name);

GetExample(ExampleName, String, CallSettings)

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

Declaration
public virtual Example GetExample(ExampleName name, string filter, CallSettings callSettings = null)
Parameters
Type Name Description
ExampleName name

Required. Name of example, format: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}/examples/{example_id}

System.String filter

Optional. An expression for filtering Examples. Filter by annotation_spec.display_name is supported. Format "annotation_spec.display_name = {display_name}"

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Example

The RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.Create();
// Initialize request argument(s)
ExampleName name = ExampleName.FromProjectDatasetAnnotatedDatasetExample("[PROJECT]", "[DATASET]", "[ANNOTATED_DATASET]", "[EXAMPLE]");
string filter = "";
// Make the request
Example response = dataLabelingServiceClient.GetExample(name, filter);

GetExample(GetExampleRequest, CallSettings)

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

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

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

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Example

The RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.Create();
// Initialize request argument(s)
GetExampleRequest request = new GetExampleRequest
{
    ExampleName = ExampleName.FromProjectDatasetAnnotatedDatasetExample("[PROJECT]", "[DATASET]", "[ANNOTATED_DATASET]", "[EXAMPLE]"),
    Filter = "",
};
// Make the request
Example response = dataLabelingServiceClient.GetExample(request);

GetExample(String, String, CallSettings)

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

Declaration
public virtual Example GetExample(string name, string filter, CallSettings callSettings = null)
Parameters
Type Name Description
System.String name

Required. Name of example, format: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}/examples/{example_id}

System.String filter

Optional. An expression for filtering Examples. Filter by annotation_spec.display_name is supported. Format "annotation_spec.display_name = {display_name}"

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Example

The RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/datasets/[DATASET]/annotatedDatasets/[ANNOTATED_DATASET]/examples/[EXAMPLE]";
string filter = "";
// Make the request
Example response = dataLabelingServiceClient.GetExample(name, filter);

GetExampleAsync(ExampleName, String, CallSettings)

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

Declaration
public virtual Task<Example> GetExampleAsync(ExampleName name, string filter, CallSettings callSettings = null)
Parameters
Type Name Description
ExampleName name

Required. Name of example, format: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}/examples/{example_id}

System.String filter

Optional. An expression for filtering Examples. Filter by annotation_spec.display_name is supported. Format "annotation_spec.display_name = {display_name}"

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task<Example>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
ExampleName name = ExampleName.FromProjectDatasetAnnotatedDatasetExample("[PROJECT]", "[DATASET]", "[ANNOTATED_DATASET]", "[EXAMPLE]");
string filter = "";
// Make the request
Example response = await dataLabelingServiceClient.GetExampleAsync(name, filter);

GetExampleAsync(ExampleName, String, CancellationToken)

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

Declaration
public virtual Task<Example> GetExampleAsync(ExampleName name, string filter, CancellationToken cancellationToken)
Parameters
Type Name Description
ExampleName name

Required. Name of example, format: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}/examples/{example_id}

System.String filter

Optional. An expression for filtering Examples. Filter by annotation_spec.display_name is supported. Format "annotation_spec.display_name = {display_name}"

System.Threading.CancellationToken cancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
Type Description
System.Threading.Tasks.Task<Example>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
ExampleName name = ExampleName.FromProjectDatasetAnnotatedDatasetExample("[PROJECT]", "[DATASET]", "[ANNOTATED_DATASET]", "[EXAMPLE]");
string filter = "";
// Make the request
Example response = await dataLabelingServiceClient.GetExampleAsync(name, filter);

GetExampleAsync(GetExampleRequest, CallSettings)

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

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

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

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task<Example>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
GetExampleRequest request = new GetExampleRequest
{
    ExampleName = ExampleName.FromProjectDatasetAnnotatedDatasetExample("[PROJECT]", "[DATASET]", "[ANNOTATED_DATASET]", "[EXAMPLE]"),
    Filter = "",
};
// Make the request
Example response = await dataLabelingServiceClient.GetExampleAsync(request);

GetExampleAsync(GetExampleRequest, CancellationToken)

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

Declaration
public virtual Task<Example> GetExampleAsync(GetExampleRequest request, CancellationToken cancellationToken)
Parameters
Type Name Description
GetExampleRequest request

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

System.Threading.CancellationToken cancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
Type Description
System.Threading.Tasks.Task<Example>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
GetExampleRequest request = new GetExampleRequest
{
    ExampleName = ExampleName.FromProjectDatasetAnnotatedDatasetExample("[PROJECT]", "[DATASET]", "[ANNOTATED_DATASET]", "[EXAMPLE]"),
    Filter = "",
};
// Make the request
Example response = await dataLabelingServiceClient.GetExampleAsync(request);

GetExampleAsync(String, String, CallSettings)

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

Declaration
public virtual Task<Example> GetExampleAsync(string name, string filter, CallSettings callSettings = null)
Parameters
Type Name Description
System.String name

Required. Name of example, format: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}/examples/{example_id}

System.String filter

Optional. An expression for filtering Examples. Filter by annotation_spec.display_name is supported. Format "annotation_spec.display_name = {display_name}"

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task<Example>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/datasets/[DATASET]/annotatedDatasets/[ANNOTATED_DATASET]/examples/[EXAMPLE]";
string filter = "";
// Make the request
Example response = await dataLabelingServiceClient.GetExampleAsync(name, filter);

GetExampleAsync(String, String, CancellationToken)

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

Declaration
public virtual Task<Example> GetExampleAsync(string name, string filter, CancellationToken cancellationToken)
Parameters
Type Name Description
System.String name

Required. Name of example, format: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}/examples/{example_id}

System.String filter

Optional. An expression for filtering Examples. Filter by annotation_spec.display_name is supported. Format "annotation_spec.display_name = {display_name}"

System.Threading.CancellationToken cancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
Type Description
System.Threading.Tasks.Task<Example>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/datasets/[DATASET]/annotatedDatasets/[ANNOTATED_DATASET]/examples/[EXAMPLE]";
string filter = "";
// Make the request
Example response = await dataLabelingServiceClient.GetExampleAsync(name, filter);

GetInstruction(GetInstructionRequest, CallSettings)

Gets an instruction by resource name.

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

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

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Instruction

The RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.Create();
// Initialize request argument(s)
GetInstructionRequest request = new GetInstructionRequest
{
    InstructionName = InstructionName.FromProjectInstruction("[PROJECT]", "[INSTRUCTION]"),
};
// Make the request
Instruction response = dataLabelingServiceClient.GetInstruction(request);

GetInstruction(InstructionName, CallSettings)

Gets an instruction by resource name.

Declaration
public virtual Instruction GetInstruction(InstructionName name, CallSettings callSettings = null)
Parameters
Type Name Description
InstructionName name

Required. Instruction resource name, format: projects/{project_id}/instructions/{instruction_id}

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Instruction

The RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.Create();
// Initialize request argument(s)
InstructionName name = InstructionName.FromProjectInstruction("[PROJECT]", "[INSTRUCTION]");
// Make the request
Instruction response = dataLabelingServiceClient.GetInstruction(name);

GetInstruction(String, CallSettings)

Gets an instruction by resource name.

Declaration
public virtual Instruction GetInstruction(string name, CallSettings callSettings = null)
Parameters
Type Name Description
System.String name

Required. Instruction resource name, format: projects/{project_id}/instructions/{instruction_id}

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Instruction

The RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/instructions/[INSTRUCTION]";
// Make the request
Instruction response = dataLabelingServiceClient.GetInstruction(name);

GetInstructionAsync(GetInstructionRequest, CallSettings)

Gets an instruction by resource name.

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

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

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task<Instruction>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
GetInstructionRequest request = new GetInstructionRequest
{
    InstructionName = InstructionName.FromProjectInstruction("[PROJECT]", "[INSTRUCTION]"),
};
// Make the request
Instruction response = await dataLabelingServiceClient.GetInstructionAsync(request);

GetInstructionAsync(GetInstructionRequest, CancellationToken)

Gets an instruction by resource name.

Declaration
public virtual Task<Instruction> GetInstructionAsync(GetInstructionRequest request, CancellationToken cancellationToken)
Parameters
Type Name Description
GetInstructionRequest request

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

System.Threading.CancellationToken cancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
Type Description
System.Threading.Tasks.Task<Instruction>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
GetInstructionRequest request = new GetInstructionRequest
{
    InstructionName = InstructionName.FromProjectInstruction("[PROJECT]", "[INSTRUCTION]"),
};
// Make the request
Instruction response = await dataLabelingServiceClient.GetInstructionAsync(request);

GetInstructionAsync(InstructionName, CallSettings)

Gets an instruction by resource name.

Declaration
public virtual Task<Instruction> GetInstructionAsync(InstructionName name, CallSettings callSettings = null)
Parameters
Type Name Description
InstructionName name

Required. Instruction resource name, format: projects/{project_id}/instructions/{instruction_id}

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task<Instruction>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
InstructionName name = InstructionName.FromProjectInstruction("[PROJECT]", "[INSTRUCTION]");
// Make the request
Instruction response = await dataLabelingServiceClient.GetInstructionAsync(name);

GetInstructionAsync(InstructionName, CancellationToken)

Gets an instruction by resource name.

Declaration
public virtual Task<Instruction> GetInstructionAsync(InstructionName name, CancellationToken cancellationToken)
Parameters
Type Name Description
InstructionName name

Required. Instruction resource name, format: projects/{project_id}/instructions/{instruction_id}

System.Threading.CancellationToken cancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
Type Description
System.Threading.Tasks.Task<Instruction>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
InstructionName name = InstructionName.FromProjectInstruction("[PROJECT]", "[INSTRUCTION]");
// Make the request
Instruction response = await dataLabelingServiceClient.GetInstructionAsync(name);

GetInstructionAsync(String, CallSettings)

Gets an instruction by resource name.

Declaration
public virtual Task<Instruction> GetInstructionAsync(string name, CallSettings callSettings = null)
Parameters
Type Name Description
System.String name

Required. Instruction resource name, format: projects/{project_id}/instructions/{instruction_id}

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task<Instruction>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/instructions/[INSTRUCTION]";
// Make the request
Instruction response = await dataLabelingServiceClient.GetInstructionAsync(name);

GetInstructionAsync(String, CancellationToken)

Gets an instruction by resource name.

Declaration
public virtual Task<Instruction> GetInstructionAsync(string name, CancellationToken cancellationToken)
Parameters
Type Name Description
System.String name

Required. Instruction resource name, format: projects/{project_id}/instructions/{instruction_id}

System.Threading.CancellationToken cancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
Type Description
System.Threading.Tasks.Task<Instruction>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/instructions/[INSTRUCTION]";
// Make the request
Instruction response = await dataLabelingServiceClient.GetInstructionAsync(name);

ImportData(DatasetName, InputConfig, CallSettings)

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

Declaration
public virtual Operation<ImportDataOperationResponse, ImportDataOperationMetadata> ImportData(DatasetName name, InputConfig inputConfig, CallSettings callSettings = null)
Parameters
Type Name Description
DatasetName name

Required. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id}

InputConfig inputConfig

Required. Specify the input source of the data.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Operation<ImportDataOperationResponse, ImportDataOperationMetadata>

The RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.Create();
// Initialize request argument(s)
DatasetName name = DatasetName.FromProjectDataset("[PROJECT]", "[DATASET]");
InputConfig inputConfig = new InputConfig();
// Make the request
Operation<ImportDataOperationResponse, ImportDataOperationMetadata> response = dataLabelingServiceClient.ImportData(name, inputConfig);

// Poll until the returned long-running operation is complete
Operation<ImportDataOperationResponse, ImportDataOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
ImportDataOperationResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<ImportDataOperationResponse, ImportDataOperationMetadata> retrievedResponse = dataLabelingServiceClient.PollOnceImportData(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    ImportDataOperationResponse retrievedResult = retrievedResponse.Result;
}

ImportData(ImportDataRequest, CallSettings)

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

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

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

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Operation<ImportDataOperationResponse, ImportDataOperationMetadata>

The RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.Create();
// Initialize request argument(s)
ImportDataRequest request = new ImportDataRequest
{
    DatasetName = DatasetName.FromProjectDataset("[PROJECT]", "[DATASET]"),
    InputConfig = new InputConfig(),
    UserEmailAddress = "",
};
// Make the request
Operation<ImportDataOperationResponse, ImportDataOperationMetadata> response = dataLabelingServiceClient.ImportData(request);

// Poll until the returned long-running operation is complete
Operation<ImportDataOperationResponse, ImportDataOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
ImportDataOperationResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<ImportDataOperationResponse, ImportDataOperationMetadata> retrievedResponse = dataLabelingServiceClient.PollOnceImportData(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    ImportDataOperationResponse retrievedResult = retrievedResponse.Result;
}

ImportData(String, InputConfig, CallSettings)

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

Declaration
public virtual Operation<ImportDataOperationResponse, ImportDataOperationMetadata> ImportData(string name, InputConfig inputConfig, CallSettings callSettings = null)
Parameters
Type Name Description
System.String name

Required. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id}

InputConfig inputConfig

Required. Specify the input source of the data.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Operation<ImportDataOperationResponse, ImportDataOperationMetadata>

The RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/datasets/[DATASET]";
InputConfig inputConfig = new InputConfig();
// Make the request
Operation<ImportDataOperationResponse, ImportDataOperationMetadata> response = dataLabelingServiceClient.ImportData(name, inputConfig);

// Poll until the returned long-running operation is complete
Operation<ImportDataOperationResponse, ImportDataOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
ImportDataOperationResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<ImportDataOperationResponse, ImportDataOperationMetadata> retrievedResponse = dataLabelingServiceClient.PollOnceImportData(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    ImportDataOperationResponse retrievedResult = retrievedResponse.Result;
}

ImportDataAsync(DatasetName, InputConfig, CallSettings)

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

Declaration
public virtual Task<Operation<ImportDataOperationResponse, ImportDataOperationMetadata>> ImportDataAsync(DatasetName name, InputConfig inputConfig, CallSettings callSettings = null)
Parameters
Type Name Description
DatasetName name

Required. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id}

InputConfig inputConfig

Required. Specify the input source of the data.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task<Operation<ImportDataOperationResponse, ImportDataOperationMetadata>>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
DatasetName name = DatasetName.FromProjectDataset("[PROJECT]", "[DATASET]");
InputConfig inputConfig = new InputConfig();
// Make the request
Operation<ImportDataOperationResponse, ImportDataOperationMetadata> response = await dataLabelingServiceClient.ImportDataAsync(name, inputConfig);

// Poll until the returned long-running operation is complete
Operation<ImportDataOperationResponse, ImportDataOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
ImportDataOperationResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<ImportDataOperationResponse, ImportDataOperationMetadata> retrievedResponse = await dataLabelingServiceClient.PollOnceImportDataAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    ImportDataOperationResponse retrievedResult = retrievedResponse.Result;
}

ImportDataAsync(DatasetName, InputConfig, CancellationToken)

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

Declaration
public virtual Task<Operation<ImportDataOperationResponse, ImportDataOperationMetadata>> ImportDataAsync(DatasetName name, InputConfig inputConfig, CancellationToken cancellationToken)
Parameters
Type Name Description
DatasetName name

Required. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id}

InputConfig inputConfig

Required. Specify the input source of the data.

System.Threading.CancellationToken cancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
Type Description
System.Threading.Tasks.Task<Operation<ImportDataOperationResponse, ImportDataOperationMetadata>>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
DatasetName name = DatasetName.FromProjectDataset("[PROJECT]", "[DATASET]");
InputConfig inputConfig = new InputConfig();
// Make the request
Operation<ImportDataOperationResponse, ImportDataOperationMetadata> response = await dataLabelingServiceClient.ImportDataAsync(name, inputConfig);

// Poll until the returned long-running operation is complete
Operation<ImportDataOperationResponse, ImportDataOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
ImportDataOperationResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<ImportDataOperationResponse, ImportDataOperationMetadata> retrievedResponse = await dataLabelingServiceClient.PollOnceImportDataAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    ImportDataOperationResponse retrievedResult = retrievedResponse.Result;
}

ImportDataAsync(ImportDataRequest, CallSettings)

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

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

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

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task<Operation<ImportDataOperationResponse, ImportDataOperationMetadata>>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
ImportDataRequest request = new ImportDataRequest
{
    DatasetName = DatasetName.FromProjectDataset("[PROJECT]", "[DATASET]"),
    InputConfig = new InputConfig(),
    UserEmailAddress = "",
};
// Make the request
Operation<ImportDataOperationResponse, ImportDataOperationMetadata> response = await dataLabelingServiceClient.ImportDataAsync(request);

// Poll until the returned long-running operation is complete
Operation<ImportDataOperationResponse, ImportDataOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
ImportDataOperationResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<ImportDataOperationResponse, ImportDataOperationMetadata> retrievedResponse = await dataLabelingServiceClient.PollOnceImportDataAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    ImportDataOperationResponse retrievedResult = retrievedResponse.Result;
}

ImportDataAsync(ImportDataRequest, CancellationToken)

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

Declaration
public virtual Task<Operation<ImportDataOperationResponse, ImportDataOperationMetadata>> ImportDataAsync(ImportDataRequest request, CancellationToken cancellationToken)
Parameters
Type Name Description
ImportDataRequest request

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

System.Threading.CancellationToken cancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
Type Description
System.Threading.Tasks.Task<Operation<ImportDataOperationResponse, ImportDataOperationMetadata>>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
ImportDataRequest request = new ImportDataRequest
{
    DatasetName = DatasetName.FromProjectDataset("[PROJECT]", "[DATASET]"),
    InputConfig = new InputConfig(),
    UserEmailAddress = "",
};
// Make the request
Operation<ImportDataOperationResponse, ImportDataOperationMetadata> response = await dataLabelingServiceClient.ImportDataAsync(request);

// Poll until the returned long-running operation is complete
Operation<ImportDataOperationResponse, ImportDataOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
ImportDataOperationResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<ImportDataOperationResponse, ImportDataOperationMetadata> retrievedResponse = await dataLabelingServiceClient.PollOnceImportDataAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    ImportDataOperationResponse retrievedResult = retrievedResponse.Result;
}

ImportDataAsync(String, InputConfig, CallSettings)

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

Declaration
public virtual Task<Operation<ImportDataOperationResponse, ImportDataOperationMetadata>> ImportDataAsync(string name, InputConfig inputConfig, CallSettings callSettings = null)
Parameters
Type Name Description
System.String name

Required. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id}

InputConfig inputConfig

Required. Specify the input source of the data.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task<Operation<ImportDataOperationResponse, ImportDataOperationMetadata>>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/datasets/[DATASET]";
InputConfig inputConfig = new InputConfig();
// Make the request
Operation<ImportDataOperationResponse, ImportDataOperationMetadata> response = await dataLabelingServiceClient.ImportDataAsync(name, inputConfig);

// Poll until the returned long-running operation is complete
Operation<ImportDataOperationResponse, ImportDataOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
ImportDataOperationResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<ImportDataOperationResponse, ImportDataOperationMetadata> retrievedResponse = await dataLabelingServiceClient.PollOnceImportDataAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    ImportDataOperationResponse retrievedResult = retrievedResponse.Result;
}

ImportDataAsync(String, InputConfig, CancellationToken)

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

Declaration
public virtual Task<Operation<ImportDataOperationResponse, ImportDataOperationMetadata>> ImportDataAsync(string name, InputConfig inputConfig, CancellationToken cancellationToken)
Parameters
Type Name Description
System.String name

Required. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id}

InputConfig inputConfig

Required. Specify the input source of the data.

System.Threading.CancellationToken cancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
Type Description
System.Threading.Tasks.Task<Operation<ImportDataOperationResponse, ImportDataOperationMetadata>>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/datasets/[DATASET]";
InputConfig inputConfig = new InputConfig();
// Make the request
Operation<ImportDataOperationResponse, ImportDataOperationMetadata> response = await dataLabelingServiceClient.ImportDataAsync(name, inputConfig);

// Poll until the returned long-running operation is complete
Operation<ImportDataOperationResponse, ImportDataOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
ImportDataOperationResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<ImportDataOperationResponse, ImportDataOperationMetadata> retrievedResponse = await dataLabelingServiceClient.PollOnceImportDataAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    ImportDataOperationResponse retrievedResult = retrievedResponse.Result;
}

LabelImage(DatasetName, HumanAnnotationConfig, LabelImageRequest.Types.Feature, CallSettings)

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

Declaration
public virtual Operation<AnnotatedDataset, LabelOperationMetadata> LabelImage(DatasetName parent, HumanAnnotationConfig basicConfig, LabelImageRequest.Types.Feature feature, CallSettings callSettings = null)
Parameters
Type Name Description
DatasetName parent

Required. Name of the dataset to request labeling task, format: projects/{project_id}/datasets/{dataset_id}

HumanAnnotationConfig basicConfig

Required. Basic human annotation config.

LabelImageRequest.Types.Feature feature

Required. The type of image labeling task.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Operation<AnnotatedDataset, LabelOperationMetadata>

The RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.Create();
// Initialize request argument(s)
DatasetName parent = DatasetName.FromProjectDataset("[PROJECT]", "[DATASET]");
HumanAnnotationConfig basicConfig = new HumanAnnotationConfig();
LabelImageRequest.Types.Feature feature = LabelImageRequest.Types.Feature.Unspecified;
// Make the request
Operation<AnnotatedDataset, LabelOperationMetadata> response = dataLabelingServiceClient.LabelImage(parent, basicConfig, feature);

// Poll until the returned long-running operation is complete
Operation<AnnotatedDataset, LabelOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
AnnotatedDataset result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<AnnotatedDataset, LabelOperationMetadata> retrievedResponse = dataLabelingServiceClient.PollOnceLabelImage(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    AnnotatedDataset retrievedResult = retrievedResponse.Result;
}

LabelImage(LabelImageRequest, CallSettings)

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

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

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

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Operation<AnnotatedDataset, LabelOperationMetadata>

The RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.Create();
// Initialize request argument(s)
LabelImageRequest request = new LabelImageRequest
{
    ParentAsDatasetName = DatasetName.FromProjectDataset("[PROJECT]", "[DATASET]"),
    BasicConfig = new HumanAnnotationConfig(),
    Feature = LabelImageRequest.Types.Feature.Unspecified,
    ImageClassificationConfig = new ImageClassificationConfig(),
    BoundingPolyConfig = new BoundingPolyConfig(),
    PolylineConfig = new PolylineConfig(),
    SegmentationConfig = new SegmentationConfig(),
};
// Make the request
Operation<AnnotatedDataset, LabelOperationMetadata> response = dataLabelingServiceClient.LabelImage(request);

// Poll until the returned long-running operation is complete
Operation<AnnotatedDataset, LabelOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
AnnotatedDataset result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<AnnotatedDataset, LabelOperationMetadata> retrievedResponse = dataLabelingServiceClient.PollOnceLabelImage(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    AnnotatedDataset retrievedResult = retrievedResponse.Result;
}

LabelImage(String, HumanAnnotationConfig, LabelImageRequest.Types.Feature, CallSettings)

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

Declaration
public virtual Operation<AnnotatedDataset, LabelOperationMetadata> LabelImage(string parent, HumanAnnotationConfig basicConfig, LabelImageRequest.Types.Feature feature, CallSettings callSettings = null)
Parameters
Type Name Description
System.String parent

Required. Name of the dataset to request labeling task, format: projects/{project_id}/datasets/{dataset_id}

HumanAnnotationConfig basicConfig

Required. Basic human annotation config.

LabelImageRequest.Types.Feature feature

Required. The type of image labeling task.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Operation<AnnotatedDataset, LabelOperationMetadata>

The RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/datasets/[DATASET]";
HumanAnnotationConfig basicConfig = new HumanAnnotationConfig();
LabelImageRequest.Types.Feature feature = LabelImageRequest.Types.Feature.Unspecified;
// Make the request
Operation<AnnotatedDataset, LabelOperationMetadata> response = dataLabelingServiceClient.LabelImage(parent, basicConfig, feature);

// Poll until the returned long-running operation is complete
Operation<AnnotatedDataset, LabelOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
AnnotatedDataset result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<AnnotatedDataset, LabelOperationMetadata> retrievedResponse = dataLabelingServiceClient.PollOnceLabelImage(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    AnnotatedDataset retrievedResult = retrievedResponse.Result;
}

LabelImageAsync(DatasetName, HumanAnnotationConfig, LabelImageRequest.Types.Feature, CallSettings)

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

Declaration
public virtual Task<Operation<AnnotatedDataset, LabelOperationMetadata>> LabelImageAsync(DatasetName parent, HumanAnnotationConfig basicConfig, LabelImageRequest.Types.Feature feature, CallSettings callSettings = null)
Parameters
Type Name Description
DatasetName parent

Required. Name of the dataset to request labeling task, format: projects/{project_id}/datasets/{dataset_id}

HumanAnnotationConfig basicConfig

Required. Basic human annotation config.

LabelImageRequest.Types.Feature feature

Required. The type of image labeling task.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task<Operation<AnnotatedDataset, LabelOperationMetadata>>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
DatasetName parent = DatasetName.FromProjectDataset("[PROJECT]", "[DATASET]");
HumanAnnotationConfig basicConfig = new HumanAnnotationConfig();
LabelImageRequest.Types.Feature feature = LabelImageRequest.Types.Feature.Unspecified;
// Make the request
Operation<AnnotatedDataset, LabelOperationMetadata> response = await dataLabelingServiceClient.LabelImageAsync(parent, basicConfig, feature);

// Poll until the returned long-running operation is complete
Operation<AnnotatedDataset, LabelOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
AnnotatedDataset result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<AnnotatedDataset, LabelOperationMetadata> retrievedResponse = await dataLabelingServiceClient.PollOnceLabelImageAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    AnnotatedDataset retrievedResult = retrievedResponse.Result;
}

LabelImageAsync(DatasetName, HumanAnnotationConfig, LabelImageRequest.Types.Feature, CancellationToken)

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

Declaration
public virtual Task<Operation<AnnotatedDataset, LabelOperationMetadata>> LabelImageAsync(DatasetName parent, HumanAnnotationConfig basicConfig, LabelImageRequest.Types.Feature feature, CancellationToken cancellationToken)
Parameters
Type Name Description
DatasetName parent

Required. Name of the dataset to request labeling task, format: projects/{project_id}/datasets/{dataset_id}

HumanAnnotationConfig basicConfig

Required. Basic human annotation config.

LabelImageRequest.Types.Feature feature

Required. The type of image labeling task.

System.Threading.CancellationToken cancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
Type Description
System.Threading.Tasks.Task<Operation<AnnotatedDataset, LabelOperationMetadata>>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
DatasetName parent = DatasetName.FromProjectDataset("[PROJECT]", "[DATASET]");
HumanAnnotationConfig basicConfig = new HumanAnnotationConfig();
LabelImageRequest.Types.Feature feature = LabelImageRequest.Types.Feature.Unspecified;
// Make the request
Operation<AnnotatedDataset, LabelOperationMetadata> response = await dataLabelingServiceClient.LabelImageAsync(parent, basicConfig, feature);

// Poll until the returned long-running operation is complete
Operation<AnnotatedDataset, LabelOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
AnnotatedDataset result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<AnnotatedDataset, LabelOperationMetadata> retrievedResponse = await dataLabelingServiceClient.PollOnceLabelImageAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    AnnotatedDataset retrievedResult = retrievedResponse.Result;
}

LabelImageAsync(LabelImageRequest, CallSettings)

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

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

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

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task<Operation<AnnotatedDataset, LabelOperationMetadata>>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
LabelImageRequest request = new LabelImageRequest
{
    ParentAsDatasetName = DatasetName.FromProjectDataset("[PROJECT]", "[DATASET]"),
    BasicConfig = new HumanAnnotationConfig(),
    Feature = LabelImageRequest.Types.Feature.Unspecified,
    ImageClassificationConfig = new ImageClassificationConfig(),
    BoundingPolyConfig = new BoundingPolyConfig(),
    PolylineConfig = new PolylineConfig(),
    SegmentationConfig = new SegmentationConfig(),
};
// Make the request
Operation<AnnotatedDataset, LabelOperationMetadata> response = await dataLabelingServiceClient.LabelImageAsync(request);

// Poll until the returned long-running operation is complete
Operation<AnnotatedDataset, LabelOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
AnnotatedDataset result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<AnnotatedDataset, LabelOperationMetadata> retrievedResponse = await dataLabelingServiceClient.PollOnceLabelImageAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    AnnotatedDataset retrievedResult = retrievedResponse.Result;
}

LabelImageAsync(LabelImageRequest, CancellationToken)

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

Declaration
public virtual Task<Operation<AnnotatedDataset, LabelOperationMetadata>> LabelImageAsync(LabelImageRequest request, CancellationToken cancellationToken)
Parameters
Type Name Description
LabelImageRequest request

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

System.Threading.CancellationToken cancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
Type Description
System.Threading.Tasks.Task<Operation<AnnotatedDataset, LabelOperationMetadata>>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
LabelImageRequest request = new LabelImageRequest
{
    ParentAsDatasetName = DatasetName.FromProjectDataset("[PROJECT]", "[DATASET]"),
    BasicConfig = new HumanAnnotationConfig(),
    Feature = LabelImageRequest.Types.Feature.Unspecified,
    ImageClassificationConfig = new ImageClassificationConfig(),
    BoundingPolyConfig = new BoundingPolyConfig(),
    PolylineConfig = new PolylineConfig(),
    SegmentationConfig = new SegmentationConfig(),
};
// Make the request
Operation<AnnotatedDataset, LabelOperationMetadata> response = await dataLabelingServiceClient.LabelImageAsync(request);

// Poll until the returned long-running operation is complete
Operation<AnnotatedDataset, LabelOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
AnnotatedDataset result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<AnnotatedDataset, LabelOperationMetadata> retrievedResponse = await dataLabelingServiceClient.PollOnceLabelImageAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    AnnotatedDataset retrievedResult = retrievedResponse.Result;
}

LabelImageAsync(String, HumanAnnotationConfig, LabelImageRequest.Types.Feature, CallSettings)

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

Declaration
public virtual Task<Operation<AnnotatedDataset, LabelOperationMetadata>> LabelImageAsync(string parent, HumanAnnotationConfig basicConfig, LabelImageRequest.Types.Feature feature, CallSettings callSettings = null)
Parameters
Type Name Description
System.String parent

Required. Name of the dataset to request labeling task, format: projects/{project_id}/datasets/{dataset_id}

HumanAnnotationConfig basicConfig

Required. Basic human annotation config.

LabelImageRequest.Types.Feature feature

Required. The type of image labeling task.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task<Operation<AnnotatedDataset, LabelOperationMetadata>>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/datasets/[DATASET]";
HumanAnnotationConfig basicConfig = new HumanAnnotationConfig();
LabelImageRequest.Types.Feature feature = LabelImageRequest.Types.Feature.Unspecified;
// Make the request
Operation<AnnotatedDataset, LabelOperationMetadata> response = await dataLabelingServiceClient.LabelImageAsync(parent, basicConfig, feature);

// Poll until the returned long-running operation is complete
Operation<AnnotatedDataset, LabelOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
AnnotatedDataset result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<AnnotatedDataset, LabelOperationMetadata> retrievedResponse = await dataLabelingServiceClient.PollOnceLabelImageAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    AnnotatedDataset retrievedResult = retrievedResponse.Result;
}

LabelImageAsync(String, HumanAnnotationConfig, LabelImageRequest.Types.Feature, CancellationToken)

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

Declaration
public virtual Task<Operation<AnnotatedDataset, LabelOperationMetadata>> LabelImageAsync(string parent, HumanAnnotationConfig basicConfig, LabelImageRequest.Types.Feature feature, CancellationToken cancellationToken)
Parameters
Type Name Description
System.String parent

Required. Name of the dataset to request labeling task, format: projects/{project_id}/datasets/{dataset_id}

HumanAnnotationConfig basicConfig

Required. Basic human annotation config.

LabelImageRequest.Types.Feature feature

Required. The type of image labeling task.

System.Threading.CancellationToken cancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
Type Description
System.Threading.Tasks.Task<Operation<AnnotatedDataset, LabelOperationMetadata>>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/datasets/[DATASET]";
HumanAnnotationConfig basicConfig = new HumanAnnotationConfig();
LabelImageRequest.Types.Feature feature = LabelImageRequest.Types.Feature.Unspecified;
// Make the request
Operation<AnnotatedDataset, LabelOperationMetadata> response = await dataLabelingServiceClient.LabelImageAsync(parent, basicConfig, feature);

// Poll until the returned long-running operation is complete
Operation<AnnotatedDataset, LabelOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
AnnotatedDataset result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<AnnotatedDataset, LabelOperationMetadata> retrievedResponse = await dataLabelingServiceClient.PollOnceLabelImageAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    AnnotatedDataset retrievedResult = retrievedResponse.Result;
}

LabelText(DatasetName, HumanAnnotationConfig, LabelTextRequest.Types.Feature, CallSettings)

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

Declaration
public virtual Operation<AnnotatedDataset, LabelOperationMetadata> LabelText(DatasetName parent, HumanAnnotationConfig basicConfig, LabelTextRequest.Types.Feature feature, CallSettings callSettings = null)
Parameters
Type Name Description
DatasetName parent

Required. Name of the data set to request labeling task, format: projects/{project_id}/datasets/{dataset_id}

HumanAnnotationConfig basicConfig

Required. Basic human annotation config.

LabelTextRequest.Types.Feature feature

Required. The type of text labeling task.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Operation<AnnotatedDataset, LabelOperationMetadata>

The RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.Create();
// Initialize request argument(s)
DatasetName parent = DatasetName.FromProjectDataset("[PROJECT]", "[DATASET]");
HumanAnnotationConfig basicConfig = new HumanAnnotationConfig();
LabelTextRequest.Types.Feature feature = LabelTextRequest.Types.Feature.Unspecified;
// Make the request
Operation<AnnotatedDataset, LabelOperationMetadata> response = dataLabelingServiceClient.LabelText(parent, basicConfig, feature);

// Poll until the returned long-running operation is complete
Operation<AnnotatedDataset, LabelOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
AnnotatedDataset result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<AnnotatedDataset, LabelOperationMetadata> retrievedResponse = dataLabelingServiceClient.PollOnceLabelText(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    AnnotatedDataset retrievedResult = retrievedResponse.Result;
}

LabelText(LabelTextRequest, CallSettings)

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

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

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

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Operation<AnnotatedDataset, LabelOperationMetadata>

The RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.Create();
// Initialize request argument(s)
LabelTextRequest request = new LabelTextRequest
{
    ParentAsDatasetName = DatasetName.FromProjectDataset("[PROJECT]", "[DATASET]"),
    BasicConfig = new HumanAnnotationConfig(),
    TextClassificationConfig = new TextClassificationConfig(),
    TextEntityExtractionConfig = new TextEntityExtractionConfig(),
    Feature = LabelTextRequest.Types.Feature.Unspecified,
};
// Make the request
Operation<AnnotatedDataset, LabelOperationMetadata> response = dataLabelingServiceClient.LabelText(request);

// Poll until the returned long-running operation is complete
Operation<AnnotatedDataset, LabelOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
AnnotatedDataset result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<AnnotatedDataset, LabelOperationMetadata> retrievedResponse = dataLabelingServiceClient.PollOnceLabelText(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    AnnotatedDataset retrievedResult = retrievedResponse.Result;
}

LabelText(String, HumanAnnotationConfig, LabelTextRequest.Types.Feature, CallSettings)

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

Declaration
public virtual Operation<AnnotatedDataset, LabelOperationMetadata> LabelText(string parent, HumanAnnotationConfig basicConfig, LabelTextRequest.Types.Feature feature, CallSettings callSettings = null)
Parameters
Type Name Description
System.String parent

Required. Name of the data set to request labeling task, format: projects/{project_id}/datasets/{dataset_id}

HumanAnnotationConfig basicConfig

Required. Basic human annotation config.

LabelTextRequest.Types.Feature feature

Required. The type of text labeling task.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Operation<AnnotatedDataset, LabelOperationMetadata>

The RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/datasets/[DATASET]";
HumanAnnotationConfig basicConfig = new HumanAnnotationConfig();
LabelTextRequest.Types.Feature feature = LabelTextRequest.Types.Feature.Unspecified;
// Make the request
Operation<AnnotatedDataset, LabelOperationMetadata> response = dataLabelingServiceClient.LabelText(parent, basicConfig, feature);

// Poll until the returned long-running operation is complete
Operation<AnnotatedDataset, LabelOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
AnnotatedDataset result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<AnnotatedDataset, LabelOperationMetadata> retrievedResponse = dataLabelingServiceClient.PollOnceLabelText(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    AnnotatedDataset retrievedResult = retrievedResponse.Result;
}

LabelTextAsync(DatasetName, HumanAnnotationConfig, LabelTextRequest.Types.Feature, CallSettings)

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

Declaration
public virtual Task<Operation<AnnotatedDataset, LabelOperationMetadata>> LabelTextAsync(DatasetName parent, HumanAnnotationConfig basicConfig, LabelTextRequest.Types.Feature feature, CallSettings callSettings = null)
Parameters
Type Name Description
DatasetName parent

Required. Name of the data set to request labeling task, format: projects/{project_id}/datasets/{dataset_id}

HumanAnnotationConfig basicConfig

Required. Basic human annotation config.

LabelTextRequest.Types.Feature feature

Required. The type of text labeling task.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task<Operation<AnnotatedDataset, LabelOperationMetadata>>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
DatasetName parent = DatasetName.FromProjectDataset("[PROJECT]", "[DATASET]");
HumanAnnotationConfig basicConfig = new HumanAnnotationConfig();
LabelTextRequest.Types.Feature feature = LabelTextRequest.Types.Feature.Unspecified;
// Make the request
Operation<AnnotatedDataset, LabelOperationMetadata> response = await dataLabelingServiceClient.LabelTextAsync(parent, basicConfig, feature);

// Poll until the returned long-running operation is complete
Operation<AnnotatedDataset, LabelOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
AnnotatedDataset result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<AnnotatedDataset, LabelOperationMetadata> retrievedResponse = await dataLabelingServiceClient.PollOnceLabelTextAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    AnnotatedDataset retrievedResult = retrievedResponse.Result;
}

LabelTextAsync(DatasetName, HumanAnnotationConfig, LabelTextRequest.Types.Feature, CancellationToken)

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

Declaration
public virtual Task<Operation<AnnotatedDataset, LabelOperationMetadata>> LabelTextAsync(DatasetName parent, HumanAnnotationConfig basicConfig, LabelTextRequest.Types.Feature feature, CancellationToken cancellationToken)
Parameters
Type Name Description
DatasetName parent

Required. Name of the data set to request labeling task, format: projects/{project_id}/datasets/{dataset_id}

HumanAnnotationConfig basicConfig

Required. Basic human annotation config.

LabelTextRequest.Types.Feature feature

Required. The type of text labeling task.

System.Threading.CancellationToken cancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
Type Description
System.Threading.Tasks.Task<Operation<AnnotatedDataset, LabelOperationMetadata>>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
DatasetName parent = DatasetName.FromProjectDataset("[PROJECT]", "[DATASET]");
HumanAnnotationConfig basicConfig = new HumanAnnotationConfig();
LabelTextRequest.Types.Feature feature = LabelTextRequest.Types.Feature.Unspecified;
// Make the request
Operation<AnnotatedDataset, LabelOperationMetadata> response = await dataLabelingServiceClient.LabelTextAsync(parent, basicConfig, feature);

// Poll until the returned long-running operation is complete
Operation<AnnotatedDataset, LabelOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
AnnotatedDataset result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<AnnotatedDataset, LabelOperationMetadata> retrievedResponse = await dataLabelingServiceClient.PollOnceLabelTextAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    AnnotatedDataset retrievedResult = retrievedResponse.Result;
}

LabelTextAsync(LabelTextRequest, CallSettings)

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

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

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

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task<Operation<AnnotatedDataset, LabelOperationMetadata>>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
LabelTextRequest request = new LabelTextRequest
{
    ParentAsDatasetName = DatasetName.FromProjectDataset("[PROJECT]", "[DATASET]"),
    BasicConfig = new HumanAnnotationConfig(),
    TextClassificationConfig = new TextClassificationConfig(),
    TextEntityExtractionConfig = new TextEntityExtractionConfig(),
    Feature = LabelTextRequest.Types.Feature.Unspecified,
};
// Make the request
Operation<AnnotatedDataset, LabelOperationMetadata> response = await dataLabelingServiceClient.LabelTextAsync(request);

// Poll until the returned long-running operation is complete
Operation<AnnotatedDataset, LabelOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
AnnotatedDataset result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<AnnotatedDataset, LabelOperationMetadata> retrievedResponse = await dataLabelingServiceClient.PollOnceLabelTextAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    AnnotatedDataset retrievedResult = retrievedResponse.Result;
}

LabelTextAsync(LabelTextRequest, CancellationToken)

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

Declaration
public virtual Task<Operation<AnnotatedDataset, LabelOperationMetadata>> LabelTextAsync(LabelTextRequest request, CancellationToken cancellationToken)
Parameters
Type Name Description
LabelTextRequest request

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

System.Threading.CancellationToken cancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
Type Description
System.Threading.Tasks.Task<Operation<AnnotatedDataset, LabelOperationMetadata>>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
LabelTextRequest request = new LabelTextRequest
{
    ParentAsDatasetName = DatasetName.FromProjectDataset("[PROJECT]", "[DATASET]"),
    BasicConfig = new HumanAnnotationConfig(),
    TextClassificationConfig = new TextClassificationConfig(),
    TextEntityExtractionConfig = new TextEntityExtractionConfig(),
    Feature = LabelTextRequest.Types.Feature.Unspecified,
};
// Make the request
Operation<AnnotatedDataset, LabelOperationMetadata> response = await dataLabelingServiceClient.LabelTextAsync(request);

// Poll until the returned long-running operation is complete
Operation<AnnotatedDataset, LabelOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
AnnotatedDataset result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<AnnotatedDataset, LabelOperationMetadata> retrievedResponse = await dataLabelingServiceClient.PollOnceLabelTextAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    AnnotatedDataset retrievedResult = retrievedResponse.Result;
}

LabelTextAsync(String, HumanAnnotationConfig, LabelTextRequest.Types.Feature, CallSettings)

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

Declaration
public virtual Task<Operation<AnnotatedDataset, LabelOperationMetadata>> LabelTextAsync(string parent, HumanAnnotationConfig basicConfig, LabelTextRequest.Types.Feature feature, CallSettings callSettings = null)
Parameters
Type Name Description
System.String parent

Required. Name of the data set to request labeling task, format: projects/{project_id}/datasets/{dataset_id}

HumanAnnotationConfig basicConfig

Required. Basic human annotation config.

LabelTextRequest.Types.Feature feature

Required. The type of text labeling task.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task<Operation<AnnotatedDataset, LabelOperationMetadata>>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/datasets/[DATASET]";
HumanAnnotationConfig basicConfig = new HumanAnnotationConfig();
LabelTextRequest.Types.Feature feature = LabelTextRequest.Types.Feature.Unspecified;
// Make the request
Operation<AnnotatedDataset, LabelOperationMetadata> response = await dataLabelingServiceClient.LabelTextAsync(parent, basicConfig, feature);

// Poll until the returned long-running operation is complete
Operation<AnnotatedDataset, LabelOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
AnnotatedDataset result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<AnnotatedDataset, LabelOperationMetadata> retrievedResponse = await dataLabelingServiceClient.PollOnceLabelTextAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    AnnotatedDataset retrievedResult = retrievedResponse.Result;
}

LabelTextAsync(String, HumanAnnotationConfig, LabelTextRequest.Types.Feature, CancellationToken)

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

Declaration
public virtual Task<Operation<AnnotatedDataset, LabelOperationMetadata>> LabelTextAsync(string parent, HumanAnnotationConfig basicConfig, LabelTextRequest.Types.Feature feature, CancellationToken cancellationToken)
Parameters
Type Name Description
System.String parent

Required. Name of the data set to request labeling task, format: projects/{project_id}/datasets/{dataset_id}

HumanAnnotationConfig basicConfig

Required. Basic human annotation config.

LabelTextRequest.Types.Feature feature

Required. The type of text labeling task.

System.Threading.CancellationToken cancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
Type Description
System.Threading.Tasks.Task<Operation<AnnotatedDataset, LabelOperationMetadata>>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/datasets/[DATASET]";
HumanAnnotationConfig basicConfig = new HumanAnnotationConfig();
LabelTextRequest.Types.Feature feature = LabelTextRequest.Types.Feature.Unspecified;
// Make the request
Operation<AnnotatedDataset, LabelOperationMetadata> response = await dataLabelingServiceClient.LabelTextAsync(parent, basicConfig, feature);

// Poll until the returned long-running operation is complete
Operation<AnnotatedDataset, LabelOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
AnnotatedDataset result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<AnnotatedDataset, LabelOperationMetadata> retrievedResponse = await dataLabelingServiceClient.PollOnceLabelTextAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    AnnotatedDataset retrievedResult = retrievedResponse.Result;
}

LabelVideo(DatasetName, HumanAnnotationConfig, LabelVideoRequest.Types.Feature, CallSettings)

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

Declaration
public virtual Operation<AnnotatedDataset, LabelOperationMetadata> LabelVideo(DatasetName parent, HumanAnnotationConfig basicConfig, LabelVideoRequest.Types.Feature feature, CallSettings callSettings = null)
Parameters
Type Name Description
DatasetName parent

Required. Name of the dataset to request labeling task, format: projects/{project_id}/datasets/{dataset_id}

HumanAnnotationConfig basicConfig

Required. Basic human annotation config.

LabelVideoRequest.Types.Feature feature

Required. The type of video labeling task.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Operation<AnnotatedDataset, LabelOperationMetadata>

The RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.Create();
// Initialize request argument(s)
DatasetName parent = DatasetName.FromProjectDataset("[PROJECT]", "[DATASET]");
HumanAnnotationConfig basicConfig = new HumanAnnotationConfig();
LabelVideoRequest.Types.Feature feature = LabelVideoRequest.Types.Feature.Unspecified;
// Make the request
Operation<AnnotatedDataset, LabelOperationMetadata> response = dataLabelingServiceClient.LabelVideo(parent, basicConfig, feature);

// Poll until the returned long-running operation is complete
Operation<AnnotatedDataset, LabelOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
AnnotatedDataset result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<AnnotatedDataset, LabelOperationMetadata> retrievedResponse = dataLabelingServiceClient.PollOnceLabelVideo(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    AnnotatedDataset retrievedResult = retrievedResponse.Result;
}

LabelVideo(LabelVideoRequest, CallSettings)

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

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

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

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Operation<AnnotatedDataset, LabelOperationMetadata>

The RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.Create();
// Initialize request argument(s)
LabelVideoRequest request = new LabelVideoRequest
{
    ParentAsDatasetName = DatasetName.FromProjectDataset("[PROJECT]", "[DATASET]"),
    BasicConfig = new HumanAnnotationConfig(),
    Feature = LabelVideoRequest.Types.Feature.Unspecified,
    VideoClassificationConfig = new VideoClassificationConfig(),
    ObjectDetectionConfig = new ObjectDetectionConfig(),
    ObjectTrackingConfig = new ObjectTrackingConfig(),
    EventConfig = new EventConfig(),
};
// Make the request
Operation<AnnotatedDataset, LabelOperationMetadata> response = dataLabelingServiceClient.LabelVideo(request);

// Poll until the returned long-running operation is complete
Operation<AnnotatedDataset, LabelOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
AnnotatedDataset result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<AnnotatedDataset, LabelOperationMetadata> retrievedResponse = dataLabelingServiceClient.PollOnceLabelVideo(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    AnnotatedDataset retrievedResult = retrievedResponse.Result;
}

LabelVideo(String, HumanAnnotationConfig, LabelVideoRequest.Types.Feature, CallSettings)

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

Declaration
public virtual Operation<AnnotatedDataset, LabelOperationMetadata> LabelVideo(string parent, HumanAnnotationConfig basicConfig, LabelVideoRequest.Types.Feature feature, CallSettings callSettings = null)
Parameters
Type Name Description
System.String parent

Required. Name of the dataset to request labeling task, format: projects/{project_id}/datasets/{dataset_id}

HumanAnnotationConfig basicConfig

Required. Basic human annotation config.

LabelVideoRequest.Types.Feature feature

Required. The type of video labeling task.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Operation<AnnotatedDataset, LabelOperationMetadata>

The RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/datasets/[DATASET]";
HumanAnnotationConfig basicConfig = new HumanAnnotationConfig();
LabelVideoRequest.Types.Feature feature = LabelVideoRequest.Types.Feature.Unspecified;
// Make the request
Operation<AnnotatedDataset, LabelOperationMetadata> response = dataLabelingServiceClient.LabelVideo(parent, basicConfig, feature);

// Poll until the returned long-running operation is complete
Operation<AnnotatedDataset, LabelOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
AnnotatedDataset result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<AnnotatedDataset, LabelOperationMetadata> retrievedResponse = dataLabelingServiceClient.PollOnceLabelVideo(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    AnnotatedDataset retrievedResult = retrievedResponse.Result;
}

LabelVideoAsync(DatasetName, HumanAnnotationConfig, LabelVideoRequest.Types.Feature, CallSettings)

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

Declaration
public virtual Task<Operation<AnnotatedDataset, LabelOperationMetadata>> LabelVideoAsync(DatasetName parent, HumanAnnotationConfig basicConfig, LabelVideoRequest.Types.Feature feature, CallSettings callSettings = null)
Parameters
Type Name Description
DatasetName parent

Required. Name of the dataset to request labeling task, format: projects/{project_id}/datasets/{dataset_id}

HumanAnnotationConfig basicConfig

Required. Basic human annotation config.

LabelVideoRequest.Types.Feature feature

Required. The type of video labeling task.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task<Operation<AnnotatedDataset, LabelOperationMetadata>>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
DatasetName parent = DatasetName.FromProjectDataset("[PROJECT]", "[DATASET]");
HumanAnnotationConfig basicConfig = new HumanAnnotationConfig();
LabelVideoRequest.Types.Feature feature = LabelVideoRequest.Types.Feature.Unspecified;
// Make the request
Operation<AnnotatedDataset, LabelOperationMetadata> response = await dataLabelingServiceClient.LabelVideoAsync(parent, basicConfig, feature);

// Poll until the returned long-running operation is complete
Operation<AnnotatedDataset, LabelOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
AnnotatedDataset result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<AnnotatedDataset, LabelOperationMetadata> retrievedResponse = await dataLabelingServiceClient.PollOnceLabelVideoAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    AnnotatedDataset retrievedResult = retrievedResponse.Result;
}

LabelVideoAsync(DatasetName, HumanAnnotationConfig, LabelVideoRequest.Types.Feature, CancellationToken)

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

Declaration
public virtual Task<Operation<AnnotatedDataset, LabelOperationMetadata>> LabelVideoAsync(DatasetName parent, HumanAnnotationConfig basicConfig, LabelVideoRequest.Types.Feature feature, CancellationToken cancellationToken)
Parameters
Type Name Description
DatasetName parent

Required. Name of the dataset to request labeling task, format: projects/{project_id}/datasets/{dataset_id}

HumanAnnotationConfig basicConfig

Required. Basic human annotation config.

LabelVideoRequest.Types.Feature feature

Required. The type of video labeling task.

System.Threading.CancellationToken cancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
Type Description
System.Threading.Tasks.Task<Operation<AnnotatedDataset, LabelOperationMetadata>>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
DatasetName parent = DatasetName.FromProjectDataset("[PROJECT]", "[DATASET]");
HumanAnnotationConfig basicConfig = new HumanAnnotationConfig();
LabelVideoRequest.Types.Feature feature = LabelVideoRequest.Types.Feature.Unspecified;
// Make the request
Operation<AnnotatedDataset, LabelOperationMetadata> response = await dataLabelingServiceClient.LabelVideoAsync(parent, basicConfig, feature);

// Poll until the returned long-running operation is complete
Operation<AnnotatedDataset, LabelOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
AnnotatedDataset result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<AnnotatedDataset, LabelOperationMetadata> retrievedResponse = await dataLabelingServiceClient.PollOnceLabelVideoAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    AnnotatedDataset retrievedResult = retrievedResponse.Result;
}

LabelVideoAsync(LabelVideoRequest, CallSettings)

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

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

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

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task<Operation<AnnotatedDataset, LabelOperationMetadata>>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
LabelVideoRequest request = new LabelVideoRequest
{
    ParentAsDatasetName = DatasetName.FromProjectDataset("[PROJECT]", "[DATASET]"),
    BasicConfig = new HumanAnnotationConfig(),
    Feature = LabelVideoRequest.Types.Feature.Unspecified,
    VideoClassificationConfig = new VideoClassificationConfig(),
    ObjectDetectionConfig = new ObjectDetectionConfig(),
    ObjectTrackingConfig = new ObjectTrackingConfig(),
    EventConfig = new EventConfig(),
};
// Make the request
Operation<AnnotatedDataset, LabelOperationMetadata> response = await dataLabelingServiceClient.LabelVideoAsync(request);

// Poll until the returned long-running operation is complete
Operation<AnnotatedDataset, LabelOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
AnnotatedDataset result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<AnnotatedDataset, LabelOperationMetadata> retrievedResponse = await dataLabelingServiceClient.PollOnceLabelVideoAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    AnnotatedDataset retrievedResult = retrievedResponse.Result;
}

LabelVideoAsync(LabelVideoRequest, CancellationToken)

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

Declaration
public virtual Task<Operation<AnnotatedDataset, LabelOperationMetadata>> LabelVideoAsync(LabelVideoRequest request, CancellationToken cancellationToken)
Parameters
Type Name Description
LabelVideoRequest request

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

System.Threading.CancellationToken cancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
Type Description
System.Threading.Tasks.Task<Operation<AnnotatedDataset, LabelOperationMetadata>>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
LabelVideoRequest request = new LabelVideoRequest
{
    ParentAsDatasetName = DatasetName.FromProjectDataset("[PROJECT]", "[DATASET]"),
    BasicConfig = new HumanAnnotationConfig(),
    Feature = LabelVideoRequest.Types.Feature.Unspecified,
    VideoClassificationConfig = new VideoClassificationConfig(),
    ObjectDetectionConfig = new ObjectDetectionConfig(),
    ObjectTrackingConfig = new ObjectTrackingConfig(),
    EventConfig = new EventConfig(),
};
// Make the request
Operation<AnnotatedDataset, LabelOperationMetadata> response = await dataLabelingServiceClient.LabelVideoAsync(request);

// Poll until the returned long-running operation is complete
Operation<AnnotatedDataset, LabelOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
AnnotatedDataset result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<AnnotatedDataset, LabelOperationMetadata> retrievedResponse = await dataLabelingServiceClient.PollOnceLabelVideoAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    AnnotatedDataset retrievedResult = retrievedResponse.Result;
}

LabelVideoAsync(String, HumanAnnotationConfig, LabelVideoRequest.Types.Feature, CallSettings)

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

Declaration
public virtual Task<Operation<AnnotatedDataset, LabelOperationMetadata>> LabelVideoAsync(string parent, HumanAnnotationConfig basicConfig, LabelVideoRequest.Types.Feature feature, CallSettings callSettings = null)
Parameters
Type Name Description
System.String parent

Required. Name of the dataset to request labeling task, format: projects/{project_id}/datasets/{dataset_id}

HumanAnnotationConfig basicConfig

Required. Basic human annotation config.

LabelVideoRequest.Types.Feature feature

Required. The type of video labeling task.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task<Operation<AnnotatedDataset, LabelOperationMetadata>>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/datasets/[DATASET]";
HumanAnnotationConfig basicConfig = new HumanAnnotationConfig();
LabelVideoRequest.Types.Feature feature = LabelVideoRequest.Types.Feature.Unspecified;
// Make the request
Operation<AnnotatedDataset, LabelOperationMetadata> response = await dataLabelingServiceClient.LabelVideoAsync(parent, basicConfig, feature);

// Poll until the returned long-running operation is complete
Operation<AnnotatedDataset, LabelOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
AnnotatedDataset result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<AnnotatedDataset, LabelOperationMetadata> retrievedResponse = await dataLabelingServiceClient.PollOnceLabelVideoAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    AnnotatedDataset retrievedResult = retrievedResponse.Result;
}

LabelVideoAsync(String, HumanAnnotationConfig, LabelVideoRequest.Types.Feature, CancellationToken)

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

Declaration
public virtual Task<Operation<AnnotatedDataset, LabelOperationMetadata>> LabelVideoAsync(string parent, HumanAnnotationConfig basicConfig, LabelVideoRequest.Types.Feature feature, CancellationToken cancellationToken)
Parameters
Type Name Description
System.String parent

Required. Name of the dataset to request labeling task, format: projects/{project_id}/datasets/{dataset_id}

HumanAnnotationConfig basicConfig

Required. Basic human annotation config.

LabelVideoRequest.Types.Feature feature

Required. The type of video labeling task.

System.Threading.CancellationToken cancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
Type Description
System.Threading.Tasks.Task<Operation<AnnotatedDataset, LabelOperationMetadata>>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/datasets/[DATASET]";
HumanAnnotationConfig basicConfig = new HumanAnnotationConfig();
LabelVideoRequest.Types.Feature feature = LabelVideoRequest.Types.Feature.Unspecified;
// Make the request
Operation<AnnotatedDataset, LabelOperationMetadata> response = await dataLabelingServiceClient.LabelVideoAsync(parent, basicConfig, feature);

// Poll until the returned long-running operation is complete
Operation<AnnotatedDataset, LabelOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
AnnotatedDataset result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<AnnotatedDataset, LabelOperationMetadata> retrievedResponse = await dataLabelingServiceClient.PollOnceLabelVideoAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    AnnotatedDataset retrievedResult = retrievedResponse.Result;
}

ListAnnotatedDatasets(DatasetName, String, String, Nullable<Int32>, CallSettings)

Lists annotated datasets for a dataset. Pagination is supported.

Declaration
public virtual PagedEnumerable<ListAnnotatedDatasetsResponse, AnnotatedDataset> ListAnnotatedDatasets(DatasetName parent, string filter, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)
Parameters
Type Name Description
DatasetName parent

Required. Name of the dataset to list annotated datasets, format: projects/{project_id}/datasets/{dataset_id}

System.String filter

Optional. Filter is not supported at this moment.

System.String pageToken

The token returned from the previous request. A value of null or an empty string retrieves the first page.

System.Nullable<System.Int32> pageSize

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerable<ListAnnotatedDatasetsResponse, AnnotatedDataset>

A pageable sequence of AnnotatedDataset resources.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.Create();
// Initialize request argument(s)
DatasetName parent = DatasetName.FromProjectDataset("[PROJECT]", "[DATASET]");
string filter = "";
// Make the request
PagedEnumerable<ListAnnotatedDatasetsResponse, AnnotatedDataset> response = dataLabelingServiceClient.ListAnnotatedDatasets(parent, filter);

// Iterate over all response items, lazily performing RPCs as required
foreach (AnnotatedDataset item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListAnnotatedDatasetsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (AnnotatedDataset item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<AnnotatedDataset> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (AnnotatedDataset item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListAnnotatedDatasets(ListAnnotatedDatasetsRequest, CallSettings)

Lists annotated datasets for a dataset. Pagination is supported.

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

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

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerable<ListAnnotatedDatasetsResponse, AnnotatedDataset>

A pageable sequence of AnnotatedDataset resources.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.Create();
// Initialize request argument(s)
ListAnnotatedDatasetsRequest request = new ListAnnotatedDatasetsRequest
{
    ParentAsDatasetName = DatasetName.FromProjectDataset("[PROJECT]", "[DATASET]"),
    Filter = "",
};
// Make the request
PagedEnumerable<ListAnnotatedDatasetsResponse, AnnotatedDataset> response = dataLabelingServiceClient.ListAnnotatedDatasets(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (AnnotatedDataset item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListAnnotatedDatasetsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (AnnotatedDataset item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<AnnotatedDataset> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (AnnotatedDataset item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListAnnotatedDatasets(String, String, String, Nullable<Int32>, CallSettings)

Lists annotated datasets for a dataset. Pagination is supported.

Declaration
public virtual PagedEnumerable<ListAnnotatedDatasetsResponse, AnnotatedDataset> ListAnnotatedDatasets(string parent, string filter, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)
Parameters
Type Name Description
System.String parent

Required. Name of the dataset to list annotated datasets, format: projects/{project_id}/datasets/{dataset_id}

System.String filter

Optional. Filter is not supported at this moment.

System.String pageToken

The token returned from the previous request. A value of null or an empty string retrieves the first page.

System.Nullable<System.Int32> pageSize

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerable<ListAnnotatedDatasetsResponse, AnnotatedDataset>

A pageable sequence of AnnotatedDataset resources.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/datasets/[DATASET]";
string filter = "";
// Make the request
PagedEnumerable<ListAnnotatedDatasetsResponse, AnnotatedDataset> response = dataLabelingServiceClient.ListAnnotatedDatasets(parent, filter);

// Iterate over all response items, lazily performing RPCs as required
foreach (AnnotatedDataset item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListAnnotatedDatasetsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (AnnotatedDataset item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<AnnotatedDataset> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (AnnotatedDataset item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListAnnotatedDatasetsAsync(DatasetName, String, String, Nullable<Int32>, CallSettings)

Lists annotated datasets for a dataset. Pagination is supported.

Declaration
public virtual PagedAsyncEnumerable<ListAnnotatedDatasetsResponse, AnnotatedDataset> ListAnnotatedDatasetsAsync(DatasetName parent, string filter, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)
Parameters
Type Name Description
DatasetName parent

Required. Name of the dataset to list annotated datasets, format: projects/{project_id}/datasets/{dataset_id}

System.String filter

Optional. Filter is not supported at this moment.

System.String pageToken

The token returned from the previous request. A value of null or an empty string retrieves the first page.

System.Nullable<System.Int32> pageSize

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerable<ListAnnotatedDatasetsResponse, AnnotatedDataset>

A pageable asynchronous sequence of AnnotatedDataset resources.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
DatasetName parent = DatasetName.FromProjectDataset("[PROJECT]", "[DATASET]");
string filter = "";
// Make the request
PagedAsyncEnumerable<ListAnnotatedDatasetsResponse, AnnotatedDataset> response = dataLabelingServiceClient.ListAnnotatedDatasetsAsync(parent, filter);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((AnnotatedDataset item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListAnnotatedDatasetsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (AnnotatedDataset item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<AnnotatedDataset> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (AnnotatedDataset item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListAnnotatedDatasetsAsync(ListAnnotatedDatasetsRequest, CallSettings)

Lists annotated datasets for a dataset. Pagination is supported.

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

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

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerable<ListAnnotatedDatasetsResponse, AnnotatedDataset>

A pageable asynchronous sequence of AnnotatedDataset resources.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
ListAnnotatedDatasetsRequest request = new ListAnnotatedDatasetsRequest
{
    ParentAsDatasetName = DatasetName.FromProjectDataset("[PROJECT]", "[DATASET]"),
    Filter = "",
};
// Make the request
PagedAsyncEnumerable<ListAnnotatedDatasetsResponse, AnnotatedDataset> response = dataLabelingServiceClient.ListAnnotatedDatasetsAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((AnnotatedDataset item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListAnnotatedDatasetsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (AnnotatedDataset item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<AnnotatedDataset> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (AnnotatedDataset item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListAnnotatedDatasetsAsync(String, String, String, Nullable<Int32>, CallSettings)

Lists annotated datasets for a dataset. Pagination is supported.

Declaration
public virtual PagedAsyncEnumerable<ListAnnotatedDatasetsResponse, AnnotatedDataset> ListAnnotatedDatasetsAsync(string parent, string filter, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)
Parameters
Type Name Description
System.String parent

Required. Name of the dataset to list annotated datasets, format: projects/{project_id}/datasets/{dataset_id}

System.String filter

Optional. Filter is not supported at this moment.

System.String pageToken

The token returned from the previous request. A value of null or an empty string retrieves the first page.

System.Nullable<System.Int32> pageSize

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerable<ListAnnotatedDatasetsResponse, AnnotatedDataset>

A pageable asynchronous sequence of AnnotatedDataset resources.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/datasets/[DATASET]";
string filter = "";
// Make the request
PagedAsyncEnumerable<ListAnnotatedDatasetsResponse, AnnotatedDataset> response = dataLabelingServiceClient.ListAnnotatedDatasetsAsync(parent, filter);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((AnnotatedDataset item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListAnnotatedDatasetsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (AnnotatedDataset item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<AnnotatedDataset> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (AnnotatedDataset item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListAnnotationSpecSets(ProjectName, String, String, Nullable<Int32>, CallSettings)

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

Declaration
public virtual PagedEnumerable<ListAnnotationSpecSetsResponse, AnnotationSpecSet> ListAnnotationSpecSets(ProjectName parent, string filter, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)
Parameters
Type Name Description
ProjectName parent

Required. Parent of AnnotationSpecSet resource, format: projects/{project_id}

System.String filter

Optional. Filter is not supported at this moment.

System.String pageToken

The token returned from the previous request. A value of null or an empty string retrieves the first page.

System.Nullable<System.Int32> pageSize

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerable<ListAnnotationSpecSetsResponse, AnnotationSpecSet>

A pageable sequence of AnnotationSpecSet resources.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.Create();
// Initialize request argument(s)
ProjectName parent = ProjectName.FromProject("[PROJECT]");
string filter = "";
// Make the request
PagedEnumerable<ListAnnotationSpecSetsResponse, AnnotationSpecSet> response = dataLabelingServiceClient.ListAnnotationSpecSets(parent, filter);

// Iterate over all response items, lazily performing RPCs as required
foreach (AnnotationSpecSet item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListAnnotationSpecSetsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (AnnotationSpecSet item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<AnnotationSpecSet> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (AnnotationSpecSet item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListAnnotationSpecSets(ListAnnotationSpecSetsRequest, CallSettings)

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

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

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

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerable<ListAnnotationSpecSetsResponse, AnnotationSpecSet>

A pageable sequence of AnnotationSpecSet resources.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.Create();
// Initialize request argument(s)
ListAnnotationSpecSetsRequest request = new ListAnnotationSpecSetsRequest
{
    ParentAsProjectName = ProjectName.FromProject("[PROJECT]"),
    Filter = "",
};
// Make the request
PagedEnumerable<ListAnnotationSpecSetsResponse, AnnotationSpecSet> response = dataLabelingServiceClient.ListAnnotationSpecSets(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (AnnotationSpecSet item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListAnnotationSpecSetsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (AnnotationSpecSet item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<AnnotationSpecSet> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (AnnotationSpecSet item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListAnnotationSpecSets(String, String, String, Nullable<Int32>, CallSettings)

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

Declaration
public virtual PagedEnumerable<ListAnnotationSpecSetsResponse, AnnotationSpecSet> ListAnnotationSpecSets(string parent, string filter, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)
Parameters
Type Name Description
System.String parent

Required. Parent of AnnotationSpecSet resource, format: projects/{project_id}

System.String filter

Optional. Filter is not supported at this moment.

System.String pageToken

The token returned from the previous request. A value of null or an empty string retrieves the first page.

System.Nullable<System.Int32> pageSize

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerable<ListAnnotationSpecSetsResponse, AnnotationSpecSet>

A pageable sequence of AnnotationSpecSet resources.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]";
string filter = "";
// Make the request
PagedEnumerable<ListAnnotationSpecSetsResponse, AnnotationSpecSet> response = dataLabelingServiceClient.ListAnnotationSpecSets(parent, filter);

// Iterate over all response items, lazily performing RPCs as required
foreach (AnnotationSpecSet item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListAnnotationSpecSetsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (AnnotationSpecSet item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<AnnotationSpecSet> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (AnnotationSpecSet item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListAnnotationSpecSetsAsync(ProjectName, String, String, Nullable<Int32>, CallSettings)

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

Declaration
public virtual PagedAsyncEnumerable<ListAnnotationSpecSetsResponse, AnnotationSpecSet> ListAnnotationSpecSetsAsync(ProjectName parent, string filter, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)
Parameters
Type Name Description
ProjectName parent

Required. Parent of AnnotationSpecSet resource, format: projects/{project_id}

System.String filter

Optional. Filter is not supported at this moment.

System.String pageToken

The token returned from the previous request. A value of null or an empty string retrieves the first page.

System.Nullable<System.Int32> pageSize

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerable<ListAnnotationSpecSetsResponse, AnnotationSpecSet>

A pageable asynchronous sequence of AnnotationSpecSet resources.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
ProjectName parent = ProjectName.FromProject("[PROJECT]");
string filter = "";
// Make the request
PagedAsyncEnumerable<ListAnnotationSpecSetsResponse, AnnotationSpecSet> response = dataLabelingServiceClient.ListAnnotationSpecSetsAsync(parent, filter);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((AnnotationSpecSet item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListAnnotationSpecSetsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (AnnotationSpecSet item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<AnnotationSpecSet> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (AnnotationSpecSet item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListAnnotationSpecSetsAsync(ListAnnotationSpecSetsRequest, CallSettings)

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

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

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

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerable<ListAnnotationSpecSetsResponse, AnnotationSpecSet>

A pageable asynchronous sequence of AnnotationSpecSet resources.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
ListAnnotationSpecSetsRequest request = new ListAnnotationSpecSetsRequest
{
    ParentAsProjectName = ProjectName.FromProject("[PROJECT]"),
    Filter = "",
};
// Make the request
PagedAsyncEnumerable<ListAnnotationSpecSetsResponse, AnnotationSpecSet> response = dataLabelingServiceClient.ListAnnotationSpecSetsAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((AnnotationSpecSet item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListAnnotationSpecSetsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (AnnotationSpecSet item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<AnnotationSpecSet> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (AnnotationSpecSet item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListAnnotationSpecSetsAsync(String, String, String, Nullable<Int32>, CallSettings)

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

Declaration
public virtual PagedAsyncEnumerable<ListAnnotationSpecSetsResponse, AnnotationSpecSet> ListAnnotationSpecSetsAsync(string parent, string filter, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)
Parameters
Type Name Description
System.String parent

Required. Parent of AnnotationSpecSet resource, format: projects/{project_id}

System.String filter

Optional. Filter is not supported at this moment.

System.String pageToken

The token returned from the previous request. A value of null or an empty string retrieves the first page.

System.Nullable<System.Int32> pageSize

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerable<ListAnnotationSpecSetsResponse, AnnotationSpecSet>

A pageable asynchronous sequence of AnnotationSpecSet resources.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]";
string filter = "";
// Make the request
PagedAsyncEnumerable<ListAnnotationSpecSetsResponse, AnnotationSpecSet> response = dataLabelingServiceClient.ListAnnotationSpecSetsAsync(parent, filter);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((AnnotationSpecSet item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListAnnotationSpecSetsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (AnnotationSpecSet item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<AnnotationSpecSet> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (AnnotationSpecSet item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListDataItems(DatasetName, String, String, Nullable<Int32>, CallSettings)

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

Declaration
public virtual PagedEnumerable<ListDataItemsResponse, DataItem> ListDataItems(DatasetName parent, string filter, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)
Parameters
Type Name Description
DatasetName parent

Required. Name of the dataset to list data items, format: projects/{project_id}/datasets/{dataset_id}

System.String filter

Optional. Filter is not supported at this moment.

System.String pageToken

The token returned from the previous request. A value of null or an empty string retrieves the first page.

System.Nullable<System.Int32> pageSize

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerable<ListDataItemsResponse, DataItem>

A pageable sequence of DataItem resources.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.Create();
// Initialize request argument(s)
DatasetName parent = DatasetName.FromProjectDataset("[PROJECT]", "[DATASET]");
string filter = "";
// Make the request
PagedEnumerable<ListDataItemsResponse, DataItem> response = dataLabelingServiceClient.ListDataItems(parent, filter);

// Iterate over all response items, lazily performing RPCs as required
foreach (DataItem item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListDataItemsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (DataItem item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<DataItem> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (DataItem item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListDataItems(ListDataItemsRequest, CallSettings)

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

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

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

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerable<ListDataItemsResponse, DataItem>

A pageable sequence of DataItem resources.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.Create();
// Initialize request argument(s)
ListDataItemsRequest request = new ListDataItemsRequest
{
    ParentAsDatasetName = DatasetName.FromProjectDataset("[PROJECT]", "[DATASET]"),
    Filter = "",
};
// Make the request
PagedEnumerable<ListDataItemsResponse, DataItem> response = dataLabelingServiceClient.ListDataItems(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (DataItem item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListDataItemsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (DataItem item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<DataItem> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (DataItem item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListDataItems(String, String, String, Nullable<Int32>, CallSettings)

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

Declaration
public virtual PagedEnumerable<ListDataItemsResponse, DataItem> ListDataItems(string parent, string filter, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)
Parameters
Type Name Description
System.String parent

Required. Name of the dataset to list data items, format: projects/{project_id}/datasets/{dataset_id}

System.String filter

Optional. Filter is not supported at this moment.

System.String pageToken

The token returned from the previous request. A value of null or an empty string retrieves the first page.

System.Nullable<System.Int32> pageSize

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerable<ListDataItemsResponse, DataItem>

A pageable sequence of DataItem resources.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/datasets/[DATASET]";
string filter = "";
// Make the request
PagedEnumerable<ListDataItemsResponse, DataItem> response = dataLabelingServiceClient.ListDataItems(parent, filter);

// Iterate over all response items, lazily performing RPCs as required
foreach (DataItem item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListDataItemsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (DataItem item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<DataItem> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (DataItem item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListDataItemsAsync(DatasetName, String, String, Nullable<Int32>, CallSettings)

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

Declaration
public virtual PagedAsyncEnumerable<ListDataItemsResponse, DataItem> ListDataItemsAsync(DatasetName parent, string filter, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)
Parameters
Type Name Description
DatasetName parent

Required. Name of the dataset to list data items, format: projects/{project_id}/datasets/{dataset_id}

System.String filter

Optional. Filter is not supported at this moment.

System.String pageToken

The token returned from the previous request. A value of null or an empty string retrieves the first page.

System.Nullable<System.Int32> pageSize

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerable<ListDataItemsResponse, DataItem>

A pageable asynchronous sequence of DataItem resources.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
DatasetName parent = DatasetName.FromProjectDataset("[PROJECT]", "[DATASET]");
string filter = "";
// Make the request
PagedAsyncEnumerable<ListDataItemsResponse, DataItem> response = dataLabelingServiceClient.ListDataItemsAsync(parent, filter);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((DataItem item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListDataItemsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (DataItem item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<DataItem> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (DataItem item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListDataItemsAsync(ListDataItemsRequest, CallSettings)

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

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

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

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerable<ListDataItemsResponse, DataItem>

A pageable asynchronous sequence of DataItem resources.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
ListDataItemsRequest request = new ListDataItemsRequest
{
    ParentAsDatasetName = DatasetName.FromProjectDataset("[PROJECT]", "[DATASET]"),
    Filter = "",
};
// Make the request
PagedAsyncEnumerable<ListDataItemsResponse, DataItem> response = dataLabelingServiceClient.ListDataItemsAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((DataItem item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListDataItemsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (DataItem item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<DataItem> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (DataItem item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListDataItemsAsync(String, String, String, Nullable<Int32>, CallSettings)

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

Declaration
public virtual PagedAsyncEnumerable<ListDataItemsResponse, DataItem> ListDataItemsAsync(string parent, string filter, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)
Parameters
Type Name Description
System.String parent

Required. Name of the dataset to list data items, format: projects/{project_id}/datasets/{dataset_id}

System.String filter

Optional. Filter is not supported at this moment.

System.String pageToken

The token returned from the previous request. A value of null or an empty string retrieves the first page.

System.Nullable<System.Int32> pageSize

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerable<ListDataItemsResponse, DataItem>

A pageable asynchronous sequence of DataItem resources.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/datasets/[DATASET]";
string filter = "";
// Make the request
PagedAsyncEnumerable<ListDataItemsResponse, DataItem> response = dataLabelingServiceClient.ListDataItemsAsync(parent, filter);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((DataItem item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListDataItemsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (DataItem item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<DataItem> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (DataItem item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListDatasets(ProjectName, String, String, Nullable<Int32>, CallSettings)

Lists datasets under a project. Pagination is supported.

Declaration
public virtual PagedEnumerable<ListDatasetsResponse, Dataset> ListDatasets(ProjectName parent, string filter, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)
Parameters
Type Name Description
ProjectName parent

Required. Dataset resource parent, format: projects/{project_id}

System.String filter

Optional. Filter on dataset is not supported at this moment.

System.String pageToken

The token returned from the previous request. A value of null or an empty string retrieves the first page.

System.Nullable<System.Int32> pageSize

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerable<ListDatasetsResponse, Dataset>

A pageable sequence of Dataset resources.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.Create();
// Initialize request argument(s)
ProjectName parent = ProjectName.FromProject("[PROJECT]");
string filter = "";
// Make the request
PagedEnumerable<ListDatasetsResponse, Dataset> response = dataLabelingServiceClient.ListDatasets(parent, filter);

// Iterate over all response items, lazily performing RPCs as required
foreach (Dataset item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListDatasetsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Dataset item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Dataset> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Dataset item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListDatasets(ListDatasetsRequest, CallSettings)

Lists datasets under a project. Pagination is supported.

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

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

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerable<ListDatasetsResponse, Dataset>

A pageable sequence of Dataset resources.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.Create();
// Initialize request argument(s)
ListDatasetsRequest request = new ListDatasetsRequest
{
    ParentAsProjectName = ProjectName.FromProject("[PROJECT]"),
    Filter = "",
};
// Make the request
PagedEnumerable<ListDatasetsResponse, Dataset> response = dataLabelingServiceClient.ListDatasets(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (Dataset item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListDatasetsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Dataset item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Dataset> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Dataset item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListDatasets(String, String, String, Nullable<Int32>, CallSettings)

Lists datasets under a project. Pagination is supported.

Declaration
public virtual PagedEnumerable<ListDatasetsResponse, Dataset> ListDatasets(string parent, string filter, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)
Parameters
Type Name Description
System.String parent

Required. Dataset resource parent, format: projects/{project_id}

System.String filter

Optional. Filter on dataset is not supported at this moment.

System.String pageToken

The token returned from the previous request. A value of null or an empty string retrieves the first page.

System.Nullable<System.Int32> pageSize

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerable<ListDatasetsResponse, Dataset>

A pageable sequence of Dataset resources.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]";
string filter = "";
// Make the request
PagedEnumerable<ListDatasetsResponse, Dataset> response = dataLabelingServiceClient.ListDatasets(parent, filter);

// Iterate over all response items, lazily performing RPCs as required
foreach (Dataset item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListDatasetsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Dataset item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Dataset> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Dataset item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListDatasetsAsync(ProjectName, String, String, Nullable<Int32>, CallSettings)

Lists datasets under a project. Pagination is supported.

Declaration
public virtual PagedAsyncEnumerable<ListDatasetsResponse, Dataset> ListDatasetsAsync(ProjectName parent, string filter, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)
Parameters
Type Name Description
ProjectName parent

Required. Dataset resource parent, format: projects/{project_id}

System.String filter

Optional. Filter on dataset is not supported at this moment.

System.String pageToken

The token returned from the previous request. A value of null or an empty string retrieves the first page.

System.Nullable<System.Int32> pageSize

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerable<ListDatasetsResponse, Dataset>

A pageable asynchronous sequence of Dataset resources.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
ProjectName parent = ProjectName.FromProject("[PROJECT]");
string filter = "";
// Make the request
PagedAsyncEnumerable<ListDatasetsResponse, Dataset> response = dataLabelingServiceClient.ListDatasetsAsync(parent, filter);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Dataset item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListDatasetsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Dataset item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Dataset> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Dataset item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListDatasetsAsync(ListDatasetsRequest, CallSettings)

Lists datasets under a project. Pagination is supported.

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

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

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerable<ListDatasetsResponse, Dataset>

A pageable asynchronous sequence of Dataset resources.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
ListDatasetsRequest request = new ListDatasetsRequest
{
    ParentAsProjectName = ProjectName.FromProject("[PROJECT]"),
    Filter = "",
};
// Make the request
PagedAsyncEnumerable<ListDatasetsResponse, Dataset> response = dataLabelingServiceClient.ListDatasetsAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Dataset item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListDatasetsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Dataset item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Dataset> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Dataset item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListDatasetsAsync(String, String, String, Nullable<Int32>, CallSettings)

Lists datasets under a project. Pagination is supported.

Declaration
public virtual PagedAsyncEnumerable<ListDatasetsResponse, Dataset> ListDatasetsAsync(string parent, string filter, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)
Parameters
Type Name Description
System.String parent

Required. Dataset resource parent, format: projects/{project_id}

System.String filter

Optional. Filter on dataset is not supported at this moment.

System.String pageToken

The token returned from the previous request. A value of null or an empty string retrieves the first page.

System.Nullable<System.Int32> pageSize

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerable<ListDatasetsResponse, Dataset>

A pageable asynchronous sequence of Dataset resources.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]";
string filter = "";
// Make the request
PagedAsyncEnumerable<ListDatasetsResponse, Dataset> response = dataLabelingServiceClient.ListDatasetsAsync(parent, filter);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Dataset item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListDatasetsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Dataset item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Dataset> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Dataset item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListEvaluationJobs(ProjectName, String, String, Nullable<Int32>, CallSettings)

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

Declaration
public virtual PagedEnumerable<ListEvaluationJobsResponse, EvaluationJob> ListEvaluationJobs(ProjectName parent, string filter, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)
Parameters
Type Name Description
ProjectName parent

Required. Evaluation job resource parent. Format: "projects/&lt;var&gt;{project_id}&lt;/var&gt;"

System.String filter

Optional. You can filter the jobs to list by model_id (also known as model_name, as described in [EvaluationJob.modelVersion][google.cloud.datalabeling.v1beta1.EvaluationJob.model_version]) or by evaluation job state (as described in [EvaluationJob.state][google.cloud.datalabeling.v1beta1.EvaluationJob.state]). To filter by both criteria, use the AND operator or the OR operator. For example, you can use the following string for your filter: "evaluation&lt;span&gt;&lt;/span&gt;job.model_id = &lt;var&gt;{model_name}&lt;/var&gt; AND evaluation&lt;span&gt;&lt;/span&gt;job.state = &lt;var&gt;{evaluation_job_state}&lt;/var&gt;"

System.String pageToken

The token returned from the previous request. A value of null or an empty string retrieves the first page.

System.Nullable<System.Int32> pageSize

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerable<ListEvaluationJobsResponse, EvaluationJob>

A pageable sequence of EvaluationJob resources.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.Create();
// Initialize request argument(s)
ProjectName parent = ProjectName.FromProject("[PROJECT]");
string filter = "";
// Make the request
PagedEnumerable<ListEvaluationJobsResponse, EvaluationJob> response = dataLabelingServiceClient.ListEvaluationJobs(parent, filter);

// Iterate over all response items, lazily performing RPCs as required
foreach (EvaluationJob item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListEvaluationJobsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (EvaluationJob item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<EvaluationJob> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (EvaluationJob item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListEvaluationJobs(ListEvaluationJobsRequest, CallSettings)

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

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

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

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerable<ListEvaluationJobsResponse, EvaluationJob>

A pageable sequence of EvaluationJob resources.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.Create();
// Initialize request argument(s)
ListEvaluationJobsRequest request = new ListEvaluationJobsRequest
{
    ParentAsProjectName = ProjectName.FromProject("[PROJECT]"),
    Filter = "",
};
// Make the request
PagedEnumerable<ListEvaluationJobsResponse, EvaluationJob> response = dataLabelingServiceClient.ListEvaluationJobs(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (EvaluationJob item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListEvaluationJobsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (EvaluationJob item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<EvaluationJob> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (EvaluationJob item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListEvaluationJobs(String, String, String, Nullable<Int32>, CallSettings)

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

Declaration
public virtual PagedEnumerable<ListEvaluationJobsResponse, EvaluationJob> ListEvaluationJobs(string parent, string filter, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)
Parameters
Type Name Description
System.String parent

Required. Evaluation job resource parent. Format: "projects/&lt;var&gt;{project_id}&lt;/var&gt;"

System.String filter

Optional. You can filter the jobs to list by model_id (also known as model_name, as described in [EvaluationJob.modelVersion][google.cloud.datalabeling.v1beta1.EvaluationJob.model_version]) or by evaluation job state (as described in [EvaluationJob.state][google.cloud.datalabeling.v1beta1.EvaluationJob.state]). To filter by both criteria, use the AND operator or the OR operator. For example, you can use the following string for your filter: "evaluation&lt;span&gt;&lt;/span&gt;job.model_id = &lt;var&gt;{model_name}&lt;/var&gt; AND evaluation&lt;span&gt;&lt;/span&gt;job.state = &lt;var&gt;{evaluation_job_state}&lt;/var&gt;"

System.String pageToken

The token returned from the previous request. A value of null or an empty string retrieves the first page.

System.Nullable<System.Int32> pageSize

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerable<ListEvaluationJobsResponse, EvaluationJob>

A pageable sequence of EvaluationJob resources.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]";
string filter = "";
// Make the request
PagedEnumerable<ListEvaluationJobsResponse, EvaluationJob> response = dataLabelingServiceClient.ListEvaluationJobs(parent, filter);

// Iterate over all response items, lazily performing RPCs as required
foreach (EvaluationJob item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListEvaluationJobsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (EvaluationJob item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<EvaluationJob> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (EvaluationJob item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListEvaluationJobsAsync(ProjectName, String, String, Nullable<Int32>, CallSettings)

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

Declaration
public virtual PagedAsyncEnumerable<ListEvaluationJobsResponse, EvaluationJob> ListEvaluationJobsAsync(ProjectName parent, string filter, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)
Parameters
Type Name Description
ProjectName parent

Required. Evaluation job resource parent. Format: "projects/&lt;var&gt;{project_id}&lt;/var&gt;"

System.String filter

Optional. You can filter the jobs to list by model_id (also known as model_name, as described in [EvaluationJob.modelVersion][google.cloud.datalabeling.v1beta1.EvaluationJob.model_version]) or by evaluation job state (as described in [EvaluationJob.state][google.cloud.datalabeling.v1beta1.EvaluationJob.state]). To filter by both criteria, use the AND operator or the OR operator. For example, you can use the following string for your filter: "evaluation&lt;span&gt;&lt;/span&gt;job.model_id = &lt;var&gt;{model_name}&lt;/var&gt; AND evaluation&lt;span&gt;&lt;/span&gt;job.state = &lt;var&gt;{evaluation_job_state}&lt;/var&gt;"

System.String pageToken

The token returned from the previous request. A value of null or an empty string retrieves the first page.

System.Nullable<System.Int32> pageSize

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerable<ListEvaluationJobsResponse, EvaluationJob>

A pageable asynchronous sequence of EvaluationJob resources.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
ProjectName parent = ProjectName.FromProject("[PROJECT]");
string filter = "";
// Make the request
PagedAsyncEnumerable<ListEvaluationJobsResponse, EvaluationJob> response = dataLabelingServiceClient.ListEvaluationJobsAsync(parent, filter);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((EvaluationJob item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListEvaluationJobsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (EvaluationJob item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<EvaluationJob> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (EvaluationJob item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListEvaluationJobsAsync(ListEvaluationJobsRequest, CallSettings)

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

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

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

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerable<ListEvaluationJobsResponse, EvaluationJob>

A pageable asynchronous sequence of EvaluationJob resources.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
ListEvaluationJobsRequest request = new ListEvaluationJobsRequest
{
    ParentAsProjectName = ProjectName.FromProject("[PROJECT]"),
    Filter = "",
};
// Make the request
PagedAsyncEnumerable<ListEvaluationJobsResponse, EvaluationJob> response = dataLabelingServiceClient.ListEvaluationJobsAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((EvaluationJob item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListEvaluationJobsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (EvaluationJob item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<EvaluationJob> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (EvaluationJob item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListEvaluationJobsAsync(String, String, String, Nullable<Int32>, CallSettings)

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

Declaration
public virtual PagedAsyncEnumerable<ListEvaluationJobsResponse, EvaluationJob> ListEvaluationJobsAsync(string parent, string filter, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)
Parameters
Type Name Description
System.String parent

Required. Evaluation job resource parent. Format: "projects/&lt;var&gt;{project_id}&lt;/var&gt;"

System.String filter

Optional. You can filter the jobs to list by model_id (also known as model_name, as described in [EvaluationJob.modelVersion][google.cloud.datalabeling.v1beta1.EvaluationJob.model_version]) or by evaluation job state (as described in [EvaluationJob.state][google.cloud.datalabeling.v1beta1.EvaluationJob.state]). To filter by both criteria, use the AND operator or the OR operator. For example, you can use the following string for your filter: "evaluation&lt;span&gt;&lt;/span&gt;job.model_id = &lt;var&gt;{model_name}&lt;/var&gt; AND evaluation&lt;span&gt;&lt;/span&gt;job.state = &lt;var&gt;{evaluation_job_state}&lt;/var&gt;"

System.String pageToken

The token returned from the previous request. A value of null or an empty string retrieves the first page.

System.Nullable<System.Int32> pageSize

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerable<ListEvaluationJobsResponse, EvaluationJob>

A pageable asynchronous sequence of EvaluationJob resources.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]";
string filter = "";
// Make the request
PagedAsyncEnumerable<ListEvaluationJobsResponse, EvaluationJob> response = dataLabelingServiceClient.ListEvaluationJobsAsync(parent, filter);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((EvaluationJob item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListEvaluationJobsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (EvaluationJob item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<EvaluationJob> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (EvaluationJob item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListExamples(AnnotatedDatasetName, String, String, Nullable<Int32>, CallSettings)

Lists examples in an annotated dataset. Pagination is supported.

Declaration
public virtual PagedEnumerable<ListExamplesResponse, Example> ListExamples(AnnotatedDatasetName parent, string filter, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)
Parameters
Type Name Description
AnnotatedDatasetName parent

Required. Example resource parent.

System.String filter

Optional. An expression for filtering Examples. For annotated datasets that have annotation spec set, filter by annotation_spec.display_name is supported. Format "annotation_spec.display_name = {display_name}"

System.String pageToken

The token returned from the previous request. A value of null or an empty string retrieves the first page.

System.Nullable<System.Int32> pageSize

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerable<ListExamplesResponse, Example>

A pageable sequence of Example resources.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.Create();
// Initialize request argument(s)
AnnotatedDatasetName parent = AnnotatedDatasetName.FromProjectDatasetAnnotatedDataset("[PROJECT]", "[DATASET]", "[ANNOTATED_DATASET]");
string filter = "";
// Make the request
PagedEnumerable<ListExamplesResponse, Example> response = dataLabelingServiceClient.ListExamples(parent, filter);

// Iterate over all response items, lazily performing RPCs as required
foreach (Example item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListExamplesResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Example item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Example> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Example item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListExamples(ListExamplesRequest, CallSettings)

Lists examples in an annotated dataset. Pagination is supported.

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

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

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerable<ListExamplesResponse, Example>

A pageable sequence of Example resources.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.Create();
// Initialize request argument(s)
ListExamplesRequest request = new ListExamplesRequest
{
    ParentAsAnnotatedDatasetName = AnnotatedDatasetName.FromProjectDatasetAnnotatedDataset("[PROJECT]", "[DATASET]", "[ANNOTATED_DATASET]"),
    Filter = "",
};
// Make the request
PagedEnumerable<ListExamplesResponse, Example> response = dataLabelingServiceClient.ListExamples(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (Example item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListExamplesResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Example item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Example> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Example item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListExamples(String, String, String, Nullable<Int32>, CallSettings)

Lists examples in an annotated dataset. Pagination is supported.

Declaration
public virtual PagedEnumerable<ListExamplesResponse, Example> ListExamples(string parent, string filter, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)
Parameters
Type Name Description
System.String parent

Required. Example resource parent.

System.String filter

Optional. An expression for filtering Examples. For annotated datasets that have annotation spec set, filter by annotation_spec.display_name is supported. Format "annotation_spec.display_name = {display_name}"

System.String pageToken

The token returned from the previous request. A value of null or an empty string retrieves the first page.

System.Nullable<System.Int32> pageSize

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerable<ListExamplesResponse, Example>

A pageable sequence of Example resources.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/datasets/[DATASET]/annotatedDatasets/[ANNOTATED_DATASET]";
string filter = "";
// Make the request
PagedEnumerable<ListExamplesResponse, Example> response = dataLabelingServiceClient.ListExamples(parent, filter);

// Iterate over all response items, lazily performing RPCs as required
foreach (Example item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListExamplesResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Example item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Example> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Example item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListExamplesAsync(AnnotatedDatasetName, String, String, Nullable<Int32>, CallSettings)

Lists examples in an annotated dataset. Pagination is supported.

Declaration
public virtual PagedAsyncEnumerable<ListExamplesResponse, Example> ListExamplesAsync(AnnotatedDatasetName parent, string filter, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)
Parameters
Type Name Description
AnnotatedDatasetName parent

Required. Example resource parent.

System.String filter

Optional. An expression for filtering Examples. For annotated datasets that have annotation spec set, filter by annotation_spec.display_name is supported. Format "annotation_spec.display_name = {display_name}"

System.String pageToken

The token returned from the previous request. A value of null or an empty string retrieves the first page.

System.Nullable<System.Int32> pageSize

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerable<ListExamplesResponse, Example>

A pageable asynchronous sequence of Example resources.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
AnnotatedDatasetName parent = AnnotatedDatasetName.FromProjectDatasetAnnotatedDataset("[PROJECT]", "[DATASET]", "[ANNOTATED_DATASET]");
string filter = "";
// Make the request
PagedAsyncEnumerable<ListExamplesResponse, Example> response = dataLabelingServiceClient.ListExamplesAsync(parent, filter);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Example item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListExamplesResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Example item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Example> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Example item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListExamplesAsync(ListExamplesRequest, CallSettings)

Lists examples in an annotated dataset. Pagination is supported.

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

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

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerable<ListExamplesResponse, Example>

A pageable asynchronous sequence of Example resources.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
ListExamplesRequest request = new ListExamplesRequest
{
    ParentAsAnnotatedDatasetName = AnnotatedDatasetName.FromProjectDatasetAnnotatedDataset("[PROJECT]", "[DATASET]", "[ANNOTATED_DATASET]"),
    Filter = "",
};
// Make the request
PagedAsyncEnumerable<ListExamplesResponse, Example> response = dataLabelingServiceClient.ListExamplesAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Example item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListExamplesResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Example item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Example> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Example item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListExamplesAsync(String, String, String, Nullable<Int32>, CallSettings)

Lists examples in an annotated dataset. Pagination is supported.

Declaration
public virtual PagedAsyncEnumerable<ListExamplesResponse, Example> ListExamplesAsync(string parent, string filter, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)
Parameters
Type Name Description
System.String parent

Required. Example resource parent.

System.String filter

Optional. An expression for filtering Examples. For annotated datasets that have annotation spec set, filter by annotation_spec.display_name is supported. Format "annotation_spec.display_name = {display_name}"

System.String pageToken

The token returned from the previous request. A value of null or an empty string retrieves the first page.

System.Nullable<System.Int32> pageSize

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerable<ListExamplesResponse, Example>

A pageable asynchronous sequence of Example resources.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/datasets/[DATASET]/annotatedDatasets/[ANNOTATED_DATASET]";
string filter = "";
// Make the request
PagedAsyncEnumerable<ListExamplesResponse, Example> response = dataLabelingServiceClient.ListExamplesAsync(parent, filter);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Example item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListExamplesResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Example item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Example> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Example item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListInstructions(ProjectName, String, String, Nullable<Int32>, CallSettings)

Lists instructions for a project. Pagination is supported.

Declaration
public virtual PagedEnumerable<ListInstructionsResponse, Instruction> ListInstructions(ProjectName parent, string filter, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)
Parameters
Type Name Description
ProjectName parent

Required. Instruction resource parent, format: projects/{project_id}

System.String filter

Optional. Filter is not supported at this moment.

System.String pageToken

The token returned from the previous request. A value of null or an empty string retrieves the first page.

System.Nullable<System.Int32> pageSize

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerable<ListInstructionsResponse, Instruction>

A pageable sequence of Instruction resources.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.Create();
// Initialize request argument(s)
ProjectName parent = ProjectName.FromProject("[PROJECT]");
string filter = "";
// Make the request
PagedEnumerable<ListInstructionsResponse, Instruction> response = dataLabelingServiceClient.ListInstructions(parent, filter);

// Iterate over all response items, lazily performing RPCs as required
foreach (Instruction item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListInstructionsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Instruction item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Instruction> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Instruction item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListInstructions(ListInstructionsRequest, CallSettings)

Lists instructions for a project. Pagination is supported.

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

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

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerable<ListInstructionsResponse, Instruction>

A pageable sequence of Instruction resources.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.Create();
// Initialize request argument(s)
ListInstructionsRequest request = new ListInstructionsRequest
{
    ParentAsProjectName = ProjectName.FromProject("[PROJECT]"),
    Filter = "",
};
// Make the request
PagedEnumerable<ListInstructionsResponse, Instruction> response = dataLabelingServiceClient.ListInstructions(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (Instruction item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListInstructionsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Instruction item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Instruction> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Instruction item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListInstructions(String, String, String, Nullable<Int32>, CallSettings)

Lists instructions for a project. Pagination is supported.

Declaration
public virtual PagedEnumerable<ListInstructionsResponse, Instruction> ListInstructions(string parent, string filter, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)
Parameters
Type Name Description
System.String parent

Required. Instruction resource parent, format: projects/{project_id}

System.String filter

Optional. Filter is not supported at this moment.

System.String pageToken

The token returned from the previous request. A value of null or an empty string retrieves the first page.

System.Nullable<System.Int32> pageSize

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerable<ListInstructionsResponse, Instruction>

A pageable sequence of Instruction resources.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]";
string filter = "";
// Make the request
PagedEnumerable<ListInstructionsResponse, Instruction> response = dataLabelingServiceClient.ListInstructions(parent, filter);

// Iterate over all response items, lazily performing RPCs as required
foreach (Instruction item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListInstructionsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Instruction item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Instruction> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Instruction item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListInstructionsAsync(ProjectName, String, String, Nullable<Int32>, CallSettings)

Lists instructions for a project. Pagination is supported.

Declaration
public virtual PagedAsyncEnumerable<ListInstructionsResponse, Instruction> ListInstructionsAsync(ProjectName parent, string filter, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)
Parameters
Type Name Description
ProjectName parent

Required. Instruction resource parent, format: projects/{project_id}

System.String filter

Optional. Filter is not supported at this moment.

System.String pageToken

The token returned from the previous request. A value of null or an empty string retrieves the first page.

System.Nullable<System.Int32> pageSize

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerable<ListInstructionsResponse, Instruction>

A pageable asynchronous sequence of Instruction resources.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
ProjectName parent = ProjectName.FromProject("[PROJECT]");
string filter = "";
// Make the request
PagedAsyncEnumerable<ListInstructionsResponse, Instruction> response = dataLabelingServiceClient.ListInstructionsAsync(parent, filter);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Instruction item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListInstructionsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Instruction item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Instruction> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Instruction item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListInstructionsAsync(ListInstructionsRequest, CallSettings)

Lists instructions for a project. Pagination is supported.

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

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

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerable<ListInstructionsResponse, Instruction>

A pageable asynchronous sequence of Instruction resources.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
ListInstructionsRequest request = new ListInstructionsRequest
{
    ParentAsProjectName = ProjectName.FromProject("[PROJECT]"),
    Filter = "",
};
// Make the request
PagedAsyncEnumerable<ListInstructionsResponse, Instruction> response = dataLabelingServiceClient.ListInstructionsAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Instruction item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListInstructionsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Instruction item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Instruction> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Instruction item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListInstructionsAsync(String, String, String, Nullable<Int32>, CallSettings)

Lists instructions for a project. Pagination is supported.

Declaration
public virtual PagedAsyncEnumerable<ListInstructionsResponse, Instruction> ListInstructionsAsync(string parent, string filter, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)
Parameters
Type Name Description
System.String parent

Required. Instruction resource parent, format: projects/{project_id}

System.String filter

Optional. Filter is not supported at this moment.

System.String pageToken

The token returned from the previous request. A value of null or an empty string retrieves the first page.

System.Nullable<System.Int32> pageSize

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerable<ListInstructionsResponse, Instruction>

A pageable asynchronous sequence of Instruction resources.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]";
string filter = "";
// Make the request
PagedAsyncEnumerable<ListInstructionsResponse, Instruction> response = dataLabelingServiceClient.ListInstructionsAsync(parent, filter);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Instruction item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListInstructionsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Instruction item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Instruction> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Instruction item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

PauseEvaluationJob(EvaluationJobName, CallSettings)

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

Declaration
public virtual void PauseEvaluationJob(EvaluationJobName name, CallSettings callSettings = null)
Parameters
Type Name Description
EvaluationJobName name

Required. Name of the evaluation job that is going to be paused. Format:

"projects/&lt;var&gt;{project_id}&lt;/var&gt;/evaluationJobs/&lt;var&gt;{evaluation_job_id}&lt;/var&gt;"

CallSettings callSettings

If not null, applies overrides to this RPC call.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.Create();
// Initialize request argument(s)
EvaluationJobName name = EvaluationJobName.FromProjectEvaluationJob("[PROJECT]", "[EVALUATION_JOB]");
// Make the request
dataLabelingServiceClient.PauseEvaluationJob(name);

PauseEvaluationJob(PauseEvaluationJobRequest, CallSettings)

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

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

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

CallSettings callSettings

If not null, applies overrides to this RPC call.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.Create();
// Initialize request argument(s)
PauseEvaluationJobRequest request = new PauseEvaluationJobRequest
{
    EvaluationJobName = EvaluationJobName.FromProjectEvaluationJob("[PROJECT]", "[EVALUATION_JOB]"),
};
// Make the request
dataLabelingServiceClient.PauseEvaluationJob(request);

PauseEvaluationJob(String, CallSettings)

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

Declaration
public virtual void PauseEvaluationJob(string name, CallSettings callSettings = null)
Parameters
Type Name Description
System.String name

Required. Name of the evaluation job that is going to be paused. Format:

"projects/&lt;var&gt;{project_id}&lt;/var&gt;/evaluationJobs/&lt;var&gt;{evaluation_job_id}&lt;/var&gt;"

CallSettings callSettings

If not null, applies overrides to this RPC call.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/evaluationJobs/[EVALUATION_JOB]";
// Make the request
dataLabelingServiceClient.PauseEvaluationJob(name);

PauseEvaluationJobAsync(EvaluationJobName, CallSettings)

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

Declaration
public virtual Task PauseEvaluationJobAsync(EvaluationJobName name, CallSettings callSettings = null)
Parameters
Type Name Description
EvaluationJobName name

Required. Name of the evaluation job that is going to be paused. Format:

"projects/&lt;var&gt;{project_id}&lt;/var&gt;/evaluationJobs/&lt;var&gt;{evaluation_job_id}&lt;/var&gt;"

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
EvaluationJobName name = EvaluationJobName.FromProjectEvaluationJob("[PROJECT]", "[EVALUATION_JOB]");
// Make the request
await dataLabelingServiceClient.PauseEvaluationJobAsync(name);

PauseEvaluationJobAsync(EvaluationJobName, CancellationToken)

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

Declaration
public virtual Task PauseEvaluationJobAsync(EvaluationJobName name, CancellationToken cancellationToken)
Parameters
Type Name Description
EvaluationJobName name

Required. Name of the evaluation job that is going to be paused. Format:

"projects/&lt;var&gt;{project_id}&lt;/var&gt;/evaluationJobs/&lt;var&gt;{evaluation_job_id}&lt;/var&gt;"

System.Threading.CancellationToken cancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
Type Description
System.Threading.Tasks.Task

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
EvaluationJobName name = EvaluationJobName.FromProjectEvaluationJob("[PROJECT]", "[EVALUATION_JOB]");
// Make the request
await dataLabelingServiceClient.PauseEvaluationJobAsync(name);

PauseEvaluationJobAsync(PauseEvaluationJobRequest, CallSettings)

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

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

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

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
PauseEvaluationJobRequest request = new PauseEvaluationJobRequest
{
    EvaluationJobName = EvaluationJobName.FromProjectEvaluationJob("[PROJECT]", "[EVALUATION_JOB]"),
};
// Make the request
await dataLabelingServiceClient.PauseEvaluationJobAsync(request);

PauseEvaluationJobAsync(PauseEvaluationJobRequest, CancellationToken)

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

Declaration
public virtual Task PauseEvaluationJobAsync(PauseEvaluationJobRequest request, CancellationToken cancellationToken)
Parameters
Type Name Description
PauseEvaluationJobRequest request

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

System.Threading.CancellationToken cancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
Type Description
System.Threading.Tasks.Task

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
PauseEvaluationJobRequest request = new PauseEvaluationJobRequest
{
    EvaluationJobName = EvaluationJobName.FromProjectEvaluationJob("[PROJECT]", "[EVALUATION_JOB]"),
};
// Make the request
await dataLabelingServiceClient.PauseEvaluationJobAsync(request);

PauseEvaluationJobAsync(String, CallSettings)

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

Declaration
public virtual Task PauseEvaluationJobAsync(string name, CallSettings callSettings = null)
Parameters
Type Name Description
System.String name

Required. Name of the evaluation job that is going to be paused. Format:

"projects/&lt;var&gt;{project_id}&lt;/var&gt;/evaluationJobs/&lt;var&gt;{evaluation_job_id}&lt;/var&gt;"

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/evaluationJobs/[EVALUATION_JOB]";
// Make the request
await dataLabelingServiceClient.PauseEvaluationJobAsync(name);

PauseEvaluationJobAsync(String, CancellationToken)

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

Declaration
public virtual Task PauseEvaluationJobAsync(string name, CancellationToken cancellationToken)
Parameters
Type Name Description
System.String name

Required. Name of the evaluation job that is going to be paused. Format:

"projects/&lt;var&gt;{project_id}&lt;/var&gt;/evaluationJobs/&lt;var&gt;{evaluation_job_id}&lt;/var&gt;"

System.Threading.CancellationToken cancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
Type Description
System.Threading.Tasks.Task

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/evaluationJobs/[EVALUATION_JOB]";
// Make the request
await dataLabelingServiceClient.PauseEvaluationJobAsync(name);

PollOnceCreateInstruction(String, CallSettings)

Poll an operation once, using an operationName from a previous invocation of CreateInstruction .

Declaration
public virtual Operation<Instruction, CreateInstructionMetadata> PollOnceCreateInstruction(string operationName, CallSettings callSettings = null)
Parameters
Type Name Description
System.String operationName

The name of a previously invoked operation. Must not be null or empty.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Operation<Instruction, CreateInstructionMetadata>

The result of polling the operation.

PollOnceCreateInstructionAsync(String, CallSettings)

Asynchronously poll an operation once, using an operationName from a previous invocation of CreateInstruction.

Declaration
public virtual Task<Operation<Instruction, CreateInstructionMetadata>> PollOnceCreateInstructionAsync(string operationName, CallSettings callSettings = null)
Parameters
Type Name Description
System.String operationName

The name of a previously invoked operation. Must not be null or empty.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task<Operation<Instruction, CreateInstructionMetadata>>

A task representing the result of polling the operation.

PollOnceExportData(String, CallSettings)

Poll an operation once, using an operationName from a previous invocation of ExportData.

Declaration
public virtual Operation<ExportDataOperationResponse, ExportDataOperationMetadata> PollOnceExportData(string operationName, CallSettings callSettings = null)
Parameters
Type Name Description
System.String operationName

The name of a previously invoked operation. Must not be null or empty.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Operation<ExportDataOperationResponse, ExportDataOperationMetadata>

The result of polling the operation.

PollOnceExportDataAsync(String, CallSettings)

Asynchronously poll an operation once, using an operationName from a previous invocation of ExportData.

Declaration
public virtual Task<Operation<ExportDataOperationResponse, ExportDataOperationMetadata>> PollOnceExportDataAsync(string operationName, CallSettings callSettings = null)
Parameters
Type Name Description
System.String operationName

The name of a previously invoked operation. Must not be null or empty.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task<Operation<ExportDataOperationResponse, ExportDataOperationMetadata>>

A task representing the result of polling the operation.

PollOnceImportData(String, CallSettings)

Poll an operation once, using an operationName from a previous invocation of ImportData.

Declaration
public virtual Operation<ImportDataOperationResponse, ImportDataOperationMetadata> PollOnceImportData(string operationName, CallSettings callSettings = null)
Parameters
Type Name Description
System.String operationName

The name of a previously invoked operation. Must not be null or empty.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Operation<ImportDataOperationResponse, ImportDataOperationMetadata>

The result of polling the operation.

PollOnceImportDataAsync(String, CallSettings)

Asynchronously poll an operation once, using an operationName from a previous invocation of ImportData.

Declaration
public virtual Task<Operation<ImportDataOperationResponse, ImportDataOperationMetadata>> PollOnceImportDataAsync(string operationName, CallSettings callSettings = null)
Parameters
Type Name Description
System.String operationName

The name of a previously invoked operation. Must not be null or empty.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task<Operation<ImportDataOperationResponse, ImportDataOperationMetadata>>

A task representing the result of polling the operation.

PollOnceLabelImage(String, CallSettings)

Poll an operation once, using an operationName from a previous invocation of LabelImage.

Declaration
public virtual Operation<AnnotatedDataset, LabelOperationMetadata> PollOnceLabelImage(string operationName, CallSettings callSettings = null)
Parameters
Type Name Description
System.String operationName

The name of a previously invoked operation. Must not be null or empty.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Operation<AnnotatedDataset, LabelOperationMetadata>

The result of polling the operation.

PollOnceLabelImageAsync(String, CallSettings)

Asynchronously poll an operation once, using an operationName from a previous invocation of LabelImage.

Declaration
public virtual Task<Operation<AnnotatedDataset, LabelOperationMetadata>> PollOnceLabelImageAsync(string operationName, CallSettings callSettings = null)
Parameters
Type Name Description
System.String operationName

The name of a previously invoked operation. Must not be null or empty.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task<Operation<AnnotatedDataset, LabelOperationMetadata>>

A task representing the result of polling the operation.

PollOnceLabelText(String, CallSettings)

Poll an operation once, using an operationName from a previous invocation of LabelText.

Declaration
public virtual Operation<AnnotatedDataset, LabelOperationMetadata> PollOnceLabelText(string operationName, CallSettings callSettings = null)
Parameters
Type Name Description
System.String operationName

The name of a previously invoked operation. Must not be null or empty.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Operation<AnnotatedDataset, LabelOperationMetadata>

The result of polling the operation.

PollOnceLabelTextAsync(String, CallSettings)

Asynchronously poll an operation once, using an operationName from a previous invocation of LabelText.

Declaration
public virtual Task<Operation<AnnotatedDataset, LabelOperationMetadata>> PollOnceLabelTextAsync(string operationName, CallSettings callSettings = null)
Parameters
Type Name Description
System.String operationName

The name of a previously invoked operation. Must not be null or empty.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task<Operation<AnnotatedDataset, LabelOperationMetadata>>

A task representing the result of polling the operation.

PollOnceLabelVideo(String, CallSettings)

Poll an operation once, using an operationName from a previous invocation of LabelVideo.

Declaration
public virtual Operation<AnnotatedDataset, LabelOperationMetadata> PollOnceLabelVideo(string operationName, CallSettings callSettings = null)
Parameters
Type Name Description
System.String operationName

The name of a previously invoked operation. Must not be null or empty.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Operation<AnnotatedDataset, LabelOperationMetadata>

The result of polling the operation.

PollOnceLabelVideoAsync(String, CallSettings)

Asynchronously poll an operation once, using an operationName from a previous invocation of LabelVideo.

Declaration
public virtual Task<Operation<AnnotatedDataset, LabelOperationMetadata>> PollOnceLabelVideoAsync(string operationName, CallSettings callSettings = null)
Parameters
Type Name Description
System.String operationName

The name of a previously invoked operation. Must not be null or empty.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task<Operation<AnnotatedDataset, LabelOperationMetadata>>

A task representing the result of polling the operation.

ResumeEvaluationJob(EvaluationJobName, CallSettings)

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

Declaration
public virtual void ResumeEvaluationJob(EvaluationJobName name, CallSettings callSettings = null)
Parameters
Type Name Description
EvaluationJobName name

Required. Name of the evaluation job that is going to be resumed. Format:

"projects/&lt;var&gt;{project_id}&lt;/var&gt;/evaluationJobs/&lt;var&gt;{evaluation_job_id}&lt;/var&gt;"

CallSettings callSettings

If not null, applies overrides to this RPC call.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.Create();
// Initialize request argument(s)
EvaluationJobName name = EvaluationJobName.FromProjectEvaluationJob("[PROJECT]", "[EVALUATION_JOB]");
// Make the request
dataLabelingServiceClient.ResumeEvaluationJob(name);

ResumeEvaluationJob(ResumeEvaluationJobRequest, CallSettings)

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

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

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

CallSettings callSettings

If not null, applies overrides to this RPC call.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.Create();
// Initialize request argument(s)
ResumeEvaluationJobRequest request = new ResumeEvaluationJobRequest
{
    EvaluationJobName = EvaluationJobName.FromProjectEvaluationJob("[PROJECT]", "[EVALUATION_JOB]"),
};
// Make the request
dataLabelingServiceClient.ResumeEvaluationJob(request);

ResumeEvaluationJob(String, CallSettings)

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

Declaration
public virtual void ResumeEvaluationJob(string name, CallSettings callSettings = null)
Parameters
Type Name Description
System.String name

Required. Name of the evaluation job that is going to be resumed. Format:

"projects/&lt;var&gt;{project_id}&lt;/var&gt;/evaluationJobs/&lt;var&gt;{evaluation_job_id}&lt;/var&gt;"

CallSettings callSettings

If not null, applies overrides to this RPC call.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/evaluationJobs/[EVALUATION_JOB]";
// Make the request
dataLabelingServiceClient.ResumeEvaluationJob(name);

ResumeEvaluationJobAsync(EvaluationJobName, CallSettings)

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

Declaration
public virtual Task ResumeEvaluationJobAsync(EvaluationJobName name, CallSettings callSettings = null)
Parameters
Type Name Description
EvaluationJobName name

Required. Name of the evaluation job that is going to be resumed. Format:

"projects/&lt;var&gt;{project_id}&lt;/var&gt;/evaluationJobs/&lt;var&gt;{evaluation_job_id}&lt;/var&gt;"

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
EvaluationJobName name = EvaluationJobName.FromProjectEvaluationJob("[PROJECT]", "[EVALUATION_JOB]");
// Make the request
await dataLabelingServiceClient.ResumeEvaluationJobAsync(name);

ResumeEvaluationJobAsync(EvaluationJobName, CancellationToken)

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

Declaration
public virtual Task ResumeEvaluationJobAsync(EvaluationJobName name, CancellationToken cancellationToken)
Parameters
Type Name Description
EvaluationJobName name

Required. Name of the evaluation job that is going to be resumed. Format:

"projects/&lt;var&gt;{project_id}&lt;/var&gt;/evaluationJobs/&lt;var&gt;{evaluation_job_id}&lt;/var&gt;"

System.Threading.CancellationToken cancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
Type Description
System.Threading.Tasks.Task

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
EvaluationJobName name = EvaluationJobName.FromProjectEvaluationJob("[PROJECT]", "[EVALUATION_JOB]");
// Make the request
await dataLabelingServiceClient.ResumeEvaluationJobAsync(name);

ResumeEvaluationJobAsync(ResumeEvaluationJobRequest, CallSettings)

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

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

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

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
ResumeEvaluationJobRequest request = new ResumeEvaluationJobRequest
{
    EvaluationJobName = EvaluationJobName.FromProjectEvaluationJob("[PROJECT]", "[EVALUATION_JOB]"),
};
// Make the request
await dataLabelingServiceClient.ResumeEvaluationJobAsync(request);

ResumeEvaluationJobAsync(ResumeEvaluationJobRequest, CancellationToken)

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

Declaration
public virtual Task ResumeEvaluationJobAsync(ResumeEvaluationJobRequest request, CancellationToken cancellationToken)
Parameters
Type Name Description
ResumeEvaluationJobRequest request

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

System.Threading.CancellationToken cancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
Type Description
System.Threading.Tasks.Task

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
ResumeEvaluationJobRequest request = new ResumeEvaluationJobRequest
{
    EvaluationJobName = EvaluationJobName.FromProjectEvaluationJob("[PROJECT]", "[EVALUATION_JOB]"),
};
// Make the request
await dataLabelingServiceClient.ResumeEvaluationJobAsync(request);

ResumeEvaluationJobAsync(String, CallSettings)

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

Declaration
public virtual Task ResumeEvaluationJobAsync(string name, CallSettings callSettings = null)
Parameters
Type Name Description
System.String name

Required. Name of the evaluation job that is going to be resumed. Format:

"projects/&lt;var&gt;{project_id}&lt;/var&gt;/evaluationJobs/&lt;var&gt;{evaluation_job_id}&lt;/var&gt;"

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/evaluationJobs/[EVALUATION_JOB]";
// Make the request
await dataLabelingServiceClient.ResumeEvaluationJobAsync(name);

ResumeEvaluationJobAsync(String, CancellationToken)

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

Declaration
public virtual Task ResumeEvaluationJobAsync(string name, CancellationToken cancellationToken)
Parameters
Type Name Description
System.String name

Required. Name of the evaluation job that is going to be resumed. Format:

"projects/&lt;var&gt;{project_id}&lt;/var&gt;/evaluationJobs/&lt;var&gt;{evaluation_job_id}&lt;/var&gt;"

System.Threading.CancellationToken cancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
Type Description
System.Threading.Tasks.Task

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/evaluationJobs/[EVALUATION_JOB]";
// Make the request
await dataLabelingServiceClient.ResumeEvaluationJobAsync(name);

SearchEvaluations(EvaluationName, String, String, Nullable<Int32>, CallSettings)

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

Declaration
public virtual PagedEnumerable<SearchEvaluationsResponse, Evaluation> SearchEvaluations(EvaluationName parent, string filter, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)
Parameters
Type Name Description
EvaluationName parent

Required. Evaluation search parent (project ID). Format: "projects/&lt;var&gt;{project_id}&lt;/var&gt;"

System.String filter

Optional. To search evaluations, you can filter by the following:

  • evaluation&lt;span&gt;_&lt;/span&gt;job.evaluation_job_id (the last part of [EvaluationJob.name][google.cloud.datalabeling.v1beta1.EvaluationJob.name])
  • evaluation&lt;span&gt;_&lt;/span&gt;job.model_id (the &lt;var&gt;{model_name}&lt;/var&gt; portion of [EvaluationJob.modelVersion][google.cloud.datalabeling.v1beta1.EvaluationJob.model_version])
  • evaluation&lt;span&gt;_&lt;/span&gt;job.evaluation_job_run_time_start (Minimum threshold for the [evaluationJobRunTime][google.cloud.datalabeling.v1beta1.Evaluation.evaluation_job_run_time] that created the evaluation)
  • evaluation&lt;span&gt;_&lt;/span&gt;job.evaluation_job_run_time_end (Maximum threshold for the [evaluationJobRunTime][google.cloud.datalabeling.v1beta1.Evaluation.evaluation_job_run_time] that created the evaluation)
  • evaluation&lt;span&gt;_&lt;/span&gt;job.job_state ([EvaluationJob.state][google.cloud.datalabeling.v1beta1.EvaluationJob.state])
  • annotation&lt;span&gt;_&lt;/span&gt;spec.display_name (the Evaluation contains a metric for the annotation spec with this [displayName][google.cloud.datalabeling.v1beta1.AnnotationSpec.display_name])

To filter by multiple critiera, use the AND operator or the OR operator. The following examples shows a string that filters by several critiera:

"evaluation&lt;span&gt;&lt;/span&gt;job.evaluation_job_id = &lt;var&gt;{evaluation_job_id}&lt;/var&gt; AND evaluation&lt;span&gt;&lt;/span&gt;job.model_id = &lt;var&gt;{model_name}&lt;/var&gt; AND evaluation&lt;span&gt;&lt;/span&gt;job.evaluation_job_run_time_start = &lt;var&gt;{timestamp_1}&lt;/var&gt; AND evaluation&lt;span&gt;&lt;/span&gt;job.evaluation_job_run_time_end = &lt;var&gt;{timestamp_2}&lt;/var&gt; AND annotation&lt;span&gt;_&lt;/span&gt;spec.display_name = &lt;var&gt;{display_name}&lt;/var&gt;"

System.String pageToken

The token returned from the previous request. A value of null or an empty string retrieves the first page.

System.Nullable<System.Int32> pageSize

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerable<SearchEvaluationsResponse, Evaluation>

A pageable sequence of Evaluation resources.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.Create();
// Initialize request argument(s)
EvaluationName parent = EvaluationName.FromProjectDatasetEvaluation("[PROJECT]", "[DATASET]", "[EVALUATION]");
string filter = "";
// Make the request
PagedEnumerable<SearchEvaluationsResponse, Evaluation> response = dataLabelingServiceClient.SearchEvaluations(parent, filter);

// Iterate over all response items, lazily performing RPCs as required
foreach (Evaluation item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (SearchEvaluationsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Evaluation item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Evaluation> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Evaluation item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

SearchEvaluations(SearchEvaluationsRequest, CallSettings)

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

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

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

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerable<SearchEvaluationsResponse, Evaluation>

A pageable sequence of Evaluation resources.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.Create();
// Initialize request argument(s)
SearchEvaluationsRequest request = new SearchEvaluationsRequest
{
    ParentAsEvaluationName = EvaluationName.FromProjectDatasetEvaluation("[PROJECT]", "[DATASET]", "[EVALUATION]"),
    Filter = "",
};
// Make the request
PagedEnumerable<SearchEvaluationsResponse, Evaluation> response = dataLabelingServiceClient.SearchEvaluations(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (Evaluation item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (SearchEvaluationsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Evaluation item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Evaluation> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Evaluation item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

SearchEvaluations(String, String, String, Nullable<Int32>, CallSettings)

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

Declaration
public virtual PagedEnumerable<SearchEvaluationsResponse, Evaluation> SearchEvaluations(string parent, string filter, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)
Parameters
Type Name Description
System.String parent

Required. Evaluation search parent (project ID). Format: "projects/&lt;var&gt;{project_id}&lt;/var&gt;"

System.String filter

Optional. To search evaluations, you can filter by the following:

  • evaluation&lt;span&gt;_&lt;/span&gt;job.evaluation_job_id (the last part of [EvaluationJob.name][google.cloud.datalabeling.v1beta1.EvaluationJob.name])
  • evaluation&lt;span&gt;_&lt;/span&gt;job.model_id (the &lt;var&gt;{model_name}&lt;/var&gt; portion of [EvaluationJob.modelVersion][google.cloud.datalabeling.v1beta1.EvaluationJob.model_version])
  • evaluation&lt;span&gt;_&lt;/span&gt;job.evaluation_job_run_time_start (Minimum threshold for the [evaluationJobRunTime][google.cloud.datalabeling.v1beta1.Evaluation.evaluation_job_run_time] that created the evaluation)
  • evaluation&lt;span&gt;_&lt;/span&gt;job.evaluation_job_run_time_end (Maximum threshold for the [evaluationJobRunTime][google.cloud.datalabeling.v1beta1.Evaluation.evaluation_job_run_time] that created the evaluation)
  • evaluation&lt;span&gt;_&lt;/span&gt;job.job_state ([EvaluationJob.state][google.cloud.datalabeling.v1beta1.EvaluationJob.state])
  • annotation&lt;span&gt;_&lt;/span&gt;spec.display_name (the Evaluation contains a metric for the annotation spec with this [displayName][google.cloud.datalabeling.v1beta1.AnnotationSpec.display_name])

To filter by multiple critiera, use the AND operator or the OR operator. The following examples shows a string that filters by several critiera:

"evaluation&lt;span&gt;&lt;/span&gt;job.evaluation_job_id = &lt;var&gt;{evaluation_job_id}&lt;/var&gt; AND evaluation&lt;span&gt;&lt;/span&gt;job.model_id = &lt;var&gt;{model_name}&lt;/var&gt; AND evaluation&lt;span&gt;&lt;/span&gt;job.evaluation_job_run_time_start = &lt;var&gt;{timestamp_1}&lt;/var&gt; AND evaluation&lt;span&gt;&lt;/span&gt;job.evaluation_job_run_time_end = &lt;var&gt;{timestamp_2}&lt;/var&gt; AND annotation&lt;span&gt;_&lt;/span&gt;spec.display_name = &lt;var&gt;{display_name}&lt;/var&gt;"

System.String pageToken

The token returned from the previous request. A value of null or an empty string retrieves the first page.

System.Nullable<System.Int32> pageSize

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerable<SearchEvaluationsResponse, Evaluation>

A pageable sequence of Evaluation resources.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/datasets/[DATASET]/evaluations/[EVALUATION]";
string filter = "";
// Make the request
PagedEnumerable<SearchEvaluationsResponse, Evaluation> response = dataLabelingServiceClient.SearchEvaluations(parent, filter);

// Iterate over all response items, lazily performing RPCs as required
foreach (Evaluation item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (SearchEvaluationsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Evaluation item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Evaluation> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Evaluation item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

SearchEvaluationsAsync(EvaluationName, String, String, Nullable<Int32>, CallSettings)

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

Declaration
public virtual PagedAsyncEnumerable<SearchEvaluationsResponse, Evaluation> SearchEvaluationsAsync(EvaluationName parent, string filter, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)
Parameters
Type Name Description
EvaluationName parent

Required. Evaluation search parent (project ID). Format: "projects/&lt;var&gt;{project_id}&lt;/var&gt;"

System.String filter

Optional. To search evaluations, you can filter by the following:

  • evaluation&lt;span&gt;_&lt;/span&gt;job.evaluation_job_id (the last part of [EvaluationJob.name][google.cloud.datalabeling.v1beta1.EvaluationJob.name])
  • evaluation&lt;span&gt;_&lt;/span&gt;job.model_id (the &lt;var&gt;{model_name}&lt;/var&gt; portion of [EvaluationJob.modelVersion][google.cloud.datalabeling.v1beta1.EvaluationJob.model_version])
  • evaluation&lt;span&gt;_&lt;/span&gt;job.evaluation_job_run_time_start (Minimum threshold for the [evaluationJobRunTime][google.cloud.datalabeling.v1beta1.Evaluation.evaluation_job_run_time] that created the evaluation)
  • evaluation&lt;span&gt;_&lt;/span&gt;job.evaluation_job_run_time_end (Maximum threshold for the [evaluationJobRunTime][google.cloud.datalabeling.v1beta1.Evaluation.evaluation_job_run_time] that created the evaluation)
  • evaluation&lt;span&gt;_&lt;/span&gt;job.job_state ([EvaluationJob.state][google.cloud.datalabeling.v1beta1.EvaluationJob.state])
  • annotation&lt;span&gt;_&lt;/span&gt;spec.display_name (the Evaluation contains a metric for the annotation spec with this [displayName][google.cloud.datalabeling.v1beta1.AnnotationSpec.display_name])

To filter by multiple critiera, use the AND operator or the OR operator. The following examples shows a string that filters by several critiera:

"evaluation&lt;span&gt;&lt;/span&gt;job.evaluation_job_id = &lt;var&gt;{evaluation_job_id}&lt;/var&gt; AND evaluation&lt;span&gt;&lt;/span&gt;job.model_id = &lt;var&gt;{model_name}&lt;/var&gt; AND evaluation&lt;span&gt;&lt;/span&gt;job.evaluation_job_run_time_start = &lt;var&gt;{timestamp_1}&lt;/var&gt; AND evaluation&lt;span&gt;&lt;/span&gt;job.evaluation_job_run_time_end = &lt;var&gt;{timestamp_2}&lt;/var&gt; AND annotation&lt;span&gt;_&lt;/span&gt;spec.display_name = &lt;var&gt;{display_name}&lt;/var&gt;"

System.String pageToken

The token returned from the previous request. A value of null or an empty string retrieves the first page.

System.Nullable<System.Int32> pageSize

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerable<SearchEvaluationsResponse, Evaluation>

A pageable asynchronous sequence of Evaluation resources.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
EvaluationName parent = EvaluationName.FromProjectDatasetEvaluation("[PROJECT]", "[DATASET]", "[EVALUATION]");
string filter = "";
// Make the request
PagedAsyncEnumerable<SearchEvaluationsResponse, Evaluation> response = dataLabelingServiceClient.SearchEvaluationsAsync(parent, filter);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Evaluation item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((SearchEvaluationsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Evaluation item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Evaluation> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Evaluation item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

SearchEvaluationsAsync(SearchEvaluationsRequest, CallSettings)

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

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

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

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerable<SearchEvaluationsResponse, Evaluation>

A pageable asynchronous sequence of Evaluation resources.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
SearchEvaluationsRequest request = new SearchEvaluationsRequest
{
    ParentAsEvaluationName = EvaluationName.FromProjectDatasetEvaluation("[PROJECT]", "[DATASET]", "[EVALUATION]"),
    Filter = "",
};
// Make the request
PagedAsyncEnumerable<SearchEvaluationsResponse, Evaluation> response = dataLabelingServiceClient.SearchEvaluationsAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Evaluation item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((SearchEvaluationsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Evaluation item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Evaluation> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Evaluation item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

SearchEvaluationsAsync(String, String, String, Nullable<Int32>, CallSettings)

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

Declaration
public virtual PagedAsyncEnumerable<SearchEvaluationsResponse, Evaluation> SearchEvaluationsAsync(string parent, string filter, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)
Parameters
Type Name Description
System.String parent

Required. Evaluation search parent (project ID). Format: "projects/&lt;var&gt;{project_id}&lt;/var&gt;"

System.String filter

Optional. To search evaluations, you can filter by the following:

  • evaluation&lt;span&gt;_&lt;/span&gt;job.evaluation_job_id (the last part of [EvaluationJob.name][google.cloud.datalabeling.v1beta1.EvaluationJob.name])
  • evaluation&lt;span&gt;_&lt;/span&gt;job.model_id (the &lt;var&gt;{model_name}&lt;/var&gt; portion of [EvaluationJob.modelVersion][google.cloud.datalabeling.v1beta1.EvaluationJob.model_version])
  • evaluation&lt;span&gt;_&lt;/span&gt;job.evaluation_job_run_time_start (Minimum threshold for the [evaluationJobRunTime][google.cloud.datalabeling.v1beta1.Evaluation.evaluation_job_run_time] that created the evaluation)
  • evaluation&lt;span&gt;_&lt;/span&gt;job.evaluation_job_run_time_end (Maximum threshold for the [evaluationJobRunTime][google.cloud.datalabeling.v1beta1.Evaluation.evaluation_job_run_time] that created the evaluation)
  • evaluation&lt;span&gt;_&lt;/span&gt;job.job_state ([EvaluationJob.state][google.cloud.datalabeling.v1beta1.EvaluationJob.state])
  • annotation&lt;span&gt;_&lt;/span&gt;spec.display_name (the Evaluation contains a metric for the annotation spec with this [displayName][google.cloud.datalabeling.v1beta1.AnnotationSpec.display_name])

To filter by multiple critiera, use the AND operator or the OR operator. The following examples shows a string that filters by several critiera:

"evaluation&lt;span&gt;&lt;/span&gt;job.evaluation_job_id = &lt;var&gt;{evaluation_job_id}&lt;/var&gt; AND evaluation&lt;span&gt;&lt;/span&gt;job.model_id = &lt;var&gt;{model_name}&lt;/var&gt; AND evaluation&lt;span&gt;&lt;/span&gt;job.evaluation_job_run_time_start = &lt;var&gt;{timestamp_1}&lt;/var&gt; AND evaluation&lt;span&gt;&lt;/span&gt;job.evaluation_job_run_time_end = &lt;var&gt;{timestamp_2}&lt;/var&gt; AND annotation&lt;span&gt;_&lt;/span&gt;spec.display_name = &lt;var&gt;{display_name}&lt;/var&gt;"

System.String pageToken

The token returned from the previous request. A value of null or an empty string retrieves the first page.

System.Nullable<System.Int32> pageSize

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerable<SearchEvaluationsResponse, Evaluation>

A pageable asynchronous sequence of Evaluation resources.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/datasets/[DATASET]/evaluations/[EVALUATION]";
string filter = "";
// Make the request
PagedAsyncEnumerable<SearchEvaluationsResponse, Evaluation> response = dataLabelingServiceClient.SearchEvaluationsAsync(parent, filter);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Evaluation item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((SearchEvaluationsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Evaluation item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Evaluation> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Evaluation item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

SearchExampleComparisons(EvaluationName, String, Nullable<Int32>, CallSettings)

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

Declaration
public virtual PagedEnumerable<SearchExampleComparisonsResponse, SearchExampleComparisonsResponse.Types.ExampleComparison> SearchExampleComparisons(EvaluationName parent, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)
Parameters
Type Name Description
EvaluationName parent

Required. Name of the [Evaluation][google.cloud.datalabeling.v1beta1.Evaluation] resource to search for example comparisons from. Format:

"projects/&lt;var&gt;{project_id}&lt;/var&gt;/datasets/&lt;var&gt;{dataset_id}&lt;/var&gt;/evaluations/&lt;var&gt;{evaluation_id}&lt;/var&gt;"

System.String pageToken

The token returned from the previous request. A value of null or an empty string retrieves the first page.

System.Nullable<System.Int32> pageSize

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerable<SearchExampleComparisonsResponse, SearchExampleComparisonsResponse.Types.ExampleComparison>

A pageable sequence of SearchExampleComparisonsResponse.Types.ExampleComparison resources.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.Create();
// Initialize request argument(s)
EvaluationName parent = EvaluationName.FromProjectDatasetEvaluation("[PROJECT]", "[DATASET]", "[EVALUATION]");
// Make the request
PagedEnumerable<SearchExampleComparisonsResponse, SearchExampleComparisonsResponse.Types.ExampleComparison> response = dataLabelingServiceClient.SearchExampleComparisons(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (SearchExampleComparisonsResponse.Types.ExampleComparison item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (SearchExampleComparisonsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (SearchExampleComparisonsResponse.Types.ExampleComparison item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<SearchExampleComparisonsResponse.Types.ExampleComparison> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (SearchExampleComparisonsResponse.Types.ExampleComparison item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

SearchExampleComparisons(SearchExampleComparisonsRequest, CallSettings)

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

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

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

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerable<SearchExampleComparisonsResponse, SearchExampleComparisonsResponse.Types.ExampleComparison>

A pageable sequence of SearchExampleComparisonsResponse.Types.ExampleComparison resources.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.Create();
// Initialize request argument(s)
SearchExampleComparisonsRequest request = new SearchExampleComparisonsRequest
{
    ParentAsEvaluationName = EvaluationName.FromProjectDatasetEvaluation("[PROJECT]", "[DATASET]", "[EVALUATION]"),
};
// Make the request
PagedEnumerable<SearchExampleComparisonsResponse, SearchExampleComparisonsResponse.Types.ExampleComparison> response = dataLabelingServiceClient.SearchExampleComparisons(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (SearchExampleComparisonsResponse.Types.ExampleComparison item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (SearchExampleComparisonsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (SearchExampleComparisonsResponse.Types.ExampleComparison item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<SearchExampleComparisonsResponse.Types.ExampleComparison> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (SearchExampleComparisonsResponse.Types.ExampleComparison item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

SearchExampleComparisons(String, String, Nullable<Int32>, CallSettings)

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

Declaration
public virtual PagedEnumerable<SearchExampleComparisonsResponse, SearchExampleComparisonsResponse.Types.ExampleComparison> SearchExampleComparisons(string parent, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)
Parameters
Type Name Description
System.String parent

Required. Name of the [Evaluation][google.cloud.datalabeling.v1beta1.Evaluation] resource to search for example comparisons from. Format:

"projects/&lt;var&gt;{project_id}&lt;/var&gt;/datasets/&lt;var&gt;{dataset_id}&lt;/var&gt;/evaluations/&lt;var&gt;{evaluation_id}&lt;/var&gt;"

System.String pageToken

The token returned from the previous request. A value of null or an empty string retrieves the first page.

System.Nullable<System.Int32> pageSize

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerable<SearchExampleComparisonsResponse, SearchExampleComparisonsResponse.Types.ExampleComparison>

A pageable sequence of SearchExampleComparisonsResponse.Types.ExampleComparison resources.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/datasets/[DATASET]/evaluations/[EVALUATION]";
// Make the request
PagedEnumerable<SearchExampleComparisonsResponse, SearchExampleComparisonsResponse.Types.ExampleComparison> response = dataLabelingServiceClient.SearchExampleComparisons(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (SearchExampleComparisonsResponse.Types.ExampleComparison item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (SearchExampleComparisonsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (SearchExampleComparisonsResponse.Types.ExampleComparison item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<SearchExampleComparisonsResponse.Types.ExampleComparison> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (SearchExampleComparisonsResponse.Types.ExampleComparison item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

SearchExampleComparisonsAsync(EvaluationName, String, Nullable<Int32>, CallSettings)

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

Declaration
public virtual PagedAsyncEnumerable<SearchExampleComparisonsResponse, SearchExampleComparisonsResponse.Types.ExampleComparison> SearchExampleComparisonsAsync(EvaluationName parent, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)
Parameters
Type Name Description
EvaluationName parent

Required. Name of the [Evaluation][google.cloud.datalabeling.v1beta1.Evaluation] resource to search for example comparisons from. Format:

"projects/&lt;var&gt;{project_id}&lt;/var&gt;/datasets/&lt;var&gt;{dataset_id}&lt;/var&gt;/evaluations/&lt;var&gt;{evaluation_id}&lt;/var&gt;"

System.String pageToken

The token returned from the previous request. A value of null or an empty string retrieves the first page.

System.Nullable<System.Int32> pageSize

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerable<SearchExampleComparisonsResponse, SearchExampleComparisonsResponse.Types.ExampleComparison>

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

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
EvaluationName parent = EvaluationName.FromProjectDatasetEvaluation("[PROJECT]", "[DATASET]", "[EVALUATION]");
// Make the request
PagedAsyncEnumerable<SearchExampleComparisonsResponse, SearchExampleComparisonsResponse.Types.ExampleComparison> response = dataLabelingServiceClient.SearchExampleComparisonsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((SearchExampleComparisonsResponse.Types.ExampleComparison item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((SearchExampleComparisonsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (SearchExampleComparisonsResponse.Types.ExampleComparison item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<SearchExampleComparisonsResponse.Types.ExampleComparison> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (SearchExampleComparisonsResponse.Types.ExampleComparison item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

SearchExampleComparisonsAsync(SearchExampleComparisonsRequest, CallSettings)

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

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

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

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerable<SearchExampleComparisonsResponse, SearchExampleComparisonsResponse.Types.ExampleComparison>

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

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
SearchExampleComparisonsRequest request = new SearchExampleComparisonsRequest
{
    ParentAsEvaluationName = EvaluationName.FromProjectDatasetEvaluation("[PROJECT]", "[DATASET]", "[EVALUATION]"),
};
// Make the request
PagedAsyncEnumerable<SearchExampleComparisonsResponse, SearchExampleComparisonsResponse.Types.ExampleComparison> response = dataLabelingServiceClient.SearchExampleComparisonsAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((SearchExampleComparisonsResponse.Types.ExampleComparison item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((SearchExampleComparisonsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (SearchExampleComparisonsResponse.Types.ExampleComparison item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<SearchExampleComparisonsResponse.Types.ExampleComparison> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (SearchExampleComparisonsResponse.Types.ExampleComparison item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

SearchExampleComparisonsAsync(String, String, Nullable<Int32>, CallSettings)

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

Declaration
public virtual PagedAsyncEnumerable<SearchExampleComparisonsResponse, SearchExampleComparisonsResponse.Types.ExampleComparison> SearchExampleComparisonsAsync(string parent, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)
Parameters
Type Name Description
System.String parent

Required. Name of the [Evaluation][google.cloud.datalabeling.v1beta1.Evaluation] resource to search for example comparisons from. Format:

"projects/&lt;var&gt;{project_id}&lt;/var&gt;/datasets/&lt;var&gt;{dataset_id}&lt;/var&gt;/evaluations/&lt;var&gt;{evaluation_id}&lt;/var&gt;"

System.String pageToken

The token returned from the previous request. A value of null or an empty string retrieves the first page.

System.Nullable<System.Int32> pageSize

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerable<SearchExampleComparisonsResponse, SearchExampleComparisonsResponse.Types.ExampleComparison>

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

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/datasets/[DATASET]/evaluations/[EVALUATION]";
// Make the request
PagedAsyncEnumerable<SearchExampleComparisonsResponse, SearchExampleComparisonsResponse.Types.ExampleComparison> response = dataLabelingServiceClient.SearchExampleComparisonsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((SearchExampleComparisonsResponse.Types.ExampleComparison item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((SearchExampleComparisonsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (SearchExampleComparisonsResponse.Types.ExampleComparison item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<SearchExampleComparisonsResponse.Types.ExampleComparison> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (SearchExampleComparisonsResponse.Types.ExampleComparison item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ShutdownDefaultChannelsAsync()

Shuts down any channels automatically created by Create() and CreateAsync(CancellationToken). Channels which weren't automatically created are not affected.

Declaration
public static Task ShutdownDefaultChannelsAsync()
Returns
Type Description
System.Threading.Tasks.Task

A task representing the asynchronous shutdown operation.

Remarks

After calling this method, further calls to Create() and CreateAsync(CancellationToken) will create new channels, which could in turn be shut down by another call to this method.

UpdateEvaluationJob(EvaluationJob, FieldMask, CallSettings)

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

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

Declaration
public virtual EvaluationJob UpdateEvaluationJob(EvaluationJob evaluationJob, FieldMask updateMask, CallSettings callSettings = null)
Parameters
Type Name Description
EvaluationJob evaluationJob

Required. Evaluation job that is going to be updated.

FieldMask updateMask

Optional. Mask for which fields to update. You can only provide the following fields:

  • evaluationJobConfig.humanAnnotationConfig.instruction
  • evaluationJobConfig.exampleCount
  • evaluationJobConfig.exampleSamplePercentage

You can provide more than one of these fields by separating them with commas.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
EvaluationJob

The RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.Create();
// Initialize request argument(s)
EvaluationJob evaluationJob = new EvaluationJob();
FieldMask updateMask = new FieldMask();
// Make the request
EvaluationJob response = dataLabelingServiceClient.UpdateEvaluationJob(evaluationJob, updateMask);

UpdateEvaluationJob(UpdateEvaluationJobRequest, CallSettings)

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

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

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

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

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
EvaluationJob

The RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.Create();
// Initialize request argument(s)
UpdateEvaluationJobRequest request = new UpdateEvaluationJobRequest
{
    EvaluationJob = new EvaluationJob(),
    UpdateMask = new FieldMask(),
};
// Make the request
EvaluationJob response = dataLabelingServiceClient.UpdateEvaluationJob(request);

UpdateEvaluationJobAsync(EvaluationJob, FieldMask, CallSettings)

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

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

Declaration
public virtual Task<EvaluationJob> UpdateEvaluationJobAsync(EvaluationJob evaluationJob, FieldMask updateMask, CallSettings callSettings = null)
Parameters
Type Name Description
EvaluationJob evaluationJob

Required. Evaluation job that is going to be updated.

FieldMask updateMask

Optional. Mask for which fields to update. You can only provide the following fields:

  • evaluationJobConfig.humanAnnotationConfig.instruction
  • evaluationJobConfig.exampleCount
  • evaluationJobConfig.exampleSamplePercentage

You can provide more than one of these fields by separating them with commas.

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task<EvaluationJob>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
EvaluationJob evaluationJob = new EvaluationJob();
FieldMask updateMask = new FieldMask();
// Make the request
EvaluationJob response = await dataLabelingServiceClient.UpdateEvaluationJobAsync(evaluationJob, updateMask);

UpdateEvaluationJobAsync(EvaluationJob, FieldMask, CancellationToken)

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

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

Declaration
public virtual Task<EvaluationJob> UpdateEvaluationJobAsync(EvaluationJob evaluationJob, FieldMask updateMask, CancellationToken cancellationToken)
Parameters
Type Name Description
EvaluationJob evaluationJob

Required. Evaluation job that is going to be updated.

FieldMask updateMask

Optional. Mask for which fields to update. You can only provide the following fields:

  • evaluationJobConfig.humanAnnotationConfig.instruction
  • evaluationJobConfig.exampleCount
  • evaluationJobConfig.exampleSamplePercentage

You can provide more than one of these fields by separating them with commas.

System.Threading.CancellationToken cancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
Type Description
System.Threading.Tasks.Task<EvaluationJob>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
EvaluationJob evaluationJob = new EvaluationJob();
FieldMask updateMask = new FieldMask();
// Make the request
EvaluationJob response = await dataLabelingServiceClient.UpdateEvaluationJobAsync(evaluationJob, updateMask);

UpdateEvaluationJobAsync(UpdateEvaluationJobRequest, CallSettings)

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

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

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

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

CallSettings callSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task<EvaluationJob>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateEvaluationJobRequest request = new UpdateEvaluationJobRequest
{
    EvaluationJob = new EvaluationJob(),
    UpdateMask = new FieldMask(),
};
// Make the request
EvaluationJob response = await dataLabelingServiceClient.UpdateEvaluationJobAsync(request);

UpdateEvaluationJobAsync(UpdateEvaluationJobRequest, CancellationToken)

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

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

Declaration
public virtual Task<EvaluationJob> UpdateEvaluationJobAsync(UpdateEvaluationJobRequest request, CancellationToken cancellationToken)
Parameters
Type Name Description
UpdateEvaluationJobRequest request

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

System.Threading.CancellationToken cancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
Type Description
System.Threading.Tasks.Task<EvaluationJob>

A Task containing the RPC response.

Sample code
// Create client
DataLabelingServiceClient dataLabelingServiceClient = await DataLabelingServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateEvaluationJobRequest request = new UpdateEvaluationJobRequest
{
    EvaluationJob = new EvaluationJob(),
    UpdateMask = new FieldMask(),
};
// Make the request
EvaluationJob response = await dataLabelingServiceClient.UpdateEvaluationJobAsync(request);
Back to top