Package com.google.cloud.datalabeling.v1beta1

Class Instruction

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
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
@Generated public final class Instruction extends com.google.protobuf.GeneratedMessage 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
See Also:

  • Field Details

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • DISPLAY_NAME_FIELD_NUMBER

      public static final int DISPLAY_NAME_FIELD_NUMBER
      See Also:

    • DESCRIPTION_FIELD_NUMBER

      public static final int DESCRIPTION_FIELD_NUMBER
      See Also:

    • CREATE_TIME_FIELD_NUMBER

      public static final int CREATE_TIME_FIELD_NUMBER
      See Also:

    • UPDATE_TIME_FIELD_NUMBER

      public static final int UPDATE_TIME_FIELD_NUMBER
      See Also:

    • DATA_TYPE_FIELD_NUMBER

      public static final int DATA_TYPE_FIELD_NUMBER
      See Also:

    • CSV_INSTRUCTION_FIELD_NUMBER

      public static final int CSV_INSTRUCTION_FIELD_NUMBER
      See Also:

    • PDF_INSTRUCTION_FIELD_NUMBER

      public static final int PDF_INSTRUCTION_FIELD_NUMBER
      See Also:

    • BLOCKING_RESOURCES_FIELD_NUMBER

      public static final int BLOCKING_RESOURCES_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • 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
      Returns:
      The name.

    • 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
      Returns:
      The bytes for name.

    • 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
      Returns:
      The displayName.

    • 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
      Returns:
      The bytes for displayName.

    • 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
      Returns:
      The description.

    • 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
      Returns:
      The bytes for description.

    • hasCreateTime

      public boolean hasCreateTime()
       Output only. Creation time of instruction.
      .google.protobuf.Timestamp create_time = 4;
      Specified by:
      hasCreateTime in interface InstructionOrBuilder
      Returns:
      Whether the createTime field is set.

    • 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
      Returns:
      The createTime.

    • 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
      Returns:
      Whether the updateTime field is set.

    • 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
      Returns:
      The updateTime.

    • 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
      Returns:
      The enum numeric value on the wire for dataType.

    • 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
      Returns:
      The dataType.

    • 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];
      Specified by:
      hasCsvInstruction in interface InstructionOrBuilder
      Returns:
      Whether the csvInstruction field is set.

    • 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];
      Specified by:
      getCsvInstruction in interface InstructionOrBuilder
      Returns:
      The csvInstruction.

    • getCsvInstructionOrBuilder

      @Deprecated public CsvInstructionOrBuilder getCsvInstructionOrBuilder()
      Deprecated.
       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];
      Specified by:
      getCsvInstructionOrBuilder in interface InstructionOrBuilder

    • 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;
      Specified by:
      hasPdfInstruction in interface InstructionOrBuilder
      Returns:
      Whether the pdfInstruction field is set.

    • 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;
      Specified by:
      getPdfInstruction in interface InstructionOrBuilder
      Returns:
      The pdfInstruction.

    • 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;
      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
      Returns:
      A list containing the blockingResources.

    • 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
      Returns:
      The count of blockingResources.

    • 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
      Parameters:
      index - The index of the element to return.
      Returns:
      The blockingResources at the given index.

    • 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
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the blockingResources at the given index.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • 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.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • 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.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • 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.GeneratedMessage

    • getDefaultInstanceForType

      public Instruction getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder