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

public abstract class DataLabelingServiceClient

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

DataLabelingService client wrapper, for convenient use.

Inheritance

object > DataLabelingServiceClient

Namespace

Google.Cloud.DataLabeling.V1Beta1

Assembly

Google.Cloud.DataLabeling.V1Beta1.dll

Remarks

Service for the AI Platform Data Labeling API.

Properties

CreateInstructionOperationsClient

public virtual OperationsClient CreateInstructionOperationsClient { get; }

The long-running operations client for CreateInstruction.

Property Value
Type Description
OperationsClient

DefaultEndpoint

public static string DefaultEndpoint { get; }

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

Property Value
Type Description
string

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default DataLabelingService scopes.

Property Value
Type Description
IReadOnlyListstring
Remarks

The default DataLabelingService scopes are:

ExportDataOperationsClient

public virtual OperationsClient ExportDataOperationsClient { get; }

The long-running operations client for ExportData.

Property Value
Type Description
OperationsClient

GrpcClient

public virtual DataLabelingService.DataLabelingServiceClient GrpcClient { get; }

The underlying gRPC DataLabelingService client

Property Value
Type Description
DataLabelingServiceDataLabelingServiceClient

ImportDataOperationsClient

public virtual OperationsClient ImportDataOperationsClient { get; }

The long-running operations client for ImportData.

Property Value
Type Description
OperationsClient

LabelImageOperationsClient

public virtual OperationsClient LabelImageOperationsClient { get; }

The long-running operations client for LabelImage.

Property Value
Type Description
OperationsClient

LabelTextOperationsClient

public virtual OperationsClient LabelTextOperationsClient { get; }

The long-running operations client for LabelText.

Property Value
Type Description
OperationsClient

LabelVideoOperationsClient

public virtual OperationsClient LabelVideoOperationsClient { get; }

The long-running operations client for LabelVideo.

Property Value
Type Description
OperationsClient

ServiceMetadata

public static ServiceMetadata ServiceMetadata { get; }

The service metadata associated with this client type.

Property Value
Type Description
ServiceMetadata

Methods

Create()

public static DataLabelingServiceClient Create()

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

Returns
Type Description
DataLabelingServiceClient

The created DataLabelingServiceClient.

CreateAnnotationSpecSet(ProjectName, AnnotationSpecSet, CallSettings)

public virtual AnnotationSpecSet CreateAnnotationSpecSet(ProjectName parent, AnnotationSpecSet annotationSpecSet, CallSettings callSettings = null)

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

Parameters
Name Description
parent ProjectName

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.

Example
// 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)

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

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

Parameters
Name Description
request CreateAnnotationSpecSetRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
AnnotationSpecSet

The RPC response.

Example
// 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)

public virtual AnnotationSpecSet CreateAnnotationSpecSet(string parent, AnnotationSpecSet annotationSpecSet, CallSettings callSettings = null)

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

Parameters
Name Description
parent string

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.

Example
// 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)

public virtual Task<AnnotationSpecSet> CreateAnnotationSpecSetAsync(ProjectName parent, AnnotationSpecSet annotationSpecSet, CallSettings callSettings = null)

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

Parameters
Name Description
parent ProjectName

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
TaskAnnotationSpecSet

A Task containing the RPC response.

Example
// 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)

public virtual Task<AnnotationSpecSet> CreateAnnotationSpecSetAsync(ProjectName parent, AnnotationSpecSet annotationSpecSet, CancellationToken cancellationToken)

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

Parameters
Name Description
parent ProjectName

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.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskAnnotationSpecSet

A Task containing the RPC response.

Example
// 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)

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

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

Parameters
Name Description
request CreateAnnotationSpecSetRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskAnnotationSpecSet

A Task containing the RPC response.

Example
// 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)

public virtual Task<AnnotationSpecSet> CreateAnnotationSpecSetAsync(CreateAnnotationSpecSetRequest request, CancellationToken cancellationToken)

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

Parameters
Name Description
request CreateAnnotationSpecSetRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskAnnotationSpecSet

A Task containing the RPC response.

Example
// 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)

public virtual Task<AnnotationSpecSet> CreateAnnotationSpecSetAsync(string parent, AnnotationSpecSet annotationSpecSet, CallSettings callSettings = null)

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

Parameters
Name Description
parent string

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
TaskAnnotationSpecSet

A Task containing the RPC response.

Example
// 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)

public virtual Task<AnnotationSpecSet> CreateAnnotationSpecSetAsync(string parent, AnnotationSpecSet annotationSpecSet, CancellationToken cancellationToken)

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

Parameters
Name Description
parent string

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.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskAnnotationSpecSet

A Task containing the RPC response.

Example
// 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)

public static Task<DataLabelingServiceClient> CreateAsync(CancellationToken cancellationToken = default)

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

Parameter
Name Description
cancellationToken CancellationToken

The CancellationToken to use while creating the client.

Returns
Type Description
TaskDataLabelingServiceClient

The task representing the created DataLabelingServiceClient.

CreateDataset(ProjectName, Dataset, CallSettings)

public virtual Dataset CreateDataset(ProjectName parent, Dataset dataset, CallSettings callSettings = null)

Creates dataset. If success return a Dataset resource.

Parameters
Name Description
parent ProjectName

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.

Example
// 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)

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

Creates dataset. If success return a Dataset resource.

Parameters
Name Description
request CreateDatasetRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Dataset

The RPC response.

Example
// 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)

public virtual Dataset CreateDataset(string parent, Dataset dataset, CallSettings callSettings = null)

Creates dataset. If success return a Dataset resource.

Parameters
Name Description
parent string

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.

Example
// 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)

public virtual Task<Dataset> CreateDatasetAsync(ProjectName parent, Dataset dataset, CallSettings callSettings = null)

Creates dataset. If success return a Dataset resource.

Parameters
Name Description
parent ProjectName

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
TaskDataset

A Task containing the RPC response.

Example
// 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)

public virtual Task<Dataset> CreateDatasetAsync(ProjectName parent, Dataset dataset, CancellationToken cancellationToken)

Creates dataset. If success return a Dataset resource.

Parameters
Name Description
parent ProjectName

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

dataset Dataset

Required. The dataset to be created.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskDataset

A Task containing the RPC response.

Example
// 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)

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

Creates dataset. If success return a Dataset resource.

Parameters
Name Description
request CreateDatasetRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskDataset

A Task containing the RPC response.

Example
// 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)

public virtual Task<Dataset> CreateDatasetAsync(CreateDatasetRequest request, CancellationToken cancellationToken)

Creates dataset. If success return a Dataset resource.

Parameters
Name Description
request CreateDatasetRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskDataset

A Task containing the RPC response.

Example
// 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)

public virtual Task<Dataset> CreateDatasetAsync(string parent, Dataset dataset, CallSettings callSettings = null)

Creates dataset. If success return a Dataset resource.

Parameters
Name Description
parent string

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
TaskDataset

A Task containing the RPC response.

Example
// 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)

public virtual Task<Dataset> CreateDatasetAsync(string parent, Dataset dataset, CancellationToken cancellationToken)

Creates dataset. If success return a Dataset resource.

Parameters
Name Description
parent string

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

dataset Dataset

Required. The dataset to be created.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskDataset

A Task containing the RPC response.

Example
// 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)

public virtual EvaluationJob CreateEvaluationJob(ProjectName parent, EvaluationJob job, CallSettings callSettings = null)

Creates an evaluation job.

Parameters
Name Description
parent ProjectName

Required. Evaluation job resource parent. Format: "projects/<var>{project_id}</var>"

job EvaluationJob

Required. The evaluation job to create.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
EvaluationJob

The RPC response.

Example
// 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)

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

Creates an evaluation job.

Parameters
Name Description
request CreateEvaluationJobRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
EvaluationJob

The RPC response.

Example
// 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)

public virtual EvaluationJob CreateEvaluationJob(string parent, EvaluationJob job, CallSettings callSettings = null)

Creates an evaluation job.

Parameters
Name Description
parent string

Required. Evaluation job resource parent. Format: "projects/<var>{project_id}</var>"

job EvaluationJob

Required. The evaluation job to create.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
EvaluationJob

The RPC response.

Example
// 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)

public virtual Task<EvaluationJob> CreateEvaluationJobAsync(ProjectName parent, EvaluationJob job, CallSettings callSettings = null)

Creates an evaluation job.

Parameters
Name Description
parent ProjectName

Required. Evaluation job resource parent. Format: "projects/<var>{project_id}</var>"

job EvaluationJob

Required. The evaluation job to create.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskEvaluationJob

A Task containing the RPC response.

Example
// 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)

public virtual Task<EvaluationJob> CreateEvaluationJobAsync(ProjectName parent, EvaluationJob job, CancellationToken cancellationToken)

Creates an evaluation job.

Parameters
Name Description
parent ProjectName

Required. Evaluation job resource parent. Format: "projects/<var>{project_id}</var>"

job EvaluationJob

Required. The evaluation job to create.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskEvaluationJob

A Task containing the RPC response.

Example
// 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)

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

Creates an evaluation job.

Parameters
Name Description
request CreateEvaluationJobRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskEvaluationJob

A Task containing the RPC response.

Example
// 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)

public virtual Task<EvaluationJob> CreateEvaluationJobAsync(CreateEvaluationJobRequest request, CancellationToken cancellationToken)

Creates an evaluation job.

Parameters
Name Description
request CreateEvaluationJobRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskEvaluationJob

A Task containing the RPC response.

Example
// 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)

public virtual Task<EvaluationJob> CreateEvaluationJobAsync(string parent, EvaluationJob job, CallSettings callSettings = null)

Creates an evaluation job.

Parameters
Name Description
parent string

Required. Evaluation job resource parent. Format: "projects/<var>{project_id}</var>"

job EvaluationJob

Required. The evaluation job to create.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskEvaluationJob

A Task containing the RPC response.

Example
// 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)

public virtual Task<EvaluationJob> CreateEvaluationJobAsync(string parent, EvaluationJob job, CancellationToken cancellationToken)

Creates an evaluation job.

Parameters
Name Description
parent string

Required. Evaluation job resource parent. Format: "projects/<var>{project_id}</var>"

job EvaluationJob

Required. The evaluation job to create.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskEvaluationJob

A Task containing the RPC response.

Example
// 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)

public virtual Operation<Instruction, CreateInstructionMetadata> CreateInstruction(ProjectName parent, Instruction instruction, CallSettings callSettings = null)

Creates an instruction for how data should be labeled.

Parameters
Name Description
parent ProjectName

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
OperationInstructionCreateInstructionMetadata

The RPC response.

Example
// 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)

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

Creates an instruction for how data should be labeled.

Parameters
Name Description
request CreateInstructionRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationInstructionCreateInstructionMetadata

The RPC response.

Example
// 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)

public virtual Operation<Instruction, CreateInstructionMetadata> CreateInstruction(string parent, Instruction instruction, CallSettings callSettings = null)

Creates an instruction for how data should be labeled.

Parameters
Name Description
parent string

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
OperationInstructionCreateInstructionMetadata

The RPC response.

Example
// 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)

public virtual Task<Operation<Instruction, CreateInstructionMetadata>> CreateInstructionAsync(ProjectName parent, Instruction instruction, CallSettings callSettings = null)

Creates an instruction for how data should be labeled.

Parameters
Name Description
parent ProjectName

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
TaskOperationInstructionCreateInstructionMetadata

