public sealed class Index : IMessage<Index>, IEquatable<Index>, IDeepCloneable<Index>, IBufferMessage, IMessageReference documentation and code samples for the Vision AI v1 API class Index.
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.
Namespace
Google.Cloud.VisionAI.V1Assembly
Google.Cloud.VisionAI.V1.dll
Constructors
Index()
public Index()Index(Index)
public Index(Index other)| Parameter | |
|---|---|
| Name | Description |
other |
Index |
Properties
AssetFilterCase
public Index.AssetFilterOneofCase AssetFilterCase { get; }| Property Value | |
|---|---|
| Type | Description |
IndexAssetFilterOneofCase |
|
CreateTime
public Timestamp CreateTime { get; set; }Output only. The create timestamp.
| Property Value | |
|---|---|
| Type | Description |
Timestamp |
|
DeployedIndexes
public RepeatedField<DeployedIndexReference> DeployedIndexes { get; }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.
| Property Value | |
|---|---|
| Type | Description |
RepeatedFieldDeployedIndexReference |
|
Description
public string Description { get; set; }Optional. Optional description of the index.
| Property Value | |
|---|---|
| Type | Description |
string |
|
DisplayName
public string DisplayName { get; set; }Optional. Optional user-specified display name of the index.
| Property Value | |
|---|---|
| Type | Description |
string |
|
EntireCorpus
public bool EntireCorpus { get; set; }Include all assets under the corpus.
| Property Value | |
|---|---|
| Type | Description |
bool |
|
HasEntireCorpus
public bool HasEntireCorpus { get; }Gets whether the "entire_corpus" field is set
| Property Value | |
|---|---|
| Type | Description |
bool |
|
HasSatisfiesPzi
public bool HasSatisfiesPzi { get; }Gets whether the "satisfies_pzi" field is set
| Property Value | |
|---|---|
| Type | Description |
bool |
|
HasSatisfiesPzs
public bool HasSatisfiesPzs { get; }Gets whether the "satisfies_pzs" field is set
| Property Value | |
|---|---|
| Type | Description |
bool |
|
IndexName
public IndexName IndexName { get; set; }| Property Value | |
|---|---|
| Type | Description |
IndexName |
|
Name
public string Name { get; set; }Output only. Resource name of the Index resource.
Format:
projects/{project_number}/locations/{location_id}/corpora/{corpus_id}/indexes/{index_id}
| Property Value | |
|---|---|
| Type | Description |
string |
|
SatisfiesPzi
public bool SatisfiesPzi { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
bool |
|
SatisfiesPzs
public bool SatisfiesPzs { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
bool |
|
State
public Index.Types.State State { get; set; }Output only. State of the index.
| Property Value | |
|---|---|
| Type | Description |
IndexTypesState |
|
UpdateTime
public Timestamp UpdateTime { get; set; }Output only. The update timestamp.
| Property Value | |
|---|---|
| Type | Description |
Timestamp |
|