Class: Google::Cloud::DataLabeling::V1beta1::Instruction

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/datalabeling/v1beta1/instruction.rb

Overview

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

Instance Attribute Summary collapse

Instance Attribute Details

#blocking_resources ⇒ ::Array<::String>

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

Returns:

  • (::Array<::String>) —

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



63
64
65
66
 
# File 'proto_docs/google/cloud/datalabeling/v1beta1/instruction.rb', line 63

class Instruction
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#create_time ⇒ ::Google::Protobuf::Timestamp

Returns Output only. Creation time of instruction.

Returns:



63
64
65
66
 
# File 'proto_docs/google/cloud/datalabeling/v1beta1/instruction.rb', line 63

class Instruction
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#csv_instruction ⇒ ::Google::Cloud::DataLabeling::V1beta1::CsvInstruction

Deprecated.

This field is deprecated and may be removed in the next major version update.

Returns 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.

Returns:

  • (::Google::Cloud::DataLabeling::V1beta1::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.


63
64
65
66
 
# File 'proto_docs/google/cloud/datalabeling/v1beta1/instruction.rb', line 63

class Instruction
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#data_type ⇒ ::Google::Cloud::DataLabeling::V1beta1::DataType

Returns Required. The data type of this instruction.

Returns:



63
64
65
66
 
# File 'proto_docs/google/cloud/datalabeling/v1beta1/instruction.rb', line 63

class Instruction
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#description ⇒ ::String

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

Returns:

  • (::String) —

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



63
64
65
66
 
# File 'proto_docs/google/cloud/datalabeling/v1beta1/instruction.rb', line 63

class Instruction
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#display_name ⇒ ::String

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

Returns:

  • (::String) —

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



63
64
65
66
 
# File 'proto_docs/google/cloud/datalabeling/v1beta1/instruction.rb', line 63

class Instruction
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#name ⇒ ::String

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

Returns:

  • (::String) —

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



63
64
65
66
 
# File 'proto_docs/google/cloud/datalabeling/v1beta1/instruction.rb', line 63

class Instruction
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#pdf_instruction ⇒ ::Google::Cloud::DataLabeling::V1beta1::PdfInstruction

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

Returns:



63
64
65
66
 
# File 'proto_docs/google/cloud/datalabeling/v1beta1/instruction.rb', line 63

class Instruction
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#update_time ⇒ ::Google::Protobuf::Timestamp

Returns Output only. Last update time of instruction.

Returns:



63
64
65
66
 
# File 'proto_docs/google/cloud/datalabeling/v1beta1/instruction.rb', line 63

class Instruction
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end