IndexArgs class

The set of arguments for Index. The set of arguments for Index.

Constructors

IndexArgs({Input<String>? description, required Input<String> displayName, Input<GoogleCloudAiplatformV1EncryptionSpec>? encryptionSpec, Input<String>? etag, Input<IndexIndexUpdateMethod>? indexUpdateMethod, Input<Map<String, String>>? labels, Input<String>? location, Input? metadata, Input<String>? metadataSchemaUri, Input<String>? project})
Creates a new IndexArgs. description The description of the Index. displayName The display name of the Index. The name can be up to 128 characters long and can consist of any UTF-8 characters. encryptionSpec 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. etag Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. indexUpdateMethod Immutable. The update method to use with this Index. If not set, BATCH_UPDATE will be used by default. labels 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. location Optional. metadata An additional information about the Index; the schema of the metadata can be found in metadata_schema. metadataSchemaUri 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. project Optional.
const
IndexArgs.fromMap(Map<String, dynamic> map)
factory

Properties

description → Input<String>?
The description of the Index.
final
displayName → Input<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 → Input<GoogleCloudAiplatformV1EncryptionSpec>?
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 → Input<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
indexUpdateMethod → Input<IndexIndexUpdateMethod>?
Immutable. The update method to use with this Index. If not set, BATCH_UPDATE will be used by default.
final
labels → Input<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
location → Input<String>?
final
metadata → Input?
An additional information about the Index; the schema of the metadata can be found in metadata_schema.
final
metadataSchemaUri → Input<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
project → Input<String>?
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
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

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