Class: Google::Apis::DatalabelingV1beta1::GoogleCloudDatalabelingV1beta1Instruction

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/datalabeling_v1beta1/classes.rb,
generated/google/apis/datalabeling_v1beta1/representations.rb,
generated/google/apis/datalabeling_v1beta1/representations.rb

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDatalabelingV1beta1Instruction

Returns a new instance of GoogleCloudDatalabelingV1beta1Instruction.



2916
2917
2918
 
# File 'generated/google/apis/datalabeling_v1beta1/classes.rb', line 2916

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#blocking_resources ⇒ Array<String>

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

Returns:

  • (Array<String>) 


2871
2872
2873
 
# File 'generated/google/apis/datalabeling_v1beta1/classes.rb', line 2871

def blocking_resources
  @blocking_resources
end

#create_time ⇒ String

Output only. Creation time of instruction. Corresponds to the JSON property createTime

Returns:

  • (String) 


2876
2877
2878
 
# File 'generated/google/apis/datalabeling_v1beta1/classes.rb', line 2876

def create_time
  @create_time
end

#csv_instruction ⇒ Google::Apis::DatalabelingV1beta1::GoogleCloudDatalabelingV1beta1CsvInstruction

Deprecated: this instruction format is not supported any more. Instruction from a CSV file. Corresponds to the JSON property csvInstruction

Returns:



2882
2883
2884
 
# File 'generated/google/apis/datalabeling_v1beta1/classes.rb', line 2882

def csv_instruction
  @csv_instruction
end

#data_type ⇒ String

Required. The data type of this instruction. Corresponds to the JSON property dataType

Returns:

  • (String) 


2887
2888
2889
 
# File 'generated/google/apis/datalabeling_v1beta1/classes.rb', line 2887

def data_type
  @data_type
end

#description ⇒ String

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

Returns:

  • (String) 


2893
2894
2895
 
# File 'generated/google/apis/datalabeling_v1beta1/classes.rb', line 2893

def description
  @description
end

#display_name ⇒ String

Required. The display name of the instruction. Maximum of 64 characters. Corresponds to the JSON property displayName

Returns:

  • (String) 


2898
2899
2900
 
# File 'generated/google/apis/datalabeling_v1beta1/classes.rb', line 2898

def display_name
  @display_name
end

#name ⇒ String

Output only. Instruction resource name, format: projects/project_id/ instructions/instruction_id Corresponds to the JSON property name

Returns:

  • (String) 


2904
2905
2906
 
# File 'generated/google/apis/datalabeling_v1beta1/classes.rb', line 2904

def name
  @name
end

#pdf_instruction ⇒ Google::Apis::DatalabelingV1beta1::GoogleCloudDatalabelingV1beta1PdfInstruction

Instruction from a PDF file. Corresponds to the JSON property pdfInstruction

Returns:



2909
2910
2911
 
# File 'generated/google/apis/datalabeling_v1beta1/classes.rb', line 2909

def pdf_instruction
  @pdf_instruction
end

#update_time ⇒ String

Output only. Last update time of instruction. Corresponds to the JSON property updateTime

Returns:

  • (String) 


2914
2915
2916
 
# File 'generated/google/apis/datalabeling_v1beta1/classes.rb', line 2914

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
 
# File 'generated/google/apis/datalabeling_v1beta1/classes.rb', line 2921

def update!(**args)
  @blocking_resources = args[:blocking_resources] if args.key?(:blocking_resources)
  @create_time = args[:create_time] if args.key?(:create_time)
  @csv_instruction = args[:csv_instruction] if args.key?(:csv_instruction)
  @data_type = args[:data_type] if args.key?(:data_type)
  @description = args[:description] if args.key?(:description)
  @display_name = args[:display_name] if args.key?(:display_name)
  @name = args[:name] if args.key?(:name)
  @pdf_instruction = args[:pdf_instruction] if args.key?(:pdf_instruction)
  @update_time = args[:update_time] if args.key?(:update_time)
end