Class GoogleCloudAiplatformV1DeployedIndex

A deployment of an Index. IndexEndpoints contain one or more DeployedIndexes.

Inheritance
object
GoogleCloudAiplatformV1DeployedIndex
Implements
Inherited Members
Namespace: Google.Apis.Aiplatform.v1.Data
Assembly: Google.Apis.Aiplatform.v1.dll
Syntax
public class GoogleCloudAiplatformV1DeployedIndex : IDirectResponseSchema

Properties

AutomaticResources

Optional. A description of resources that the DeployedIndex uses, which to large degree are decided by Vertex AI, and optionally allows only a modest additional configuration. If min_replica_count is not set, the default value is 2 (we don't provide SLA when min_replica_count=1). If max_replica_count is not set, the default value is min_replica_count. The max allowed replica count is 1000.

Declaration
[JsonProperty("automaticResources")]
public virtual GoogleCloudAiplatformV1AutomaticResources AutomaticResources { get; set; }
Property Value
Type Description
GoogleCloudAiplatformV1AutomaticResources

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 the DeployedIndex was created.

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

DedicatedResources

Optional. A description of resources that are dedicated to the DeployedIndex, and that need a higher degree of manual configuration. The field min_replica_count must be set to a value strictly greater than 0, or else validation will fail. We don't provide SLA when min_replica_count=1. If max_replica_count is not set, the default value is min_replica_count. The max allowed replica count is 1000. Available machine types for SMALL shard: e2-standard-2 and all machine types available for MEDIUM and LARGE shard. Available machine types for MEDIUM shard: e2-standard-16 and all machine types available for LARGE shard. Available machine types for LARGE shard: e2-highmem-16, n2d-standard-32. n1-standard-16 and n1-standard-32 are still available, but we recommend e2-standard-16 and e2-highmem-16 for cost efficiency.

Declaration
[JsonProperty("dedicatedResources")]
public virtual GoogleCloudAiplatformV1DedicatedResources DedicatedResources { get; set; }
Property Value
Type Description
GoogleCloudAiplatformV1DedicatedResources

DeployedIndexAuthConfig

Optional. If set, the authentication is enabled for the private endpoint.

Declaration
[JsonProperty("deployedIndexAuthConfig")]
public virtual GoogleCloudAiplatformV1DeployedIndexAuthConfig DeployedIndexAuthConfig { get; set; }
Property Value
Type Description
GoogleCloudAiplatformV1DeployedIndexAuthConfig

DeploymentGroup

Optional. The deployment group can be no longer than 64 characters (eg: 'test', 'prod'). If not set, we will use the 'default' deployment group. Creating deployment_groups with reserved_ip_ranges is a recommended practice when the peered network has multiple peering ranges. This creates your deployments from predictable IP spaces for easier traffic administration. Also, one deployment_group (except 'default') can only be used with the same reserved_ip_ranges which means if the deployment_group has been used with reserved_ip_ranges: [a, b, c], using it with [a, b] or [d, e] is disallowed. Note: we only support up to 5 deployment groups(not including 'default').

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

DisplayName

The display name of the DeployedIndex. If not provided upon creation, the Index's display_name is used.

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

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

EnableAccessLogging

Optional. If true, private endpoint's access logs are sent to Cloud Logging. These logs are like standard server access logs, containing information like timestamp and latency for each MatchRequest. Note that logs may incur a cost, especially if the deployed index receives a high queries per second rate (QPS). Estimate your costs before enabling this option.

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

Id

Required. The user specified ID of the DeployedIndex. The ID can be up to 128 characters long and must start with a letter and only contain letters, numbers, and underscores. The ID must be unique within the project it is created in.

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

Index

Required. The name of the Index this is the deployment of. We may refer to this Index as the DeployedIndex's "original" Index.

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

IndexSyncTime

object representation of IndexSyncTimeRaw.

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

IndexSyncTimeDateTimeOffset

DateTimeOffset representation of IndexSyncTimeRaw.

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

IndexSyncTimeRaw

Output only. The DeployedIndex may depend on various data on its original Index. Additionally when certain changes to the original Index are being done (e.g. when what the Index contains is being changed) the DeployedIndex may be asynchronously updated in the background to reflect these changes. If this timestamp's value is at least the Index.update_time of the original Index, it means that this DeployedIndex and the original Index are in sync. If this timestamp is older, then to see which updates this DeployedIndex already contains (and which it does not), one must list the operations that are running on the original Index. Only the successfully completed Operations with update_time equal or before this sync time are contained in this DeployedIndex.

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

PrivateEndpoints

Output only. Provides paths for users to send requests directly to the deployed index services running on Cloud via private services access. This field is populated if network is configured.

Declaration
[JsonProperty("privateEndpoints")]
public virtual GoogleCloudAiplatformV1IndexPrivateEndpoints PrivateEndpoints { get; set; }
Property Value
Type Description
GoogleCloudAiplatformV1IndexPrivateEndpoints

PscAutomationConfigs

Optional. If set for PSC deployed index, PSC connection will be automatically created after deployment is done and the endpoint information is populated in private_endpoints.psc_automated_endpoints.

Declaration
[JsonProperty("pscAutomationConfigs")]
public virtual IList<GoogleCloudAiplatformV1PSCAutomationConfig> PscAutomationConfigs { get; set; }
Property Value
Type Description
IList<GoogleCloudAiplatformV1PSCAutomationConfig>

ReservedIpRanges

Optional. A list of reserved ip ranges under the VPC network that can be used for this DeployedIndex. If set, we will deploy the index within the provided ip ranges. Otherwise, the index might be deployed to any ip ranges under the provided VPC network. The value should be the name of the address (https://cloud.google.com/compute/docs/reference/rest/v1/addresses) Example: ['vertex-ai-ip-range']. For more information about subnets and network IP ranges, please see https://cloud.google.com/vpc/docs/subnets#manually_created_subnet_ip_ranges.

Declaration
[JsonProperty("reservedIpRanges")]
public virtual IList<string> ReservedIpRanges { get; set; }
Property Value
Type Description
IList<string>

Implements