Class: Google::Cloud::AIPlatform::V1::Index

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/aiplatform/v1/index.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.

Defined Under Namespace

Modules: IndexUpdateMethod Classes: LabelsEntry

Instance Attribute Summary collapse

Instance Attribute Details

#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. Timestamp when this Index was created.

Returns:



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'proto_docs/google/cloud/aiplatform/v1/index.rb', line 100

class Index
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The update method of an Index.
  module IndexUpdateMethod
    # Should not be used.
    INDEX_UPDATE_METHOD_UNSPECIFIED = 0

    # BatchUpdate: user can call UpdateIndex with files on Cloud Storage of
    # Datapoints to update.
    BATCH_UPDATE = 1

    # StreamUpdate: user can call UpsertDatapoints/DeleteDatapoints to update
    # the Index and the updates will be applied in corresponding
    # DeployedIndexes in nearly real-time.
    STREAM_UPDATE = 2
  end
end

#deployed_indexes ⇒ ::Array<::Google::Cloud::AIPlatform::V1::DeployedIndexRef> (readonly)

Returns Output only. The pointers to DeployedIndexes created from this Index. An Index can be only deleted if all its DeployedIndexes had been undeployed first.

Returns:



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'proto_docs/google/cloud/aiplatform/v1/index.rb', line 100

class Index
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The update method of an Index.
  module IndexUpdateMethod
    # Should not be used.
    INDEX_UPDATE_METHOD_UNSPECIFIED = 0

    # BatchUpdate: user can call UpdateIndex with files on Cloud Storage of
    # Datapoints to update.
    BATCH_UPDATE = 1

    # StreamUpdate: user can call UpsertDatapoints/DeleteDatapoints to update
    # the Index and the updates will be applied in corresponding
    # DeployedIndexes in nearly real-time.
    STREAM_UPDATE = 2
  end
end

#description ⇒ ::String

Returns The description of the Index.

Returns:

  • (::String) —

    The description of the Index.



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'proto_docs/google/cloud/aiplatform/v1/index.rb', line 100

class Index
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The update method of an Index.
  module IndexUpdateMethod
    # Should not be used.
    INDEX_UPDATE_METHOD_UNSPECIFIED = 0

    # BatchUpdate: user can call UpdateIndex with files on Cloud Storage of
    # Datapoints to update.
    BATCH_UPDATE = 1

    # StreamUpdate: user can call UpsertDatapoints/DeleteDatapoints to update
    # the Index and the updates will be applied in corresponding
    # DeployedIndexes in nearly real-time.
    STREAM_UPDATE = 2
  end
end

#display_name ⇒ ::String

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

