Vision AI v1 API - Class IndexEndpoint (1.0.0-beta01) 

public sealed class IndexEndpoint : IMessage<IndexEndpoint>, IEquatable<IndexEndpoint>, IDeepCloneable<IndexEndpoint>, IBufferMessage, IMessage

Reference documentation and code samples for the Vision AI v1 API class IndexEndpoint.

Message representing IndexEndpoint resource. Indexes are deployed into it.

Inheritance

object > IndexEndpoint

Namespace

Google.Cloud.VisionAI.V1

Assembly

Google.Cloud.VisionAI.V1.dll

Constructors

IndexEndpoint()

public IndexEndpoint()

IndexEndpoint(IndexEndpoint)

public IndexEndpoint(IndexEndpoint other)
Parameter
Name Description
other IndexEndpoint

Properties

CreateTime

public Timestamp CreateTime { get; set; }

Output only. Create timestamp.

Property Value
Type Description
Timestamp

DeployedIndex

public DeployedIndex DeployedIndex { get; set; }

Output only. The Index deployed in this IndexEndpoint.

Property Value
Type Description
DeployedIndex

Description

public string Description { get; set; }

Optional. Description of the IndexEndpoint. Can be up to 25000 characters long.

Property Value
Type Description
string

DisplayName

public string DisplayName { get; set; }

Optional. Display name of the IndexEndpoint. Can be up to 32 characters long.

Property Value
Type Description
string

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

IndexEndpointName

public IndexEndpointName IndexEndpointName { get; set; }

IndexEndpointName-typed view over the Name resource name property.

Property Value
Type Description
IndexEndpointName

Labels

public MapField<string, string> Labels { get; }

Optional. The labels applied to a resource must meet the following requirements:

  • Each resource can have multiple labels, up to a maximum of 64.
  • Each label must be a key-value pair.
  • Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters.
  • Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed.
  • The key portion of a label must be unique. However, you can use the same key with multiple resources.
  • Keys must start with a lowercase letter or international character.

See Google Cloud Document for more details.

Property Value
Type Description
MapFieldstringstring

Name

public string Name { get; set; }

Output only. Resource name of the IndexEndpoint. Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint_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 endpoint is a valid zone isolated index endpoint 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 endpoint is a valid zone separated index endpoint and false if it isn't.

Property Value
Type Description
bool

State

public IndexEndpoint.Types.State State { get; set; }

Output only. IndexEndpoint state.

Property Value
Type Description
IndexEndpointTypesState

UpdateTime

public Timestamp UpdateTime { get; set; }

Output only. Update timestamp.

Property Value
Type Description
Timestamp