Class Collection (0.11.0)

Collection(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Message describing Collection object

Attributes

Name Description
name str
Identifier. name of resource
display_name str
Optional. User-specified display name of the collection
description str
Optional. User-specified description of the collection
create_time google.protobuf.timestamp_pb2.Timestamp
Output only. [Output only] Create time stamp
update_time google.protobuf.timestamp_pb2.Timestamp
Output only. [Output only] Update time stamp
labels MutableMapping[str, str]
Optional. Labels as key value pairs.
schema google.protobuf.struct_pb2.Struct
Optional. Deprecated: JSON Schema for data. Please use data_schema instead.
vector_schema MutableMapping[str, google.cloud.vectorsearch_v1beta.types.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.
data_schema google.protobuf.struct_pb2.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
encryption_spec google.cloud.vectorsearch_v1beta.types.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.

Classes

LabelsEntry

LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters
Name Description
kwargs dict

Keys and values corresponding to the fields of the message.

mapping Union[dict, .Message]

A dictionary or message to be used to determine the values for this message.

ignore_unknown_fields Optional(bool)

If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.

VectorSchemaEntry

VectorSchemaEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters
Name Description
kwargs dict

Keys and values corresponding to the fields of the message.

mapping Union[dict, .Message]

A dictionary or message to be used to determine the values for this message.

ignore_unknown_fields Optional(bool)

If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.