Class: Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Annotation

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

Overview

Used to assign specific AnnotationSpec to a particular area of a DataItem or the whole part of the DataItem.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudAiplatformV1Annotation

Returns a new instance of GoogleCloudAiplatformV1Annotation.



732
733
734
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 732

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

Instance Attribute Details

#annotation_source ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1UserActionReference

References an API call. It contains more information about long running operation and Jobs that are triggered by the API call. Corresponds to the JSON property annotationSource

Returns:



678
679
680
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 678

def annotation_source
  @annotation_source
end

#create_time ⇒ String

Output only. Timestamp when this Annotation was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


683
684
685
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 683

def create_time
  @create_time
end

#etag ⇒ String

Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. Corresponds to the JSON property etag

Returns:

  • (String) 


689
690
691
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 689

def etag
  @etag
end

#labels ⇒ Hash<String,String>

Optional. The labels with user-defined metadata to organize your Annotations. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Annotation(System labels are excluded). See https://goo. gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable. Following system labels exist for each Annotation: * "aiplatform.googleapis. com/annotation_set_name": optional, name of the UI's annotation set this Annotation belongs to. If not set, the Annotation is not visible in the UI. * " aiplatform.googleapis.com/payload_schema": output only, its value is the payload_schema's title. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


705
706
707
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 705

def labels
  @labels
end

#name ⇒ String

Output only. Resource name of the Annotation. Corresponds to the JSON property name

Returns:

  • (String) 


710
711
712
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 710

def name
  @name
end

#payload ⇒ Object

Required. The schema of the payload can be found in payload_schema. Corresponds to the JSON property payload

Returns:

  • (Object) 


715
716
717
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 715

def payload
  @payload
end

#payload_schema_uri ⇒ String

Required. Google Cloud Storage URI points to a YAML file describing payload. The schema is defined as an OpenAPI 3.0.2 Schema Object. The schema files that can be used here are found in gs://google-cloud-aiplatform/ schema/dataset/annotation/, note that the chosen schema must be consistent with the parent Dataset's metadata. Corresponds to the JSON property payloadSchemaUri

Returns:

  • (String) 


725
726
727
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 725

def payload_schema_uri
  @payload_schema_uri
end

#update_time ⇒ String

Output only. Timestamp when this Annotation was last updated. Corresponds to the JSON property updateTime

Returns:

  • (String) 


730
731
732
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 730

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



737
738
739
740
741
742
743
744
745
746
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 737

def update!(**args)
  @annotation_source = args[:annotation_source] if args.key?(:annotation_source)
  @create_time = args[:create_time] if args.key?(:create_time)
  @etag = args[:etag] if args.key?(:etag)
  @labels = args[:labels] if args.key?(:labels)
  @name = args[:name] if args.key?(:name)
  @payload = args[:payload] if args.key?(:payload)
  @payload_schema_uri = args[:payload_schema_uri] if args.key?(:payload_schema_uri)
  @update_time = args[:update_time] if args.key?(:update_time)
end