GetIndexResult class
Result data returned by getIndex.
Constructors
-
GetIndexResult({required String createTime, required List<
GoogleCloudAiplatformV1DeployedIndexRefResponse> deployedIndexes, required String description, required String displayName, required GoogleCloudAiplatformV1EncryptionSpecResponse encryptionSpec, required String etag, required GoogleCloudAiplatformV1IndexStatsResponse indexStats, required String indexUpdateMethod, required Map<String, String> labels, required dynamic metadata, required String metadataSchemaUri, required String name, required String updateTime}) -
Creates a new GetIndexResult.
createTimeTimestamp when this Index was created.deployedIndexesThe pointers to DeployedIndexes created from this Index. An Index can be only deleted if all its DeployedIndexes had been undeployed first.descriptionThe description of the Index.displayNameThe display name of the Index. The name can be up to 128 characters long and can consist of any UTF-8 characters.encryptionSpecImmutable. Customer-managed encryption key spec for an Index. If set, this Index and all sub-resources of this Index will be secured by this key.etagUsed to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.indexStatsStats of the index resource.indexUpdateMethodImmutable. The update method to use with this Index. If not set, BATCH_UPDATE will be used by default.labelsThe labels with user-defined metadata to organize your Indexes. 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.metadataAn additional information about the Index; the schema of the metadata can be found in metadata_schema.metadataSchemaUriImmutable. Points to a YAML file stored on Google Cloud Storage describing additional information about the Index, that is specific to it. Unset if the Index does not have any additional information. The schema is defined as an OpenAPI 3.0.2 Schema Object. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.nameThe resource name of the Index.updateTimeTimestamp when this Index was most recently updated. This also includes any update to the contents of the Index. Note that Operations working on this Index may have their Operations.metadata.generic_metadata.update_time a little after the value of this timestamp, yet that does not mean their results are not already reflected in the Index. Result of any successfully completed Operation on the Index is reflected in it.const -
GetIndexResult.fromMap(Map<
String, dynamic> map) -
factory
Properties
- createTime → String
-
Timestamp when this Index was created.
final
-
deployedIndexes
→ List<
GoogleCloudAiplatformV1DeployedIndexRefResponse> -
The pointers to DeployedIndexes created from this Index. An Index can be only deleted if all its DeployedIndexes had been undeployed first.
final
- description → String
-
The description of the Index.
final
- displayName → String
-
The display name of the Index. The name can be up to 128 characters long and can consist of any UTF-8 characters.
final
- encryptionSpec → GoogleCloudAiplatformV1EncryptionSpecResponse
-
Immutable. Customer-managed encryption key spec for an Index. If set, this Index and all sub-resources of this Index 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
- indexStats → GoogleCloudAiplatformV1IndexStatsResponse
-
Stats of the index resource.
final
- indexUpdateMethod → String
-
Immutable. The update method to use with this Index. If not set, BATCH_UPDATE will be used by default.
final
-
labels
→ Map<
String, String> -
The labels with user-defined metadata to organize your Indexes. 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.
final
- metadata → dynamic
-
An additional information about the Index; the schema of the metadata can be found in metadata_schema.
final
- metadataSchemaUri → String
-
Immutable. Points to a YAML file stored on Google Cloud Storage describing additional information about the Index, that is specific to it. Unset if the Index does not have any additional information. The schema is defined as an OpenAPI 3.0.2 Schema Object. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.
final
- name → String
-
The resource name of the Index.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- updateTime → String
-
Timestamp when this Index was most recently updated. This also includes any update to the contents of the Index. Note that Operations working on this Index may have their Operations.metadata.generic_metadata.update_time a little after the value of this timestamp, yet that does not mean their results are not already reflected in the Index. Result of any successfully completed Operation on the Index is reflected in it.
final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toMap(
) → Map< String, dynamic> -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited