Class protos.google.cloud.datalabeling.v1beta1.Instruction

Represents an Instruction.

Package

@google-cloud/datalabeling

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.datalabeling.v1beta1.IInstruction);

Constructs a new Instruction.

Parameter
NameDescription
properties IInstruction

Properties to set

Properties

blockingResources

public blockingResources: string[];

Instruction blockingResources.

createTime

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

Instruction createTime.

csvInstruction

public csvInstruction?: (google.cloud.datalabeling.v1beta1.ICsvInstruction|null);

Instruction csvInstruction.

dataType

public dataType: (google.cloud.datalabeling.v1beta1.DataType|keyof typeof google.cloud.datalabeling.v1beta1.DataType);

Instruction dataType.

description

public description: string;

Instruction description.

displayName

public displayName: string;

Instruction displayName.

name

public name: string;

Instruction name.

pdfInstruction

public pdfInstruction?: (google.cloud.datalabeling.v1beta1.IPdfInstruction|null);

Instruction pdfInstruction.

updateTime

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

Instruction updateTime.

Methods

create(properties)

public static create(properties?: google.cloud.datalabeling.v1beta1.IInstruction): google.cloud.datalabeling.v1beta1.Instruction;

Creates a new Instruction instance using the specified properties.

Parameter
NameDescription
properties IInstruction

Properties to set

Returns
TypeDescription
google.cloud.datalabeling.v1beta1.Instruction

Instruction instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.datalabeling.v1beta1.Instruction;

Decodes an Instruction message from the specified reader or buffer.

Parameters
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
google.cloud.datalabeling.v1beta1.Instruction

Instruction

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.datalabeling.v1beta1.Instruction;

Decodes an Instruction message from the specified reader or buffer, length delimited.

Parameter
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
google.cloud.datalabeling.v1beta1.Instruction

Instruction

encode(message, writer)

public static encode(message: google.cloud.datalabeling.v1beta1.IInstruction, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Instruction message. Does not implicitly messages.

Parameters
NameDescription
message IInstruction

Instruction message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.datalabeling.v1beta1.IInstruction, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IInstruction

Instruction message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.datalabeling.v1beta1.Instruction;

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

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
google.cloud.datalabeling.v1beta1.Instruction

Instruction

toJSON()

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

Converts this Instruction to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message google.cloud.datalabeling.v1beta1.Instruction

Instruction

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

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

Verifies an Instruction message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not