DocumentArgs class

The set of arguments for Document. The set of arguments for Document.

Constructors

DocumentArgs({required Input<String> collection, Input<String?>? database, Input<String?>? deletionPolicy, required Input<String> documentId, required Input<String> fields, Input<String?>? project})
Creates a new DocumentArgs. collection The collection ID, relative to database. For example: chatrooms or chatrooms/my-document/private-messages. 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. project The ID of the project in which the resource belongs.
const
DocumentArgs.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
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
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

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