A Task containing the RPC response.

Example
// 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)

public virtual Task<Operation<Instruction, CreateInstructionMetadata>> CreateInstructionAsync(ProjectName parent, Instruction instruction, CancellationToken cancellationToken)

Creates an instruction for how data should be labeled.

Parameters
Name Description
parent ProjectName

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

instruction Instruction

Required. Instruction of how to perform the labeling task.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationInstructionCreateInstructionMetadata

A Task containing the RPC response.

Example
// 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)

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

Creates an instruction for how data should be labeled.

Parameters
Name Description
request CreateInstructionRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationInstructionCreateInstructionMetadata

A Task containing the RPC response.

Example
// 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)

public virtual Task<Operation<Instruction, CreateInstructionMetadata>> CreateInstructionAsync(CreateInstructionRequest request, CancellationToken cancellationToken)

Creates an instruction for how data should be labeled.

Parameters
Name Description
request CreateInstructionRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationInstructionCreateInstructionMetadata

A Task containing the RPC response.

Example
// 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)

public virtual Task<Operation<Instruction, CreateInstructionMetadata>> CreateInstructionAsync(string parent, Instruction instruction, CallSettings callSettings = null)

Creates an instruction for how data should be labeled.

Parameters
Name Description
parent string

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
TaskOperationInstructionCreateInstructionMetadata

A Task containing the RPC response.

Example
// 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)

public virtual Task<Operation<Instruction, CreateInstructionMetadata>> CreateInstructionAsync(string parent, Instruction instruction, CancellationToken cancellationToken)

Creates an instruction for how data should be labeled.

Parameters
Name Description
parent string

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

instruction Instruction

Required. Instruction of how to perform the labeling task.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationInstructionCreateInstructionMetadata

A Task containing the RPC response.

Example
// 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)

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

Deletes an annotated dataset by resource name.

Parameters
Name Description
request DeleteAnnotatedDatasetRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Example
// 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)

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

Deletes an annotated dataset by resource name.

Parameters
Name Description
request DeleteAnnotatedDatasetRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// 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)

public virtual Task DeleteAnnotatedDatasetAsync(DeleteAnnotatedDatasetRequest request, CancellationToken cancellationToken)

Deletes an annotated dataset by resource name.

Parameters
Name Description
request DeleteAnnotatedDatasetRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// 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)

public virtual void DeleteAnnotationSpecSet(AnnotationSpecSetName name, CallSettings callSettings = null)

Deletes an annotation spec set by resource name.

Parameters
Name Description
name AnnotationSpecSetName

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Example
// 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)

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

Deletes an annotation spec set by resource name.

Parameters
Name Description
request DeleteAnnotationSpecSetRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Example
// 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)

public virtual void DeleteAnnotationSpecSet(string name, CallSettings callSettings = null)

Deletes an annotation spec set by resource name.

Parameters
Name Description
name string

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Example
// 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)

public virtual Task DeleteAnnotationSpecSetAsync(AnnotationSpecSetName name, CallSettings callSettings = null)

Deletes an annotation spec set by resource name.

Parameters
Name Description
name AnnotationSpecSetName

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
Task

A Task containing the RPC response.

Example
// 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)

public virtual Task DeleteAnnotationSpecSetAsync(AnnotationSpecSetName name, CancellationToken cancellationToken)

Deletes an annotation spec set by resource name.

Parameters
Name Description
name AnnotationSpecSetName

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// 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)

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

Deletes an annotation spec set by resource name.

Parameters
Name Description
request DeleteAnnotationSpecSetRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// 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)

public virtual Task DeleteAnnotationSpecSetAsync(DeleteAnnotationSpecSetRequest request, CancellationToken cancellationToken)

Deletes an annotation spec set by resource name.

Parameters
Name Description
request DeleteAnnotationSpecSetRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// 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)

public virtual Task DeleteAnnotationSpecSetAsync(string name, CallSettings callSettings = null)

Deletes an annotation spec set by resource name.

Parameters
Name Description
name string

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
Task

A Task containing the RPC response.

Example
// 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)

public virtual Task DeleteAnnotationSpecSetAsync(string name, CancellationToken cancellationToken)

Deletes an annotation spec set by resource name.

Parameters
Name Description
name string

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// 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)

public virtual void DeleteDataset(DatasetName name, CallSettings callSettings = null)

Deletes a dataset by resource name.

Parameters
Name Description
name DatasetName

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Example
// 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)

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

Deletes a dataset by resource name.

Parameters
Name Description
request DeleteDatasetRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Example
// 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)

public virtual void DeleteDataset(string name, CallSettings callSettings = null)

Deletes a dataset by resource name.

Parameters
Name Description
name string

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Example
// 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)

public virtual Task DeleteDatasetAsync(DatasetName name, CallSettings callSettings = null)

Deletes a dataset by resource name.

Parameters
Name Description
name DatasetName

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
Task

A Task containing the RPC response.

Example
// 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)

public virtual Task DeleteDatasetAsync(DatasetName name, CancellationToken cancellationToken)

Deletes a dataset by resource name.

Parameters
Name Description
name DatasetName

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// 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)

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

Deletes a dataset by resource name.

Parameters
Name Description
request DeleteDatasetRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// 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)

public virtual Task DeleteDatasetAsync(DeleteDatasetRequest request, CancellationToken cancellationToken)

Deletes a dataset by resource name.

Parameters
Name Description
request DeleteDatasetRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// 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)

public virtual Task DeleteDatasetAsync(string name, CallSettings callSettings = null)

Deletes a dataset by resource name.

Parameters
Name Description
name string

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
Task

A Task containing the RPC response.

Example
// 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)

public virtual Task DeleteDatasetAsync(string name, CancellationToken cancellationToken)

Deletes a dataset by resource name.

Parameters
Name Description
name string

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// 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)

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

Stops and deletes an evaluation job.

Parameters
Name Description
request DeleteEvaluationJobRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Example
// 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)

public virtual void DeleteEvaluationJob(EvaluationJobName name, CallSettings callSettings = null)

Stops and deletes an evaluation job.

Parameters
Name Description
name EvaluationJobName

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

"projects/<var>{project_id}</var>/evaluationJobs/<var>{evaluation_job_id}</var>"

callSettings CallSettings

If not null, applies overrides to this RPC call.

Example
// 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)

public virtual void DeleteEvaluationJob(string name, CallSettings callSettings = null)

Stops and deletes an evaluation job.

Parameters
Name Description
name string

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

"projects/<var>{project_id}</var>/evaluationJobs/<var>{evaluation_job_id}</var>"

callSettings CallSettings

If not null, applies overrides to this RPC call.

Example
// 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)

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

Stops and deletes an evaluation job.

Parameters
Name Description
request DeleteEvaluationJobRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// 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)

public virtual Task DeleteEvaluationJobAsync(DeleteEvaluationJobRequest request, CancellationToken cancellationToken)

Stops and deletes an evaluation job.

Parameters
Name Description
request DeleteEvaluationJobRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// 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)

public virtual Task DeleteEvaluationJobAsync(EvaluationJobName name, CallSettings callSettings = null)

Stops and deletes an evaluation job.

Parameters
Name Description
name EvaluationJobName

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

"projects/<var>{project_id}</var>/evaluationJobs/<var>{evaluation_job_id}</var>"

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// 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)

public virtual Task DeleteEvaluationJobAsync(EvaluationJobName name, CancellationToken cancellationToken)

Stops and deletes an evaluation job.

Parameters
Name Description
name EvaluationJobName

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

"projects/<var>{project_id}</var>/evaluationJobs/<var>{evaluation_job_id}</var>"

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// 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)

public virtual Task DeleteEvaluationJobAsync(string name, CallSettings callSettings = null)

Stops and deletes an evaluation job.

Parameters
Name Description
name string

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

"projects/<var>{project_id}</var>/evaluationJobs/<var>{evaluation_job_id}</var>"

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// 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)

public virtual Task DeleteEvaluationJobAsync(string name, CancellationToken cancellationToken)

Stops and deletes an evaluation job.

Parameters
Name Description
name string

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

"projects/<var>{project_id}</var>/evaluationJobs/<var>{evaluation_job_id}</var>"

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// 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)

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

Deletes an instruction object by resource name.

Parameters
Name Description
request DeleteInstructionRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Example
// 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)

public virtual void DeleteInstruction(InstructionName name, CallSettings callSettings = null)

Deletes an instruction object by resource name.

Parameters
Name Description
name InstructionName

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Example
// 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)

public virtual void DeleteInstruction(string name, CallSettings callSettings = null)

Deletes an instruction object by resource name.

Parameters
Name Description
name string

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Example
// 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)

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

Deletes an instruction object by resource name.

Parameters
Name Description
request DeleteInstructionRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// 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)

public virtual Task DeleteInstructionAsync(DeleteInstructionRequest request, CancellationToken cancellationToken)

Deletes an instruction object by resource name.

Parameters
Name Description
request DeleteInstructionRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// 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)

public virtual Task DeleteInstructionAsync(InstructionName name, CallSettings callSettings = null)

Deletes an instruction object by resource name.

Parameters
Name Description
name InstructionName

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
Task

A Task containing the RPC response.

Example
// 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)

public virtual Task DeleteInstructionAsync(InstructionName name, CancellationToken cancellationToken)

Deletes an instruction object by resource name.

Parameters
Name Description
name InstructionName

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// 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)

public virtual Task DeleteInstructionAsync(string name, CallSettings callSettings = null)

Deletes an instruction object by resource name.

Parameters
Name Description
name string

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
Task

A Task containing the RPC response.

Example
// 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)

public virtual Task DeleteInstructionAsync(string name, CancellationToken cancellationToken)

Deletes an instruction object by resource name.

Parameters
Name Description
name string

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// 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)

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

Exports data and annotations from dataset.

Parameters
Name Description
name DatasetName

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

annotatedDataset AnnotatedDatasetName

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}

filter string

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
OperationExportDataOperationResponseExportDataOperationMetadata

The RPC response.

Example
// 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)

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

Exports data and annotations from dataset.

Parameters
Name Description
request ExportDataRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationExportDataOperationResponseExportDataOperationMetadata

The RPC response.

Example
// 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)

public virtual Operation<ExportDataOperationResponse, ExportDataOperationMetadata> ExportData(string name, string annotatedDataset, string filter, OutputConfig outputConfig, CallSettings callSettings = null)

Exports data and annotations from dataset.

Parameters
Name Description
name string

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

annotatedDataset string

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}

filter string

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
OperationExportDataOperationResponseExportDataOperationMetadata

The RPC response.

Example
// 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)

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

Exports data and annotations from dataset.

Parameters
Name Description
name DatasetName

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

annotatedDataset AnnotatedDatasetName

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}

filter string

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
TaskOperationExportDataOperationResponseExportDataOperationMetadata

A Task containing the RPC response.

Example
// 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)

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

Exports data and annotations from dataset.

Parameters
Name Description
name DatasetName

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

annotatedDataset AnnotatedDatasetName

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}

filter string

Optional. Filter is not supported at this moment.

outputConfig OutputConfig

Required. Specify the output destination.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationExportDataOperationResponseExportDataOperationMetadata

A Task containing the RPC response.

Example
// 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)

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

Exports data and annotations from dataset.

Parameters
Name Description
request ExportDataRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationExportDataOperationResponseExportDataOperationMetadata

