Class: Google::Apis::HealthcareV1beta1::Annotation

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

Overview

An annotation record.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Annotation

Returns a new instance of Annotation.



152
153
154
 
# File 'generated/google/apis/healthcare_v1beta1/classes.rb', line 152

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

Instance Attribute Details

#annotation_source ⇒ Google::Apis::HealthcareV1beta1::AnnotationSource

AnnotationSource holds the source information of the annotation. Corresponds to the JSON property annotationSource

Returns:



122
123
124
 
# File 'generated/google/apis/healthcare_v1beta1/classes.rb', line 122

def annotation_source
  @annotation_source
end

#custom_data ⇒ Hash<String,String>

Additional information for this annotation record, such as annotator and verifier information or study campaign. Corresponds to the JSON property customData

Returns:

  • (Hash<String,String>) 


128
129
130
 
# File 'generated/google/apis/healthcare_v1beta1/classes.rb', line 128

def custom_data
  @custom_data
end

#image_annotation ⇒ Google::Apis::HealthcareV1beta1::ImageAnnotation

Image annotation. Corresponds to the JSON property imageAnnotation

Returns:



133
134
135
 
# File 'generated/google/apis/healthcare_v1beta1/classes.rb', line 133

def image_annotation
  @image_annotation
end

#name ⇒ String

Resource name of the Annotation, of the form projects/project_id/locations/ location_id/datasets/dataset_id/annotationStores/annotation_store_id/ annotations/annotation_id`. Corresponds to the JSON propertyname`

Returns:

  • (String) 


140
141
142
 
# File 'generated/google/apis/healthcare_v1beta1/classes.rb', line 140

def name
  @name
end

#resource_annotation ⇒ Google::Apis::HealthcareV1beta1::ResourceAnnotation

Resource level annotation. Corresponds to the JSON property resourceAnnotation

Returns:



145
146
147
 
# File 'generated/google/apis/healthcare_v1beta1/classes.rb', line 145

def resource_annotation
  @resource_annotation
end

#text_annotation ⇒ Google::Apis::HealthcareV1beta1::SensitiveTextAnnotation

A TextAnnotation specifies a text range that includes sensitive information. Corresponds to the JSON property textAnnotation

Returns:



150
151
152
 
# File 'generated/google/apis/healthcare_v1beta1/classes.rb', line 150

def text_annotation
  @text_annotation
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



157
158
159
160
161
162
163
164
 
# File 'generated/google/apis/healthcare_v1beta1/classes.rb', line 157

def update!(**args)
  @annotation_source = args[:annotation_source] if args.key?(:annotation_source)
  @custom_data = args[:custom_data] if args.key?(:custom_data)
  @image_annotation = args[:image_annotation] if args.key?(:image_annotation)
  @name = args[:name] if args.key?(:name)
  @resource_annotation = args[:resource_annotation] if args.key?(:resource_annotation)
  @text_annotation = args[:text_annotation] if args.key?(:text_annotation)
end