Reference documentation and code samples for the Vector Search V1 API class Google::Cloud::VectorSearch::V1::Collection.
Message describing Collection object
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#create_time
def create_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. [Output only] Create time stamp
#data_schema
def data_schema() -> ::Google::Protobuf::Struct
Returns
- (::Google::Protobuf::Struct) — Optional. JSON Schema for data. Field names must contain only alphanumeric characters, underscores, and hyphens. The schema must be compliant with JSON Schema Draft 7.
#data_schema=
def data_schema=(value) -> ::Google::Protobuf::Struct
Parameter
- value (::Google::Protobuf::Struct) — Optional. JSON Schema for data. Field names must contain only alphanumeric characters, underscores, and hyphens. The schema must be compliant with JSON Schema Draft 7.
Returns
- (::Google::Protobuf::Struct) — Optional. JSON Schema for data. Field names must contain only alphanumeric characters, underscores, and hyphens. The schema must be compliant with JSON Schema Draft 7.
#description
def description() -> ::String
Returns
- (::String) — Optional. User-specified description of the collection
#description=
def description=(value) -> ::String
Parameter
- value (::String) — Optional. User-specified description of the collection
Returns
- (::String) — Optional. User-specified description of the collection
#display_name
def display_name() -> ::String
Returns
- (::String) — Optional. User-specified display name of the collection
#display_name=
def display_name=(value) -> ::String
Parameter
- value (::String) — Optional. User-specified display name of the collection
Returns
- (::String) — Optional. User-specified display name of the collection
#encryption_spec
def encryption_spec() -> ::Google::Cloud::VectorSearch::V1::EncryptionSpec
Returns
- (::Google::Cloud::VectorSearch::V1::EncryptionSpec) — Optional. Immutable. Specifies the customer-managed encryption key spec for a Collection. If set, this Collection and all sub-resources of this Collection will be secured by this key.
#encryption_spec=
def encryption_spec=(value) -> ::Google::Cloud::VectorSearch::V1::EncryptionSpec
Parameter
- value (::Google::Cloud::VectorSearch::V1::EncryptionSpec) — Optional. Immutable. Specifies the customer-managed encryption key spec for a Collection. If set, this Collection and all sub-resources of this Collection will be secured by this key.
Returns
- (::Google::Cloud::VectorSearch::V1::EncryptionSpec) — Optional. Immutable. Specifies the customer-managed encryption key spec for a Collection. If set, this Collection and all sub-resources of this Collection will be secured by this key.
#labels
def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
- (::Google::Protobuf::Map{::String => ::String}) — Optional. Labels as key value pairs.
#labels=
def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
- value (::Google::Protobuf::Map{::String => ::String}) — Optional. Labels as key value pairs.
Returns
- (::Google::Protobuf::Map{::String => ::String}) — Optional. Labels as key value pairs.
#name
def name() -> ::String
Returns
- (::String) — Identifier. name of resource
#name=
def name=(value) -> ::String
Parameter
- value (::String) — Identifier. name of resource
Returns
- (::String) — Identifier. name of resource
#update_time
def update_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. [Output only] Update time stamp
#vector_schema
def vector_schema() -> ::Google::Protobuf::Map{::String => ::Google::Cloud::VectorSearch::V1::VectorField}
Returns
- (::Google::Protobuf::Map{::String => ::Google::Cloud::VectorSearch::V1::VectorField}) — Optional. Schema for vector fields. Only vector fields in this schema will be searchable. Field names must contain only alphanumeric characters, underscores, and hyphens.
#vector_schema=
def vector_schema=(value) -> ::Google::Protobuf::Map{::String => ::Google::Cloud::VectorSearch::V1::VectorField}
Parameter
- value (::Google::Protobuf::Map{::String => ::Google::Cloud::VectorSearch::V1::VectorField}) — Optional. Schema for vector fields. Only vector fields in this schema will be searchable. Field names must contain only alphanumeric characters, underscores, and hyphens.
Returns
- (::Google::Protobuf::Map{::String => ::Google::Cloud::VectorSearch::V1::VectorField}) — Optional. Schema for vector fields. Only vector fields in this schema will be searchable. Field names must contain only alphanumeric characters, underscores, and hyphens.