A Task containing the RPC response.

Example
// 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)

public virtual Task<Operation<ExportDataOperationResponse, ExportDataOperationMetadata>> ExportDataAsync(ExportDataRequest request, CancellationToken cancellationToken)

Exports data and annotations from dataset.

Parameters
Name Description
request ExportDataRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationExportDataOperationResponseExportDataOperationMetadata

A Task containing the RPC response.

Example
// 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)

public virtual Task<Operation<ExportDataOperationResponse, ExportDataOperationMetadata>> ExportDataAsync(string name, string annotatedDataset, string filter, OutputConfig outputConfig, CallSettings callSettings = null)

Exports data and annotations from dataset.

Parameters
Name Description
name string

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

annotatedDataset string

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}

filter string

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
TaskOperationExportDataOperationResponseExportDataOperationMetadata

A Task containing the RPC response.

Example
// 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)

public virtual Task<Operation<ExportDataOperationResponse, ExportDataOperationMetadata>> ExportDataAsync(string name, string annotatedDataset, string filter, OutputConfig outputConfig, CancellationToken cancellationToken)

Exports data and annotations from dataset.

Parameters
Name Description
name string

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

annotatedDataset string

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}

filter string

Optional. Filter is not supported at this moment.

outputConfig OutputConfig

Required. Specify the output destination.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationExportDataOperationResponseExportDataOperationMetadata

A Task containing the RPC response.

Example
// 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)

public virtual AnnotatedDataset GetAnnotatedDataset(AnnotatedDatasetName name, CallSettings callSettings = null)

Gets an annotated dataset by resource name.

Parameters
Name Description
name AnnotatedDatasetName

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.

Example
// 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)

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

Gets an annotated dataset by resource name.

Parameters
Name Description
request GetAnnotatedDatasetRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
AnnotatedDataset

The RPC response.

Example
// 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)

public virtual AnnotatedDataset GetAnnotatedDataset(string name, CallSettings callSettings = null)

Gets an annotated dataset by resource name.

Parameters
Name Description
name string

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.

Example
// 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)

public virtual Task<AnnotatedDataset> GetAnnotatedDatasetAsync(AnnotatedDatasetName name, CallSettings callSettings = null)

Gets an annotated dataset by resource name.

Parameters
Name Description
name AnnotatedDatasetName

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
TaskAnnotatedDataset

A Task containing the RPC response.

Example
// 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)

public virtual Task<AnnotatedDataset> GetAnnotatedDatasetAsync(AnnotatedDatasetName name, CancellationToken cancellationToken)

Gets an annotated dataset by resource name.

Parameters
Name Description
name AnnotatedDatasetName

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskAnnotatedDataset

A Task containing the RPC response.

Example
// 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)

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

Gets an annotated dataset by resource name.

Parameters
Name Description
request GetAnnotatedDatasetRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskAnnotatedDataset

A Task containing the RPC response.

Example
// 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)

public virtual Task<AnnotatedDataset> GetAnnotatedDatasetAsync(GetAnnotatedDatasetRequest request, CancellationToken cancellationToken)

Gets an annotated dataset by resource name.

Parameters
Name Description
request GetAnnotatedDatasetRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskAnnotatedDataset

A Task containing the RPC response.

Example
// 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)

public virtual Task<AnnotatedDataset> GetAnnotatedDatasetAsync(string name, CallSettings callSettings = null)

Gets an annotated dataset by resource name.

Parameters
Name Description
name string

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
TaskAnnotatedDataset

A Task containing the RPC response.

Example
// 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)

public virtual Task<AnnotatedDataset> GetAnnotatedDatasetAsync(string name, CancellationToken cancellationToken)

Gets an annotated dataset by resource name.

Parameters
Name Description
name string

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskAnnotatedDataset

A Task containing the RPC response.

Example
// 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)

public virtual AnnotationSpecSet GetAnnotationSpecSet(AnnotationSpecSetName name, CallSettings callSettings = null)

Gets an annotation spec set by resource name.

Parameters
Name Description
name AnnotationSpecSetName

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.

Example
// 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)

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

Gets an annotation spec set by resource name.

Parameters
Name Description
request GetAnnotationSpecSetRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
AnnotationSpecSet

The RPC response.

Example
// 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)

public virtual AnnotationSpecSet GetAnnotationSpecSet(string name, CallSettings callSettings = null)

Gets an annotation spec set by resource name.

Parameters
Name Description
name string

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.

Example
// 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)

public virtual Task<AnnotationSpecSet> GetAnnotationSpecSetAsync(AnnotationSpecSetName name, CallSettings callSettings = null)

Gets an annotation spec set by resource name.

Parameters
Name Description
name AnnotationSpecSetName

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
TaskAnnotationSpecSet

A Task containing the RPC response.

Example
// 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)

public virtual Task<AnnotationSpecSet> GetAnnotationSpecSetAsync(AnnotationSpecSetName name, CancellationToken cancellationToken)

Gets an annotation spec set by resource name.

Parameters
Name Description
name AnnotationSpecSetName

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskAnnotationSpecSet

A Task containing the RPC response.

Example
// 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)

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

Gets an annotation spec set by resource name.

Parameters
Name Description
request GetAnnotationSpecSetRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskAnnotationSpecSet

A Task containing the RPC response.

Example
// 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)

public virtual Task<AnnotationSpecSet> GetAnnotationSpecSetAsync(GetAnnotationSpecSetRequest request, CancellationToken cancellationToken)

Gets an annotation spec set by resource name.

Parameters
Name Description
request GetAnnotationSpecSetRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskAnnotationSpecSet

A Task containing the RPC response.

Example
// 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)

public virtual Task<AnnotationSpecSet> GetAnnotationSpecSetAsync(string name, CallSettings callSettings = null)

Gets an annotation spec set by resource name.

Parameters
Name Description
name string

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
TaskAnnotationSpecSet

A Task containing the RPC response.

Example
// 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)

public virtual Task<AnnotationSpecSet> GetAnnotationSpecSetAsync(string name, CancellationToken cancellationToken)

Gets an annotation spec set by resource name.

Parameters
Name Description
name string

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskAnnotationSpecSet

A Task containing the RPC response.

Example
// 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)

public virtual DataItem GetDataItem(DataItemName name, CallSettings callSettings = null)

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

Parameters
Name Description
name DataItemName

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.

Example
// 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)

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

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

Parameters
Name Description
request GetDataItemRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
DataItem

The RPC response.

Example
// 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)

public virtual DataItem GetDataItem(string name, CallSettings callSettings = null)

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

Parameters
Name Description
name string

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.

Example
// 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)

public virtual Task<DataItem> GetDataItemAsync(DataItemName name, CallSettings callSettings = null)

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

Parameters
Name Description
name DataItemName

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
TaskDataItem

A Task containing the RPC response.

Example
// 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)

public virtual Task<DataItem> GetDataItemAsync(DataItemName name, CancellationToken cancellationToken)

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

Parameters
Name Description
name DataItemName

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskDataItem

A Task containing the RPC response.

Example
// 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)

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

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

Parameters
Name Description
request GetDataItemRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskDataItem

A Task containing the RPC response.

Example
// 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)

public virtual Task<DataItem> GetDataItemAsync(GetDataItemRequest request, CancellationToken cancellationToken)

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

Parameters
Name Description
request GetDataItemRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskDataItem

A Task containing the RPC response.

Example
// 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)

public virtual Task<DataItem> GetDataItemAsync(string name, CallSettings callSettings = null)

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

Parameters
Name Description
name string

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
TaskDataItem

A Task containing the RPC response.

Example
// 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)

public virtual Task<DataItem> GetDataItemAsync(string name, CancellationToken cancellationToken)

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

Parameters
Name Description
name string

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskDataItem

A Task containing the RPC response.

Example
// 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)

public virtual Dataset GetDataset(DatasetName name, CallSettings callSettings = null)

Gets dataset by resource name.

Parameters
Name Description
name DatasetName

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.

Example
// 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)

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

Gets dataset by resource name.

Parameters
Name Description
request GetDatasetRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Dataset

The RPC response.

Example
// 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)

public virtual Dataset GetDataset(string name, CallSettings callSettings = null)

Gets dataset by resource name.

Parameters
Name Description
name string

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.

Example
// 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)

public virtual Task<Dataset> GetDatasetAsync(DatasetName name, CallSettings callSettings = null)

Gets dataset by resource name.

Parameters
Name Description
name DatasetName

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
TaskDataset

A Task containing the RPC response.

Example
// 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)

public virtual Task<Dataset> GetDatasetAsync(DatasetName name, CancellationToken cancellationToken)

Gets dataset by resource name.

Parameters
Name Description
name DatasetName

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskDataset

A Task containing the RPC response.

Example
// 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)

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

Gets dataset by resource name.

Parameters
Name Description
request GetDatasetRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskDataset

A Task containing the RPC response.

Example
// 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)

public virtual Task<Dataset> GetDatasetAsync(GetDatasetRequest request, CancellationToken cancellationToken)

Gets dataset by resource name.

Parameters
Name Description
request GetDatasetRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskDataset

A Task containing the RPC response.

Example
// 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)

public virtual Task<Dataset> GetDatasetAsync(string name, CallSettings callSettings = null)

Gets dataset by resource name.

Parameters
Name Description
name string

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
TaskDataset

A Task containing the RPC response.

Example
// 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)

public virtual Task<Dataset> GetDatasetAsync(string name, CancellationToken cancellationToken)

Gets dataset by resource name.

Parameters
Name Description
name string

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskDataset

A Task containing the RPC response.

Example
// 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)

public virtual Evaluation GetEvaluation(EvaluationName name, CallSettings callSettings = null)

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

Parameters
Name Description
name EvaluationName

Required. Name of the evaluation. Format:

"projects/<var>{project_id}</var>/datasets/<var>{dataset_id}</var>/evaluations/<var>{evaluation_id}</var>'

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Evaluation

The RPC response.

Example
// 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)

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

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

Parameters
Name Description
request GetEvaluationRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Evaluation

The RPC response.

Example
// 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)

public virtual Evaluation GetEvaluation(string name, CallSettings callSettings = null)

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

Parameters
Name Description
name string

Required. Name of the evaluation. Format:

"projects/<var>{project_id}</var>/datasets/<var>{dataset_id}</var>/evaluations/<var>{evaluation_id}</var>'

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Evaluation

The RPC response.

Example
// 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)

public virtual Task<Evaluation> GetEvaluationAsync(EvaluationName name, CallSettings callSettings = null)

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

Parameters
Name Description
name EvaluationName

Required. Name of the evaluation. Format:

"projects/<var>{project_id}</var>/datasets/<var>{dataset_id}</var>/evaluations/<var>{evaluation_id}</var>'

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskEvaluation

A Task containing the RPC response.

Example
// 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)

public virtual Task<Evaluation> GetEvaluationAsync(EvaluationName name, CancellationToken cancellationToken)

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

Parameters
Name Description
name EvaluationName

Required. Name of the evaluation. Format:

"projects/<var>{project_id}</var>/datasets/<var>{dataset_id}</var>/evaluations/<var>{evaluation_id}</var>'

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskEvaluation

A Task containing the RPC response.

Example
// 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)

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

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

Parameters
Name Description
request GetEvaluationRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskEvaluation

A Task containing the RPC response.

Example
// 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)

