IndexArgs class

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

Constructors

IndexArgs({Input<String?>? apiScope, required Input<String> collection, Input<String?>? database, Input<String?>? deletionPolicy, Input<String?>? density, required Input<List<IndexField>> fields, Input<bool?>? multikey, Input<String?>? project, Input<String?>? queryScope, Input<bool?>? skipWait, Input<bool?>? unique})
Creates a new IndexArgs. apiScope The API scope at which a query is run. collection The collection being indexed. database The Firestore database id. Defaults to "(default)". deletionPolicy Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. density The density configuration for this index. fields The field(s) supported by this index. Indexes with the ANY_API apiScope in Standard multikey Optional. Whether the index is multikey. By default, the index is not multikey. For non-multikey indexes, none of the paths in the index definition reach or traverse an array, except via an explicit array index. For multikey indexes, at most one of the paths in the index definition reach or traverse an array, except via an explicit array index. Violations will result in errors. Note this field only applies to indexes with MONGODB_COMPATIBLE_API ApiScope. project The ID of the project in which the resource belongs. queryScope The scope at which a query is run. skipWait Whether to skip waiting for the index to be created. unique Whether it is an unique index. Unique index ensures all values for the indexed field(s) are unique across documents.
const
IndexArgs.fromMap(Map<String, dynamic> map)
factory

Properties

apiScope → Input<String?>?
The API scope at which a query is run. Default value is ANY_API. Possible values are: ANY_API, DATASTORE_MODE_API, MONGODB_COMPATIBLE_API.
final
collection → Input<String>
The collection being indexed.
final
database → Input<String?>?
The Firestore database id. Defaults to "(default)".
final
deletionPolicy → Input<String?>?
Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
final
density → Input<String?>?
The density configuration for this index. Possible values are: SPARSE_ALL, SPARSE_ANY, DENSE.
final
fields → Input<List<IndexField>>
The field(s) supported by this index. Indexes with the ANY_API apiScope in Standard edition databases have special behavior with respect to the __name__ field. In these indexes, the last non-stored field entry is always for the field path __name__. If, on creation, __name__ was not specified as the last field, it will be added automatically with the same direction as that of the last field defined. If the final field in an index is not directional, the __name__ will be ordered "ASCENDING" (unless explicitly specified otherwise). Structure is documented below.
final
hashCode → int
The hash code for this object.
no setterinherited
multikey → Input<bool?>?
Optional. Whether the index is multikey. By default, the index is not multikey. For non-multikey indexes, none of the paths in the index definition reach or traverse an array, except via an explicit array index. For multikey indexes, at most one of the paths in the index definition reach or traverse an array, except via an explicit array index. Violations will result in errors. Note this field only applies to indexes with MONGODB_COMPATIBLE_API ApiScope.
final
project → Input<String?>?
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
final
queryScope → Input<String?>?
The scope at which a query is run. Default value is COLLECTION. Possible values are: COLLECTION, COLLECTION_GROUP, COLLECTION_RECURSIVE.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
skipWait → Input<bool?>?
Whether to skip waiting for the index to be created.
final
unique → Input<bool?>?
Whether it is an unique index. Unique index ensures all values for the indexed field(s) are unique across documents.
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