Class Instruction (2.0.0-beta01)

public sealed class Instruction : IMessage<Instruction>, IEquatable<Instruction>, IDeepCloneable<Instruction>, IBufferMessage, IMessage

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

Inheritance

Object > Instruction

Namespace

Google.Cloud.DataLabeling.V1Beta1

Assembly

Google.Cloud.DataLabeling.V1Beta1.dll

Constructors

Instruction()

public Instruction()

Instruction(Instruction)

public Instruction(Instruction other)
Parameter
NameDescription
otherInstruction

Properties

BlockingResources

public RepeatedField<string> BlockingResources { get; }

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

Property Value
TypeDescription
RepeatedField<String>

CreateTime

public Timestamp CreateTime { get; set; }

Output only. Creation time of instruction.

Property Value
TypeDescription
Timestamp

CsvInstruction

[Obsolete]
public CsvInstruction CsvInstruction { get; set; }

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.
Property Value
TypeDescription
CsvInstruction

DataType

public DataType DataType { get; set; }

Required. The data type of this instruction.

Property Value
TypeDescription
DataType

Description

public string Description { get; set; }

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

Property Value
TypeDescription
String

DisplayName

public string DisplayName { get; set; }

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

Property Value
TypeDescription
String

InstructionName

public InstructionName InstructionName { get; set; }

InstructionName-typed view over the Name resource name property.

Property Value
TypeDescription
InstructionName

Name

public string Name { get; set; }

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

Property Value
TypeDescription
String

PdfInstruction

public PdfInstruction PdfInstruction { get; set; }

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

Property Value
TypeDescription
PdfInstruction

UpdateTime

public Timestamp UpdateTime { get; set; }

Output only. Last update time of instruction.

Property Value
TypeDescription
Timestamp