public virtual Task<Evaluation> GetEvaluationAsync(GetEvaluationRequest request, CancellationToken cancellationToken)

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

Parameters
Name Description
request GetEvaluationRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskEvaluation

A Task containing the RPC response.

Example
// 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)

public virtual Task<Evaluation> GetEvaluationAsync(string name, CallSettings callSettings = null)

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

Parameters
Name Description
name string

Required. Name of the evaluation. Format:

"projects/<var>{project_id}</var>/datasets/<var>{dataset_id}</var>/evaluations/<var>{evaluation_id}</var>'

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskEvaluation

A Task containing the RPC response.

Example
// 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)

public virtual Task<Evaluation> GetEvaluationAsync(string name, CancellationToken cancellationToken)

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

Parameters
Name Description
name string

Required. Name of the evaluation. Format:

"projects/<var>{project_id}</var>/datasets/<var>{dataset_id}</var>/evaluations/<var>{evaluation_id}</var>'

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskEvaluation

A Task containing the RPC response.

Example
// 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)

public virtual EvaluationJob GetEvaluationJob(EvaluationJobName name, CallSettings callSettings = null)

Gets an evaluation job by resource name.

Parameters
Name Description
name EvaluationJobName

Required. Name of the evaluation job. Format:

"projects/<var>{project_id}</var>/evaluationJobs/<var>{evaluation_job_id}</var>"

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
EvaluationJob

The RPC response.

Example
// 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)

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

Gets an evaluation job by resource name.

Parameters
Name Description
request GetEvaluationJobRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
EvaluationJob

The RPC response.

Example
// 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)

public virtual EvaluationJob GetEvaluationJob(string name, CallSettings callSettings = null)

Gets an evaluation job by resource name.

Parameters
Name Description
name string

Required. Name of the evaluation job. Format:

"projects/<var>{project_id}</var>/evaluationJobs/<var>{evaluation_job_id}</var>"

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
EvaluationJob

The RPC response.

Example
// 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)

public virtual Task<EvaluationJob> GetEvaluationJobAsync(EvaluationJobName name, CallSettings callSettings = null)

Gets an evaluation job by resource name.

Parameters
Name Description
name EvaluationJobName

Required. Name of the evaluation job. Format:

"projects/<var>{project_id}</var>/evaluationJobs/<var>{evaluation_job_id}</var>"

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskEvaluationJob

A Task containing the RPC response.

Example
// 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)

public virtual Task<EvaluationJob> GetEvaluationJobAsync(EvaluationJobName name, CancellationToken cancellationToken)

Gets an evaluation job by resource name.

Parameters
Name Description
name EvaluationJobName

Required. Name of the evaluation job. Format:

"projects/<var>{project_id}</var>/evaluationJobs/<var>{evaluation_job_id}</var>"

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskEvaluationJob

A Task containing the RPC response.

Example
// 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)

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

Gets an evaluation job by resource name.

Parameters
Name Description
request GetEvaluationJobRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskEvaluationJob

A Task containing the RPC response.

Example
// 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)

public virtual Task<EvaluationJob> GetEvaluationJobAsync(GetEvaluationJobRequest request, CancellationToken cancellationToken)

Gets an evaluation job by resource name.

Parameters
Name Description
request GetEvaluationJobRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskEvaluationJob

A Task containing the RPC response.

Example
// 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)

public virtual Task<EvaluationJob> GetEvaluationJobAsync(string name, CallSettings callSettings = null)

Gets an evaluation job by resource name.

Parameters
Name Description
name string

Required. Name of the evaluation job. Format:

"projects/<var>{project_id}</var>/evaluationJobs/<var>{evaluation_job_id}</var>"

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskEvaluationJob

A Task containing the RPC response.

Example
// 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)

public virtual Task<EvaluationJob> GetEvaluationJobAsync(string name, CancellationToken cancellationToken)

Gets an evaluation job by resource name.

Parameters
Name Description
name string

Required. Name of the evaluation job. Format:

"projects/<var>{project_id}</var>/evaluationJobs/<var>{evaluation_job_id}</var>"

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskEvaluationJob

A Task containing the RPC response.

Example
// 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)

public virtual Example GetExample(ExampleName name, string filter, CallSettings callSettings = null)

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

Parameters
Name Description
name ExampleName

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

filter string

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.

Example
// 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)

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

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

Parameters
Name Description
request GetExampleRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Example

The RPC response.

Example
// 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)

public virtual Example GetExample(string name, string filter, CallSettings callSettings = null)

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

Parameters
Name Description
name string

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

filter string

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.

Example
// 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)

public virtual Task<Example> GetExampleAsync(ExampleName name, string filter, CallSettings callSettings = null)

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

Parameters
Name Description
name ExampleName

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

filter string

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
TaskExample

A Task containing the RPC response.

Example
// 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)

public virtual Task<Example> GetExampleAsync(ExampleName name, string filter, CancellationToken cancellationToken)

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

Parameters
Name Description
name ExampleName

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

filter string

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskExample

A Task containing the RPC response.

Example
// 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)

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

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

Parameters
Name Description
request GetExampleRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskExample

A Task containing the RPC response.

Example
// 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)

public virtual Task<Example> GetExampleAsync(GetExampleRequest request, CancellationToken cancellationToken)

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

Parameters
Name Description
request GetExampleRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskExample

A Task containing the RPC response.

Example
// 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)

public virtual Task<Example> GetExampleAsync(string name, string filter, CallSettings callSettings = null)

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

Parameters
Name Description
name string

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

filter string

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
TaskExample

A Task containing the RPC response.

Example
// 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)

public virtual Task<Example> GetExampleAsync(string name, string filter, CancellationToken cancellationToken)

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

Parameters
Name Description
name string

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

filter string

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskExample

A Task containing the RPC response.

Example
// 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)

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

Gets an instruction by resource name.

Parameters
Name Description
request GetInstructionRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Instruction

The RPC response.

Example
// 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)

public virtual Instruction GetInstruction(InstructionName name, CallSettings callSettings = null)

Gets an instruction by resource name.

Parameters
Name Description
name InstructionName

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.

Example
// 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)

public virtual Instruction GetInstruction(string name, CallSettings callSettings = null)

Gets an instruction by resource name.

Parameters
Name Description
name string

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.

Example
// 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)

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

Gets an instruction by resource name.

Parameters
Name Description
request GetInstructionRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskInstruction

A Task containing the RPC response.

Example
// 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)

public virtual Task<Instruction> GetInstructionAsync(GetInstructionRequest request, CancellationToken cancellationToken)

Gets an instruction by resource name.

Parameters
Name Description
request GetInstructionRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskInstruction

A Task containing the RPC response.

Example
// 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)

public virtual Task<Instruction> GetInstructionAsync(InstructionName name, CallSettings callSettings = null)

Gets an instruction by resource name.

Parameters
Name Description
name InstructionName

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
TaskInstruction

A Task containing the RPC response.

Example
// 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)

public virtual Task<Instruction> GetInstructionAsync(InstructionName name, CancellationToken cancellationToken)

Gets an instruction by resource name.

Parameters
Name Description
name InstructionName

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskInstruction

A Task containing the RPC response.

Example
// 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)

public virtual Task<Instruction> GetInstructionAsync(string name, CallSettings callSettings = null)

Gets an instruction by resource name.

Parameters
Name Description
name string

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
TaskInstruction

A Task containing the RPC response.

Example
// 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)

public virtual Task<Instruction> GetInstructionAsync(string name, CancellationToken cancellationToken)

Gets an instruction by resource name.

Parameters
Name Description
name string

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskInstruction

A Task containing the RPC response.

Example
// 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)

public virtual Operation<ImportDataOperationResponse, ImportDataOperationMetadata> ImportData(DatasetName name, InputConfig inputConfig, CallSettings callSettings = null)

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

Parameters
Name Description
name DatasetName

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
OperationImportDataOperationResponseImportDataOperationMetadata

The RPC response.

Example
// 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)

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

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

Parameters
Name Description
request ImportDataRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationImportDataOperationResponseImportDataOperationMetadata

The RPC response.

Example
// 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)

public virtual Operation<ImportDataOperationResponse, ImportDataOperationMetadata> ImportData(string name, InputConfig inputConfig, CallSettings callSettings = null)

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

Parameters
Name Description
name string

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
OperationImportDataOperationResponseImportDataOperationMetadata

The RPC response.

Example
// 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)

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

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

Parameters
Name Description
name DatasetName

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
TaskOperationImportDataOperationResponseImportDataOperationMetadata

A Task containing the RPC response.

Example
// 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)

public virtual Task<Operation<ImportDataOperationResponse, ImportDataOperationMetadata>> ImportDataAsync(DatasetName name, InputConfig inputConfig, CancellationToken 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.

Parameters
Name Description
name DatasetName

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

inputConfig InputConfig

Required. Specify the input source of the data.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationImportDataOperationResponseImportDataOperationMetadata

A Task containing the RPC response.

Example
// 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)

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

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

Parameters
Name Description
request ImportDataRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationImportDataOperationResponseImportDataOperationMetadata

A Task containing the RPC response.

Example
// 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)

public virtual Task<Operation<ImportDataOperationResponse, ImportDataOperationMetadata>> ImportDataAsync(ImportDataRequest request, CancellationToken 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.

Parameters
Name Description
request ImportDataRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationImportDataOperationResponseImportDataOperationMetadata

A Task containing the RPC response.

Example
// 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)

public virtual Task<Operation<ImportDataOperationResponse, ImportDataOperationMetadata>> ImportDataAsync(string name, InputConfig inputConfig, CallSettings callSettings = null)

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

Parameters
Name Description
name string

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
TaskOperationImportDataOperationResponseImportDataOperationMetadata

A Task containing the RPC response.

Example
// 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)

public virtual Task<Operation<ImportDataOperationResponse, ImportDataOperationMetadata>> ImportDataAsync(string name, InputConfig inputConfig, CancellationToken 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.

Parameters
Name Description
name string

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

inputConfig InputConfig

Required. Specify the input source of the data.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationImportDataOperationResponseImportDataOperationMetadata

A Task containing the RPC response.

Example
// 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, Feature, CallSettings)

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

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

Parameters
Name Description
parent DatasetName

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

basicConfig HumanAnnotationConfig

Required. Basic human annotation config.

feature LabelImageRequestTypesFeature

Required. The type of image labeling task.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationAnnotatedDatasetLabelOperationMetadata

The RPC response.

Example
// 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)

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

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

Parameters
Name Description
request LabelImageRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationAnnotatedDatasetLabelOperationMetadata

The RPC response.

Example
// 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(),
};
// 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, Feature, CallSettings)

public virtual Operation<AnnotatedDataset, LabelOperationMetadata> LabelImage(string parent, HumanAnnotationConfig basicConfig, LabelImageRequest.Types.Feature feature, CallSettings callSettings = null)

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

Parameters
Name Description
parent string

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

basicConfig HumanAnnotationConfig

Required. Basic human annotation config.

feature LabelImageRequestTypesFeature

Required. The type of image labeling task.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationAnnotatedDatasetLabelOperationMetadata

The RPC response.

Example
// 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, Feature, CallSettings)

public virtual Task<Operation<AnnotatedDataset, LabelOperationMetadata>> LabelImageAsync(DatasetName parent, HumanAnnotationConfig basicConfig, LabelImageRequest.Types.Feature feature, CallSettings callSettings = null)

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

Parameters
Name Description
parent DatasetName

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

basicConfig HumanAnnotationConfig

Required. Basic human annotation config.

feature LabelImageRequestTypesFeature

Required. The type of image labeling task.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationAnnotatedDatasetLabelOperationMetadata

A Task containing the RPC response.

Example
// 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, Feature, CancellationToken)

public virtual Task<Operation<AnnotatedDataset, LabelOperationMetadata>> LabelImageAsync(DatasetName parent, HumanAnnotationConfig basicConfig, LabelImageRequest.Types.Feature feature, CancellationToken cancellationToken)

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

Parameters
Name Description
parent DatasetName

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

basicConfig HumanAnnotationConfig

Required. Basic human annotation config.

feature LabelImageRequestTypesFeature

Required. The type of image labeling task.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationAnnotatedDatasetLabelOperationMetadata

A Task containing the RPC response.

Example
// 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)

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

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

Parameters
Name Description
request LabelImageRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationAnnotatedDatasetLabelOperationMetadata

A Task containing the RPC response.

Example
// 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(),
};
// 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)

public virtual Task<Operation<AnnotatedDataset, LabelOperationMetadata>> LabelImageAsync(LabelImageRequest request, CancellationToken cancellationToken)

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

Parameters
Name Description
request LabelImageRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationAnnotatedDatasetLabelOperationMetadata

A Task containing the RPC response.

Example
// 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(),
};
// 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, Feature, CallSettings)

