Package com.google.cloud.datalabeling.v1beta1

Interface InstructionOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Instruction, Instruction.Builder
@Generated public interface InstructionOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getName

      String getName()
       Output only. Instruction resource name, format:
 projects/{project_id}/instructions/{instruction_id}
      string name = 1;
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       Output only. Instruction resource name, format:
 projects/{project_id}/instructions/{instruction_id}
      string name = 1;
      Returns:
      The bytes for name.

    • getDisplayName

      String getDisplayName()
       Required. The display name of the instruction. Maximum of 64 characters.
      string display_name = 2;
      Returns:
      The displayName.

    • getDisplayNameBytes

      com.google.protobuf.ByteString getDisplayNameBytes()
       Required. The display name of the instruction. Maximum of 64 characters.
      string display_name = 2;
      Returns:
      The bytes for displayName.

    • getDescription

      String getDescription()
       Optional. User-provided description of the instruction.
 The description can be up to 10000 characters long.
      string description = 3;
      Returns:
      The description.

    • getDescriptionBytes

      com.google.protobuf.ByteString getDescriptionBytes()
       Optional. User-provided description of the instruction.
 The description can be up to 10000 characters long.
      string description = 3;
      Returns:
      The bytes for description.

    • hasCreateTime

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

    • getCreateTime

      com.google.protobuf.Timestamp getCreateTime()
       Output only. Creation time of instruction.
      .google.protobuf.Timestamp create_time = 4;
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
       Output only. Creation time of instruction.
      .google.protobuf.Timestamp create_time = 4;

    • hasUpdateTime

      boolean hasUpdateTime()
       Output only. Last update time of instruction.
      .google.protobuf.Timestamp update_time = 5;
      Returns:
      Whether the updateTime field is set.

    • getUpdateTime

      com.google.protobuf.Timestamp getUpdateTime()
       Output only. Last update time of instruction.
      .google.protobuf.Timestamp update_time = 5;
      Returns:
      The updateTime.

    • getUpdateTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
       Output only. Last update time of instruction.
      .google.protobuf.Timestamp update_time = 5;

    • getDataTypeValue

      int getDataTypeValue()
       Required. The data type of this instruction.
      .google.cloud.datalabeling.v1beta1.DataType data_type = 6;
      Returns:
      The enum numeric value on the wire for dataType.

    • getDataType

      DataType getDataType()
       Required. The data type of this instruction.
      .google.cloud.datalabeling.v1beta1.DataType data_type = 6;
      Returns:
      The dataType.

    • hasCsvInstruction

      @Deprecated 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:
      Whether the csvInstruction field is set.

    • getCsvInstruction

      @Deprecated 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];
      Returns:
      The csvInstruction.

    • getCsvInstructionOrBuilder

      @Deprecated 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];

    • hasPdfInstruction

      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:
      Whether the pdfInstruction field is set.

    • getPdfInstruction

      PdfInstruction getPdfInstruction()
       Instruction from a PDF document. The PDF should be in a Cloud Storage
 bucket.
      .google.cloud.datalabeling.v1beta1.PdfInstruction pdf_instruction = 9;
      Returns:
      The pdfInstruction.

    • getPdfInstructionOrBuilder

      PdfInstructionOrBuilder getPdfInstructionOrBuilder()
       Instruction from a PDF document. The PDF should be in a Cloud Storage
 bucket.
      .google.cloud.datalabeling.v1beta1.PdfInstruction pdf_instruction = 9;

    • getBlockingResourcesList

      List<String> getBlockingResourcesList()
       Output only. The names of any related resources that are blocking changes
 to the instruction.
      repeated string blocking_resources = 10;
      Returns:
      A list containing the blockingResources.

    • getBlockingResourcesCount

      int getBlockingResourcesCount()
       Output only. The names of any related resources that are blocking changes
 to the instruction.
      repeated string blocking_resources = 10;
      Returns:
      The count of blockingResources.

    • getBlockingResources

      String getBlockingResources(int index)
       Output only. The names of any related resources that are blocking changes
 to the instruction.
      repeated string blocking_resources = 10;
      Parameters:
      index - The index of the element to return.
      Returns:
      The blockingResources at the given index.

    • getBlockingResourcesBytes

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