Class: Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Index

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

Overview

A representation of a collection of database items organized in a way that allows for approximate nearest neighbor (a.k.a ANN) algorithms search.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudAiplatformV1beta1Index

Returns a new instance of GoogleCloudAiplatformV1beta1Index.



10825
10826
10827
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 10825

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

Instance Attribute Details

#create_time ⇒ String

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

Returns:

  • (String) 


10741
10742
10743
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 10741

def create_time
  @create_time
end

#deployed_indexes ⇒ Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1DeployedIndexRef>

Output only. The pointers to DeployedIndexes created from this Index. An Index can be only deleted if all its DeployedIndexes had been undeployed first. Corresponds to the JSON property deployedIndexes

Returns:



10747
10748
10749
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 10747

def deployed_indexes
  @deployed_indexes
end

#description ⇒ String

The description of the Index. Corresponds to the JSON property description

Returns:

  • (String) 


10752
10753
10754
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 10752

def description
  @description
end

#display_name ⇒ String

Required. The display name of the Index. The name can be up to 128 characters long and can consist of any UTF-8 characters. Corresponds to the JSON property displayName

Returns:

  • (String) 


10758
10759
10760
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 10758

def display_name
  @display_name
end

#encryption_spec ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EncryptionSpec

Represents a customer-managed encryption key spec that can be applied to a top- level resource. Corresponds to the JSON property encryptionSpec

Returns:



10764
10765
10766
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 10764

def encryption_spec
  @encryption_spec
end

#etag ⇒ String

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

Returns:

  • (String) 


10770
10771
10772
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 10770

def etag
  @etag
end

#index_stats ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1IndexStats

Stats of the Index. Corresponds to the JSON property indexStats

Returns:



10775
10776
10777
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 10775

def index_stats
  @index_stats
end

#index_update_method ⇒ String

Immutable. The update method to use with this Index. If not set, BATCH_UPDATE will be used by default. Corresponds to the JSON property indexUpdateMethod

Returns:

  • (String) 


10781
10782
10783
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 10781

def index_update_method
  @index_update_method
end

#labels ⇒ Hash<String,String>

The labels with user-defined metadata to organize your Indexes. 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. See https://goo.gl/xmQnxf for more information and examples of labels. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


10790
10791
10792
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 10790

def labels
  @labels
end

#metadata ⇒ Object

An additional information about the Index; the schema of the metadata can be found in metadata_schema. Corresponds to the JSON property metadata

Returns:

  • (Object) 


10796
10797
10798
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 10796

def metadata
  @metadata
end

#metadata_schema_uri ⇒ String

Immutable. Points to a YAML file stored on Google Cloud Storage describing additional information about the Index, that is specific to it. Unset if the Index does not have any additional information. The schema is defined as an OpenAPI 3.0.2 Schema Object. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access. Corresponds to the JSON property metadataSchemaUri

Returns:

  • (String) 


10808
10809
10810
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 10808

def metadata_schema_uri
  @metadata_schema_uri
end

#name ⇒ String

Output only. The resource name of the Index. Corresponds to the JSON property name

Returns:

  • (String) 


10813
10814
10815
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 10813

def name
  @name
end

#update_time ⇒ String

Output only. Timestamp when this Index was most recently updated. This also includes any update to the contents of the Index. Note that Operations working on this Index may have their Operations.metadata.generic_metadata.update_time a little after the value of this timestamp, yet that does not mean their results are not already reflected in the Index. Result of any successfully completed Operation on the Index is reflected in it. Corresponds to the JSON property updateTime

Returns:

  • (String) 


10823
10824
10825
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 10823

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



10830
10831
10832
10833
10834
10835
10836
10837
10838
10839
10840
10841
10842
10843
10844
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 10830

def update!(**args)
  @create_time = args[:create_time] if args.key?(:create_time)
  @deployed_indexes = args[:deployed_indexes] if args.key?(:deployed_indexes)
  @description = args[:description] if args.key?(:description)
  @display_name = args[:display_name] if args.key?(:display_name)
  @encryption_spec = args[:encryption_spec] if args.key?(:encryption_spec)
  @etag = args[:etag] if args.key?(:etag)
  @index_stats = args[:index_stats] if args.key?(:index_stats)
  @index_update_method = args[:index_update_method] if args.key?(:index_update_method)
  @labels = args[:labels] if args.key?(:labels)
  @metadata = args[:metadata] if args.key?(:metadata)
  @metadata_schema_uri = args[:metadata_schema_uri] if args.key?(:metadata_schema_uri)
  @name = args[:name] if args.key?(:name)
  @update_time = args[:update_time] if args.key?(:update_time)
end