DocumentState class

Input properties used for looking up and filtering Document resources.

Constructors

DocumentState({Input<String?>? collection, Input<String?>? createTime, Input<String?>? database, Input<String?>? deletionPolicy, Input<String?>? documentId, Input<String?>? fields, Input<String?>? name, Input<String?>? path, Input<String?>? project, Input<String?>? updateTime})
Creates a new DocumentState. collection The collection ID, relative to database. For example: chatrooms or chatrooms/my-document/private-messages. createTime Creation timestamp in RFC3339 format. database The Firestore database id. Defaults to "(default)". deletionPolicy Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. documentId The client-assigned document ID to use for this document during creation. fields The document's fields formated as a json string. name A server defined name for this document. Format: path A relative path to the collection this document exists within project The ID of the project in which the resource belongs. updateTime Last update timestamp in RFC3339 format.
const
DocumentState.fromMap(Map<String, dynamic> map)
factory

Properties

collection → Input<String?>?
The collection ID, relative to database. For example: chatrooms or chatrooms/my-document/private-messages.
final
createTime → Input<String?>?
Creation timestamp in RFC3339 format.
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
documentId → Input<String?>?
The client-assigned document ID to use for this document during creation.
final
fields → Input<String?>?
The document's fields formated as a json string.
final
hashCode → int
The hash code for this object.
no setterinherited
name → Input<String?>?
A server defined name for this document. Format: projects/{{project_id}}/databases/{{database_id}}/documents/{{path}}/{{document_id}}
final
path → Input<String?>?
A relative path to the collection this document exists within
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 setterinherited
updateTime → Input<String?>?
Last update timestamp in RFC3339 format.
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