public virtual Task<Operation<AnnotatedDataset, LabelOperationMetadata>> LabelImageAsync(string parent, HumanAnnotationConfig basicConfig, LabelImageRequest.Types.Feature feature, CallSettings callSettings = null)

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

Parameters
Name Description
parent string

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

basicConfig HumanAnnotationConfig

Required. Basic human annotation config.

feature LabelImageRequestTypesFeature

Required. The type of image labeling task.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationAnnotatedDatasetLabelOperationMetadata

A Task containing the RPC response.

Example
// 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, Feature, CancellationToken)

public virtual Task<Operation<AnnotatedDataset, LabelOperationMetadata>> LabelImageAsync(string parent, HumanAnnotationConfig basicConfig, LabelImageRequest.Types.Feature feature, CancellationToken cancellationToken)

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

Parameters
Name Description
parent string

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

basicConfig HumanAnnotationConfig

Required. Basic human annotation config.

feature LabelImageRequestTypesFeature

Required. The type of image labeling task.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationAnnotatedDatasetLabelOperationMetadata

A Task containing the RPC response.

Example
// 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, Feature, CallSettings)

public virtual Operation<AnnotatedDataset, LabelOperationMetadata> LabelText(DatasetName parent, HumanAnnotationConfig basicConfig, LabelTextRequest.Types.Feature feature, CallSettings callSettings = null)

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

Parameters
Name Description
parent DatasetName

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

basicConfig HumanAnnotationConfig

Required. Basic human annotation config.

feature LabelTextRequestTypesFeature

Required. The type of text labeling task.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationAnnotatedDatasetLabelOperationMetadata

The RPC response.

Example
// 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)

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

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

Parameters
Name Description
request LabelTextRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationAnnotatedDatasetLabelOperationMetadata

The RPC response.

Example
// 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(),
    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, Feature, CallSettings)

public virtual Operation<AnnotatedDataset, LabelOperationMetadata> LabelText(string parent, HumanAnnotationConfig basicConfig, LabelTextRequest.Types.Feature feature, CallSettings callSettings = null)

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

Parameters
Name Description
parent string

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

basicConfig HumanAnnotationConfig

Required. Basic human annotation config.

feature LabelTextRequestTypesFeature

Required. The type of text labeling task.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationAnnotatedDatasetLabelOperationMetadata

The RPC response.

Example
// 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, Feature, CallSettings)

public virtual Task<Operation<AnnotatedDataset, LabelOperationMetadata>> LabelTextAsync(DatasetName parent, HumanAnnotationConfig basicConfig, LabelTextRequest.Types.Feature feature, CallSettings callSettings = null)

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

Parameters
Name Description
parent DatasetName

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

basicConfig HumanAnnotationConfig

Required. Basic human annotation config.

feature LabelTextRequestTypesFeature

Required. The type of text labeling task.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationAnnotatedDatasetLabelOperationMetadata

A Task containing the RPC response.

Example
// 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, Feature, CancellationToken)

public virtual Task<Operation<AnnotatedDataset, LabelOperationMetadata>> LabelTextAsync(DatasetName parent, HumanAnnotationConfig basicConfig, LabelTextRequest.Types.Feature feature, CancellationToken cancellationToken)

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

Parameters
Name Description
parent DatasetName

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

basicConfig HumanAnnotationConfig

Required. Basic human annotation config.

feature LabelTextRequestTypesFeature

Required. The type of text labeling task.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationAnnotatedDatasetLabelOperationMetadata

A Task containing the RPC response.

Example
// 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)

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

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

Parameters
Name Description
request LabelTextRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationAnnotatedDatasetLabelOperationMetadata

A Task containing the RPC response.

Example
// 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(),
    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)

public virtual Task<Operation<AnnotatedDataset, LabelOperationMetadata>> LabelTextAsync(LabelTextRequest request, CancellationToken cancellationToken)

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

Parameters
Name Description
request LabelTextRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationAnnotatedDatasetLabelOperationMetadata

A Task containing the RPC response.

Example
// 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(),
    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, Feature, CallSettings)

public virtual Task<Operation<AnnotatedDataset, LabelOperationMetadata>> LabelTextAsync(string parent, HumanAnnotationConfig basicConfig, LabelTextRequest.Types.Feature feature, CallSettings callSettings = null)

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

Parameters
Name Description
parent string

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

basicConfig HumanAnnotationConfig

Required. Basic human annotation config.

feature LabelTextRequestTypesFeature

Required. The type of text labeling task.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationAnnotatedDatasetLabelOperationMetadata

A Task containing the RPC response.

Example
// 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, Feature, CancellationToken)

public virtual Task<Operation<AnnotatedDataset, LabelOperationMetadata>> LabelTextAsync(string parent, HumanAnnotationConfig basicConfig, LabelTextRequest.Types.Feature feature, CancellationToken cancellationToken)

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

Parameters
Name Description
parent string

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

basicConfig HumanAnnotationConfig

Required. Basic human annotation config.

feature LabelTextRequestTypesFeature

Required. The type of text labeling task.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationAnnotatedDatasetLabelOperationMetadata

A Task containing the RPC response.

Example
// 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, Feature, CallSettings)

public virtual Operation<AnnotatedDataset, LabelOperationMetadata> LabelVideo(DatasetName parent, HumanAnnotationConfig basicConfig, LabelVideoRequest.Types.Feature feature, CallSettings callSettings = null)

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

Parameters
Name Description
parent DatasetName

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

basicConfig HumanAnnotationConfig

Required. Basic human annotation config.

feature LabelVideoRequestTypesFeature

Required. The type of video labeling task.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationAnnotatedDatasetLabelOperationMetadata

The RPC response.

Example
// 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)

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

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

Parameters
Name Description
request LabelVideoRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationAnnotatedDatasetLabelOperationMetadata

The RPC response.

Example
// 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(),
};
// 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, Feature, CallSettings)

public virtual Operation<AnnotatedDataset, LabelOperationMetadata> LabelVideo(string parent, HumanAnnotationConfig basicConfig, LabelVideoRequest.Types.Feature feature, CallSettings callSettings = null)

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

Parameters
Name Description
parent string

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

basicConfig HumanAnnotationConfig

Required. Basic human annotation config.

feature LabelVideoRequestTypesFeature

Required. The type of video labeling task.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationAnnotatedDatasetLabelOperationMetadata

The RPC response.

Example
// 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, Feature, CallSettings)

public virtual Task<Operation<AnnotatedDataset, LabelOperationMetadata>> LabelVideoAsync(DatasetName parent, HumanAnnotationConfig basicConfig, LabelVideoRequest.Types.Feature feature, CallSettings callSettings = null)

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

Parameters
Name Description
parent DatasetName

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

basicConfig HumanAnnotationConfig

Required. Basic human annotation config.

feature LabelVideoRequestTypesFeature

Required. The type of video labeling task.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationAnnotatedDatasetLabelOperationMetadata

A Task containing the RPC response.

Example
// 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, Feature, CancellationToken)

public virtual Task<Operation<AnnotatedDataset, LabelOperationMetadata>> LabelVideoAsync(DatasetName parent, HumanAnnotationConfig basicConfig, LabelVideoRequest.Types.Feature feature, CancellationToken cancellationToken)

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

Parameters
Name Description
parent DatasetName

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

basicConfig HumanAnnotationConfig

Required. Basic human annotation config.

feature LabelVideoRequestTypesFeature

Required. The type of video labeling task.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationAnnotatedDatasetLabelOperationMetadata

A Task containing the RPC response.

Example
// 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)

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

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

Parameters
Name Description
request LabelVideoRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationAnnotatedDatasetLabelOperationMetadata

A Task containing the RPC response.

Example
// 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(),
};
// 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)

public virtual Task<Operation<AnnotatedDataset, LabelOperationMetadata>> LabelVideoAsync(LabelVideoRequest request, CancellationToken cancellationToken)

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

Parameters
Name Description
request LabelVideoRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationAnnotatedDatasetLabelOperationMetadata

A Task containing the RPC response.

Example
// 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(),
};
// 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, Feature, CallSettings)

public virtual Task<Operation<AnnotatedDataset, LabelOperationMetadata>> LabelVideoAsync(string parent, HumanAnnotationConfig basicConfig, LabelVideoRequest.Types.Feature feature, CallSettings callSettings = null)

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

Parameters
Name Description
parent string

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

basicConfig HumanAnnotationConfig

Required. Basic human annotation config.

feature LabelVideoRequestTypesFeature

Required. The type of video labeling task.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationAnnotatedDatasetLabelOperationMetadata

A Task containing the RPC response.

Example
// 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, Feature, CancellationToken)

public virtual Task<Operation<AnnotatedDataset, LabelOperationMetadata>> LabelVideoAsync(string parent, HumanAnnotationConfig basicConfig, LabelVideoRequest.Types.Feature feature, CancellationToken cancellationToken)

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

Parameters
Name Description
parent string

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

basicConfig HumanAnnotationConfig

Required. Basic human annotation config.

feature LabelVideoRequestTypesFeature

Required. The type of video labeling task.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationAnnotatedDatasetLabelOperationMetadata

A Task containing the RPC response.

Example
// 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, int?, CallSettings)

