Index(mapping=None, *, ignore_unknown_fields=False, **kwargs)An Index is a resource in Corpus. It contains an indexed version of the assets and annotations. When deployed to an endpoint, it will allow users to search the Index.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
Attributes |
|
|---|---|
| Name | Description |
entire_corpus |
bool
Include all assets under the corpus. This field is a member of oneof_ asset_filter.
|
name |
str
Output only. Resource name of the Index resource. Format: projects/{project_number}/locations/{location_id}/corpora/{corpus_id}/indexes/{index_id}
|
display_name |
str
Optional. Optional user-specified display name of the index. |
description |
str
Optional. Optional description of the index. |
state |
google.cloud.visionai_v1.types.Index.State
Output only. State of the index. |
create_time |
google.protobuf.timestamp_pb2.Timestamp
Output only. The create timestamp. |
update_time |
google.protobuf.timestamp_pb2.Timestamp
Output only. The update timestamp. |
deployed_indexes |
MutableSequence[google.cloud.visionai_v1.types.DeployedIndexReference]
Output only. References to the deployed index instance. Index of VIDEO_ON_DEMAND corpus can have at most one deployed index. Index of IMAGE corpus can have multiple deployed indexes. |
satisfies_pzs |
bool
Output only. This boolean field is only set for projects that have Physical Zone Separation enabled via an Org Policy constraint. It is set to true when the index is a valid zone separated index and false if it isn't. This field is a member of oneof_ _satisfies_pzs.
|
satisfies_pzi |
bool
Output only. This boolean field is only set for projects that have Physical Zone Isolation enabled via an Org Policy constraint. It is set to true when the index is a valid zone isolated index and false if it isn't. This field is a member of oneof_ _satisfies_pzi.
|
Classes
State
State(value)Enum representing the different states through which an Index might cycle during its lifetime.