Class v1beta1.DataLabelingServiceClient

Service for the AI Platform Data Labeling API. v1beta1

Package

@google-cloud/datalabeling!

Constructors

(constructor)(opts)

constructor(opts?: ClientOptions);

Construct an instance of DataLabelingServiceClient.

Parameter
Type Name Description
ClientOptions opts

Properties

apiEndpoint

static get apiEndpoint(): string;

The DNS address for this API service - same as servicePath(), exists for compatibility reasons.

Property Value
Type Description
string

auth

auth: gax.GoogleAuth;
Property Value
Type Description
gax.GoogleAuth

dataLabelingServiceStub

dataLabelingServiceStub?: Promise<{
        [name: string]: Function;
    }>;
Property Value
Type Description
Promise<{ [name: string]: Function; }>

descriptors

descriptors: Descriptors;
Property Value
Type Description
Descriptors

innerApiCalls

innerApiCalls: {
        [name: string]: Function;
    };
Property Value
Type Description
{ [name: string]: Function; }

operationsClient

operationsClient: gax.OperationsClient;
Property Value
Type Description
gax.OperationsClient

pathTemplates

pathTemplates: {
        [name: string]: gax.PathTemplate;
    };
Property Value
Type Description
{ [name: string]: gax.PathTemplate; }

port

static get port(): number;

The port for this API service.

Property Value
Type Description
number

scopes

static get scopes(): string[];

The scopes needed to make gRPC calls for every method defined in this service.

Property Value
Type Description
string[]

servicePath

static get servicePath(): string;

The DNS address for this API service.

Property Value
Type Description
string

warn

warn: (code: string, message: string, warnType?: string) => void;
Property Value
Type Description
(code: string, message: string, warnType?: string) => void

Methods

annotatedDatasetPath(project, dataset, annotatedDataset)

annotatedDatasetPath(project: string, dataset: string, annotatedDataset: string): string;

Return a fully-qualified annotatedDataset resource name string.

Parameters
Type Name Description
string project
string dataset
string annotatedDataset
Returns
Type Description
string

{string} Resource name string.

annotationSpecSetPath(project, annotationSpecSet)

annotationSpecSetPath(project: string, annotationSpecSet: string): string;

Return a fully-qualified annotationSpecSet resource name string.

Parameters
Type Name Description
string project
string annotationSpecSet
Returns
Type Description
string

{string} Resource name string.

checkCreateInstructionProgress(name)

checkCreateInstructionProgress(name: string): Promise<LROperation<protos.google.cloud.datalabeling.v1beta1.Instruction, protos.google.cloud.datalabeling.v1beta1.CreateInstructionMetadata>>;

Check the status of the long running operation returned by createInstruction().

Parameter
Type Name Description
string name

The operation name that will be passed.
Returns
Type Description
Promise<LROperation<protos.google.cloud.datalabeling.v1beta1.Instruction, protos.google.cloud.datalabeling.v1beta1.CreateInstructionMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

checkExportDataProgress(name)

checkExportDataProgress(name: string): Promise<LROperation<protos.google.cloud.datalabeling.v1beta1.ExportDataOperationResponse, protos.google.cloud.datalabeling.v1beta1.ExportDataOperationMetadata>>;

Check the status of the long running operation returned by exportData().

Parameter
Type Name Description
string name

The operation name that will be passed.
Returns
Type Description
Promise<LROperation<protos.google.cloud.datalabeling.v1beta1.ExportDataOperationResponse, protos.google.cloud.datalabeling.v1beta1.ExportDataOperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

checkImportDataProgress(name)

checkImportDataProgress(name: string): Promise<LROperation<protos.google.cloud.datalabeling.v1beta1.ImportDataOperationResponse, protos.google.cloud.datalabeling.v1beta1.ImportDataOperationMetadata>>;

Check the status of the long running operation returned by importData().

Parameter
Type Name Description
string name

The operation name that will be passed.
Returns
Type Description
Promise<LROperation<protos.google.cloud.datalabeling.v1beta1.ImportDataOperationResponse, protos.google.cloud.datalabeling.v1beta1.ImportDataOperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

checkLabelImageProgress(name)

checkLabelImageProgress(name: string): Promise<LROperation<protos.google.cloud.datalabeling.v1beta1.AnnotatedDataset, protos.google.cloud.datalabeling.v1beta1.LabelOperationMetadata>>;

Check the status of the long running operation returned by labelImage().

Parameter
Type Name Description
string name

The operation name that will be passed.
Returns
Type Description
Promise<LROperation<protos.google.cloud.datalabeling.v1beta1.AnnotatedDataset, protos.google.cloud.datalabeling.v1beta1.LabelOperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

checkLabelTextProgress(name)

checkLabelTextProgress(name: string): Promise<LROperation<protos.google.cloud.datalabeling.v1beta1.AnnotatedDataset, protos.google.cloud.datalabeling.v1beta1.LabelOperationMetadata>>;

Check the status of the long running operation returned by labelText().

Parameter
Type Name Description
string name

The operation name that will be passed.
Returns
Type Description
Promise<LROperation<protos.google.cloud.datalabeling.v1beta1.AnnotatedDataset, protos.google.cloud.datalabeling.v1beta1.LabelOperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

checkLabelVideoProgress(name)

checkLabelVideoProgress(name: string): Promise<LROperation<protos.google.cloud.datalabeling.v1beta1.AnnotatedDataset, protos.google.cloud.datalabeling.v1beta1.LabelOperationMetadata>>;

Check the status of the long running operation returned by labelVideo().

Parameter
Type Name Description
string name

The operation name that will be passed.
Returns
Type Description
Promise<LROperation<protos.google.cloud.datalabeling.v1beta1.AnnotatedDataset, protos.google.cloud.datalabeling.v1beta1.LabelOperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

close()

close(): Promise<void>;

Terminate the gRPC channel and close the client.

The client will no longer be usable and all future behavior is undefined.

Returns
Type Description
Promise<void>

{Promise} A promise that resolves when the client is closed.

createAnnotationSpecSet(request, options)

createAnnotationSpecSet(request?: protos.google.cloud.datalabeling.v1beta1.ICreateAnnotationSpecSetRequest, options?: CallOptions): Promise<[protos.google.cloud.datalabeling.v1beta1.IAnnotationSpecSet, (protos.google.cloud.datalabeling.v1beta1.ICreateAnnotationSpecSetRequest | undefined), {} | undefined]>;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.ICreateAnnotationSpecSetRequest request
CallOptions options
Returns
Type Description
Promise<[protos.google.cloud.datalabeling.v1beta1.IAnnotationSpecSet, (protos.google.cloud.datalabeling.v1beta1.ICreateAnnotationSpecSetRequest | undefined), {} | undefined]>

createAnnotationSpecSet(request, options, callback)

createAnnotationSpecSet(request: protos.google.cloud.datalabeling.v1beta1.ICreateAnnotationSpecSetRequest, options: CallOptions, callback: Callback<protos.google.cloud.datalabeling.v1beta1.IAnnotationSpecSet, protos.google.cloud.datalabeling.v1beta1.ICreateAnnotationSpecSetRequest | null | undefined, {} | null | undefined>): void;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.ICreateAnnotationSpecSetRequest request
CallOptions options
Callback<protos.google.cloud.datalabeling.v1beta1.IAnnotationSpecSet, protos.google.cloud.datalabeling.v1beta1.ICreateAnnotationSpecSetRequest | null | undefined, {} | null | undefined> callback
Returns
Type Description
void

createAnnotationSpecSet(request, callback)

createAnnotationSpecSet(request: protos.google.cloud.datalabeling.v1beta1.ICreateAnnotationSpecSetRequest, callback: Callback<protos.google.cloud.datalabeling.v1beta1.IAnnotationSpecSet, protos.google.cloud.datalabeling.v1beta1.ICreateAnnotationSpecSetRequest | null | undefined, {} | null | undefined>): void;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.ICreateAnnotationSpecSetRequest request
Callback<protos.google.cloud.datalabeling.v1beta1.IAnnotationSpecSet, protos.google.cloud.datalabeling.v1beta1.ICreateAnnotationSpecSetRequest | null | undefined, {} | null | undefined> callback
Returns
Type Description
void

createDataset(request, options)

createDataset(request?: protos.google.cloud.datalabeling.v1beta1.ICreateDatasetRequest, options?: CallOptions): Promise<[protos.google.cloud.datalabeling.v1beta1.IDataset, (protos.google.cloud.datalabeling.v1beta1.ICreateDatasetRequest | undefined), {} | undefined]>;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.ICreateDatasetRequest request
CallOptions options
Returns
Type Description
Promise<[protos.google.cloud.datalabeling.v1beta1.IDataset, (protos.google.cloud.datalabeling.v1beta1.ICreateDatasetRequest | undefined), {} | undefined]>

createDataset(request, options, callback)

createDataset(request: protos.google.cloud.datalabeling.v1beta1.ICreateDatasetRequest, options: CallOptions, callback: Callback<protos.google.cloud.datalabeling.v1beta1.IDataset, protos.google.cloud.datalabeling.v1beta1.ICreateDatasetRequest | null | undefined, {} | null | undefined>): void;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.ICreateDatasetRequest request
CallOptions options
Callback<protos.google.cloud.datalabeling.v1beta1.IDataset, protos.google.cloud.datalabeling.v1beta1.ICreateDatasetRequest | null | undefined, {} | null | undefined> callback
Returns
Type Description
void

createDataset(request, callback)

createDataset(request: protos.google.cloud.datalabeling.v1beta1.ICreateDatasetRequest, callback: Callback<protos.google.cloud.datalabeling.v1beta1.IDataset, protos.google.cloud.datalabeling.v1beta1.ICreateDatasetRequest | null | undefined, {} | null | undefined>): void;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.ICreateDatasetRequest request
Callback<protos.google.cloud.datalabeling.v1beta1.IDataset, protos.google.cloud.datalabeling.v1beta1.ICreateDatasetRequest | null | undefined, {} | null | undefined> callback
Returns
Type Description
void

createEvaluationJob(request, options)

createEvaluationJob(request?: protos.google.cloud.datalabeling.v1beta1.ICreateEvaluationJobRequest, options?: CallOptions): Promise<[protos.google.cloud.datalabeling.v1beta1.IEvaluationJob, (protos.google.cloud.datalabeling.v1beta1.ICreateEvaluationJobRequest | undefined), {} | undefined]>;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.ICreateEvaluationJobRequest request
CallOptions options
Returns
Type Description
Promise<[protos.google.cloud.datalabeling.v1beta1.IEvaluationJob, (protos.google.cloud.datalabeling.v1beta1.ICreateEvaluationJobRequest | undefined), {} | undefined]>

createEvaluationJob(request, options, callback)

createEvaluationJob(request: protos.google.cloud.datalabeling.v1beta1.ICreateEvaluationJobRequest, options: CallOptions, callback: Callback<protos.google.cloud.datalabeling.v1beta1.IEvaluationJob, protos.google.cloud.datalabeling.v1beta1.ICreateEvaluationJobRequest | null | undefined, {} | null | undefined>): void;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.ICreateEvaluationJobRequest request
CallOptions options
Callback<protos.google.cloud.datalabeling.v1beta1.IEvaluationJob, protos.google.cloud.datalabeling.v1beta1.ICreateEvaluationJobRequest | null | undefined, {} | null | undefined> callback
Returns
Type Description
void