Returns:

  • (::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.



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'proto_docs/google/cloud/aiplatform/v1/index.rb', line 100

class Index
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The update method of an Index.
  module IndexUpdateMethod
    # Should not be used.
    INDEX_UPDATE_METHOD_UNSPECIFIED = 0

    # BatchUpdate: user can call UpdateIndex with files on Cloud Storage of
    # Datapoints to update.
    BATCH_UPDATE = 1

    # StreamUpdate: user can call UpsertDatapoints/DeleteDatapoints to update
    # the Index and the updates will be applied in corresponding
    # DeployedIndexes in nearly real-time.
    STREAM_UPDATE = 2
  end
end

#encryption_spec ⇒ ::Google::Cloud::AIPlatform::V1::EncryptionSpec

Returns Immutable. Customer-managed encryption key spec for an Index. If set, this Index and all sub-resources of this Index will be secured by this key.

Returns:



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'proto_docs/google/cloud/aiplatform/v1/index.rb', line 100

class Index
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The update method of an Index.
  module IndexUpdateMethod
    # Should not be used.
    INDEX_UPDATE_METHOD_UNSPECIFIED = 0

    # BatchUpdate: user can call UpdateIndex with files on Cloud Storage of
    # Datapoints to update.
    BATCH_UPDATE = 1

    # StreamUpdate: user can call UpsertDatapoints/DeleteDatapoints to update
    # the Index and the updates will be applied in corresponding
    # DeployedIndexes in nearly real-time.
    STREAM_UPDATE = 2
  end
end

#etag ⇒ ::String

Returns Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

Returns:

  • (::String) —

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



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'proto_docs/google/cloud/aiplatform/v1/index.rb', line 100

class Index
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The update method of an Index.
  module IndexUpdateMethod
    # Should not be used.
    INDEX_UPDATE_METHOD_UNSPECIFIED = 0

    # BatchUpdate: user can call UpdateIndex with files on Cloud Storage of
    # Datapoints to update.
    BATCH_UPDATE = 1

    # StreamUpdate: user can call UpsertDatapoints/DeleteDatapoints to update
    # the Index and the updates will be applied in corresponding
    # DeployedIndexes in nearly real-time.
    STREAM_UPDATE = 2
  end
end

#index_stats ⇒ ::Google::Cloud::AIPlatform::V1::IndexStats (readonly)

Returns Output only. Stats of the index resource.

Returns:



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'proto_docs/google/cloud/aiplatform/v1/index.rb', line 100

class Index
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The update method of an Index.
  module IndexUpdateMethod
    # Should not be used.
    INDEX_UPDATE_METHOD_UNSPECIFIED = 0

    # BatchUpdate: user can call UpdateIndex with files on Cloud Storage of
    # Datapoints to update.
    BATCH_UPDATE = 1

    # StreamUpdate: user can call UpsertDatapoints/DeleteDatapoints to update
    # the Index and the updates will be applied in corresponding
    # DeployedIndexes in nearly real-time.
    STREAM_UPDATE = 2
  end
end

#index_update_method ⇒ ::Google::Cloud::AIPlatform::V1::Index::IndexUpdateMethod

Returns Immutable. The update method to use with this Index. If not set, BATCH_UPDATE will be used by default.

Returns:



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'proto_docs/google/cloud/aiplatform/v1/index.rb', line 100

class Index
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The update method of an Index.
  module IndexUpdateMethod
    # Should not be used.
    INDEX_UPDATE_METHOD_UNSPECIFIED = 0

    # BatchUpdate: user can call UpdateIndex with files on Cloud Storage of
    # Datapoints to update.
    BATCH_UPDATE = 1

    # StreamUpdate: user can call UpsertDatapoints/DeleteDatapoints to update
    # the Index and the updates will be applied in corresponding
    # DeployedIndexes in nearly real-time.
    STREAM_UPDATE = 2
  end
end

#labels ⇒ ::Google::Protobuf::Map{::String => ::String}

Returns 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.

Returns:

  • (::Google::Protobuf::Map{::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.



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'proto_docs/google/cloud/aiplatform/v1/index.rb', line 100

class Index
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The update method of an Index.
  module IndexUpdateMethod
    # Should not be used.
    INDEX_UPDATE_METHOD_UNSPECIFIED = 0

    # BatchUpdate: user can call UpdateIndex with files on Cloud Storage of
    # Datapoints to update.
    BATCH_UPDATE = 1

    # StreamUpdate: user can call UpsertDatapoints/DeleteDatapoints to update
    # the Index and the updates will be applied in corresponding
    # DeployedIndexes in nearly real-time.
    STREAM_UPDATE = 2
  end
end

#metadata ⇒ ::Google::Protobuf::Value

Returns An additional information about the Index; the schema of the metadata can be found in metadata_schema.

Returns:



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'proto_docs/google/cloud/aiplatform/v1/index.rb', line 100

class Index
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The update method of an Index.
  module IndexUpdateMethod
    # Should not be used.
    INDEX_UPDATE_METHOD_UNSPECIFIED = 0

    # BatchUpdate: user can call UpdateIndex with files on Cloud Storage of
    # Datapoints to update.
    BATCH_UPDATE = 1

    # StreamUpdate: user can call UpsertDatapoints/DeleteDatapoints to update
    # the Index and the updates will be applied in corresponding
    # DeployedIndexes in nearly real-time.
    STREAM_UPDATE = 2
  end
end

#metadata_schema_uri ⇒ ::String

Returns 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.

Returns:

  • (::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.



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'proto_docs/google/cloud/aiplatform/v1/index.rb', line 100

class Index
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The update method of an Index.
  module IndexUpdateMethod
    # Should not be used.
    INDEX_UPDATE_METHOD_UNSPECIFIED = 0

    # BatchUpdate: user can call UpdateIndex with files on Cloud Storage of
    # Datapoints to update.
    BATCH_UPDATE = 1

    # StreamUpdate: user can call UpsertDatapoints/DeleteDatapoints to update
    # the Index and the updates will be applied in corresponding
    # DeployedIndexes in nearly real-time.
    STREAM_UPDATE = 2
  end
end

#name ⇒ ::String (readonly)

Returns Output only. The resource name of the Index.

Returns:

  • (::String) —

    Output only. The resource name of the Index.



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'proto_docs/google/cloud/aiplatform/v1/index.rb', line 100

class Index
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The update method of an Index.
  module IndexUpdateMethod
    # Should not be used.
    INDEX_UPDATE_METHOD_UNSPECIFIED = 0

    # BatchUpdate: user can call UpdateIndex with files on Cloud Storage of
    # Datapoints to update.
    BATCH_UPDATE = 1

    # StreamUpdate: user can call UpsertDatapoints/DeleteDatapoints to update
    # the Index and the updates will be applied in corresponding
    # DeployedIndexes in nearly real-time.
    STREAM_UPDATE = 2
  end
end

#satisfies_pzi ⇒ ::Boolean (readonly)

Returns Output only. Reserved for future use.

Returns:

  • (::Boolean) —

    Output only. Reserved for future use.



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'proto_docs/google/cloud/aiplatform/v1/index.rb', line 100

class Index
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The update method of an Index.
  module IndexUpdateMethod
    # Should not be used.
    INDEX_UPDATE_METHOD_UNSPECIFIED = 0

    # BatchUpdate: user can call UpdateIndex with files on Cloud Storage of
    # Datapoints to update.
    BATCH_UPDATE = 1

    # StreamUpdate: user can call UpsertDatapoints/DeleteDatapoints to update
    # the Index and the updates will be applied in corresponding
    # DeployedIndexes in nearly real-time.
    STREAM_UPDATE = 2
  end
end

#satisfies_pzs ⇒ ::Boolean (readonly)

Returns Output only. Reserved for future use.

Returns:

  • (::Boolean) —

    Output only. Reserved for future use.



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'proto_docs/google/cloud/aiplatform/v1/index.rb', line 100

class Index
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The update method of an Index.
  module IndexUpdateMethod
    # Should not be used.
    INDEX_UPDATE_METHOD_UNSPECIFIED = 0

    # BatchUpdate: user can call UpdateIndex with files on Cloud Storage of
    # Datapoints to update.
    BATCH_UPDATE = 1

    # StreamUpdate: user can call UpsertDatapoints/DeleteDatapoints to update
    # the Index and the updates will be applied in corresponding
    # DeployedIndexes in nearly real-time.
    STREAM_UPDATE = 2
  end
end

#update_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns 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] [google.cloud.aiplatform.v1.GenericOperationMetadata.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.

Returns:

  • (::Google::Protobuf::Timestamp) —

    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] [google.cloud.aiplatform.v1.GenericOperationMetadata.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.



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'proto_docs/google/cloud/aiplatform/v1/index.rb', line 100

class Index
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The update method of an Index.
  module IndexUpdateMethod
    # Should not be used.
    INDEX_UPDATE_METHOD_UNSPECIFIED = 0

    # BatchUpdate: user can call UpdateIndex with files on Cloud Storage of
    # Datapoints to update.
    BATCH_UPDATE = 1

    # StreamUpdate: user can call UpsertDatapoints/DeleteDatapoints to update
    # the Index and the updates will be applied in corresponding
    # DeployedIndexes in nearly real-time.
    STREAM_UPDATE = 2
  end
end