public sealed class IndexEndpoint : IMessage<IndexEndpoint>, IEquatable<IndexEndpoint>, IDeepCloneable<IndexEndpoint>, IBufferMessage, IMessageReference documentation and code samples for the Cloud AI Platform v1beta1 API class IndexEndpoint.
Indexes are deployed into it. An IndexEndpoint can have multiple DeployedIndexes.
Implements
IMessageIndexEndpoint, IEquatableIndexEndpoint, IDeepCloneableIndexEndpoint, IBufferMessage, IMessageNamespace
Google.Cloud.AIPlatform.V1Beta1Assembly
Google.Cloud.AIPlatform.V1Beta1.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. Timestamp when this IndexEndpoint was created.
| Property Value | |
|---|---|
| Type | Description |
Timestamp |
|
DeployedIndexes
public RepeatedField<DeployedIndex> DeployedIndexes { get; }Output only. The indexes deployed in this endpoint.
| Property Value | |
|---|---|
| Type | Description |
RepeatedFieldDeployedIndex |
|
Description
public string Description { get; set; }The description of the IndexEndpoint.
| Property Value | |
|---|---|
| Type | Description |
string |
|
DisplayName
public string DisplayName { get; set; }Required. The display name of the IndexEndpoint. The name can be up to 128 characters long and can consist of any UTF-8 characters.
| Property Value | |
|---|---|
| Type | Description |
string |
|
EnablePrivateServiceConnect
[Obsolete]
public bool EnablePrivateServiceConnect { get; set; }Optional. Deprecated: If true, expose the IndexEndpoint via private service connect.
Only one of the fields, [network][google.cloud.aiplatform.v1beta1.IndexEndpoint.network] or [enable_private_service_connect][google.cloud.aiplatform.v1beta1.IndexEndpoint.enable_private_service_connect], can be set.
| Property Value | |
|---|---|
| Type | Description |
bool |
|
EncryptionSpec
public EncryptionSpec EncryptionSpec { get; set; }Immutable. Customer-managed encryption key spec for an IndexEndpoint. If set, this IndexEndpoint and all sub-resources of this IndexEndpoint will be secured by this key.
| Property Value | |
|---|---|
| Type | Description |
EncryptionSpec |
|
Etag
public string Etag { get; set; }Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
| Property Value | |
|---|---|
| Type | Description |
string |
|
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; }The labels with user-defined metadata to organize your IndexEndpoints.
Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed.
See https://goo.gl/xmQnxf for more information and examples of labels.
| Property Value | |
|---|---|
| Type | Description |
MapFieldstringstring |
|
Name
public string Name { get; set; }Output only. The resource name of the IndexEndpoint.
| Property Value | |
|---|---|
| Type | Description |
string |
|
Network
public string Network { get; set; }Optional. The full name of the Google Compute Engine network to which the IndexEndpoint should be peered.
Private services access must already be configured for the network. If left unspecified, the Endpoint is not peered with any network.
[network][google.cloud.aiplatform.v1beta1.IndexEndpoint.network] and [private_service_connect_config][google.cloud.aiplatform.v1beta1.IndexEndpoint.private_service_connect_config] are mutually exclusive.
Format:
projects/{project}/global/networks/{network}.
Where {project} is a project number, as in '12345', and {network} is
network name.
| Property Value | |
|---|---|
| Type | Description |
string |
|
PrivateServiceConnectConfig
public PrivateServiceConnectConfig PrivateServiceConnectConfig { get; set; }Optional. Configuration for private service connect.
[network][google.cloud.aiplatform.v1beta1.IndexEndpoint.network] and [private_service_connect_config][google.cloud.aiplatform.v1beta1.IndexEndpoint.private_service_connect_config] are mutually exclusive.
| Property Value | |
|---|---|
| Type | Description |
PrivateServiceConnectConfig |
|
PublicEndpointDomainName
public string PublicEndpointDomainName { get; set; }Output only. If [public_endpoint_enabled][google.cloud.aiplatform.v1beta1.IndexEndpoint.public_endpoint_enabled] is true, this field will be populated with the domain name to use for this index endpoint.
| Property Value | |
|---|---|
| Type | Description |
string |
|
PublicEndpointEnabled
public bool PublicEndpointEnabled { get; set; }Optional. If true, the deployed index will be accessible through public endpoint.
| Property Value | |
|---|---|
| Type | Description |
bool |
|
SatisfiesPzi
public bool SatisfiesPzi { get; set; }Output only. Reserved for future use.
| Property Value | |
|---|---|
| Type | Description |
bool |
|
SatisfiesPzs
public bool SatisfiesPzs { get; set; }Output only. Reserved for future use.
| Property Value | |
|---|---|
| Type | Description |
bool |
|
UpdateTime
public Timestamp UpdateTime { get; set; }Output only. Timestamp when this IndexEndpoint was last updated. This timestamp is not updated when the endpoint's DeployedIndexes are updated, e.g. due to updates of the original Indexes they are the deployments of.
| Property Value | |
|---|---|
| Type | Description |
Timestamp |
|