Struct gapi_grpc::google::cloud::datalabeling::v1beta1::Instruction

pub struct Instruction {
    pub name: String,
    pub display_name: String,
    pub description: String,
    pub create_time: Option<Timestamp>,
    pub update_time: Option<Timestamp>,
    pub data_type: i32,
    pub csv_instruction: Option<CsvInstruction>,
    pub pdf_instruction: Option<PdfInstruction>,
    pub blocking_resources: Vec<String>,
}

Instruction of how to perform the labeling task for human operators. Currently only PDF instruction is supported.

Fields

name: String

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

display_name: String

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

description: String

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

create_time: Option<Timestamp>

Output only. Creation time of instruction.

update_time: Option<Timestamp>

Output only. Last update time of instruction.

data_type: i32

Required. The data type of this instruction.

csv_instruction: Option<CsvInstruction>

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.

pdf_instruction: Option<PdfInstruction>

Instruction from a PDF document. The PDF should be in a Cloud Storage bucket.

blocking_resources: Vec<String>

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

Implementations

impl Instruction

pub fn data_type(&self) -> DataType

Returns the enum value of data_type, or the default if the field is set to an invalid enum value.

pub fn set_data_type(&mut self, value: DataType)

Sets data_type to the provided enum value.

Trait Implementations

impl Clone for Instruction

fn clone(&self) -> Instruction

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Instruction

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Instruction

fn default() -> Instruction

Returns the “default value” for a type.

impl Message for Instruction

fn encode_raw<B>(&self, buf: &mut B) where
    B: BufMut, 

fn merge_field<B>(
    &mut self,
    tag: u32,
    wire_type: WireType,
    buf: &mut B,
    ctx: DecodeContext
) -> Result<(), DecodeError> where
    B: Buf, 

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

pub fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message to a buffer.

pub fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message with a length-delimiter to a buffer.

pub fn decode<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

Decodes an instance of the message from a buffer.

pub fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

Decodes a length-delimited instance of the message from the buffer.

pub fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes an instance of the message from a buffer, and merges it into self.

pub fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq<Instruction> for Instruction

fn eq(&self, other: &Instruction) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Instruction) -> bool

This method tests for !=.

impl StructuralPartialEq for Instruction