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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
Static Fields
BLOCKING_RESOURCES_FIELD_NUMBER
public static final int BLOCKING_RESOURCES_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
CSV_INSTRUCTION_FIELD_NUMBER
public static final int CSV_INSTRUCTION_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
DATA_TYPE_FIELD_NUMBER
public static final int DATA_TYPE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
PDF_INSTRUCTION_FIELD_NUMBER
public static final int PDF_INSTRUCTION_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static Instruction getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Instruction.Builder newBuilder()
newBuilder(Instruction prototype)
public static Instruction.Builder newBuilder(Instruction prototype)
public static Instruction parseDelimitedFrom(InputStream input)
public static Instruction parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static Instruction parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Instruction parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static Instruction parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Instruction parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Instruction parseFrom(CodedInputStream input)
public static Instruction parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Instruction parseFrom(InputStream input)
public static Instruction parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static Instruction parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Instruction parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<Instruction> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
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;
| Parameter |
|---|
| 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;
| Parameter |
|---|
| 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;
| Returns |
|---|
| 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;
| Returns |
|---|
| Type | Description |
Timestamp | The createTime.
|
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;
| Returns |
|---|
| Type | Description |
DataType | The dataType.
|
getDataTypeValue()
public int getDataTypeValue()
Required. The data type of this instruction.
.google.cloud.datalabeling.v1beta1.DataType data_type = 6;
| Returns |
|---|
| Type | Description |
int | The enum numeric value on the wire for dataType.
|
getDefaultInstanceForType()
public Instruction getDefaultInstanceForType()
getDescription()
public String getDescription()
Optional. User-provided description of the instruction.
The description can be up to 10000 characters long.
string description = 3;
| Returns |
|---|
| 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;
| Returns |
|---|
| 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;
| Returns |
|---|
| Type | Description |
String | The displayName.
|
getDisplayNameBytes()
public ByteString getDisplayNameBytes()
Required. The display name of the instruction. Maximum of 64 characters.
string display_name = 2;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for displayName.
|
getName()
Output only. Instruction resource name, format:
projects/{project_id}/instructions/{instruction_id}
string name = 1;
| Returns |
|---|
| Type | Description |
String | The name.
|
getNameBytes()
public ByteString getNameBytes()
Output only. Instruction resource name, format:
projects/{project_id}/instructions/{instruction_id}
string name = 1;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for name.
|
getParserForType()
public Parser<Instruction> getParserForType()
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 |
|---|
| Type | Description |
int | |
Overrides
getUpdateTime()
public Timestamp getUpdateTime()
Output only. Last update time of instruction.
.google.protobuf.Timestamp update_time = 5;
| Returns |
|---|
| Type | Description |
Timestamp | The updateTime.
|
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;
| Returns |
|---|
| 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];
| Returns |
|---|
| 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;
| Returns |
|---|
| 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;
| Returns |
|---|
| Type | Description |
boolean | Whether the updateTime field is set.
|
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public Instruction.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Instruction.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public Instruction.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
