/*
* Copyright 2020 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/cloud/datalabeling/v1beta1/instruction.proto
package com.google.cloud.datalabeling.v1beta1;
public interface InstructionOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.datalabeling.v1beta1.Instruction)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* Output only. Instruction resource name, format:
* projects/{project_id}/instructions/{instruction_id}
*
*
* string name = 1;
*
* @return The name.
*/
java.lang.String getName();
/**
*
*
*
* Output only. Instruction resource name, format:
* projects/{project_id}/instructions/{instruction_id}
*
*
* string name = 1;
*
* @return The bytes for name.
*/
com.google.protobuf.ByteString getNameBytes();
/**
*
*
*
* Required. The display name of the instruction. Maximum of 64 characters.
*
*
* string display_name = 2;
*
* @return The displayName.
*/
java.lang.String getDisplayName();
/**
*
*
*
* Required. The display name of the instruction. Maximum of 64 characters.
*
*
* string display_name = 2;
*
* @return The bytes for displayName.
*/
com.google.protobuf.ByteString getDisplayNameBytes();
/**
*
*
*
* Optional. User-provided description of the instruction.
* The description can be up to 10000 characters long.
*
*
* string description = 3;
*
* @return The description.
*/
java.lang.String getDescription();
/**
*
*
*
* Optional. User-provided description of the instruction.
* The description can be up to 10000 characters long.
*
*
* string description = 3;
*
* @return The bytes for description.
*/
com.google.protobuf.ByteString getDescriptionBytes();
/**
*
*
*
* Output only. Creation time of instruction.
*
*
* .google.protobuf.Timestamp create_time = 4;
*
* @return Whether the createTime field is set.
*/
boolean hasCreateTime();
/**
*
*
*
* Output only. Creation time of instruction.
*
*
* .google.protobuf.Timestamp create_time = 4;
*
* @return The createTime.
*/
com.google.protobuf.Timestamp getCreateTime();
/**
*
*
*
* Output only. Creation time of instruction.
*
*
* .google.protobuf.Timestamp create_time = 4;
*/
com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder();
/**
*
*
*
* Output only. Last update time of instruction.
*
*
* .google.protobuf.Timestamp update_time = 5;
*
* @return Whether the updateTime field is set.
*/
boolean hasUpdateTime();
/**
*
*
*
* Output only. Last update time of instruction.
*
*
* .google.protobuf.Timestamp update_time = 5;
*
* @return The updateTime.
*/
com.google.protobuf.Timestamp getUpdateTime();
/**
*
*
*
* Output only. Last update time of instruction.
*
*
* .google.protobuf.Timestamp update_time = 5;
*/
com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder();
/**
*
*
*
* Required. The data type of this instruction.
*
*
* .google.cloud.datalabeling.v1beta1.DataType data_type = 6;
*
* @return The enum numeric value on the wire for dataType.
*/
int getDataTypeValue();
/**
*
*
*
* Required. The data type of this instruction.
*
*
* .google.cloud.datalabeling.v1beta1.DataType data_type = 6;
*
* @return The dataType.
*/
com.google.cloud.datalabeling.v1beta1.DataType getDataType();
/**
*
*
*
* 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];
*
*
* @deprecated google.cloud.datalabeling.v1beta1.Instruction.csv_instruction is deprecated. See
* google/cloud/datalabeling/v1beta1/instruction.proto;l=64
* @return Whether the csvInstruction field is set.
*/
@java.lang.Deprecated
boolean hasCsvInstruction();
/**
*
*
*
* 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];
*
*
* @deprecated google.cloud.datalabeling.v1beta1.Instruction.csv_instruction is deprecated. See
* google/cloud/datalabeling/v1beta1/instruction.proto;l=64
* @return The csvInstruction.
*/
@java.lang.Deprecated
com.google.cloud.datalabeling.v1beta1.CsvInstruction getCsvInstruction();
/**
*
*
*
* 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];
*
*/
@java.lang.Deprecated
com.google.cloud.datalabeling.v1beta1.CsvInstructionOrBuilder getCsvInstructionOrBuilder();
/**
*
*
*
* Instruction from a PDF document. The PDF should be in a Cloud Storage
* bucket.
*
*
* .google.cloud.datalabeling.v1beta1.PdfInstruction pdf_instruction = 9;
*
* @return Whether the pdfInstruction field is set.
*/
boolean hasPdfInstruction();
/**
*
*
*
* Instruction from a PDF document. The PDF should be in a Cloud Storage
* bucket.
*
*
* .google.cloud.datalabeling.v1beta1.PdfInstruction pdf_instruction = 9;
*
* @return The pdfInstruction.
*/
com.google.cloud.datalabeling.v1beta1.PdfInstruction getPdfInstruction();
/**
*
*
*
* Instruction from a PDF document. The PDF should be in a Cloud Storage
* bucket.
*
*
* .google.cloud.datalabeling.v1beta1.PdfInstruction pdf_instruction = 9;
*/
com.google.cloud.datalabeling.v1beta1.PdfInstructionOrBuilder getPdfInstructionOrBuilder();
/**
*
*
*
* Output only. The names of any related resources that are blocking changes
* to the instruction.
*
*
* repeated string blocking_resources = 10;
*
* @return A list containing the blockingResources.
*/
java.util.List getBlockingResourcesList();
/**
*
*
*
* Output only. The names of any related resources that are blocking changes
* to the instruction.
*
*
* repeated string blocking_resources = 10;
*
* @return The count of blockingResources.
*/
int getBlockingResourcesCount();
/**
*
*
*
* Output only. The names of any related resources that are blocking changes
* to the instruction.
*
*
* repeated string blocking_resources = 10;
*
* @param index The index of the element to return.
* @return The blockingResources at the given index.
*/
java.lang.String getBlockingResources(int index);
/**
*
*
*
* Output only. The names of any related resources that are blocking changes
* to the instruction.
*
*
* repeated string blocking_resources = 10;
*
* @param index The index of the value to return.
* @return The bytes of the blockingResources at the given index.
*/
com.google.protobuf.ByteString getBlockingResourcesBytes(int index);
}