DeployedIndex class final

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

Inheritance
  • Object
  • ProtoMessage
  • DeployedIndex

Constructors

DeployedIndex({required String id, required String index, String displayName = '', Timestamp? createTime, IndexPrivateEndpoints? privateEndpoints, Timestamp? indexSyncTime, AutomaticResources? automaticResources, DedicatedResources? dedicatedResources, bool enableAccessLogging = false, bool enableDatapointUpsertLogging = false, DeployedIndexAuthConfig? deployedIndexAuthConfig, List<String> reservedIpRanges = const [], String deploymentGroup = '', List<PscautomationConfig> pscAutomationConfigs = const []})
DeployedIndex.fromJson(Object? j)
factory

Properties

automaticResources → 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.
final
createTime → Timestamp?
Output only. Timestamp when the DeployedIndex was created.
final
dedicatedResources → 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.
final
deployedIndexAuthConfig → DeployedIndexAuthConfig?
Optional. If set, the authentication is enabled for the private endpoint.
final
deploymentGroup → String
Optional. The deployment group can be no longer than 64 characters (eg: 'test', 'prod'). If not set, we will use the 'default' deployment group.
final
displayName → String
The display name of the DeployedIndex. If not provided upon creation, the Index's display_name is used.
final
enableAccessLogging → bool
Optional. If true, private endpoint's access logs are sent to Cloud Logging.
final
enableDatapointUpsertLogging → bool
Optional. If true, logs to Cloud Logging errors relating to datapoint upserts.
final
hashCode → int
The hash code for this object.
no setterinherited
id → String
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.
final
index → String
Required. The name of the Index this is the deployment of. We may refer to this Index as the DeployedIndex's "original" Index.
final
indexSyncTime → Timestamp?
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.
final
privateEndpoints → IndexPrivateEndpoints?
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.
final
pscAutomationConfigs → List<PscautomationConfig>
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.
final
qualifiedName → String
The fully qualified name of this message, i.e., google.protobuf.Duration or google.rpc.ErrorInfo.
finalinherited
reservedIpRanges → List<String>
Optional. A list of reserved ip ranges under the VPC network that can be used for this DeployedIndex.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Object
override
toString() → String
A string representation of this object.
override

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Constants

fullyQualifiedName → const String