public virtual PagedEnumerable<ListAnnotatedDatasetsResponse, AnnotatedDataset> ListAnnotatedDatasets(DatasetName parent, string filter, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists annotated datasets for a dataset. Pagination is supported.

Parameters
Name Description
parent DatasetName

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

filter string

Optional. Filter is not supported at this moment.

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

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
PagedEnumerableListAnnotatedDatasetsResponseAnnotatedDataset

A pageable sequence of AnnotatedDataset resources.

Example
// 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)

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

Lists annotated datasets for a dataset. Pagination is supported.

Parameters
Name Description
request ListAnnotatedDatasetsRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListAnnotatedDatasetsResponseAnnotatedDataset

A pageable sequence of AnnotatedDataset resources.

Example
// 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, int?, CallSettings)

public virtual PagedEnumerable<ListAnnotatedDatasetsResponse, AnnotatedDataset> ListAnnotatedDatasets(string parent, string filter, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists annotated datasets for a dataset. Pagination is supported.

Parameters
Name Description
parent string

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

filter string

Optional. Filter is not supported at this moment.

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

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
PagedEnumerableListAnnotatedDatasetsResponseAnnotatedDataset

A pageable sequence of AnnotatedDataset resources.

Example
// 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, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListAnnotatedDatasetsResponse, AnnotatedDataset> ListAnnotatedDatasetsAsync(DatasetName parent, string filter, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists annotated datasets for a dataset. Pagination is supported.

Parameters
Name Description
parent DatasetName

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

filter string

Optional. Filter is not supported at this moment.

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

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
PagedAsyncEnumerableListAnnotatedDatasetsResponseAnnotatedDataset

A pageable asynchronous sequence of AnnotatedDataset resources.

Example
// 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)

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

Lists annotated datasets for a dataset. Pagination is supported.

Parameters
Name Description
request ListAnnotatedDatasetsRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListAnnotatedDatasetsResponseAnnotatedDataset

A pageable asynchronous sequence of AnnotatedDataset resources.

Example
// 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, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListAnnotatedDatasetsResponse, AnnotatedDataset> ListAnnotatedDatasetsAsync(string parent, string filter, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists annotated datasets for a dataset. Pagination is supported.

Parameters
Name Description
parent string

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

filter string

Optional. Filter is not supported at this moment.

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

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
PagedAsyncEnumerableListAnnotatedDatasetsResponseAnnotatedDataset

A pageable asynchronous sequence of AnnotatedDataset resources.

Example
// 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, int?, CallSettings)

public virtual PagedEnumerable<ListAnnotationSpecSetsResponse, AnnotationSpecSet> ListAnnotationSpecSets(ProjectName parent, string filter, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

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

Parameters
Name Description
parent ProjectName

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

filter string

Optional. Filter is not supported at this moment.

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

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
PagedEnumerableListAnnotationSpecSetsResponseAnnotationSpecSet

A pageable sequence of AnnotationSpecSet resources.

Example
// 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)

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

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

Parameters
Name Description
request ListAnnotationSpecSetsRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListAnnotationSpecSetsResponseAnnotationSpecSet

A pageable sequence of AnnotationSpecSet resources.

Example
// 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, int?, CallSettings)

public virtual PagedEnumerable<ListAnnotationSpecSetsResponse, AnnotationSpecSet> ListAnnotationSpecSets(string parent, string filter, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

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

Parameters
Name Description
parent string

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

filter string

Optional. Filter is not supported at this moment.

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

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
PagedEnumerableListAnnotationSpecSetsResponseAnnotationSpecSet

A pageable sequence of AnnotationSpecSet resources.

Example
// 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, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListAnnotationSpecSetsResponse, AnnotationSpecSet> ListAnnotationSpecSetsAsync(ProjectName parent, string filter, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

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

Parameters
Name Description
parent ProjectName

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

filter string

Optional. Filter is not supported at this moment.

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

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
PagedAsyncEnumerableListAnnotationSpecSetsResponseAnnotationSpecSet

A pageable asynchronous sequence of AnnotationSpecSet resources.

Example
// 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)

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

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

Parameters
Name Description
request ListAnnotationSpecSetsRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListAnnotationSpecSetsResponseAnnotationSpecSet

A pageable asynchronous sequence of AnnotationSpecSet resources.

Example
// 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, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListAnnotationSpecSetsResponse, AnnotationSpecSet> ListAnnotationSpecSetsAsync(string parent, string filter, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

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

Parameters
Name Description
parent string

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

filter string

Optional. Filter is not supported at this moment.

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

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
PagedAsyncEnumerableListAnnotationSpecSetsResponseAnnotationSpecSet

A pageable asynchronous sequence of AnnotationSpecSet resources.

Example
// 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, int?, CallSettings)

public virtual PagedEnumerable<ListDataItemsResponse, DataItem> ListDataItems(DatasetName parent, string filter, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

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

Parameters
Name Description
parent DatasetName

Required. Name of the dataset to list data items, format: projects/{project_id}/datasets/{dataset_id}

filter string

Optional. Filter is not supported at this moment.

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

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
PagedEnumerableListDataItemsResponseDataItem

A pageable sequence of DataItem resources.

Example
// 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)

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

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

Parameters
Name Description
request ListDataItemsRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListDataItemsResponseDataItem

A pageable sequence of DataItem resources.

Example
// 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, int?, CallSettings)

public virtual PagedEnumerable<ListDataItemsResponse, DataItem> ListDataItems(string parent, string filter, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

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

Parameters
Name Description
parent string

Required. Name of the dataset to list data items, format: projects/{project_id}/datasets/{dataset_id}

filter string

Optional. Filter is not supported at this moment.

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

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
PagedEnumerableListDataItemsResponseDataItem

A pageable sequence of DataItem resources.

Example
// 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, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListDataItemsResponse, DataItem> ListDataItemsAsync(DatasetName parent, string filter, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

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

Parameters
Name Description
parent DatasetName

Required. Name of the dataset to list data items, format: projects/{project_id}/datasets/{dataset_id}

filter string

Optional. Filter is not supported at this moment.

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

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
PagedAsyncEnumerableListDataItemsResponseDataItem

A pageable asynchronous sequence of DataItem resources.

Example
// 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)

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

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

Parameters
Name Description
request ListDataItemsRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListDataItemsResponseDataItem

A pageable asynchronous sequence of DataItem resources.

Example
// 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, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListDataItemsResponse, DataItem> ListDataItemsAsync(string parent, string filter, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

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

Parameters
Name Description
parent string

Required. Name of the dataset to list data items, format: projects/{project_id}/datasets/{dataset_id}

filter string

Optional. Filter is not supported at this moment.

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

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
PagedAsyncEnumerableListDataItemsResponseDataItem

A pageable asynchronous sequence of DataItem resources.

Example
// 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, int?, CallSettings)

public virtual PagedEnumerable<ListDatasetsResponse, Dataset> ListDatasets(ProjectName parent, string filter, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists datasets under a project. Pagination is supported.

Parameters
Name Description
parent ProjectName

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

filter string

Optional. Filter on dataset is not supported at this moment.

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

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
PagedEnumerableListDatasetsResponseDataset

A pageable sequence of Dataset resources.

Example
// 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)

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

Lists datasets under a project. Pagination is supported.

Parameters
Name Description
request ListDatasetsRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListDatasetsResponseDataset

A pageable sequence of Dataset resources.

Example
// 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, int?, CallSettings)

public virtual PagedEnumerable<ListDatasetsResponse, Dataset> ListDatasets(string parent, string filter, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists datasets under a project. Pagination is supported.

Parameters
Name Description
parent string

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

filter string

Optional. Filter on dataset is not supported at this moment.

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

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
PagedEnumerableListDatasetsResponseDataset

A pageable sequence of Dataset resources.

Example
// 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, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListDatasetsResponse, Dataset> ListDatasetsAsync(ProjectName parent, string filter, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists datasets under a project. Pagination is supported.

Parameters
Name Description
parent ProjectName

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

filter string

Optional. Filter on dataset is not supported at this moment.

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

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
PagedAsyncEnumerableListDatasetsResponseDataset

A pageable asynchronous sequence of Dataset resources.

Example
// 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)

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

Lists datasets under a project. Pagination is supported.

Parameters
Name Description
request ListDatasetsRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListDatasetsResponseDataset

A pageable asynchronous sequence of Dataset resources.

Example
// 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, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListDatasetsResponse, Dataset> ListDatasetsAsync(string parent, string filter, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists datasets under a project. Pagination is supported.

Parameters
Name Description
parent string

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

filter string

Optional. Filter on dataset is not supported at this moment.

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

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
PagedAsyncEnumerableListDatasetsResponseDataset

A pageable asynchronous sequence of Dataset resources.

Example
// 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, int?, CallSettings)

public virtual PagedEnumerable<ListEvaluationJobsResponse, EvaluationJob> ListEvaluationJobs(ProjectName parent, string filter, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

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

Parameters
Name Description
parent ProjectName

Required. Evaluation job resource parent. Format: "projects/<var>{project_id}</var>"

filter string

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<span></span>job.model_id = <var>{model_name}</var> AND evaluation<span></span>job.state = <var>{evaluation_job_state}</var>"

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

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
PagedEnumerableListEvaluationJobsResponseEvaluationJob

A pageable sequence of EvaluationJob resources.

Example
// 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)

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

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

Parameters
Name Description
request ListEvaluationJobsRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListEvaluationJobsResponseEvaluationJob

A pageable sequence of EvaluationJob resources.

Example
// 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, int?, CallSettings)

public virtual PagedEnumerable<ListEvaluationJobsResponse, EvaluationJob> ListEvaluationJobs(string parent, string filter, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

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

Parameters
Name Description
parent string

Required. Evaluation job resource parent. Format: "projects/<var>{project_id}</var>"

filter string

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<span></span>job.model_id = <var>{model_name}</var> AND evaluation<span></span>job.state = <var>{evaluation_job_state}</var>"

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

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
PagedEnumerableListEvaluationJobsResponseEvaluationJob

A pageable sequence of EvaluationJob resources.

Example
// 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, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListEvaluationJobsResponse, EvaluationJob> ListEvaluationJobsAsync(ProjectName parent, string filter, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

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

Parameters
Name Description
parent ProjectName

Required. Evaluation job resource parent. Format: "projects/<var>{project_id}</var>"

filter string

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<span></span>job.model_id = <var>{model_name}</var> AND evaluation<span></span>job.state = <var>{evaluation_job_state}</var>"

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

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
PagedAsyncEnumerableListEvaluationJobsResponseEvaluationJob

A pageable asynchronous sequence of EvaluationJob resources.

Example
// 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)

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

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

Parameters
Name Description
request ListEvaluationJobsRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListEvaluationJobsResponseEvaluationJob

A pageable asynchronous sequence of EvaluationJob resources.

Example
// 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, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListEvaluationJobsResponse, EvaluationJob> ListEvaluationJobsAsync(string parent, string filter, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

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

Parameters
Name Description
parent string

Required. Evaluation job resource parent. Format: "projects/<var>{project_id}</var>"

filter string

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<span></span>job.model_id = <var>{model_name}</var> AND evaluation<span></span>job.state = <var>{evaluation_job_state}</var>"

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

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
PagedAsyncEnumerableListEvaluationJobsResponseEvaluationJob

A pageable asynchronous sequence of EvaluationJob resources.

Example
// 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, int?, CallSettings)

public virtual PagedEnumerable<ListExamplesResponse, Example> ListExamples(AnnotatedDatasetName parent, string filter, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists examples in an annotated dataset. Pagination is supported.

Parameters
Name Description
parent AnnotatedDatasetName

Required. Example resource parent.

filter string

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}"

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

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
PagedEnumerableListExamplesResponseExample

A pageable sequence of Example resources.

Example
// 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)

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

Lists examples in an annotated dataset. Pagination is supported.

Parameters
Name Description
request ListExamplesRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListExamplesResponseExample

A pageable sequence of Example resources.

Example
// 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, int?, CallSettings)

public virtual PagedEnumerable<ListExamplesResponse, Example> ListExamples(string parent, string filter, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists examples in an annotated dataset. Pagination is supported.

Parameters
Name Description
parent string

Required. Example resource parent.

filter string

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}"

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

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
PagedEnumerableListExamplesResponseExample

A pageable sequence of Example resources.

Example
// 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, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListExamplesResponse, Example> ListExamplesAsync(AnnotatedDatasetName parent, string filter, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists examples in an annotated dataset. Pagination is supported.

Parameters
Name Description
parent AnnotatedDatasetName

Required. Example resource parent.

filter string

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}"

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

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
PagedAsyncEnumerableListExamplesResponseExample

A pageable asynchronous sequence of Example resources.

Example
// 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)

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

Lists examples in an annotated dataset. Pagination is supported.

Parameters
Name Description
request ListExamplesRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListExamplesResponseExample

A pageable asynchronous sequence of Example resources.

Example
// 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, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListExamplesResponse, Example> ListExamplesAsync(string parent, string filter, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists examples in an annotated dataset. Pagination is supported.

Parameters
Name Description
parent string

Required. Example resource parent.

filter string

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}"

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

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
PagedAsyncEnumerableListExamplesResponseExample

A pageable asynchronous sequence of Example resources.

Example
// 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, int?, CallSettings)

public virtual PagedEnumerable<ListInstructionsResponse, Instruction> ListInstructions(ProjectName parent, string filter, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists instructions for a project. Pagination is supported.

Parameters
Name Description
parent ProjectName

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

filter string

Optional. Filter is not supported at this moment.

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

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
PagedEnumerableListInstructionsResponseInstruction

A pageable sequence of Instruction resources.

Example
// 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)

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

Lists instructions for a project. Pagination is supported.

Parameters
Name Description
request ListInstructionsRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListInstructionsResponseInstruction

A pageable sequence of Instruction resources.

Example
// 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, int?, CallSettings)

public virtual PagedEnumerable<ListInstructionsResponse, Instruction> ListInstructions(string parent, string filter, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists instructions for a project. Pagination is supported.

Parameters
Name Description
parent string

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

filter string

Optional. Filter is not supported at this moment.

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

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
PagedEnumerableListInstructionsResponseInstruction

A pageable sequence of Instruction resources.

Example
// 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, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListInstructionsResponse, Instruction> ListInstructionsAsync(ProjectName parent, string filter, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists instructions for a project. Pagination is supported.

Parameters
Name Description
parent ProjectName

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

filter string

Optional. Filter is not supported at this moment.

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

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
PagedAsyncEnumerableListInstructionsResponseInstruction

A pageable asynchronous sequence of Instruction resources.

Example
// 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)

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

Lists instructions for a project. Pagination is supported.

Parameters
Name Description
request ListInstructionsRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListInstructionsResponseInstruction

A pageable asynchronous sequence of Instruction resources.

Example
// 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, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListInstructionsResponse, Instruction> ListInstructionsAsync(string parent, string filter, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists instructions for a project. Pagination is supported.

Parameters
Name Description
parent string

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

filter string

Optional. Filter is not supported at this moment.

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

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
PagedAsyncEnumerableListInstructionsResponseInstruction

A pageable asynchronous sequence of Instruction resources.

Example
// 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)

public virtual void PauseEvaluationJob(EvaluationJobName name, CallSettings callSettings = null)

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

Parameters
Name Description
name EvaluationJobName

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

"projects/<var>{project_id}</var>/evaluationJobs/<var>{evaluation_job_id}</var>"

callSettings CallSettings

If not null, applies overrides to this RPC call.

Example
// 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)

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

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

Parameters
Name Description
request PauseEvaluationJobRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Example
// 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)

public virtual void PauseEvaluationJob(string name, CallSettings callSettings = null)

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

Parameters
Name Description
name string

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

"projects/<var>{project_id}</var>/evaluationJobs/<var>{evaluation_job_id}</var>"

callSettings CallSettings

If not null, applies overrides to this RPC call.

Example
// 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)

public virtual Task PauseEvaluationJobAsync(EvaluationJobName name, CallSettings callSettings = null)

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

Parameters
Name Description
name EvaluationJobName

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

"projects/<var>{project_id}</var>/evaluationJobs/<var>{evaluation_job_id}</var>"

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// 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)

public virtual Task PauseEvaluationJobAsync(EvaluationJobName name, CancellationToken cancellationToken)

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

Parameters
Name Description
name EvaluationJobName

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

"projects/<var>{project_id}</var>/evaluationJobs/<var>{evaluation_job_id}</var>"

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// 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)

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

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

Parameters
Name Description
request PauseEvaluationJobRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// 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)

public virtual Task PauseEvaluationJobAsync(PauseEvaluationJobRequest request, CancellationToken cancellationToken)

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

Parameters
Name Description
request PauseEvaluationJobRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// 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)

public virtual Task PauseEvaluationJobAsync(string name, CallSettings callSettings = null)

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

Parameters
Name Description
name string

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

"projects/<var>{project_id}</var>/evaluationJobs/<var>{evaluation_job_id}</var>"

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// 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)

public virtual Task PauseEvaluationJobAsync(string name, CancellationToken cancellationToken)

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

Parameters
Name Description
name string

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

"projects/<var>{project_id}</var>/evaluationJobs/<var>{evaluation_job_id}</var>"

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// 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)

public virtual Operation<Instruction, CreateInstructionMetadata> PollOnceCreateInstruction(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of CreateInstruction .

Parameters
Name Description
operationName string

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
OperationInstructionCreateInstructionMetadata

The result of polling the operation.

PollOnceCreateInstructionAsync(string, CallSettings)

public virtual Task<Operation<Instruction, CreateInstructionMetadata>> PollOnceCreateInstructionAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of CreateInstruction.

Parameters
Name Description
operationName string

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
TaskOperationInstructionCreateInstructionMetadata

A task representing the result of polling the operation.

PollOnceExportData(string, CallSettings)

public virtual Operation<ExportDataOperationResponse, ExportDataOperationMetadata> PollOnceExportData(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of ExportData.

Parameters
Name Description
operationName string

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
OperationExportDataOperationResponseExportDataOperationMetadata

The result of polling the operation.

PollOnceExportDataAsync(string, CallSettings)

public virtual Task<Operation<ExportDataOperationResponse, ExportDataOperationMetadata>> PollOnceExportDataAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of ExportData.

Parameters
Name Description
operationName string

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
TaskOperationExportDataOperationResponseExportDataOperationMetadata

A task representing the result of polling the operation.

PollOnceImportData(string, CallSettings)

public virtual Operation<ImportDataOperationResponse, ImportDataOperationMetadata> PollOnceImportData(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of ImportData.

Parameters
Name Description
operationName string

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
OperationImportDataOperationResponseImportDataOperationMetadata

The result of polling the operation.

PollOnceImportDataAsync(string, CallSettings)

public virtual Task<Operation<ImportDataOperationResponse, ImportDataOperationMetadata>> PollOnceImportDataAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of ImportData.

Parameters
Name Description
operationName string

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
TaskOperationImportDataOperationResponseImportDataOperationMetadata

A task representing the result of polling the operation.

PollOnceLabelImage(string, CallSettings)

public virtual Operation<AnnotatedDataset, LabelOperationMetadata> PollOnceLabelImage(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of LabelImage.

Parameters
Name Description
operationName string

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
OperationAnnotatedDatasetLabelOperationMetadata

The result of polling the operation.

PollOnceLabelImageAsync(string, CallSettings)

public virtual Task<Operation<AnnotatedDataset, LabelOperationMetadata>> PollOnceLabelImageAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of LabelImage.

Parameters
Name Description
operationName string

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
TaskOperationAnnotatedDatasetLabelOperationMetadata

A task representing the result of polling the operation.

PollOnceLabelText(string, CallSettings)

public virtual Operation<AnnotatedDataset, LabelOperationMetadata> PollOnceLabelText(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of LabelText.

Parameters
Name Description
operationName string

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
OperationAnnotatedDatasetLabelOperationMetadata

The result of polling the operation.

PollOnceLabelTextAsync(string, CallSettings)

public virtual Task<Operation<AnnotatedDataset, LabelOperationMetadata>> PollOnceLabelTextAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of LabelText.

Parameters
Name Description
operationName string

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
TaskOperationAnnotatedDatasetLabelOperationMetadata

A task representing the result of polling the operation.

PollOnceLabelVideo(string, CallSettings)

public virtual Operation<AnnotatedDataset, LabelOperationMetadata> PollOnceLabelVideo(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of LabelVideo.

Parameters
Name Description
operationName string

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
OperationAnnotatedDatasetLabelOperationMetadata

The result of polling the operation.

PollOnceLabelVideoAsync(string, CallSettings)

public virtual Task<Operation<AnnotatedDataset, LabelOperationMetadata>> PollOnceLabelVideoAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of LabelVideo.

Parameters
Name Description
operationName string

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
TaskOperationAnnotatedDatasetLabelOperationMetadata

A task representing the result of polling the operation.

ResumeEvaluationJob(EvaluationJobName, CallSettings)

public virtual void ResumeEvaluationJob(EvaluationJobName name, CallSettings callSettings = null)

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

Parameters
Name Description
name EvaluationJobName

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

"projects/<var>{project_id}</var>/evaluationJobs/<var>{evaluation_job_id}</var>"

callSettings CallSettings

If not null, applies overrides to this RPC call.

Example
// 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)

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

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

Parameters
Name Description
request ResumeEvaluationJobRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Example
// 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)

public virtual void ResumeEvaluationJob(string name, CallSettings callSettings = null)

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

Parameters
Name Description
name string

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

"projects/<var>{project_id}</var>/evaluationJobs/<var>{evaluation_job_id}</var>"

callSettings CallSettings

If not null, applies overrides to this RPC call.

Example
// 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)

public virtual Task ResumeEvaluationJobAsync(EvaluationJobName name, CallSettings callSettings = null)

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

Parameters
Name Description
name EvaluationJobName

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

"projects/<var>{project_id}</var>/evaluationJobs/<var>{evaluation_job_id}</var>"

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// 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)

public virtual Task ResumeEvaluationJobAsync(EvaluationJobName name, CancellationToken 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.

Parameters
Name Description
name EvaluationJobName

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

"projects/<var>{project_id}</var>/evaluationJobs/<var>{evaluation_job_id}</var>"

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// 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)

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

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

Parameters
Name Description
request ResumeEvaluationJobRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// 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)

public virtual Task ResumeEvaluationJobAsync(ResumeEvaluationJobRequest request, CancellationToken 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.

Parameters
Name Description
request ResumeEvaluationJobRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// 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)

public virtual Task ResumeEvaluationJobAsync(string name, CallSettings callSettings = null)

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

Parameters
Name Description
name string

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

"projects/<var>{project_id}</var>/evaluationJobs/<var>{evaluation_job_id}</var>"

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// 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)

public virtual Task ResumeEvaluationJobAsync(string name, CancellationToken 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.

Parameters
Name Description
name string

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

"projects/<var>{project_id}</var>/evaluationJobs/<var>{evaluation_job_id}</var>"

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// 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, int?, CallSettings)

public virtual PagedEnumerable<SearchEvaluationsResponse, Evaluation> SearchEvaluations(EvaluationName parent, string filter, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

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

Parameters
Name Description
parent EvaluationName

Required. Evaluation search parent (project ID). Format: "projects/<var>{project_id}</var>"

filter string

Optional. To search evaluations, you can filter by the following:

  • evaluation<span>_</span>job.evaluation_job_id (the last part of [EvaluationJob.name][google.cloud.datalabeling.v1beta1.EvaluationJob.name])
  • evaluation<span>_</span>job.model_id (the <var>{model_name}</var> portion of [EvaluationJob.modelVersion][google.cloud.datalabeling.v1beta1.EvaluationJob.model_version])
  • evaluation<span>_</span>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<span>_</span>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<span>_</span>job.job_state ([EvaluationJob.state][google.cloud.datalabeling.v1beta1.EvaluationJob.state])
  • annotation<span>_</span>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<span></span>job.evaluation_job_id = <var>{evaluation_job_id}</var> AND evaluation<span></span>job.model_id = <var>{model_name}</var> AND evaluation<span></span>job.evaluation_job_run_time_start = <var>{timestamp_1}</var> AND evaluation<span></span>job.evaluation_job_run_time_end = <var>{timestamp_2}</var> AND annotation<span>_</span>spec.display_name = <var>{display_name}</var>"

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

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
PagedEnumerableSearchEvaluationsResponseEvaluation

A pageable sequence of Evaluation resources.

Example
// 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)

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

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

Parameters
Name Description
request SearchEvaluationsRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableSearchEvaluationsResponseEvaluation

A pageable sequence of Evaluation resources.

Example
// 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, int?, CallSettings)

public virtual PagedEnumerable<SearchEvaluationsResponse, Evaluation> SearchEvaluations(string parent, string filter, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

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

Parameters
Name Description
parent string

Required. Evaluation search parent (project ID). Format: "projects/<var>{project_id}</var>"

filter string

Optional. To search evaluations, you can filter by the following:

  • evaluation<span>_</span>job.evaluation_job_id (the last part of [EvaluationJob.name][google.cloud.datalabeling.v1beta1.EvaluationJob.name])
  • evaluation<span>_</span>job.model_id (the <var>{model_name}</var> portion of [EvaluationJob.modelVersion][google.cloud.datalabeling.v1beta1.EvaluationJob.model_version])
  • evaluation<span>_</span>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<span>_</span>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<span>_</span>job.job_state ([EvaluationJob.state][google.cloud.datalabeling.v1beta1.EvaluationJob.state])
  • annotation<span>_</span>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<span></span>job.evaluation_job_id = <var>{evaluation_job_id}</var> AND evaluation<span></span>job.model_id = <var>{model_name}</var> AND evaluation<span></span>job.evaluation_job_run_time_start = <var>{timestamp_1}</var> AND evaluation<span></span>job.evaluation_job_run_time_end = <var>{timestamp_2}</var> AND annotation<span>_</span>spec.display_name = <var>{display_name}</var>"

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

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
PagedEnumerableSearchEvaluationsResponseEvaluation

A pageable sequence of Evaluation resources.

Example
// 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, int?, CallSettings)

public virtual PagedAsyncEnumerable<SearchEvaluationsResponse, Evaluation> SearchEvaluationsAsync(EvaluationName parent, string filter, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

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

Parameters
Name Description
parent EvaluationName

Required. Evaluation search parent (project ID). Format: "projects/<var>{project_id}</var>"

filter string

Optional. To search evaluations, you can filter by the following:

  • evaluation<span>_</span>job.evaluation_job_id (the last part of [EvaluationJob.name][google.cloud.datalabeling.v1beta1.EvaluationJob.name])
  • evaluation<span>_</span>job.model_id (the <var>{model_name}</var> portion of [EvaluationJob.modelVersion][google.cloud.datalabeling.v1beta1.EvaluationJob.model_version])
  • evaluation<span>_</span>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<span>_</span>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<span>_</span>job.job_state ([EvaluationJob.state][google.cloud.datalabeling.v1beta1.EvaluationJob.state])
  • annotation<span>_</span>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<span></span>job.evaluation_job_id = <var>{evaluation_job_id}</var> AND evaluation<span></span>job.model_id = <var>{model_name}</var> AND evaluation<span></span>job.evaluation_job_run_time_start = <var>{timestamp_1}</var> AND evaluation<span></span>job.evaluation_job_run_time_end = <var>{timestamp_2}</var> AND annotation<span>_</span>spec.display_name = <var>{display_name}</var>"

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

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
PagedAsyncEnumerableSearchEvaluationsResponseEvaluation

A pageable asynchronous sequence of Evaluation resources.

Example
// 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)

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

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

Parameters
Name Description
request SearchEvaluationsRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableSearchEvaluationsResponseEvaluation

A pageable asynchronous sequence of Evaluation resources.

Example
// 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, int?, CallSettings)

public virtual PagedAsyncEnumerable<SearchEvaluationsResponse, Evaluation> SearchEvaluationsAsync(string parent, string filter, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

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

Parameters
Name Description
parent string

Required. Evaluation search parent (project ID). Format: "projects/<var>{project_id}</var>"

filter string

Optional. To search evaluations, you can filter by the following:

  • evaluation<span>_</span>job.evaluation_job_id (the last part of [EvaluationJob.name][google.cloud.datalabeling.v1beta1.EvaluationJob.name])
  • evaluation<span>_</span>job.model_id (the <var>{model_name}</var> portion of [EvaluationJob.modelVersion][google.cloud.datalabeling.v1beta1.EvaluationJob.model_version])
  • evaluation<span>_</span>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<span>_</span>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<span>_</span>job.job_state ([EvaluationJob.state][google.cloud.datalabeling.v1beta1.EvaluationJob.state])
  • annotation<span>_</span>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<span></span>job.evaluation_job_id = <var>{evaluation_job_id}</var> AND evaluation<span></span>job.model_id = <var>{model_name}</var> AND evaluation<span></span>job.evaluation_job_run_time_start = <var>{timestamp_1}</var> AND evaluation<span></span>job.evaluation_job_run_time_end = <var>{timestamp_2}</var> AND annotation<span>_</span>spec.display_name = <var>{display_name}</var>"

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

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
PagedAsyncEnumerableSearchEvaluationsResponseEvaluation

A pageable asynchronous sequence of Evaluation resources.

Example
// 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, int?, CallSettings)

public virtual PagedEnumerable<SearchExampleComparisonsResponse, SearchExampleComparisonsResponse.Types.ExampleComparison> SearchExampleComparisons(EvaluationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

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

Parameters
Name Description
parent EvaluationName

Required. Name of the [Evaluation][google.cloud.datalabeling.v1beta1.Evaluation] resource to search for example comparisons from. Format:

"projects/<var>{project_id}</var>/datasets/<var>{dataset_id}</var>/evaluations/<var>{evaluation_id}</var>"

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

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
PagedEnumerableSearchExampleComparisonsResponseSearchExampleComparisonsResponseTypesExampleComparison

A pageable sequence of SearchExampleComparisonsResponse.Types.ExampleComparison resources.

Example
// 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)

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

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

Parameters
Name Description
request SearchExampleComparisonsRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableSearchExampleComparisonsResponseSearchExampleComparisonsResponseTypesExampleComparison

A pageable sequence of SearchExampleComparisonsResponse.Types.ExampleComparison resources.

Example
// 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, int?, CallSettings)

public virtual PagedEnumerable<SearchExampleComparisonsResponse, SearchExampleComparisonsResponse.Types.ExampleComparison> SearchExampleComparisons(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

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

Parameters
Name Description
parent string

Required. Name of the [Evaluation][google.cloud.datalabeling.v1beta1.Evaluation] resource to search for example comparisons from. Format:

"projects/<var>{project_id}</var>/datasets/<var>{dataset_id}</var>/evaluations/<var>{evaluation_id}</var>"

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

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
PagedEnumerableSearchExampleComparisonsResponseSearchExampleComparisonsResponseTypesExampleComparison

A pageable sequence of SearchExampleComparisonsResponse.Types.ExampleComparison resources.

Example
// 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, int?, CallSettings)

public virtual PagedAsyncEnumerable<SearchExampleComparisonsResponse, SearchExampleComparisonsResponse.Types.ExampleComparison> SearchExampleComparisonsAsync(EvaluationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

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

Parameters
Name Description
parent EvaluationName

Required. Name of the [Evaluation][google.cloud.datalabeling.v1beta1.Evaluation] resource to search for example comparisons from. Format:

"projects/<var>{project_id}</var>/datasets/<var>{dataset_id}</var>/evaluations/<var>{evaluation_id}</var>"

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

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
PagedAsyncEnumerableSearchExampleComparisonsResponseSearchExampleComparisonsResponseTypesExampleComparison

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

Example
// 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)

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

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

Parameters
Name Description
request SearchExampleComparisonsRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableSearchExampleComparisonsResponseSearchExampleComparisonsResponseTypesExampleComparison

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

Example
// 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, int?, CallSettings)

public virtual PagedAsyncEnumerable<SearchExampleComparisonsResponse, SearchExampleComparisonsResponse.Types.ExampleComparison> SearchExampleComparisonsAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

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

Parameters
Name Description
parent string

Required. Name of the [Evaluation][google.cloud.datalabeling.v1beta1.Evaluation] resource to search for example comparisons from. Format:

"projects/<var>{project_id}</var>/datasets/<var>{dataset_id}</var>/evaluations/<var>{evaluation_id}</var>"

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

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
PagedAsyncEnumerableSearchExampleComparisonsResponseSearchExampleComparisonsResponseTypesExampleComparison

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

Example
// 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()

public static Task ShutdownDefaultChannelsAsync()

Shuts down any channels automatically created by Create() and CreateAsync(CancellationToken). Channels which weren't automatically created are not affected.

Returns
Type Description
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)

public virtual EvaluationJob UpdateEvaluationJob(EvaluationJob evaluationJob, FieldMask updateMask, CallSettings callSettings = null)

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

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

Parameters
Name Description
evaluationJob EvaluationJob

Required. Evaluation job that is going to be updated.

updateMask FieldMask

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.

Example
// 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)

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

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

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

Parameters
Name Description
request UpdateEvaluationJobRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
EvaluationJob

The RPC response.

Example
// 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)

public virtual Task<EvaluationJob> UpdateEvaluationJobAsync(EvaluationJob evaluationJob, FieldMask updateMask, CallSettings callSettings = null)

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

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

Parameters
Name Description
evaluationJob EvaluationJob

Required. Evaluation job that is going to be updated.

updateMask FieldMask

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
TaskEvaluationJob

A Task containing the RPC response.

Example
// 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)

public virtual Task<EvaluationJob> UpdateEvaluationJobAsync(EvaluationJob evaluationJob, FieldMask updateMask, CancellationToken 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.

Parameters
Name Description
evaluationJob EvaluationJob

Required. Evaluation job that is going to be updated.

updateMask FieldMask

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.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskEvaluationJob

A Task containing the RPC response.

Example
// 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)

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

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

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

Parameters
Name Description
request UpdateEvaluationJobRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskEvaluationJob

A Task containing the RPC response.

Example
// 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)

public virtual Task<EvaluationJob> UpdateEvaluationJobAsync(UpdateEvaluationJobRequest request, CancellationToken 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.

Parameters
Name Description
request UpdateEvaluationJobRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskEvaluationJob

A Task containing the RPC response.

Example
// 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);