Class Instruction

Instruction of how to perform the labeling task for human operators. Currently only PDF instruction is supported.

Inheritance
System.Object
Instruction
Implements
System.IEquatable<Instruction>
Google.Protobuf.IBufferMessage
Inherited Members
System.Object.ToString()
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Google.Cloud.DataLabeling.V1Beta1
Assembly: Google.Cloud.DataLabeling.V1Beta1.dll
Syntax
public sealed class Instruction : IMessage<Instruction>, IEquatable<Instruction>, IDeepCloneable<Instruction>, IBufferMessage, IMessage

Constructors

Instruction()

Declaration
public Instruction()

Instruction(Instruction)

Declaration
public Instruction(Instruction other)
Parameters
Type Name Description
Instruction other

Properties

BlockingResources

Output only. The names of any related resources that are blocking changes to the instruction.

Declaration
public RepeatedField<string> BlockingResources { get; }
Property Value
Type Description
RepeatedField<System.String>

CreateTime

Output only. Creation time of instruction.

Declaration
public Timestamp CreateTime { get; set; }
Property Value
Type Description
Timestamp

CsvInstruction

Deprecated: this instruction format is not supported any more. Instruction from a CSV file, such as for classification task. The CSV file should have exact two columns, in the following format:

  • The first column is labeled data, such as an image reference, text.
  • The second column is comma separated labels associated with data.
Declaration
[Obsolete]
public CsvInstruction CsvInstruction { get; set; }
Property Value
Type Description
CsvInstruction

DataType

Required. The data type of this instruction.

Declaration
public DataType DataType { get; set; }
Property Value
Type Description
DataType

Description

Optional. User-provided description of the instruction. The description can be up to 10000 characters long.

Declaration
public string Description { get; set; }
Property Value
Type Description
System.String

DisplayName

Required. The display name of the instruction. Maximum of 64 characters.

Declaration
public string DisplayName { get; set; }
Property Value
Type Description
System.String

InstructionName

InstructionName-typed view over the Name resource name property.

Declaration
public InstructionName InstructionName { get; set; }
Property Value
Type Description
InstructionName

Name

Output only. Instruction resource name, format: projects/{project_id}/instructions/{instruction_id}

Declaration
public string Name { get; set; }
Property Value
Type Description
System.String

PdfInstruction

Instruction from a PDF document. The PDF should be in a Cloud Storage bucket.

Declaration
public PdfInstruction PdfInstruction { get; set; }
Property Value
Type Description
PdfInstruction

UpdateTime

Output only. Last update time of instruction.

Declaration
public Timestamp UpdateTime { get; set; }
Property Value
Type Description
Timestamp