Class: Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Index

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

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) ⇒ GoogleCloudAiplatformV1Index

Returns a new instance of GoogleCloudAiplatformV1Index.



9519
9520
9521
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9519

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) 


9435
9436
9437
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9435

def create_time
  @create_time
end

#deployed_indexes ⇒ Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1DeployedIndexRef>

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:



9441
9442
9443
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9441

def deployed_indexes
  @deployed_indexes
end

#description ⇒ String

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

Returns:

  • (String) 


9446
9447
9448
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9446

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) 


9452
9453
9454
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9452

def display_name
  @display_name
end

#encryption_spec ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EncryptionSpec

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

Returns:



9458
9459
9460
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9458

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) 


9464
9465
9466
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9464

def etag
  @etag
end

#index_stats ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1IndexStats

Stats of the Index. Corresponds to the JSON property indexStats

Returns:



9469
9470
9471
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9469

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) 


9475
9476
9477
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9475

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>) 


9484
9485
9486
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9484

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) 


9490
9491
9492
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9490

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) 


9502
9503
9504
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9502

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) 


9507
9508
9509
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9507

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) 


9517
9518
9519
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9517

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



9524
9525
9526
9527
9528
9529
9530
9531
9532
9533
9534
9535
9536
9537
9538
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9524

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