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 LabelTextRequestTypes