com.google.cloud.datalabeling.v1beta1

Class Instruction

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.datalabeling.v1beta1.Instruction

All Implemented Interfaces:

InstructionOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class Instruction
extends com.google.protobuf.GeneratedMessageV3
implements InstructionOrBuilder

 Instruction of how to perform the labeling task for human operators.
 Currently two types of instruction are supported - CSV file and PDF.
 One of the two types instruction must be provided.
 CSV file is only supported for image classification task. Instructions for
 other task should be provided as PDF.
 For image classification, CSV and PDF can be provided at the same time.
 

Protobuf type google.cloud.datalabeling.v1beta1.Instruction

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Instruction.Builder Instruction of how to perform the labeling task for human operators.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable

Field Summary

Fields

Modifier and Type	Field and Description
static int	BLOCKING_RESOURCES_FIELD_NUMBER
static int	CREATE_TIME_FIELD_NUMBER
static int	CSV_INSTRUCTION_FIELD_NUMBER
static int	DATA_TYPE_FIELD_NUMBER
static int	DESCRIPTION_FIELD_NUMBER
static int	DISPLAY_NAME_FIELD_NUMBER
static int	NAME_FIELD_NUMBER
static int	PDF_INSTRUCTION_FIELD_NUMBER
static int	UPDATE_TIME_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getBlockingResources(int index) Output only.
com.google.protobuf.ByteString	getBlockingResourcesBytes(int index) Output only.
int	getBlockingResourcesCount() Output only.
com.google.protobuf.ProtocolStringList	getBlockingResourcesList() Output only.
com.google.protobuf.Timestamp	getCreateTime() Output only.
com.google.protobuf.TimestampOrBuilder	getCreateTimeOrBuilder() Output only.
CsvInstruction	getCsvInstruction() One of CSV or PDF instruction is required.
CsvInstructionOrBuilder	getCsvInstructionOrBuilder() One of CSV or PDF instruction is required.
DataType	getDataType() Required.
int	getDataTypeValue() Required.
static Instruction	getDefaultInstance()
Instruction	getDefaultInstanceForType()
String	getDescription() Optional.
com.google.protobuf.ByteString	getDescriptionBytes() Optional.
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getDisplayName() Required.
com.google.protobuf.ByteString	getDisplayNameBytes() Required.
String	getName() Output only.
com.google.protobuf.ByteString	getNameBytes() Output only.
com.google.protobuf.Parser<Instruction>	getParserForType()
PdfInstruction	getPdfInstruction() One of CSV or PDF instruction is required.
PdfInstructionOrBuilder	getPdfInstructionOrBuilder() One of CSV or PDF instruction is required.
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
com.google.protobuf.Timestamp	getUpdateTime() Output only.
com.google.protobuf.TimestampOrBuilder	getUpdateTimeOrBuilder() Output only.
boolean	hasCreateTime() Output only.
boolean	hasCsvInstruction() One of CSV or PDF instruction is required.
int	hashCode()
boolean	hasPdfInstruction() One of CSV or PDF instruction is required.
boolean	hasUpdateTime() Output only.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Instruction.Builder	newBuilder()
static Instruction.Builder	newBuilder(Instruction prototype)
Instruction.Builder	newBuilderForType()
protected Instruction.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
static Instruction	parseDelimitedFrom(InputStream input)
static Instruction	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Instruction	parseFrom(byte[] data)
static Instruction	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Instruction	parseFrom(ByteBuffer data)
static Instruction	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Instruction	parseFrom(com.google.protobuf.ByteString data)
static Instruction	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Instruction	parseFrom(com.google.protobuf.CodedInputStream input)
static Instruction	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Instruction	parseFrom(InputStream input)
static Instruction	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Instruction>	parser()
Instruction.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

See Also:

Constant Field Values

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER

See Also:

Constant Field Values

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER

See Also:

Constant Field Values

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER

See Also:

Constant Field Values

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER

See Also:

Constant Field Values

DATA_TYPE_FIELD_NUMBER

public static final int DATA_TYPE_FIELD_NUMBER

See Also:

Constant Field Values

CSV_INSTRUCTION_FIELD_NUMBER

public static final int CSV_INSTRUCTION_FIELD_NUMBER

See Also:

Constant Field Values

PDF_INSTRUCTION_FIELD_NUMBER

public static final int PDF_INSTRUCTION_FIELD_NUMBER

See Also:

Constant Field Values

BLOCKING_RESOURCES_FIELD_NUMBER

public static final int BLOCKING_RESOURCES_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getName

public String getName()

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

string name = 1;

Specified by:

getName in interface InstructionOrBuilder

getNameBytes

public com.google.protobuf.ByteString getNameBytes()

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

string name = 1;

Specified by:

getNameBytes in interface InstructionOrBuilder

getDisplayName

public String getDisplayName()

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

string display_name = 2;

Specified by:

getDisplayName in interface InstructionOrBuilder

getDisplayNameBytes

public com.google.protobuf.ByteString getDisplayNameBytes()

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

string display_name = 2;

Specified by:

getDisplayNameBytes in interface InstructionOrBuilder

getDescription

public String getDescription()

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

string description = 3;

Specified by:

getDescription in interface InstructionOrBuilder

getDescriptionBytes

public com.google.protobuf.ByteString getDescriptionBytes()

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

string description = 3;

Specified by:

getDescriptionBytes in interface InstructionOrBuilder

hasCreateTime

public boolean hasCreateTime()

 Output only. Creation time of instruction.
 

.google.protobuf.Timestamp create_time = 4;

Specified by:

