IndexEndpoint class final

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

Inheritance
  • Object
  • ProtoMessage
  • IndexEndpoint

Constructors

IndexEndpoint({String name = '', required String displayName, String description = '', List<DeployedIndex> deployedIndexes = const [], String etag = '', Map<String, String> labels = const {}, Timestamp? createTime, Timestamp? updateTime, String network = '', bool enablePrivateServiceConnect = false, PrivateServiceConnectConfig? privateServiceConnectConfig, bool publicEndpointEnabled = false, String publicEndpointDomainName = '', EncryptionSpec? encryptionSpec, bool satisfiesPzs = false, bool satisfiesPzi = false})
IndexEndpoint.fromJson(Map<String, dynamic> json)
factory

Properties

createTime → Timestamp?
Output only. Timestamp when this IndexEndpoint was created.
final
deployedIndexes → List<DeployedIndex>
Output only. The indexes deployed in this endpoint.
final
description → String
The description of the IndexEndpoint.
final
displayName → String
Required. The display name of the IndexEndpoint. The name can be up to 128 characters long and can consist of any UTF-8 characters.
final
enablePrivateServiceConnect → bool
Optional. Deprecated: If true, expose the IndexEndpoint via private service connect.
final
encryptionSpec → 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.
final
etag → String
Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
final
hashCode → int
The hash code for this object.
no setterinherited
labels → Map<String, String>
The labels with user-defined metadata to organize your IndexEndpoints.
final
name → String
Output only. The resource name of the IndexEndpoint.
final
network → String
Optional. The full name of the Google Compute Engine network to which the IndexEndpoint should be peered.
final
privateServiceConnectConfig → PrivateServiceConnectConfig?
Optional. Configuration for private service connect.
final
publicEndpointDomainName → String
Output only. If public_endpoint_enabled is true, this field will be populated with the domain name to use for this index endpoint.
final
publicEndpointEnabled → bool
Optional. If true, the deployed index will be accessible through public endpoint.
final
qualifiedName → String
The fully qualified name of this message, i.e., google.protobuf.Duration or google.rpc.ErrorInfo.
finalinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
satisfiesPzi → bool
Output only. Reserved for future use.
final
satisfiesPzs → bool
Output only. Reserved for future use.
final
updateTime → Timestamp?
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.
final

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