Represents an Instruction.
Package
@google-cloud/datalabelingConstructors
(constructor)(properties)
constructor(properties?: google.cloud.datalabeling.v1beta1.IInstruction);Constructs a new Instruction.
| Parameter | |
|---|---|
| Name | Description |
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 | |
|---|---|
| Name | Description |
properties |
IInstruction
Properties to set |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
reader |
($protobuf.Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
reader |
($protobuf.Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
message |
IInstruction
Instruction 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.datalabeling.v1beta1.IInstruction, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Instruction message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IInstruction
Instruction 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.datalabeling.v1beta1.Instruction;Creates an Instruction 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.datalabeling.v1beta1.Instruction | Instruction |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for Instruction
| 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 Instruction to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [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 | |
|---|---|
| Name | Description |
message |
google.cloud.datalabeling.v1beta1.Instruction
Instruction |
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 an Instruction message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|