hasCreateTime in interface InstructionOrBuilder

getCreateTime

public com.google.protobuf.Timestamp getCreateTime()

 Output only. Creation time of instruction.
 

.google.protobuf.Timestamp create_time = 4;

Specified by:

getCreateTime in interface InstructionOrBuilder

getCreateTimeOrBuilder

public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()

 Output only. Creation time of instruction.
 

.google.protobuf.Timestamp create_time = 4;

Specified by:

getCreateTimeOrBuilder in interface InstructionOrBuilder

hasUpdateTime

public boolean hasUpdateTime()

 Output only. Last update time of instruction.
 

.google.protobuf.Timestamp update_time = 5;

Specified by:

hasUpdateTime in interface InstructionOrBuilder

getUpdateTime

public com.google.protobuf.Timestamp getUpdateTime()

 Output only. Last update time of instruction.
 

.google.protobuf.Timestamp update_time = 5;

Specified by:

getUpdateTime in interface InstructionOrBuilder

getUpdateTimeOrBuilder

public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()

 Output only. Last update time of instruction.
 

.google.protobuf.Timestamp update_time = 5;

Specified by:

getUpdateTimeOrBuilder in interface InstructionOrBuilder

getDataTypeValue

public int getDataTypeValue()

 Required. The data type of this instruction.
 

.google.cloud.datalabeling.v1beta1.DataType data_type = 6;

Specified by:

getDataTypeValue in interface InstructionOrBuilder

getDataType

public DataType getDataType()

 Required. The data type of this instruction.
 

.google.cloud.datalabeling.v1beta1.DataType data_type = 6;

Specified by:

getDataType in interface InstructionOrBuilder

hasCsvInstruction

public boolean hasCsvInstruction()

 One of CSV or PDF instruction is required.
 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;

Specified by:

hasCsvInstruction in interface InstructionOrBuilder

getCsvInstruction

public CsvInstruction getCsvInstruction()

 One of CSV or PDF instruction is required.
 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;

Specified by:

getCsvInstruction in interface InstructionOrBuilder

getCsvInstructionOrBuilder

public CsvInstructionOrBuilder getCsvInstructionOrBuilder()

 One of CSV or PDF instruction is required.
 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;

Specified by:

getCsvInstructionOrBuilder in interface InstructionOrBuilder

hasPdfInstruction

public boolean hasPdfInstruction()

 One of CSV or PDF instruction is required.
 Instruction from a PDF document. The PDF should be in a Cloud Storage
 bucket.
 

.google.cloud.datalabeling.v1beta1.PdfInstruction pdf_instruction = 9;

Specified by:

hasPdfInstruction in interface InstructionOrBuilder

getPdfInstruction

public PdfInstruction getPdfInstruction()

 One of CSV or PDF instruction is required.
 Instruction from a PDF document. The PDF should be in a Cloud Storage
 bucket.
 

.google.cloud.datalabeling.v1beta1.PdfInstruction pdf_instruction = 9;

Specified by:

getPdfInstruction in interface InstructionOrBuilder

getPdfInstructionOrBuilder

public PdfInstructionOrBuilder getPdfInstructionOrBuilder()

 One of CSV or PDF instruction is required.
 Instruction from a PDF document. The PDF should be in a Cloud Storage
 bucket.
 

.google.cloud.datalabeling.v1beta1.PdfInstruction pdf_instruction = 9;

Specified by:

getPdfInstructionOrBuilder in interface InstructionOrBuilder

getBlockingResourcesList

public com.google.protobuf.ProtocolStringList getBlockingResourcesList()

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

repeated string blocking_resources = 10;

Specified by:

getBlockingResourcesList in interface InstructionOrBuilder

getBlockingResourcesCount

public int getBlockingResourcesCount()

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

repeated string blocking_resources = 10;

Specified by:

getBlockingResourcesCount in interface InstructionOrBuilder

getBlockingResources

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;

Specified by:

getBlockingResources in interface InstructionOrBuilder

getBlockingResourcesBytes

public com.google.protobuf.ByteString getBlockingResourcesBytes(int index)

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

repeated string blocking_resources = 10;

Specified by:

getBlockingResourcesBytes in interface InstructionOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static Instruction parseFrom(ByteBuffer data)
                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Instruction parseFrom(ByteBuffer data,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Instruction parseFrom(com.google.protobuf.ByteString data)
                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Instruction parseFrom(com.google.protobuf.ByteString data,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Instruction parseFrom(byte[] data)
                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Instruction parseFrom(byte[] data,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Instruction parseFrom(InputStream input)
                             throws IOException

Throws:

IOException

parseFrom

public static Instruction parseFrom(InputStream input,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws IOException

Throws:

IOException

parseDelimitedFrom

public static Instruction parseDelimitedFrom(InputStream input)
                                      throws IOException

Throws:

IOException

parseDelimitedFrom

public static Instruction parseDelimitedFrom(InputStream input,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws IOException

Throws:

IOException

parseFrom

public static Instruction parseFrom(com.google.protobuf.CodedInputStream input)
                             throws IOException

Throws:

IOException

parseFrom

public static Instruction parseFrom(com.google.protobuf.CodedInputStream input,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws IOException

Throws:

IOException

newBuilderForType

public Instruction.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Instruction.Builder newBuilder()

newBuilder

public static Instruction.Builder newBuilder(Instruction prototype)

toBuilder

public Instruction.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected Instruction.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static Instruction getDefaultInstance()

parser

public static com.google.protobuf.Parser<Instruction> parser()

getParserForType

public com.google.protobuf.Parser<Instruction> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public Instruction getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder