FieldState class

Input properties used for looking up and filtering Field resources.

Constructors

FieldState({Input<String?>? collection, Input<String?>? database, Input<String?>? deletionPolicy, Input<String?>? field, Input<FieldIndexConfig?>? indexConfig, Input<String?>? name, Input<String?>? project, Input<bool?>? skipWait, Input<FieldTtlConfig?>? ttlConfig})

Creates a new FieldState. collection The id of the collection group to configure. database The Firestore database id. Defaults to "(default)". deletionPolicy Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. field The id of the field to configure. indexConfig The single field index configuration for this field. name The name of this field. Format: project The ID of the project in which the resource belongs. skipWait Whether to skip waiting for the field operation to complete. ttlConfig The TTL configuration for this Field. If set to an empty (i.e. ttlConfig {}) or non-empty block, a TTL policy is configured based on the field. If unset, a TTL policy is not configured (or will be disabled upon updating the resource).

const

FieldState.fromMap(Map<String, dynamic> map)

factory

Properties

collection → Input<String?>?

The id of the collection group to configure.

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

field → Input<String?>?

The id of the field to configure.

final

hashCode → int

The hash code for this object.

no setter, inherited

indexConfig → Input<FieldIndexConfig?>?

The single field index configuration for this field. Creating an index configuration for this field will override any inherited configuration with the indexes specified. Configuring the index configuration with an empty block disables all indexes on the field. Structure is documented below.

final

name → Input<String?>?

The name of this field. Format: projects/{{project}}/databases/{{database}}/collectionGroups/{{collection}}/fields/{{field}}

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

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

skipWait → Input<bool?>?

Whether to skip waiting for the field operation to complete.

final

ttlConfig → Input<FieldTtlConfig?>?

The TTL configuration for this Field. If set to an empty (i.e. ttlConfig {}) or non-empty block, a TTL policy is configured based on the field. If unset, a TTL policy is not configured (or will be disabled upon updating the resource). Structure is documented below.

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