Class protos.google.cloud.aiplatform.v1.DataLabelingJob (2.11.0)

Represents a DataLabelingJob.

Package

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.aiplatform.v1.IDataLabelingJob);

Constructs a new DataLabelingJob.

Parameter
Name	Description
`properties`	`IDataLabelingJob` Properties to set

Properties

activeLearningConfig

public activeLearningConfig?: (google.cloud.aiplatform.v1.IActiveLearningConfig|null);

DataLabelingJob activeLearningConfig.

annotationLabels

public annotationLabels: { [k: string]: string };

DataLabelingJob annotationLabels.

createTime

public createTime?: (google.protobuf.ITimestamp|null);

DataLabelingJob createTime.

currentSpend

public currentSpend?: (google.type.IMoney|null);

DataLabelingJob currentSpend.

datasets

public datasets: string[];

DataLabelingJob datasets.

displayName

public displayName: string;

DataLabelingJob displayName.

encryptionSpec

public encryptionSpec?: (google.cloud.aiplatform.v1.IEncryptionSpec|null);

DataLabelingJob encryptionSpec.

error

public error?: (google.rpc.IStatus|null);

DataLabelingJob error.

inputs

public inputs?: (google.protobuf.IValue|null);

DataLabelingJob inputs.

inputsSchemaUri

public inputsSchemaUri: string;

DataLabelingJob inputsSchemaUri.

instructionUri

public instructionUri: string;

DataLabelingJob instructionUri.

labelerCount

public labelerCount: number;

DataLabelingJob labelerCount.

labelingProgress

public labelingProgress: number;

DataLabelingJob labelingProgress.

labels

public labels: { [k: string]: string };

DataLabelingJob labels.

name

public name: string;

DataLabelingJob name.

specialistPools

public specialistPools: string[];

DataLabelingJob specialistPools.

state

public state: (google.cloud.aiplatform.v1.JobState|keyof typeof google.cloud.aiplatform.v1.JobState);

DataLabelingJob state.

updateTime

public updateTime?: (google.protobuf.ITimestamp|null);

DataLabelingJob updateTime.

Methods

create(properties)

public static create(properties?: google.cloud.aiplatform.v1.IDataLabelingJob): google.cloud.aiplatform.v1.DataLabelingJob;

Creates a new DataLabelingJob instance using the specified properties.

Parameter
Name	Description
`properties`	`IDataLabelingJob` Properties to set

Returns
Type	Description
`google.cloud.aiplatform.v1.DataLabelingJob`	DataLabelingJob instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.aiplatform.v1.DataLabelingJob;

Decodes a DataLabelingJob message from the specified reader or buffer.

Parameters
Name	Description
`reader`	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from
`length`	`number` Message length if known beforehand

Returns
Type	Description
`google.cloud.aiplatform.v1.DataLabelingJob`	DataLabelingJob

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.aiplatform.v1.DataLabelingJob;

Decodes a DataLabelingJob message from the specified reader or buffer, length delimited.

Parameter
Name	Description
`reader`	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from

Returns
Type	Description
`google.cloud.aiplatform.v1.DataLabelingJob`	DataLabelingJob

encode(message, writer)

public static encode(message: google.cloud.aiplatform.v1.IDataLabelingJob, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified DataLabelingJob message. Does not implicitly messages.

Parameters
Name	Description
`message`	`IDataLabelingJob` DataLabelingJob message or plain object to encode
`writer`	`$protobuf.Writer` Writer to encode to

Returns
Type	Description
`$protobuf.Writer`	Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.aiplatform.v1.IDataLabelingJob, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified DataLabelingJob message, length delimited. Does not implicitly messages.

Parameters
Name	Description
`message`	`IDataLabelingJob` DataLabelingJob message or plain object to encode
`writer`	`$protobuf.Writer` Writer to encode to

Returns
Type	Description
`$protobuf.Writer`	Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.aiplatform.v1.DataLabelingJob;

Creates a DataLabelingJob message from a plain object. Also converts values to their respective internal types.

Parameter
Name	Description
`object`	`{ [k: string]: any }` Plain object

Returns
Type	Description
`google.cloud.aiplatform.v1.DataLabelingJob`	DataLabelingJob

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for DataLabelingJob

Parameter
Name	Description
`typeUrlPrefix`	`string` your custom typeUrlPrefix(default "type.googleapis.com")

Returns
Type	Description
`string`	The default type url

toJSON()

public toJSON(): { [k: string]: any };

Converts this DataLabelingJob to JSON.

Returns
Type	Description
`{ [k: string]: any }`	JSON object

toObject(message, options)

public static toObject(message: google.cloud.aiplatform.v1.DataLabelingJob, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from a DataLabelingJob message. Also converts values to other types if specified.

Parameters
Name	Description
`message`	`google.cloud.aiplatform.v1.DataLabelingJob` DataLabelingJob
`options`	`$protobuf.IConversionOptions` Conversion options

Returns
Type	Description
`{ [k: string]: any }`	Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a DataLabelingJob message.

Parameter
Name	Description
`message`	`{ [k: string]: any }` Plain object to verify

Returns
Type	Description
`(string\|null)`	`null` if valid, otherwise the reason why it is not