public final class Instruction extends GeneratedMessageV3 implements InstructionOrBuilder
Instruction of how to perform the labeling task for human operators.
Currently only PDF instruction is supported.
Protobuf type google.cloud.datalabeling.v1beta1.Instruction
Static Fields
BLOCKING_RESOURCES_FIELD_NUMBER
public static final int BLOCKING_RESOURCES_FIELD_NUMBER
Field Value
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
Field Value
CSV_INSTRUCTION_FIELD_NUMBER
public static final int CSV_INSTRUCTION_FIELD_NUMBER
Field Value
DATA_TYPE_FIELD_NUMBER
public static final int DATA_TYPE_FIELD_NUMBER
Field Value
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
Field Value
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
PDF_INSTRUCTION_FIELD_NUMBER
public static final int PDF_INSTRUCTION_FIELD_NUMBER
Field Value
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static Instruction getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static Instruction.Builder newBuilder()
Returns
newBuilder(Instruction prototype)
public static Instruction.Builder newBuilder(Instruction prototype)
Parameter
Returns
public static Instruction parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static Instruction parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static Instruction parseFrom(byte[] data)
Parameter
| Name | Description |
data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Instruction parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static Instruction parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Instruction parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Instruction parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static Instruction parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Instruction parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static Instruction parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static Instruction parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Instruction parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<Instruction> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getBlockingResources(int index)
public String getBlockingResources(int index)
Output only. The names of any related resources that are blocking changes
to the instruction.
repeated string blocking_resources = 10;
| Name | Description |
index | int
The index of the element to return.
|
Returns
| Type | Description |
String | The blockingResources at the given index.
|
getBlockingResourcesBytes(int index)
public ByteString getBlockingResourcesBytes(int index)
Output only. The names of any related resources that are blocking changes
to the instruction.
repeated string blocking_resources = 10;
| Name | Description |
index | int
The index of the value to return.
|
Returns
| Type | Description |
ByteString | The bytes of the blockingResources at the given index.
|
getBlockingResourcesCount()
public int getBlockingResourcesCount()
Output only. The names of any related resources that are blocking changes
to the instruction.
repeated string blocking_resources = 10;
| Type | Description |
int | The count of blockingResources.
|
getBlockingResourcesList()
public ProtocolStringList getBlockingResourcesList()
Output only. The names of any related resources that are blocking changes
to the instruction.
repeated string blocking_resources = 10;
getCreateTime()
public Timestamp getCreateTime()
Output only. Creation time of instruction.
.google.protobuf.Timestamp create_time = 4;
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. Creation time of instruction.
.google.protobuf.Timestamp create_time = 4;
getCsvInstruction() (deprecated)
public CsvInstruction getCsvInstruction()
Deprecated. google.cloud.datalabeling.v1beta1.Instruction.csv_instruction is deprecated. See
google/cloud/datalabeling/v1beta1/instruction.proto;l=64
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.
.google.cloud.datalabeling.v1beta1.CsvInstruction csv_instruction = 7 [deprecated = true];
getCsvInstructionOrBuilder()
public CsvInstructionOrBuilder getCsvInstructionOrBuilder()
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.
.google.cloud.datalabeling.v1beta1.CsvInstruction csv_instruction = 7 [deprecated = true];
getDataType()
public DataType getDataType()
Required. The data type of this instruction.
.google.cloud.datalabeling.v1beta1.DataType data_type = 6;
getDataTypeValue()
public int getDataTypeValue()
Required. The data type of this instruction.
.google.cloud.datalabeling.v1beta1.DataType data_type = 6;
| Type | Description |
int | The enum numeric value on the wire for dataType.
|
getDefaultInstanceForType()
public Instruction getDefaultInstanceForType()
Returns
getDescription()
public String getDescription()
Optional. User-provided description of the instruction.
The description can be up to 10000 characters long.
string description = 3;
| Type | Description |
String | The description.
|
getDescriptionBytes()
public ByteString getDescriptionBytes()
Optional. User-provided description of the instruction.
The description can be up to 10000 characters long.
string description = 3;
| Type | Description |
ByteString | The bytes for description.
|
getDisplayName()
public String getDisplayName()
Required. The display name of the instruction. Maximum of 64 characters.
string display_name = 2;
| Type | Description |
String | The displayName.
|
getDisplayNameBytes()
public ByteString getDisplayNameBytes()
Required. The display name of the instruction. Maximum of 64 characters.
string display_name = 2;
| Type | Description |
ByteString | The bytes for displayName.
|
getName()
Output only. Instruction resource name, format:
projects/{project_id}/instructions/{instruction_id}
string name = 1;
| Type | Description |
String | The name.
|
getNameBytes()
public ByteString getNameBytes()
Output only. Instruction resource name, format:
projects/{project_id}/instructions/{instruction_id}
string name = 1;
getParserForType()
public Parser<Instruction> getParserForType()
Returns
Overrides
getPdfInstruction()
public PdfInstruction getPdfInstruction()
Instruction from a PDF document. The PDF should be in a Cloud Storage
bucket.
.google.cloud.datalabeling.v1beta1.PdfInstruction pdf_instruction = 9;
getPdfInstructionOrBuilder()
public PdfInstructionOrBuilder getPdfInstructionOrBuilder()
Instruction from a PDF document. The PDF should be in a Cloud Storage
bucket.
.google.cloud.datalabeling.v1beta1.PdfInstruction pdf_instruction = 9;
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
getUpdateTime()
public Timestamp getUpdateTime()
Output only. Last update time of instruction.
.google.protobuf.Timestamp update_time = 5;
getUpdateTimeOrBuilder()
public TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. Last update time of instruction.
.google.protobuf.Timestamp update_time = 5;
hasCreateTime()
public boolean hasCreateTime()
Output only. Creation time of instruction.
.google.protobuf.Timestamp create_time = 4;
| Type | Description |
boolean | Whether the createTime field is set.
|
hasCsvInstruction() (deprecated)
public boolean hasCsvInstruction()
Deprecated. google.cloud.datalabeling.v1beta1.Instruction.csv_instruction is deprecated. See
google/cloud/datalabeling/v1beta1/instruction.proto;l=64
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.
.google.cloud.datalabeling.v1beta1.CsvInstruction csv_instruction = 7 [deprecated = true];
| Type | Description |
boolean | Whether the csvInstruction field is set.
|
hasPdfInstruction()
public boolean hasPdfInstruction()
Instruction from a PDF document. The PDF should be in a Cloud Storage
bucket.
.google.cloud.datalabeling.v1beta1.PdfInstruction pdf_instruction = 9;
| Type | Description |
boolean | Whether the pdfInstruction field is set.
|
hasUpdateTime()
public boolean hasUpdateTime()
Output only. Last update time of instruction.
.google.protobuf.Timestamp update_time = 5;
| Type | Description |
boolean | Whether the updateTime field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public Instruction.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Instruction.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public Instruction.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