createEvaluationJob(request, callback)

createEvaluationJob(request: protos.google.cloud.datalabeling.v1beta1.ICreateEvaluationJobRequest, callback: Callback<protos.google.cloud.datalabeling.v1beta1.IEvaluationJob, protos.google.cloud.datalabeling.v1beta1.ICreateEvaluationJobRequest | null | undefined, {} | null | undefined>): void;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.ICreateEvaluationJobRequest request
Callback<protos.google.cloud.datalabeling.v1beta1.IEvaluationJob, protos.google.cloud.datalabeling.v1beta1.ICreateEvaluationJobRequest | null | undefined, {} | null | undefined> callback
Returns
Type Description
void

createInstruction(request, options)

createInstruction(request?: protos.google.cloud.datalabeling.v1beta1.ICreateInstructionRequest, options?: CallOptions): Promise<[LROperation<protos.google.cloud.datalabeling.v1beta1.IInstruction, protos.google.cloud.datalabeling.v1beta1.ICreateInstructionMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.ICreateInstructionRequest request
CallOptions options
Returns
Type Description
Promise<[LROperation<protos.google.cloud.datalabeling.v1beta1.IInstruction, protos.google.cloud.datalabeling.v1beta1.ICreateInstructionMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>

createInstruction(request, options, callback)

createInstruction(request: protos.google.cloud.datalabeling.v1beta1.ICreateInstructionRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.datalabeling.v1beta1.IInstruction, protos.google.cloud.datalabeling.v1beta1.ICreateInstructionMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.ICreateInstructionRequest request
CallOptions options
Callback<LROperation<protos.google.cloud.datalabeling.v1beta1.IInstruction, protos.google.cloud.datalabeling.v1beta1.ICreateInstructionMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined> callback
Returns
Type Description
void

createInstruction(request, callback)

createInstruction(request: protos.google.cloud.datalabeling.v1beta1.ICreateInstructionRequest, callback: Callback<LROperation<protos.google.cloud.datalabeling.v1beta1.IInstruction, protos.google.cloud.datalabeling.v1beta1.ICreateInstructionMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.ICreateInstructionRequest request
Callback<LROperation<protos.google.cloud.datalabeling.v1beta1.IInstruction, protos.google.cloud.datalabeling.v1beta1.ICreateInstructionMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined> callback
Returns
Type Description
void

dataItemPath(project, dataset, dataItem)

dataItemPath(project: string, dataset: string, dataItem: string): string;

Return a fully-qualified dataItem resource name string.

Parameters
Type Name Description
string project
string dataset
string dataItem
Returns
Type Description
string

{string} Resource name string.

datasetPath(project, dataset)

datasetPath(project: string, dataset: string): string;

Return a fully-qualified dataset resource name string.

Parameters
Type Name Description
string project
string dataset
Returns
Type Description
string

{string} Resource name string.

deleteAnnotatedDataset(request, options)

deleteAnnotatedDataset(request?: protos.google.cloud.datalabeling.v1beta1.IDeleteAnnotatedDatasetRequest, options?: CallOptions): Promise<[protos.google.protobuf.IEmpty, (protos.google.cloud.datalabeling.v1beta1.IDeleteAnnotatedDatasetRequest | undefined), {} | undefined]>;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.IDeleteAnnotatedDatasetRequest request
CallOptions options
Returns
Type Description
Promise<[protos.google.protobuf.IEmpty, (protos.google.cloud.datalabeling.v1beta1.IDeleteAnnotatedDatasetRequest | undefined), {} | undefined]>

deleteAnnotatedDataset(request, options, callback)

deleteAnnotatedDataset(request: protos.google.cloud.datalabeling.v1beta1.IDeleteAnnotatedDatasetRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.datalabeling.v1beta1.IDeleteAnnotatedDatasetRequest | null | undefined, {} | null | undefined>): void;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.IDeleteAnnotatedDatasetRequest request
CallOptions options
Callback<protos.google.protobuf.IEmpty, protos.google.cloud.datalabeling.v1beta1.IDeleteAnnotatedDatasetRequest | null | undefined, {} | null | undefined> callback
Returns
Type Description
void

deleteAnnotatedDataset(request, callback)

deleteAnnotatedDataset(request: protos.google.cloud.datalabeling.v1beta1.IDeleteAnnotatedDatasetRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.datalabeling.v1beta1.IDeleteAnnotatedDatasetRequest | null | undefined, {} | null | undefined>): void;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.IDeleteAnnotatedDatasetRequest request
Callback<protos.google.protobuf.IEmpty, protos.google.cloud.datalabeling.v1beta1.IDeleteAnnotatedDatasetRequest | null | undefined, {} | null | undefined> callback
Returns
Type Description
void

deleteAnnotationSpecSet(request, options)

deleteAnnotationSpecSet(request?: protos.google.cloud.datalabeling.v1beta1.IDeleteAnnotationSpecSetRequest, options?: CallOptions): Promise<[protos.google.protobuf.IEmpty, (protos.google.cloud.datalabeling.v1beta1.IDeleteAnnotationSpecSetRequest | undefined), {} | undefined]>;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.IDeleteAnnotationSpecSetRequest request
CallOptions options
Returns
Type Description
Promise<[protos.google.protobuf.IEmpty, (protos.google.cloud.datalabeling.v1beta1.IDeleteAnnotationSpecSetRequest | undefined), {} | undefined]>

deleteAnnotationSpecSet(request, options, callback)

deleteAnnotationSpecSet(request: protos.google.cloud.datalabeling.v1beta1.IDeleteAnnotationSpecSetRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.datalabeling.v1beta1.IDeleteAnnotationSpecSetRequest | null | undefined, {} | null | undefined>): void;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.IDeleteAnnotationSpecSetRequest request
CallOptions options
Callback<protos.google.protobuf.IEmpty, protos.google.cloud.datalabeling.v1beta1.IDeleteAnnotationSpecSetRequest | null | undefined, {} | null | undefined> callback
Returns
Type Description
void

deleteAnnotationSpecSet(request, callback)

deleteAnnotationSpecSet(request: protos.google.cloud.datalabeling.v1beta1.IDeleteAnnotationSpecSetRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.datalabeling.v1beta1.IDeleteAnnotationSpecSetRequest | null | undefined, {} | null | undefined>): void;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.IDeleteAnnotationSpecSetRequest request
Callback<protos.google.protobuf.IEmpty, protos.google.cloud.datalabeling.v1beta1.IDeleteAnnotationSpecSetRequest | null | undefined, {} | null | undefined> callback
Returns
Type Description
void

deleteDataset(request, options)

deleteDataset(request?: protos.google.cloud.datalabeling.v1beta1.IDeleteDatasetRequest, options?: CallOptions): Promise<[protos.google.protobuf.IEmpty, (protos.google.cloud.datalabeling.v1beta1.IDeleteDatasetRequest | undefined), {} | undefined]>;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.IDeleteDatasetRequest request
CallOptions options
Returns
Type Description
Promise<[protos.google.protobuf.IEmpty, (protos.google.cloud.datalabeling.v1beta1.IDeleteDatasetRequest | undefined), {} | undefined]>

deleteDataset(request, options, callback)

deleteDataset(request: protos.google.cloud.datalabeling.v1beta1.IDeleteDatasetRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.datalabeling.v1beta1.IDeleteDatasetRequest | null | undefined, {} | null | undefined>): void;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.IDeleteDatasetRequest request
CallOptions options
Callback<protos.google.protobuf.IEmpty, protos.google.cloud.datalabeling.v1beta1.IDeleteDatasetRequest | null | undefined, {} | null | undefined> callback
Returns
Type Description
void

deleteDataset(request, callback)

deleteDataset(request: protos.google.cloud.datalabeling.v1beta1.IDeleteDatasetRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.datalabeling.v1beta1.IDeleteDatasetRequest | null | undefined, {} | null | undefined>): void;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.IDeleteDatasetRequest request
Callback<protos.google.protobuf.IEmpty, protos.google.cloud.datalabeling.v1beta1.IDeleteDatasetRequest | null | undefined, {} | null | undefined> callback
Returns
Type Description
void

deleteEvaluationJob(request, options)

deleteEvaluationJob(request?: protos.google.cloud.datalabeling.v1beta1.IDeleteEvaluationJobRequest, options?: CallOptions): Promise<[protos.google.protobuf.IEmpty, (protos.google.cloud.datalabeling.v1beta1.IDeleteEvaluationJobRequest | undefined), {} | undefined]>;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.IDeleteEvaluationJobRequest request
CallOptions options
Returns
Type Description
Promise<[protos.google.protobuf.IEmpty, (protos.google.cloud.datalabeling.v1beta1.IDeleteEvaluationJobRequest | undefined), {} | undefined]>

deleteEvaluationJob(request, options, callback)

deleteEvaluationJob(request: protos.google.cloud.datalabeling.v1beta1.IDeleteEvaluationJobRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.datalabeling.v1beta1.IDeleteEvaluationJobRequest | null | undefined, {} | null | undefined>): void;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.IDeleteEvaluationJobRequest request
CallOptions options
Callback<protos.google.protobuf.IEmpty, protos.google.cloud.datalabeling.v1beta1.IDeleteEvaluationJobRequest | null | undefined, {} | null | undefined> callback
Returns
Type Description
void

deleteEvaluationJob(request, callback)

deleteEvaluationJob(request: protos.google.cloud.datalabeling.v1beta1.IDeleteEvaluationJobRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.datalabeling.v1beta1.IDeleteEvaluationJobRequest | null | undefined, {} | null | undefined>): void;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.IDeleteEvaluationJobRequest request
Callback<protos.google.protobuf.IEmpty, protos.google.cloud.datalabeling.v1beta1.IDeleteEvaluationJobRequest | null | undefined, {} | null | undefined> callback
Returns
Type Description
void

deleteInstruction(request, options)

deleteInstruction(request?: protos.google.cloud.datalabeling.v1beta1.IDeleteInstructionRequest, options?: CallOptions): Promise<[protos.google.protobuf.IEmpty, (protos.google.cloud.datalabeling.v1beta1.IDeleteInstructionRequest | undefined), {} | undefined]>;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.IDeleteInstructionRequest request
CallOptions options
Returns
Type Description
Promise<[protos.google.protobuf.IEmpty, (protos.google.cloud.datalabeling.v1beta1.IDeleteInstructionRequest | undefined), {} | undefined]>

deleteInstruction(request, options, callback)

deleteInstruction(request: protos.google.cloud.datalabeling.v1beta1.IDeleteInstructionRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.datalabeling.v1beta1.IDeleteInstructionRequest | null | undefined, {} | null | undefined>): void;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.IDeleteInstructionRequest request
CallOptions options
Callback<protos.google.protobuf.IEmpty, protos.google.cloud.datalabeling.v1beta1.IDeleteInstructionRequest | null | undefined, {} | null | undefined> callback
Returns
Type Description
void

deleteInstruction(request, callback)

deleteInstruction(request: protos.google.cloud.datalabeling.v1beta1.IDeleteInstructionRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.datalabeling.v1beta1.IDeleteInstructionRequest | null | undefined, {} | null | undefined>): void;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.IDeleteInstructionRequest request
Callback<protos.google.protobuf.IEmpty, protos.google.cloud.datalabeling.v1beta1.IDeleteInstructionRequest | null | undefined, {} | null | undefined> callback
Returns
Type Description
void

evaluationJobPath(project, evaluationJob)

evaluationJobPath(project: string, evaluationJob: string): string;

Return a fully-qualified evaluationJob resource name string.

Parameters
Type Name Description
string project
string evaluationJob
Returns
Type Description
string

{string} Resource name string.

evaluationPath(project, dataset, evaluation)

evaluationPath(project: string, dataset: string, evaluation: string): string;

Return a fully-qualified evaluation resource name string.

Parameters
Type Name Description
string project
string dataset
string evaluation
Returns
Type Description
string

{string} Resource name string.

examplePath(project, dataset, annotatedDataset, example)

examplePath(project: string, dataset: string, annotatedDataset: string, example: string): string;

Return a fully-qualified example resource name string.

Parameters
Type Name Description
string project
string dataset
string annotatedDataset
string example
Returns
Type Description
string

{string} Resource name string.

exportData(request, options)

exportData(request?: protos.google.cloud.datalabeling.v1beta1.IExportDataRequest, options?: CallOptions): Promise<[LROperation<protos.google.cloud.datalabeling.v1beta1.IExportDataOperationResponse, protos.google.cloud.datalabeling.v1beta1.IExportDataOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.IExportDataRequest request
CallOptions options
Returns
Type Description
Promise<[LROperation<protos.google.cloud.datalabeling.v1beta1.IExportDataOperationResponse, protos.google.cloud.datalabeling.v1beta1.IExportDataOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>

exportData(request, options, callback)

exportData(request: protos.google.cloud.datalabeling.v1beta1.IExportDataRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.datalabeling.v1beta1.IExportDataOperationResponse, protos.google.cloud.datalabeling.v1beta1.IExportDataOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.IExportDataRequest request
CallOptions options
Callback<LROperation<protos.google.cloud.datalabeling.v1beta1.IExportDataOperationResponse, protos.google.cloud.datalabeling.v1beta1.IExportDataOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined> callback
Returns
Type Description
void

exportData(request, callback)

exportData(request: protos.google.cloud.datalabeling.v1beta1.IExportDataRequest, callback: Callback<LROperation<protos.google.cloud.datalabeling.v1beta1.IExportDataOperationResponse, protos.google.cloud.datalabeling.v1beta1.IExportDataOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.IExportDataRequest request
Callback<LROperation<protos.google.cloud.datalabeling.v1beta1.IExportDataOperationResponse, protos.google.cloud.datalabeling.v1beta1.IExportDataOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined> callback
Returns
Type Description
void

getAnnotatedDataset(request, options)

getAnnotatedDataset(request?: protos.google.cloud.datalabeling.v1beta1.IGetAnnotatedDatasetRequest, options?: CallOptions): Promise<[protos.google.cloud.datalabeling.v1beta1.IAnnotatedDataset, (protos.google.cloud.datalabeling.v1beta1.IGetAnnotatedDatasetRequest | undefined), {} | undefined]>;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.IGetAnnotatedDatasetRequest request
CallOptions options
Returns
Type Description
Promise<[protos.google.cloud.datalabeling.v1beta1.IAnnotatedDataset, (protos.google.cloud.datalabeling.v1beta1.IGetAnnotatedDatasetRequest | undefined), {} | undefined]>

getAnnotatedDataset(request, options, callback)

getAnnotatedDataset(request: protos.google.cloud.datalabeling.v1beta1.IGetAnnotatedDatasetRequest, options: CallOptions, callback: Callback<protos.google.cloud.datalabeling.v1beta1.IAnnotatedDataset, protos.google.cloud.datalabeling.v1beta1.IGetAnnotatedDatasetRequest | null | undefined, {} | null | undefined>): void;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.IGetAnnotatedDatasetRequest request
CallOptions options
Callback<protos.google.cloud.datalabeling.v1beta1.IAnnotatedDataset, protos.google.cloud.datalabeling.v1beta1.IGetAnnotatedDatasetRequest | null | undefined, {} | null | undefined> callback
Returns
Type Description
void

getAnnotatedDataset(request, callback)

getAnnotatedDataset(request: protos.google.cloud.datalabeling.v1beta1.IGetAnnotatedDatasetRequest, callback: Callback<protos.google.cloud.datalabeling.v1beta1.IAnnotatedDataset, protos.google.cloud.datalabeling.v1beta1.IGetAnnotatedDatasetRequest | null | undefined, {} | null | undefined>): void;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.IGetAnnotatedDatasetRequest request
Callback<protos.google.cloud.datalabeling.v1beta1.IAnnotatedDataset, protos.google.cloud.datalabeling.v1beta1.IGetAnnotatedDatasetRequest | null | undefined, {} | null | undefined> callback
Returns
Type Description
void

getAnnotationSpecSet(request, options)

getAnnotationSpecSet(request?: protos.google.cloud.datalabeling.v1beta1.IGetAnnotationSpecSetRequest, options?: CallOptions): Promise<[protos.google.cloud.datalabeling.v1beta1.IAnnotationSpecSet, (protos.google.cloud.datalabeling.v1beta1.IGetAnnotationSpecSetRequest | undefined), {} | undefined]>;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.IGetAnnotationSpecSetRequest request
CallOptions options
Returns
Type Description
Promise<[protos.google.cloud.datalabeling.v1beta1.IAnnotationSpecSet, (protos.google.cloud.datalabeling.v1beta1.IGetAnnotationSpecSetRequest | undefined), {} | undefined]>

getAnnotationSpecSet(request, options, callback)

getAnnotationSpecSet(request: protos.google.cloud.datalabeling.v1beta1.IGetAnnotationSpecSetRequest, options: CallOptions, callback: Callback<protos.google.cloud.datalabeling.v1beta1.IAnnotationSpecSet, protos.google.cloud.datalabeling.v1beta1.IGetAnnotationSpecSetRequest | null | undefined, {} | null | undefined>): void;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.IGetAnnotationSpecSetRequest request
CallOptions options
Callback<protos.google.cloud.datalabeling.v1beta1.IAnnotationSpecSet, protos.google.cloud.datalabeling.v1beta1.IGetAnnotationSpecSetRequest | null | undefined, {} | null | undefined> callback
Returns
Type Description
void

getAnnotationSpecSet(request, callback)

getAnnotationSpecSet(request: protos.google.cloud.datalabeling.v1beta1.IGetAnnotationSpecSetRequest, callback: Callback<protos.google.cloud.datalabeling.v1beta1.IAnnotationSpecSet, protos.google.cloud.datalabeling.v1beta1.IGetAnnotationSpecSetRequest | null | undefined, {} | null | undefined>): void;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.IGetAnnotationSpecSetRequest request
Callback<protos.google.cloud.datalabeling.v1beta1.IAnnotationSpecSet, protos.google.cloud.datalabeling.v1beta1.IGetAnnotationSpecSetRequest | null | undefined, {} | null | undefined> callback
Returns
Type Description
void

getDataItem(request, options)

getDataItem(request?: protos.google.cloud.datalabeling.v1beta1.IGetDataItemRequest, options?: CallOptions): Promise<[protos.google.cloud.datalabeling.v1beta1.IDataItem, protos.google.cloud.datalabeling.v1beta1.IGetDataItemRequest | undefined, {} | undefined]>;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.IGetDataItemRequest request
CallOptions options
Returns
Type Description
Promise<[protos.google.cloud.datalabeling.v1beta1.IDataItem, protos.google.cloud.datalabeling.v1beta1.IGetDataItemRequest | undefined, {} | undefined]>

getDataItem(request, options, callback)

getDataItem(request: protos.google.cloud.datalabeling.v1beta1.IGetDataItemRequest, options: CallOptions, callback: Callback<protos.google.cloud.datalabeling.v1beta1.IDataItem, protos.google.cloud.datalabeling.v1beta1.IGetDataItemRequest | null | undefined, {} | null | undefined>): void;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.IGetDataItemRequest request
CallOptions options
Callback<protos.google.cloud.datalabeling.v1beta1.IDataItem, protos.google.cloud.datalabeling.v1beta1.IGetDataItemRequest | null | undefined, {} | null | undefined> callback
Returns
Type Description
void

getDataItem(request, callback)

getDataItem(request: protos.google.cloud.datalabeling.v1beta1.IGetDataItemRequest, callback: Callback<protos.google.cloud.datalabeling.v1beta1.IDataItem, protos.google.cloud.datalabeling.v1beta1.IGetDataItemRequest | null | undefined, {} | null | undefined>): void;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.IGetDataItemRequest request
Callback<protos.google.cloud.datalabeling.v1beta1.IDataItem, protos.google.cloud.datalabeling.v1beta1.IGetDataItemRequest | null | undefined, {} | null | undefined> callback
Returns
Type Description
void

getDataset(request, options)

getDataset(request?: protos.google.cloud.datalabeling.v1beta1.IGetDatasetRequest, options?: CallOptions): Promise<[protos.google.cloud.datalabeling.v1beta1.IDataset, protos.google.cloud.datalabeling.v1beta1.IGetDatasetRequest | undefined, {} | undefined]>;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.IGetDatasetRequest request
CallOptions options
Returns
Type Description
Promise<[protos.google.cloud.datalabeling.v1beta1.IDataset, protos.google.cloud.datalabeling.v1beta1.IGetDatasetRequest | undefined, {} | undefined]>

getDataset(request, options, callback)

getDataset(request: protos.google.cloud.datalabeling.v1beta1.IGetDatasetRequest, options: CallOptions, callback: Callback<protos.google.cloud.datalabeling.v1beta1.IDataset, protos.google.cloud.datalabeling.v1beta1.IGetDatasetRequest | null | undefined, {} | null | undefined>): void;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.IGetDatasetRequest request
CallOptions options
Callback<protos.google.cloud.datalabeling.v1beta1.IDataset, protos.google.cloud.datalabeling.v1beta1.IGetDatasetRequest | null | undefined, {} | null | undefined> callback
Returns
Type Description
void

getDataset(request, callback)

getDataset(request: protos.google.cloud.datalabeling.v1beta1.IGetDatasetRequest, callback: Callback<protos.google.cloud.datalabeling.v1beta1.IDataset, protos.google.cloud.datalabeling.v1beta1.IGetDatasetRequest | null | undefined, {} | null | undefined>): void;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.IGetDatasetRequest request
Callback<protos.google.cloud.datalabeling.v1beta1.IDataset, protos.google.cloud.datalabeling.v1beta1.IGetDatasetRequest | null | undefined, {} | null | undefined> callback
Returns
Type Description
void

getEvaluation(request, options)

getEvaluation(request?: protos.google.cloud.datalabeling.v1beta1.IGetEvaluationRequest, options?: CallOptions): Promise<[protos.google.cloud.datalabeling.v1beta1.IEvaluation, (protos.google.cloud.datalabeling.v1beta1.IGetEvaluationRequest | undefined), {} | undefined]>;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.IGetEvaluationRequest request
CallOptions options
Returns
Type Description
Promise<[protos.google.cloud.datalabeling.v1beta1.IEvaluation, (protos.google.cloud.datalabeling.v1beta1.IGetEvaluationRequest | undefined), {} | undefined]>

getEvaluation(request, options, callback)

getEvaluation(request: protos.google.cloud.datalabeling.v1beta1.IGetEvaluationRequest, options: CallOptions, callback: Callback<protos.google.cloud.datalabeling.v1beta1.IEvaluation, protos.google.cloud.datalabeling.v1beta1.IGetEvaluationRequest | null | undefined, {} | null | undefined>): void;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.IGetEvaluationRequest request
CallOptions options
Callback<protos.google.cloud.datalabeling.v1beta1.IEvaluation, protos.google.cloud.datalabeling.v1beta1.IGetEvaluationRequest | null | undefined, {} | null | undefined> callback
Returns
Type Description
void

getEvaluation(request, callback)

getEvaluation(request: protos.google.cloud.datalabeling.v1beta1.IGetEvaluationRequest, callback: Callback<protos.google.cloud.datalabeling.v1beta1.IEvaluation, protos.google.cloud.datalabeling.v1beta1.IGetEvaluationRequest | null | undefined, {} | null | undefined>): void;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.IGetEvaluationRequest request
Callback<protos.google.cloud.datalabeling.v1beta1.IEvaluation, protos.google.cloud.datalabeling.v1beta1.IGetEvaluationRequest | null | undefined, {} | null | undefined> callback
Returns
Type Description
void

getEvaluationJob(request, options)

getEvaluationJob(request?: protos.google.cloud.datalabeling.v1beta1.IGetEvaluationJobRequest, options?: CallOptions): Promise<[protos.google.cloud.datalabeling.v1beta1.IEvaluationJob, (protos.google.cloud.datalabeling.v1beta1.IGetEvaluationJobRequest | undefined), {} | undefined]>;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.IGetEvaluationJobRequest request
CallOptions options
Returns
Type Description
Promise<[protos.google.cloud.datalabeling.v1beta1.IEvaluationJob, (protos.google.cloud.datalabeling.v1beta1.IGetEvaluationJobRequest | undefined), {} | undefined]>

getEvaluationJob(request, options, callback)

getEvaluationJob(request: protos.google.cloud.datalabeling.v1beta1.IGetEvaluationJobRequest, options: CallOptions, callback: Callback<protos.google.cloud.datalabeling.v1beta1.IEvaluationJob, protos.google.cloud.datalabeling.v1beta1.IGetEvaluationJobRequest | null | undefined, {} | null | undefined>): void;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.IGetEvaluationJobRequest request
CallOptions options
Callback<protos.google.cloud.datalabeling.v1beta1.IEvaluationJob, protos.google.cloud.datalabeling.v1beta1.IGetEvaluationJobRequest | null | undefined, {} | null | undefined> callback
Returns
Type Description
void

getEvaluationJob(request, callback)

getEvaluationJob(request: protos.google.cloud.datalabeling.v1beta1.IGetEvaluationJobRequest, callback: Callback<protos.google.cloud.datalabeling.v1beta1.IEvaluationJob, protos.google.cloud.datalabeling.v1beta1.IGetEvaluationJobRequest | null | undefined, {} | null | undefined>): void;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.IGetEvaluationJobRequest request
Callback<protos.google.cloud.datalabeling.v1beta1.IEvaluationJob, protos.google.cloud.datalabeling.v1beta1.IGetEvaluationJobRequest | null | undefined, {} | null | undefined> callback
Returns
Type Description
void

getExample(request, options)

getExample(request?: protos.google.cloud.datalabeling.v1beta1.IGetExampleRequest, options?: CallOptions): Promise<[protos.google.cloud.datalabeling.v1beta1.IExample, protos.google.cloud.datalabeling.v1beta1.IGetExampleRequest | undefined, {} | undefined]>;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.IGetExampleRequest request
CallOptions options
Returns
Type Description
Promise<[protos.google.cloud.datalabeling.v1beta1.IExample, protos.google.cloud.datalabeling.v1beta1.IGetExampleRequest | undefined, {} | undefined]>

getExample(request, options, callback)

getExample(request: protos.google.cloud.datalabeling.v1beta1.IGetExampleRequest, options: CallOptions, callback: Callback<protos.google.cloud.datalabeling.v1beta1.IExample, protos.google.cloud.datalabeling.v1beta1.IGetExampleRequest | null | undefined, {} | null | undefined>): void;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.IGetExampleRequest request
CallOptions options
Callback<protos.google.cloud.datalabeling.v1beta1.IExample, protos.google.cloud.datalabeling.v1beta1.IGetExampleRequest | null | undefined, {} | null | undefined> callback
Returns
Type Description
void

getExample(request, callback)

getExample(request: protos.google.cloud.datalabeling.v1beta1.IGetExampleRequest, callback: Callback<protos.google.cloud.datalabeling.v1beta1.IExample, protos.google.cloud.datalabeling.v1beta1.IGetExampleRequest | null | undefined, {} | null | undefined>): void;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.IGetExampleRequest request
Callback<protos.google.cloud.datalabeling.v1beta1.IExample, protos.google.cloud.datalabeling.v1beta1.IGetExampleRequest | null | undefined, {} | null | undefined> callback
Returns
Type Description
void

getInstruction(request, options)

getInstruction(request?: protos.google.cloud.datalabeling.v1beta1.IGetInstructionRequest, options?: CallOptions): Promise<[protos.google.cloud.datalabeling.v1beta1.IInstruction, (protos.google.cloud.datalabeling.v1beta1.IGetInstructionRequest | undefined), {} | undefined]>;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.IGetInstructionRequest request
CallOptions options
Returns
Type Description
Promise<[protos.google.cloud.datalabeling.v1beta1.IInstruction, (protos.google.cloud.datalabeling.v1beta1.IGetInstructionRequest | undefined), {} | undefined]>

getInstruction(request, options, callback)

getInstruction(request: protos.google.cloud.datalabeling.v1beta1.IGetInstructionRequest, options: CallOptions, callback: Callback<protos.google.cloud.datalabeling.v1beta1.IInstruction, protos.google.cloud.datalabeling.v1beta1.IGetInstructionRequest | null | undefined, {} | null | undefined>): void;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.IGetInstructionRequest request
CallOptions options
Callback<protos.google.cloud.datalabeling.v1beta1.IInstruction, protos.google.cloud.datalabeling.v1beta1.IGetInstructionRequest | null | undefined, {} | null | undefined> callback
Returns
Type Description
void

getInstruction(request, callback)

getInstruction(request: protos.google.cloud.datalabeling.v1beta1.IGetInstructionRequest, callback: Callback<protos.google.cloud.datalabeling.v1beta1.IInstruction, protos.google.cloud.datalabeling.v1beta1.IGetInstructionRequest | null | undefined, {} | null | undefined>): void;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.IGetInstructionRequest request
Callback<protos.google.cloud.datalabeling.v1beta1.IInstruction, protos.google.cloud.datalabeling.v1beta1.IGetInstructionRequest | null | undefined, {} | null | undefined> callback
Returns
Type Description
void

getProjectId()

getProjectId(): Promise<string>;
Returns
Type Description
Promise<string>

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;
Parameter
Type Name Description
Callback<string, undefined, undefined> callback
Returns
Type Description
void

importData(request, options)

importData(request?: protos.google.cloud.datalabeling.v1beta1.IImportDataRequest, options?: CallOptions): Promise<[LROperation<protos.google.cloud.datalabeling.v1beta1.IImportDataOperationResponse, protos.google.cloud.datalabeling.v1beta1.IImportDataOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.IImportDataRequest request
CallOptions options
Returns
Type Description
Promise<[LROperation<protos.google.cloud.datalabeling.v1beta1.IImportDataOperationResponse, protos.google.cloud.datalabeling.v1beta1.IImportDataOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>

importData(request, options, callback)

importData(request: protos.google.cloud.datalabeling.v1beta1.IImportDataRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.datalabeling.v1beta1.IImportDataOperationResponse, protos.google.cloud.datalabeling.v1beta1.IImportDataOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.IImportDataRequest request
CallOptions options
Callback<LROperation<protos.google.cloud.datalabeling.v1beta1.IImportDataOperationResponse, protos.google.cloud.datalabeling.v1beta1.IImportDataOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined> callback
Returns
Type Description
void

importData(request, callback)

importData(request: protos.google.cloud.datalabeling.v1beta1.IImportDataRequest, callback: Callback<LROperation<protos.google.cloud.datalabeling.v1beta1.IImportDataOperationResponse, protos.google.cloud.datalabeling.v1beta1.IImportDataOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.IImportDataRequest request
Callback<LROperation<protos.google.cloud.datalabeling.v1beta1.IImportDataOperationResponse, protos.google.cloud.datalabeling.v1beta1.IImportDataOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined> callback
Returns
Type Description
void

initialize()

initialize(): Promise<{
        [name: string]: Function;
    }>;

Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.

You can await on this method if you want to make sure the client is initialized.

Returns
Type Description
Promise<{ [name: string]: Function; }>

{Promise} A promise that resolves to an authenticated service stub.

instructionPath(project, instruction)

instructionPath(project: string, instruction: string): string;

Return a fully-qualified instruction resource name string.

Parameters
Type Name Description
string project
string instruction
Returns
Type Description
string

{string} Resource name string.

labelImage(request, options)

labelImage(request?: protos.google.cloud.datalabeling.v1beta1.ILabelImageRequest, options?: CallOptions): Promise<[LROperation<protos.google.cloud.datalabeling.v1beta1.IAnnotatedDataset, protos.google.cloud.datalabeling.v1beta1.ILabelOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.ILabelImageRequest request
CallOptions options
Returns
Type Description
Promise<[LROperation<protos.google.cloud.datalabeling.v1beta1.IAnnotatedDataset, protos.google.cloud.datalabeling.v1beta1.ILabelOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>

labelImage(request, options, callback)

labelImage(request: protos.google.cloud.datalabeling.v1beta1.ILabelImageRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.datalabeling.v1beta1.IAnnotatedDataset, protos.google.cloud.datalabeling.v1beta1.ILabelOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.ILabelImageRequest request
CallOptions options
Callback<LROperation<protos.google.cloud.datalabeling.v1beta1.IAnnotatedDataset, protos.google.cloud.datalabeling.v1beta1.ILabelOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined> callback
Returns
Type Description
void

labelImage(request, callback)

labelImage(request: protos.google.cloud.datalabeling.v1beta1.ILabelImageRequest, callback: Callback<LROperation<protos.google.cloud.datalabeling.v1beta1.IAnnotatedDataset, protos.google.cloud.datalabeling.v1beta1.ILabelOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.ILabelImageRequest request
Callback<LROperation<protos.google.cloud.datalabeling.v1beta1.IAnnotatedDataset, protos.google.cloud.datalabeling.v1beta1.ILabelOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined> callback
Returns
Type Description
void

labelText(request, options)

labelText(request?: protos.google.cloud.datalabeling.v1beta1.ILabelTextRequest, options?: CallOptions): Promise<[LROperation<protos.google.cloud.datalabeling.v1beta1.IAnnotatedDataset, protos.google.cloud.datalabeling.v1beta1.ILabelOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.ILabelTextRequest request
CallOptions options
Returns
Type Description
Promise<[LROperation<protos.google.cloud.datalabeling.v1beta1.IAnnotatedDataset, protos.google.cloud.datalabeling.v1beta1.ILabelOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>

labelText(request, options, callback)

labelText(request: protos.google.cloud.datalabeling.v1beta1.ILabelTextRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.datalabeling.v1beta1.IAnnotatedDataset, protos.google.cloud.datalabeling.v1beta1.ILabelOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.ILabelTextRequest request
CallOptions options
Callback<LROperation<protos.google.cloud.datalabeling.v1beta1.IAnnotatedDataset, protos.google.cloud.datalabeling.v1beta1.ILabelOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined> callback
Returns
Type Description
void

labelText(request, callback)

labelText(request: protos.google.cloud.datalabeling.v1beta1.ILabelTextRequest, callback: Callback<LROperation<protos.google.cloud.datalabeling.v1beta1.IAnnotatedDataset, protos.google.cloud.datalabeling.v1beta1.ILabelOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.ILabelTextRequest request
Callback<LROperation<protos.google.cloud.datalabeling.v1beta1.IAnnotatedDataset, protos.google.cloud.datalabeling.v1beta1.ILabelOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined> callback
Returns
Type Description
void

labelVideo(request, options)

labelVideo(request?: protos.google.cloud.datalabeling.v1beta1.ILabelVideoRequest, options?: CallOptions): Promise<[LROperation<protos.google.cloud.datalabeling.v1beta1.IAnnotatedDataset, protos.google.cloud.datalabeling.v1beta1.ILabelOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.ILabelVideoRequest request
CallOptions options
Returns
Type Description
Promise<[LROperation<protos.google.cloud.datalabeling.v1beta1.IAnnotatedDataset, protos.google.cloud.datalabeling.v1beta1.ILabelOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>

labelVideo(request, options, callback)

labelVideo(request: protos.google.cloud.datalabeling.v1beta1.ILabelVideoRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.datalabeling.v1beta1.IAnnotatedDataset, protos.google.cloud.datalabeling.v1beta1.ILabelOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.ILabelVideoRequest request
CallOptions options
Callback<LROperation<protos.google.cloud.datalabeling.v1beta1.IAnnotatedDataset, protos.google.cloud.datalabeling.v1beta1.ILabelOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined> callback
Returns
Type Description
void

labelVideo(request, callback)

labelVideo(request: protos.google.cloud.datalabeling.v1beta1.ILabelVideoRequest, callback: Callback<LROperation<protos.google.cloud.datalabeling.v1beta1.IAnnotatedDataset, protos.google.cloud.datalabeling.v1beta1.ILabelOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.ILabelVideoRequest request
Callback<LROperation<protos.google.cloud.datalabeling.v1beta1.IAnnotatedDataset, protos.google.cloud.datalabeling.v1beta1.ILabelOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined> callback
Returns
Type Description
void

listAnnotatedDatasets(request, options)

listAnnotatedDatasets(request?: protos.google.cloud.datalabeling.v1beta1.IListAnnotatedDatasetsRequest, options?: CallOptions): Promise<[protos.google.cloud.datalabeling.v1beta1.IAnnotatedDataset[], protos.google.cloud.datalabeling.v1beta1.IListAnnotatedDatasetsRequest | null, protos.google.cloud.datalabeling.v1beta1.IListAnnotatedDatasetsResponse]>;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.IListAnnotatedDatasetsRequest request
CallOptions options
Returns
Type Description
Promise<[protos.google.cloud.datalabeling.v1beta1.IAnnotatedDataset[], protos.google.cloud.datalabeling.v1beta1.IListAnnotatedDatasetsRequest | null, protos.google.cloud.datalabeling.v1beta1.IListAnnotatedDatasetsResponse]>

listAnnotatedDatasets(request, options, callback)

listAnnotatedDatasets(request: protos.google.cloud.datalabeling.v1beta1.IListAnnotatedDatasetsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.datalabeling.v1beta1.IListAnnotatedDatasetsRequest, protos.google.cloud.datalabeling.v1beta1.IListAnnotatedDatasetsResponse | null | undefined, protos.google.cloud.datalabeling.v1beta1.IAnnotatedDataset>): void;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.IListAnnotatedDatasetsRequest request
CallOptions options
PaginationCallback<protos.google.cloud.datalabeling.v1beta1.IListAnnotatedDatasetsRequest, protos.google.cloud.datalabeling.v1beta1.IListAnnotatedDatasetsResponse | null | undefined, protos.google.cloud.datalabeling.v1beta1.IAnnotatedDataset> callback
Returns
Type Description
void

listAnnotatedDatasets(request, callback)

listAnnotatedDatasets(request: protos.google.cloud.datalabeling.v1beta1.IListAnnotatedDatasetsRequest, callback: PaginationCallback<protos.google.cloud.datalabeling.v1beta1.IListAnnotatedDatasetsRequest, protos.google.cloud.datalabeling.v1beta1.IListAnnotatedDatasetsResponse | null | undefined, protos.google.cloud.datalabeling.v1beta1.IAnnotatedDataset>): void;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.IListAnnotatedDatasetsRequest request
PaginationCallback<protos.google.cloud.datalabeling.v1beta1.IListAnnotatedDatasetsRequest, protos.google.cloud.datalabeling.v1beta1.IListAnnotatedDatasetsResponse | null | undefined, protos.google.cloud.datalabeling.v1beta1.IAnnotatedDataset> callback
Returns
Type Description
void

listAnnotatedDatasetsAsync(request, options)

listAnnotatedDatasetsAsync(request?: protos.google.cloud.datalabeling.v1beta1.IListAnnotatedDatasetsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.datalabeling.v1beta1.IAnnotatedDataset>;

Equivalent to listAnnotatedDatasets, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.IListAnnotatedDatasetsRequest request

The request object that will be sent.
CallOptions options

Call options. See CallOptions for more details.
Returns
Type Description
AsyncIterable<protos.google.cloud.datalabeling.v1beta1.IAnnotatedDataset>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [AnnotatedDataset]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listAnnotatedDatasetsStream(request, options)

listAnnotatedDatasetsStream(request?: protos.google.cloud.datalabeling.v1beta1.IListAnnotatedDatasetsRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.IListAnnotatedDatasetsRequest request

The request object that will be sent.
CallOptions options

Call options. See CallOptions for more details.
Returns
Type Description
Transform

{Stream} An object stream which emits an object representing [AnnotatedDataset] on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listAnnotatedDatasetsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listAnnotationSpecSets(request, options)

listAnnotationSpecSets(request?: protos.google.cloud.datalabeling.v1beta1.IListAnnotationSpecSetsRequest, options?: CallOptions): Promise<[protos.google.cloud.datalabeling.v1beta1.IAnnotationSpecSet[], protos.google.cloud.datalabeling.v1beta1.IListAnnotationSpecSetsRequest | null, protos.google.cloud.datalabeling.v1beta1.IListAnnotationSpecSetsResponse]>;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.IListAnnotationSpecSetsRequest request
CallOptions options
Returns
Type Description
Promise<[protos.google.cloud.datalabeling.v1beta1.IAnnotationSpecSet[], protos.google.cloud.datalabeling.v1beta1.IListAnnotationSpecSetsRequest | null, protos.google.cloud.datalabeling.v1beta1.IListAnnotationSpecSetsResponse]>

listAnnotationSpecSets(request, options, callback)

listAnnotationSpecSets(request: protos.google.cloud.datalabeling.v1beta1.IListAnnotationSpecSetsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.datalabeling.v1beta1.IListAnnotationSpecSetsRequest, protos.google.cloud.datalabeling.v1beta1.IListAnnotationSpecSetsResponse | null | undefined, protos.google.cloud.datalabeling.v1beta1.IAnnotationSpecSet>): void;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.IListAnnotationSpecSetsRequest request
CallOptions options
PaginationCallback<protos.google.cloud.datalabeling.v1beta1.IListAnnotationSpecSetsRequest, protos.google.cloud.datalabeling.v1beta1.IListAnnotationSpecSetsResponse | null | undefined, protos.google.cloud.datalabeling.v1beta1.IAnnotationSpecSet> callback
Returns
Type Description
void

listAnnotationSpecSets(request, callback)

listAnnotationSpecSets(request: protos.google.cloud.datalabeling.v1beta1.IListAnnotationSpecSetsRequest, callback: PaginationCallback<protos.google.cloud.datalabeling.v1beta1.IListAnnotationSpecSetsRequest, protos.google.cloud.datalabeling.v1beta1.IListAnnotationSpecSetsResponse | null | undefined, protos.google.cloud.datalabeling.v1beta1.IAnnotationSpecSet>): void;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.IListAnnotationSpecSetsRequest request
PaginationCallback<protos.google.cloud.datalabeling.v1beta1.IListAnnotationSpecSetsRequest, protos.google.cloud.datalabeling.v1beta1.IListAnnotationSpecSetsResponse | null | undefined, protos.google.cloud.datalabeling.v1beta1.IAnnotationSpecSet> callback
Returns
Type Description
void

listAnnotationSpecSetsAsync(request, options)

listAnnotationSpecSetsAsync(request?: protos.google.cloud.datalabeling.v1beta1.IListAnnotationSpecSetsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.datalabeling.v1beta1.IAnnotationSpecSet>;

Equivalent to listAnnotationSpecSets, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.IListAnnotationSpecSetsRequest request

The request object that will be sent.
CallOptions options

Call options. See CallOptions for more details.
Returns
Type Description
AsyncIterable<protos.google.cloud.datalabeling.v1beta1.IAnnotationSpecSet>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [AnnotationSpecSet]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listAnnotationSpecSetsStream(request, options)

listAnnotationSpecSetsStream(request?: protos.google.cloud.datalabeling.v1beta1.IListAnnotationSpecSetsRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.IListAnnotationSpecSetsRequest request

The request object that will be sent.
CallOptions options

Call options. See CallOptions for more details.
Returns
Type Description
Transform

{Stream} An object stream which emits an object representing [AnnotationSpecSet] on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listAnnotationSpecSetsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listDataItems(request, options)

listDataItems(request?: protos.google.cloud.datalabeling.v1beta1.IListDataItemsRequest, options?: CallOptions): Promise<[protos.google.cloud.datalabeling.v1beta1.IDataItem[], protos.google.cloud.datalabeling.v1beta1.IListDataItemsRequest | null, protos.google.cloud.datalabeling.v1beta1.IListDataItemsResponse]>;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.IListDataItemsRequest request
CallOptions options
Returns
Type Description
Promise<[protos.google.cloud.datalabeling.v1beta1.IDataItem[], protos.google.cloud.datalabeling.v1beta1.IListDataItemsRequest | null, protos.google.cloud.datalabeling.v1beta1.IListDataItemsResponse]>

listDataItems(request, options, callback)

listDataItems(request: protos.google.cloud.datalabeling.v1beta1.IListDataItemsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.datalabeling.v1beta1.IListDataItemsRequest, protos.google.cloud.datalabeling.v1beta1.IListDataItemsResponse | null | undefined, protos.google.cloud.datalabeling.v1beta1.IDataItem>): void;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.IListDataItemsRequest request
CallOptions options
PaginationCallback<protos.google.cloud.datalabeling.v1beta1.IListDataItemsRequest, protos.google.cloud.datalabeling.v1beta1.IListDataItemsResponse | null | undefined, protos.google.cloud.datalabeling.v1beta1.IDataItem> callback
Returns
Type Description
void

listDataItems(request, callback)

listDataItems(request: protos.google.cloud.datalabeling.v1beta1.IListDataItemsRequest, callback: PaginationCallback<protos.google.cloud.datalabeling.v1beta1.IListDataItemsRequest, protos.google.cloud.datalabeling.v1beta1.IListDataItemsResponse | null | undefined, protos.google.cloud.datalabeling.v1beta1.IDataItem>): void;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.IListDataItemsRequest request
PaginationCallback<protos.google.cloud.datalabeling.v1beta1.IListDataItemsRequest, protos.google.cloud.datalabeling.v1beta1.IListDataItemsResponse | null | undefined, protos.google.cloud.datalabeling.v1beta1.IDataItem> callback
Returns
Type Description
void

listDataItemsAsync(request, options)

listDataItemsAsync(request?: protos.google.cloud.datalabeling.v1beta1.IListDataItemsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.datalabeling.v1beta1.IDataItem>;

Equivalent to listDataItems, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.IListDataItemsRequest request

The request object that will be sent.
CallOptions options

Call options. See CallOptions for more details.
Returns
Type Description
AsyncIterable<protos.google.cloud.datalabeling.v1beta1.IDataItem>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [DataItem]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listDataItemsStream(request, options)

listDataItemsStream(request?: protos.google.cloud.datalabeling.v1beta1.IListDataItemsRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.IListDataItemsRequest request

The request object that will be sent.
CallOptions options

Call options. See CallOptions for more details.
Returns
Type Description
Transform

{Stream} An object stream which emits an object representing [DataItem] on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listDataItemsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listDatasets(request, options)

listDatasets(request?: protos.google.cloud.datalabeling.v1beta1.IListDatasetsRequest, options?: CallOptions): Promise<[protos.google.cloud.datalabeling.v1beta1.IDataset[], protos.google.cloud.datalabeling.v1beta1.IListDatasetsRequest | null, protos.google.cloud.datalabeling.v1beta1.IListDatasetsResponse]>;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.IListDatasetsRequest request
CallOptions options
Returns
Type Description
Promise<[protos.google.cloud.datalabeling.v1beta1.IDataset[], protos.google.cloud.datalabeling.v1beta1.IListDatasetsRequest | null, protos.google.cloud.datalabeling.v1beta1.IListDatasetsResponse]>

listDatasets(request, options, callback)

listDatasets(request: protos.google.cloud.datalabeling.v1beta1.IListDatasetsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.datalabeling.v1beta1.IListDatasetsRequest, protos.google.cloud.datalabeling.v1beta1.IListDatasetsResponse | null | undefined, protos.google.cloud.datalabeling.v1beta1.IDataset>): void;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.IListDatasetsRequest request
CallOptions options
PaginationCallback<protos.google.cloud.datalabeling.v1beta1.IListDatasetsRequest, protos.google.cloud.datalabeling.v1beta1.IListDatasetsResponse | null | undefined, protos.google.cloud.datalabeling.v1beta1.IDataset> callback
Returns
Type Description
void

listDatasets(request, callback)

listDatasets(request: protos.google.cloud.datalabeling.v1beta1.IListDatasetsRequest, callback: PaginationCallback<protos.google.cloud.datalabeling.v1beta1.IListDatasetsRequest, protos.google.cloud.datalabeling.v1beta1.IListDatasetsResponse | null | undefined, protos.google.cloud.datalabeling.v1beta1.IDataset>): void;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.IListDatasetsRequest request
PaginationCallback<protos.google.cloud.datalabeling.v1beta1.IListDatasetsRequest, protos.google.cloud.datalabeling.v1beta1.IListDatasetsResponse | null | undefined, protos.google.cloud.datalabeling.v1beta1.IDataset> callback
Returns
Type Description
void

listDatasetsAsync(request, options)

listDatasetsAsync(request?: protos.google.cloud.datalabeling.v1beta1.IListDatasetsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.datalabeling.v1beta1.IDataset>;

Equivalent to listDatasets, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.IListDatasetsRequest request

The request object that will be sent.
CallOptions options

Call options. See CallOptions for more details.
Returns
Type Description
AsyncIterable<protos.google.cloud.datalabeling.v1beta1.IDataset>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [Dataset]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listDatasetsStream(request, options)

listDatasetsStream(request?: protos.google.cloud.datalabeling.v1beta1.IListDatasetsRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.IListDatasetsRequest request

The request object that will be sent.
CallOptions options

Call options. See CallOptions for more details.
Returns
Type Description
Transform

{Stream} An object stream which emits an object representing [Dataset] on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listDatasetsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listEvaluationJobs(request, options)

listEvaluationJobs(request?: protos.google.cloud.datalabeling.v1beta1.IListEvaluationJobsRequest, options?: CallOptions): Promise<[protos.google.cloud.datalabeling.v1beta1.IEvaluationJob[], protos.google.cloud.datalabeling.v1beta1.IListEvaluationJobsRequest | null, protos.google.cloud.datalabeling.v1beta1.IListEvaluationJobsResponse]>;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.IListEvaluationJobsRequest request
CallOptions options
Returns
Type Description
Promise<[protos.google.cloud.datalabeling.v1beta1.IEvaluationJob[], protos.google.cloud.datalabeling.v1beta1.IListEvaluationJobsRequest | null, protos.google.cloud.datalabeling.v1beta1.IListEvaluationJobsResponse]>

listEvaluationJobs(request, options, callback)

listEvaluationJobs(request: protos.google.cloud.datalabeling.v1beta1.IListEvaluationJobsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.datalabeling.v1beta1.IListEvaluationJobsRequest, protos.google.cloud.datalabeling.v1beta1.IListEvaluationJobsResponse | null | undefined, protos.google.cloud.datalabeling.v1beta1.IEvaluationJob>): void;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.IListEvaluationJobsRequest request
CallOptions options
PaginationCallback<protos.google.cloud.datalabeling.v1beta1.IListEvaluationJobsRequest, protos.google.cloud.datalabeling.v1beta1.IListEvaluationJobsResponse | null | undefined, protos.google.cloud.datalabeling.v1beta1.IEvaluationJob> callback
Returns
Type Description
void

listEvaluationJobs(request, callback)

listEvaluationJobs(request: protos.google.cloud.datalabeling.v1beta1.IListEvaluationJobsRequest, callback: PaginationCallback<protos.google.cloud.datalabeling.v1beta1.IListEvaluationJobsRequest, protos.google.cloud.datalabeling.v1beta1.IListEvaluationJobsResponse | null | undefined, protos.google.cloud.datalabeling.v1beta1.IEvaluationJob>): void;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.IListEvaluationJobsRequest request
PaginationCallback<protos.google.cloud.datalabeling.v1beta1.IListEvaluationJobsRequest, protos.google.cloud.datalabeling.v1beta1.IListEvaluationJobsResponse | null | undefined, protos.google.cloud.datalabeling.v1beta1.IEvaluationJob> callback
Returns
Type Description
void

listEvaluationJobsAsync(request, options)

listEvaluationJobsAsync(request?: protos.google.cloud.datalabeling.v1beta1.IListEvaluationJobsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.datalabeling.v1beta1.IEvaluationJob>;

Equivalent to listEvaluationJobs, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.IListEvaluationJobsRequest request

The request object that will be sent.
CallOptions options

Call options. See CallOptions for more details.
Returns
Type Description
AsyncIterable<protos.google.cloud.datalabeling.v1beta1.IEvaluationJob>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [EvaluationJob]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listEvaluationJobsStream(request, options)

listEvaluationJobsStream(request?: protos.google.cloud.datalabeling.v1beta1.IListEvaluationJobsRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.IListEvaluationJobsRequest request

The request object that will be sent.
CallOptions options

Call options. See CallOptions for more details.
Returns
Type Description
Transform

{Stream} An object stream which emits an object representing [EvaluationJob] on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listEvaluationJobsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listExamples(request, options)

listExamples(request?: protos.google.cloud.datalabeling.v1beta1.IListExamplesRequest, options?: CallOptions): Promise<[protos.google.cloud.datalabeling.v1beta1.IExample[], protos.google.cloud.datalabeling.v1beta1.IListExamplesRequest | null, protos.google.cloud.datalabeling.v1beta1.IListExamplesResponse]>;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.IListExamplesRequest request
CallOptions options
Returns
Type Description
Promise<[protos.google.cloud.datalabeling.v1beta1.IExample[], protos.google.cloud.datalabeling.v1beta1.IListExamplesRequest | null, protos.google.cloud.datalabeling.v1beta1.IListExamplesResponse]>

listExamples(request, options, callback)

listExamples(request: protos.google.cloud.datalabeling.v1beta1.IListExamplesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.datalabeling.v1beta1.IListExamplesRequest, protos.google.cloud.datalabeling.v1beta1.IListExamplesResponse | null | undefined, protos.google.cloud.datalabeling.v1beta1.IExample>): void;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.IListExamplesRequest request
CallOptions options
PaginationCallback<protos.google.cloud.datalabeling.v1beta1.IListExamplesRequest, protos.google.cloud.datalabeling.v1beta1.IListExamplesResponse | null | undefined, protos.google.cloud.datalabeling.v1beta1.IExample> callback
Returns
Type Description
void

listExamples(request, callback)

listExamples(request: protos.google.cloud.datalabeling.v1beta1.IListExamplesRequest, callback: PaginationCallback<protos.google.cloud.datalabeling.v1beta1.IListExamplesRequest, protos.google.cloud.datalabeling.v1beta1.IListExamplesResponse | null | undefined, protos.google.cloud.datalabeling.v1beta1.IExample>): void;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.IListExamplesRequest request
PaginationCallback<protos.google.cloud.datalabeling.v1beta1.IListExamplesRequest, protos.google.cloud.datalabeling.v1beta1.IListExamplesResponse | null | undefined, protos.google.cloud.datalabeling.v1beta1.IExample> callback
Returns
Type Description
void

listExamplesAsync(request, options)

listExamplesAsync(request?: protos.google.cloud.datalabeling.v1beta1.IListExamplesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.datalabeling.v1beta1.IExample>;

Equivalent to listExamples, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.IListExamplesRequest request

The request object that will be sent.
CallOptions options

Call options. See CallOptions for more details.
Returns
Type Description
AsyncIterable<protos.google.cloud.datalabeling.v1beta1.IExample>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [Example]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listExamplesStream(request, options)

listExamplesStream(request?: protos.google.cloud.datalabeling.v1beta1.IListExamplesRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.IListExamplesRequest request

The request object that will be sent.
CallOptions options

Call options. See CallOptions for more details.
Returns
Type Description
Transform

{Stream} An object stream which emits an object representing [Example] on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listExamplesAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listInstructions(request, options)

listInstructions(request?: protos.google.cloud.datalabeling.v1beta1.IListInstructionsRequest, options?: CallOptions): Promise<[protos.google.cloud.datalabeling.v1beta1.IInstruction[], protos.google.cloud.datalabeling.v1beta1.IListInstructionsRequest | null, protos.google.cloud.datalabeling.v1beta1.IListInstructionsResponse]>;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.IListInstructionsRequest request
CallOptions options
Returns
Type Description
Promise<[protos.google.cloud.datalabeling.v1beta1.IInstruction[], protos.google.cloud.datalabeling.v1beta1.IListInstructionsRequest | null, protos.google.cloud.datalabeling.v1beta1.IListInstructionsResponse]>

listInstructions(request, options, callback)

listInstructions(request: protos.google.cloud.datalabeling.v1beta1.IListInstructionsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.datalabeling.v1beta1.IListInstructionsRequest, protos.google.cloud.datalabeling.v1beta1.IListInstructionsResponse | null | undefined, protos.google.cloud.datalabeling.v1beta1.IInstruction>): void;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.IListInstructionsRequest request
CallOptions options
PaginationCallback<protos.google.cloud.datalabeling.v1beta1.IListInstructionsRequest, protos.google.cloud.datalabeling.v1beta1.IListInstructionsResponse | null | undefined, protos.google.cloud.datalabeling.v1beta1.IInstruction> callback
Returns
Type Description
void

listInstructions(request, callback)

listInstructions(request: protos.google.cloud.datalabeling.v1beta1.IListInstructionsRequest, callback: PaginationCallback<protos.google.cloud.datalabeling.v1beta1.IListInstructionsRequest, protos.google.cloud.datalabeling.v1beta1.IListInstructionsResponse | null | undefined, protos.google.cloud.datalabeling.v1beta1.IInstruction>): void;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.IListInstructionsRequest request
PaginationCallback<protos.google.cloud.datalabeling.v1beta1.IListInstructionsRequest, protos.google.cloud.datalabeling.v1beta1.IListInstructionsResponse | null | undefined, protos.google.cloud.datalabeling.v1beta1.IInstruction> callback
Returns
Type Description
void

listInstructionsAsync(request, options)

listInstructionsAsync(request?: protos.google.cloud.datalabeling.v1beta1.IListInstructionsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.datalabeling.v1beta1.IInstruction>;

Equivalent to listInstructions, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.IListInstructionsRequest request

The request object that will be sent.
CallOptions options

Call options. See CallOptions for more details.
Returns
Type Description
AsyncIterable<protos.google.cloud.datalabeling.v1beta1.IInstruction>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [Instruction]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listInstructionsStream(request, options)

listInstructionsStream(request?: protos.google.cloud.datalabeling.v1beta1.IListInstructionsRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.IListInstructionsRequest request

The request object that will be sent.
CallOptions options

Call options. See CallOptions for more details.
Returns
Type Description
Transform

{Stream} An object stream which emits an object representing [Instruction] on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listInstructionsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

matchAnnotatedDatasetFromAnnotatedDatasetName(annotatedDatasetName)

matchAnnotatedDatasetFromAnnotatedDatasetName(annotatedDatasetName: string): string | number;

Parse the annotated_dataset from AnnotatedDataset resource.

Parameter
Type Name Description
string annotatedDatasetName

A fully-qualified path representing AnnotatedDataset resource.
Returns
Type Description
string | number

{string} A string representing the annotated_dataset.

matchAnnotatedDatasetFromExampleName(exampleName)

matchAnnotatedDatasetFromExampleName(exampleName: string): string | number;

Parse the annotated_dataset from Example resource.

Parameter
Type Name Description
string exampleName

A fully-qualified path representing Example resource.
Returns
Type Description
string | number

{string} A string representing the annotated_dataset.

matchAnnotationSpecSetFromAnnotationSpecSetName(annotationSpecSetName)

matchAnnotationSpecSetFromAnnotationSpecSetName(annotationSpecSetName: string): string | number;

Parse the annotation_spec_set from AnnotationSpecSet resource.

Parameter
Type Name Description
string annotationSpecSetName

A fully-qualified path representing AnnotationSpecSet resource.
Returns
Type Description
string | number

{string} A string representing the annotation_spec_set.

matchDataItemFromDataItemName(dataItemName)

matchDataItemFromDataItemName(dataItemName: string): string | number;

Parse the data_item from DataItem resource.

Parameter
Type Name Description
string dataItemName

A fully-qualified path representing DataItem resource.
Returns
Type Description
string | number

{string} A string representing the data_item.

matchDatasetFromAnnotatedDatasetName(annotatedDatasetName)

matchDatasetFromAnnotatedDatasetName(annotatedDatasetName: string): string | number;

Parse the dataset from AnnotatedDataset resource.

Parameter
Type Name Description
string annotatedDatasetName

A fully-qualified path representing AnnotatedDataset resource.
Returns
Type Description
string | number

{string} A string representing the dataset.

matchDatasetFromDataItemName(dataItemName)

matchDatasetFromDataItemName(dataItemName: string): string | number;

Parse the dataset from DataItem resource.

Parameter
Type Name Description
string dataItemName

A fully-qualified path representing DataItem resource.
Returns
Type Description
string | number

{string} A string representing the dataset.

matchDatasetFromDatasetName(datasetName)

matchDatasetFromDatasetName(datasetName: string): string | number;

Parse the dataset from Dataset resource.

Parameter
Type Name Description
string datasetName

A fully-qualified path representing Dataset resource.
Returns
Type Description
string | number

{string} A string representing the dataset.

matchDatasetFromEvaluationName(evaluationName)

matchDatasetFromEvaluationName(evaluationName: string): string | number;

Parse the dataset from Evaluation resource.

Parameter
Type Name Description
string evaluationName

A fully-qualified path representing Evaluation resource.
Returns
Type Description
string | number

{string} A string representing the dataset.

matchDatasetFromExampleName(exampleName)

matchDatasetFromExampleName(exampleName: string): string | number;

Parse the dataset from Example resource.

Parameter
Type Name Description
string exampleName

A fully-qualified path representing Example resource.
Returns
Type Description
string | number

{string} A string representing the dataset.

matchEvaluationFromEvaluationName(evaluationName)

matchEvaluationFromEvaluationName(evaluationName: string): string | number;

Parse the evaluation from Evaluation resource.

Parameter
Type Name Description
string evaluationName

A fully-qualified path representing Evaluation resource.
Returns
Type Description
string | number

{string} A string representing the evaluation.

matchEvaluationJobFromEvaluationJobName(evaluationJobName)

matchEvaluationJobFromEvaluationJobName(evaluationJobName: string): string | number;

Parse the evaluation_job from EvaluationJob resource.

Parameter
Type Name Description
string evaluationJobName

A fully-qualified path representing EvaluationJob resource.
Returns
Type Description
string | number

{string} A string representing the evaluation_job.

matchExampleFromExampleName(exampleName)

matchExampleFromExampleName(exampleName: string): string | number;

Parse the example from Example resource.

Parameter
Type Name Description
string exampleName

A fully-qualified path representing Example resource.
Returns
Type Description
string | number

{string} A string representing the example.

matchInstructionFromInstructionName(instructionName)

matchInstructionFromInstructionName(instructionName: string): string | number;

Parse the instruction from Instruction resource.

Parameter
Type Name Description
string instructionName

A fully-qualified path representing Instruction resource.
Returns
Type Description
string | number

{string} A string representing the instruction.

matchProjectFromAnnotatedDatasetName(annotatedDatasetName)

matchProjectFromAnnotatedDatasetName(annotatedDatasetName: string): string | number;

Parse the project from AnnotatedDataset resource.

Parameter
Type Name Description
string annotatedDatasetName

A fully-qualified path representing AnnotatedDataset resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromAnnotationSpecSetName(annotationSpecSetName)

matchProjectFromAnnotationSpecSetName(annotationSpecSetName: string): string | number;

Parse the project from AnnotationSpecSet resource.

Parameter
Type Name Description
string annotationSpecSetName

A fully-qualified path representing AnnotationSpecSet resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromDataItemName(dataItemName)

matchProjectFromDataItemName(dataItemName: string): string | number;

Parse the project from DataItem resource.

Parameter
Type Name Description
string dataItemName

A fully-qualified path representing DataItem resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromDatasetName(datasetName)

matchProjectFromDatasetName(datasetName: string): string | number;

Parse the project from Dataset resource.

Parameter
Type Name Description
string datasetName

A fully-qualified path representing Dataset resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromEvaluationJobName(evaluationJobName)

matchProjectFromEvaluationJobName(evaluationJobName: string): string | number;

Parse the project from EvaluationJob resource.

Parameter
Type Name Description
string evaluationJobName

A fully-qualified path representing EvaluationJob resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromEvaluationName(evaluationName)

matchProjectFromEvaluationName(evaluationName: string): string | number;

Parse the project from Evaluation resource.

Parameter
Type Name Description
string evaluationName

A fully-qualified path representing Evaluation resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromExampleName(exampleName)

matchProjectFromExampleName(exampleName: string): string | number;

Parse the project from Example resource.

Parameter
Type Name Description
string exampleName

A fully-qualified path representing Example resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromInstructionName(instructionName)

matchProjectFromInstructionName(instructionName: string): string | number;

Parse the project from Instruction resource.

Parameter
Type Name Description
string instructionName

A fully-qualified path representing Instruction resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectName(projectName)

matchProjectFromProjectName(projectName: string): string | number;

Parse the project from Project resource.

Parameter
Type Name Description
string projectName

A fully-qualified path representing Project resource.
Returns
Type Description
string | number

{string} A string representing the project.

pauseEvaluationJob(request, options)

pauseEvaluationJob(request?: protos.google.cloud.datalabeling.v1beta1.IPauseEvaluationJobRequest, options?: CallOptions): Promise<[protos.google.protobuf.IEmpty, (protos.google.cloud.datalabeling.v1beta1.IPauseEvaluationJobRequest | undefined), {} | undefined]>;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.IPauseEvaluationJobRequest request
CallOptions options
Returns
Type Description
Promise<[protos.google.protobuf.IEmpty, (protos.google.cloud.datalabeling.v1beta1.IPauseEvaluationJobRequest | undefined), {} | undefined]>

pauseEvaluationJob(request, options, callback)

pauseEvaluationJob(request: protos.google.cloud.datalabeling.v1beta1.IPauseEvaluationJobRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.datalabeling.v1beta1.IPauseEvaluationJobRequest | null | undefined, {} | null | undefined>): void;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.IPauseEvaluationJobRequest request
CallOptions options
Callback<protos.google.protobuf.IEmpty, protos.google.cloud.datalabeling.v1beta1.IPauseEvaluationJobRequest | null | undefined, {} | null | undefined> callback
Returns
Type Description
void

pauseEvaluationJob(request, callback)

pauseEvaluationJob(request: protos.google.cloud.datalabeling.v1beta1.IPauseEvaluationJobRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.datalabeling.v1beta1.IPauseEvaluationJobRequest | null | undefined, {} | null | undefined>): void;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.IPauseEvaluationJobRequest request
Callback<protos.google.protobuf.IEmpty, protos.google.cloud.datalabeling.v1beta1.IPauseEvaluationJobRequest | null | undefined, {} | null | undefined> callback
Returns
Type Description
void

projectPath(project)

projectPath(project: string): string;

Return a fully-qualified project resource name string.

Parameter
Type Name Description
string project
Returns
Type Description
string

{string} Resource name string.

resumeEvaluationJob(request, options)

resumeEvaluationJob(request?: protos.google.cloud.datalabeling.v1beta1.IResumeEvaluationJobRequest, options?: CallOptions): Promise<[protos.google.protobuf.IEmpty, (protos.google.cloud.datalabeling.v1beta1.IResumeEvaluationJobRequest | undefined), {} | undefined]>;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.IResumeEvaluationJobRequest request
CallOptions options
Returns
Type Description
Promise<[protos.google.protobuf.IEmpty, (protos.google.cloud.datalabeling.v1beta1.IResumeEvaluationJobRequest | undefined), {} | undefined]>

resumeEvaluationJob(request, options, callback)

resumeEvaluationJob(request: protos.google.cloud.datalabeling.v1beta1.IResumeEvaluationJobRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.datalabeling.v1beta1.IResumeEvaluationJobRequest | null | undefined, {} | null | undefined>): void;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.IResumeEvaluationJobRequest request
CallOptions options
Callback<protos.google.protobuf.IEmpty, protos.google.cloud.datalabeling.v1beta1.IResumeEvaluationJobRequest | null | undefined, {} | null | undefined> callback
Returns
Type Description
void

resumeEvaluationJob(request, callback)

resumeEvaluationJob(request: protos.google.cloud.datalabeling.v1beta1.IResumeEvaluationJobRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.datalabeling.v1beta1.IResumeEvaluationJobRequest | null | undefined, {} | null | undefined>): void;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.IResumeEvaluationJobRequest request
Callback<protos.google.protobuf.IEmpty, protos.google.cloud.datalabeling.v1beta1.IResumeEvaluationJobRequest | null | undefined, {} | null | undefined> callback
Returns
Type Description
void

searchEvaluations(request, options)

searchEvaluations(request?: protos.google.cloud.datalabeling.v1beta1.ISearchEvaluationsRequest, options?: CallOptions): Promise<[protos.google.cloud.datalabeling.v1beta1.IEvaluation[], protos.google.cloud.datalabeling.v1beta1.ISearchEvaluationsRequest | null, protos.google.cloud.datalabeling.v1beta1.ISearchEvaluationsResponse]>;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.ISearchEvaluationsRequest request
CallOptions options
Returns
Type Description
Promise<[protos.google.cloud.datalabeling.v1beta1.IEvaluation[], protos.google.cloud.datalabeling.v1beta1.ISearchEvaluationsRequest | null, protos.google.cloud.datalabeling.v1beta1.ISearchEvaluationsResponse]>

searchEvaluations(request, options, callback)

searchEvaluations(request: protos.google.cloud.datalabeling.v1beta1.ISearchEvaluationsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.datalabeling.v1beta1.ISearchEvaluationsRequest, protos.google.cloud.datalabeling.v1beta1.ISearchEvaluationsResponse | null | undefined, protos.google.cloud.datalabeling.v1beta1.IEvaluation>): void;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.ISearchEvaluationsRequest request
CallOptions options
PaginationCallback<protos.google.cloud.datalabeling.v1beta1.ISearchEvaluationsRequest, protos.google.cloud.datalabeling.v1beta1.ISearchEvaluationsResponse | null | undefined, protos.google.cloud.datalabeling.v1beta1.IEvaluation> callback
Returns
Type Description
void

searchEvaluations(request, callback)

searchEvaluations(request: protos.google.cloud.datalabeling.v1beta1.ISearchEvaluationsRequest, callback: PaginationCallback<protos.google.cloud.datalabeling.v1beta1.ISearchEvaluationsRequest, protos.google.cloud.datalabeling.v1beta1.ISearchEvaluationsResponse | null | undefined, protos.google.cloud.datalabeling.v1beta1.IEvaluation>): void;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.ISearchEvaluationsRequest request
PaginationCallback<protos.google.cloud.datalabeling.v1beta1.ISearchEvaluationsRequest, protos.google.cloud.datalabeling.v1beta1.ISearchEvaluationsResponse | null | undefined, protos.google.cloud.datalabeling.v1beta1.IEvaluation> callback
Returns
Type Description
void

searchEvaluationsAsync(request, options)

searchEvaluationsAsync(request?: protos.google.cloud.datalabeling.v1beta1.ISearchEvaluationsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.datalabeling.v1beta1.IEvaluation>;

Equivalent to searchEvaluations, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.ISearchEvaluationsRequest request

The request object that will be sent.
CallOptions options

Call options. See CallOptions for more details.
Returns
Type Description
AsyncIterable<protos.google.cloud.datalabeling.v1beta1.IEvaluation>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [Evaluation]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

searchEvaluationsStream(request, options)

searchEvaluationsStream(request?: protos.google.cloud.datalabeling.v1beta1.ISearchEvaluationsRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.ISearchEvaluationsRequest request

The request object that will be sent.
CallOptions options

Call options. See CallOptions for more details.
Returns
Type Description
Transform

{Stream} An object stream which emits an object representing [Evaluation] on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using searchEvaluationsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

searchExampleComparisons(request, options)

searchExampleComparisons(request?: protos.google.cloud.datalabeling.v1beta1.ISearchExampleComparisonsRequest, options?: CallOptions): Promise<[protos.google.cloud.datalabeling.v1beta1.SearchExampleComparisonsResponse.IExampleComparison[], protos.google.cloud.datalabeling.v1beta1.ISearchExampleComparisonsRequest | null, protos.google.cloud.datalabeling.v1beta1.ISearchExampleComparisonsResponse]>;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.ISearchExampleComparisonsRequest request
CallOptions options
Returns
Type Description
Promise<[protos.google.cloud.datalabeling.v1beta1.SearchExampleComparisonsResponse.IExampleComparison[], protos.google.cloud.datalabeling.v1beta1.ISearchExampleComparisonsRequest | null, protos.google.cloud.datalabeling.v1beta1.ISearchExampleComparisonsResponse]>

searchExampleComparisons(request, options, callback)

searchExampleComparisons(request: protos.google.cloud.datalabeling.v1beta1.ISearchExampleComparisonsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.datalabeling.v1beta1.ISearchExampleComparisonsRequest, protos.google.cloud.datalabeling.v1beta1.ISearchExampleComparisonsResponse | null | undefined, protos.google.cloud.datalabeling.v1beta1.SearchExampleComparisonsResponse.IExampleComparison>): void;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.ISearchExampleComparisonsRequest request
CallOptions options
PaginationCallback<protos.google.cloud.datalabeling.v1beta1.ISearchExampleComparisonsRequest, protos.google.cloud.datalabeling.v1beta1.ISearchExampleComparisonsResponse | null | undefined, protos.google.cloud.datalabeling.v1beta1.SearchExampleComparisonsResponse.IExampleComparison> callback
Returns
Type Description
void

searchExampleComparisons(request, callback)

searchExampleComparisons(request: protos.google.cloud.datalabeling.v1beta1.ISearchExampleComparisonsRequest, callback: PaginationCallback<protos.google.cloud.datalabeling.v1beta1.ISearchExampleComparisonsRequest, protos.google.cloud.datalabeling.v1beta1.ISearchExampleComparisonsResponse | null | undefined, protos.google.cloud.datalabeling.v1beta1.SearchExampleComparisonsResponse.IExampleComparison>): void;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.ISearchExampleComparisonsRequest request
PaginationCallback<protos.google.cloud.datalabeling.v1beta1.ISearchExampleComparisonsRequest, protos.google.cloud.datalabeling.v1beta1.ISearchExampleComparisonsResponse | null | undefined, protos.google.cloud.datalabeling.v1beta1.SearchExampleComparisonsResponse.IExampleComparison> callback
Returns
Type Description
void

searchExampleComparisonsAsync(request, options)

searchExampleComparisonsAsync(request?: protos.google.cloud.datalabeling.v1beta1.ISearchExampleComparisonsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.datalabeling.v1beta1.SearchExampleComparisonsResponse.IExampleComparison>;

Equivalent to searchExampleComparisons, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.ISearchExampleComparisonsRequest request

The request object that will be sent.
CallOptions options

Call options. See CallOptions for more details.
Returns
Type Description
AsyncIterable<protos.google.cloud.datalabeling.v1beta1.SearchExampleComparisonsResponse.IExampleComparison>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [ExampleComparison]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

searchExampleComparisonsStream(request, options)

searchExampleComparisonsStream(request?: protos.google.cloud.datalabeling.v1beta1.ISearchExampleComparisonsRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.ISearchExampleComparisonsRequest request

The request object that will be sent.
CallOptions options

Call options. See CallOptions for more details.
Returns
Type Description
Transform

{Stream} An object stream which emits an object representing [ExampleComparison] on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using searchExampleComparisonsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

updateEvaluationJob(request, options)

updateEvaluationJob(request?: protos.google.cloud.datalabeling.v1beta1.IUpdateEvaluationJobRequest, options?: CallOptions): Promise<[protos.google.cloud.datalabeling.v1beta1.IEvaluationJob, (protos.google.cloud.datalabeling.v1beta1.IUpdateEvaluationJobRequest | undefined), {} | undefined]>;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.IUpdateEvaluationJobRequest request
CallOptions options
Returns
Type Description
Promise<[protos.google.cloud.datalabeling.v1beta1.IEvaluationJob, (protos.google.cloud.datalabeling.v1beta1.IUpdateEvaluationJobRequest | undefined), {} | undefined]>

updateEvaluationJob(request, options, callback)

updateEvaluationJob(request: protos.google.cloud.datalabeling.v1beta1.IUpdateEvaluationJobRequest, options: CallOptions, callback: Callback<protos.google.cloud.datalabeling.v1beta1.IEvaluationJob, protos.google.cloud.datalabeling.v1beta1.IUpdateEvaluationJobRequest | null | undefined, {} | null | undefined>): void;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.IUpdateEvaluationJobRequest request
CallOptions options
Callback<protos.google.cloud.datalabeling.v1beta1.IEvaluationJob, protos.google.cloud.datalabeling.v1beta1.IUpdateEvaluationJobRequest | null | undefined, {} | null | undefined> callback
Returns
Type Description
void

updateEvaluationJob(request, callback)

updateEvaluationJob(request: protos.google.cloud.datalabeling.v1beta1.IUpdateEvaluationJobRequest, callback: Callback<protos.google.cloud.datalabeling.v1beta1.IEvaluationJob, protos.google.cloud.datalabeling.v1beta1.IUpdateEvaluationJobRequest | null | undefined, {} | null | undefined>): void;
Parameters
Type Name Description
protos.google.cloud.datalabeling.v1beta1.IUpdateEvaluationJobRequest request
Callback<protos.google.cloud.datalabeling.v1beta1.IEvaluationJob, protos.google.cloud.datalabeling.v1beta1.IUpdateEvaluationJobRequest | null | undefined, {} | null | undefined> callback
Returns
Type Description
void