Show / Hide Table of Contents

Class GoogleCloudAiplatformV1IndexEndpoint

Indexes are deployed into it. An IndexEndpoint can have multiple DeployedIndexes.

Inheritance
object
GoogleCloudAiplatformV1IndexEndpoint
Implements
IDirectResponseSchema
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.Aiplatform.v1.Data
Assembly: Google.Apis.Aiplatform.v1.dll
Syntax
public class GoogleCloudAiplatformV1IndexEndpoint : IDirectResponseSchema

Properties

CreateTime

object representation of CreateTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use CreateTimeDateTimeOffset instead.")]
public virtual object CreateTime { get; set; }
Property Value
Type Description
object

CreateTimeDateTimeOffset

DateTimeOffset representation of CreateTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? CreateTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

CreateTimeRaw

Output only. Timestamp when this IndexEndpoint was created.

Declaration
[JsonProperty("createTime")]
public virtual string CreateTimeRaw { get; set; }
Property Value
Type Description
string

DeployedIndexes

Output only. The indexes deployed in this endpoint.

Declaration
[JsonProperty("deployedIndexes")]
public virtual IList<GoogleCloudAiplatformV1DeployedIndex> DeployedIndexes { get; set; }
Property Value
Type Description
IList<GoogleCloudAiplatformV1DeployedIndex>

Description

The description of the IndexEndpoint.

Declaration
[JsonProperty("description")]
public virtual string Description { get; set; }
Property Value
Type Description
string

DisplayName

Required. The display name of the IndexEndpoint. The name can be up to 128 characters long and can consist of any UTF-8 characters.

Declaration
[JsonProperty("displayName")]
public virtual string DisplayName { get; set; }
Property Value
Type Description
string

ETag

Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

Declaration
[JsonProperty("etag")]
public virtual string ETag { get; set; }
Property Value
Type Description
string

EnablePrivateServiceConnect

Optional. Deprecated: If true, expose the IndexEndpoint via private service connect. Only one of the fields, network or enable_private_service_connect, can be set.

Declaration
[JsonProperty("enablePrivateServiceConnect")]
public virtual bool? EnablePrivateServiceConnect { get; set; }
Property Value
Type Description
bool?

EncryptionSpec

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.

Declaration
[JsonProperty("encryptionSpec")]
public virtual GoogleCloudAiplatformV1EncryptionSpec EncryptionSpec { get; set; }
Property Value
Type Description
GoogleCloudAiplatformV1EncryptionSpec

Labels

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.

Declaration
[JsonProperty("labels")]
public virtual IDictionary<string, string> Labels { get; set; }
Property Value
Type Description
IDictionary<string, string>

Name

Output only. The resource name of the IndexEndpoint.

Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type Description
string

Network

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 and 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.

Declaration
[JsonProperty("network")]
public virtual string Network { get; set; }
Property Value
Type Description
string

PrivateServiceConnectConfig

Optional. Configuration for private service connect. network and private_service_connect_config are mutually exclusive.

Declaration
[JsonProperty("privateServiceConnectConfig")]
public virtual GoogleCloudAiplatformV1PrivateServiceConnectConfig PrivateServiceConnectConfig { get; set; }
Property Value
Type Description
GoogleCloudAiplatformV1PrivateServiceConnectConfig

PublicEndpointDomainName

Output only. If public_endpoint_enabled is true, this field will be populated with the domain name to use for this index endpoint.

Declaration
[JsonProperty("publicEndpointDomainName")]
public virtual string PublicEndpointDomainName { get; set; }
Property Value
Type Description
string

PublicEndpointEnabled

Optional. If true, the deployed index will be accessible through public endpoint.

Declaration
[JsonProperty("publicEndpointEnabled")]
public virtual bool? PublicEndpointEnabled { get; set; }
Property Value
Type Description
bool?

SatisfiesPzi

Output only. Reserved for future use.

Declaration
[JsonProperty("satisfiesPzi")]
public virtual bool? SatisfiesPzi { get; set; }
Property Value
Type Description
bool?

SatisfiesPzs

Output only. Reserved for future use.

Declaration
[JsonProperty("satisfiesPzs")]
public virtual bool? SatisfiesPzs { get; set; }
Property Value
Type Description
bool?

UpdateTime

object representation of UpdateTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use UpdateTimeDateTimeOffset instead.")]
public virtual object UpdateTime { get; set; }
Property Value
Type Description
object

UpdateTimeDateTimeOffset

DateTimeOffset representation of UpdateTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? UpdateTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

UpdateTimeRaw

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.

Declaration
[JsonProperty("updateTime")]
public virtual string UpdateTimeRaw { get; set; }
Property Value
Type Description
string

Implements

IDirectResponseSchema
In this article
Back to top Generated by DocFX