ChangeStreamArgs class
The set of arguments for ChangeStream. The set of arguments for ChangeStream.
Constructors
-
ChangeStreamArgs({Input<
ChangeStreamCollectionGroupScope?> ? collectionGroupScope, Input<String?> ? database, Input<Map< ? databaseScope, Input<String, dynamic> ?>String?> ? deletionPolicy, Input<String?> ? name, Input<String?> ? project, required Input<String> retentionPeriod}) -
Creates a new ChangeStreamArgs.
collectionGroupScopeTracks changes for a specific collection group.databaseThe Firestore database ID. Defaults to"(default)".databaseScopeTracks changes across all collections in the database.deletionPolicyWhether Terraform will be prevented from destroying the resource. Defaults to DELETE.nameThe ID to use for the change stream, which will become the final componentprojectThe ID of the project in which the resource belongs.retentionPeriodThe duration for which change stream data is retained.const -
ChangeStreamArgs.fromMap(Map<
String, dynamic> map) -
factory
Properties
-
collectionGroupScope
→ Input<
ChangeStreamCollectionGroupScope?> ? -
Tracks changes for a specific collection group.
Structure is documented below.
final
-
database
→ Input<
String?> ? -
The Firestore database ID. Defaults to
"(default)".final -
databaseScope
→ Input<
Map< ?String, dynamic> ?> -
Tracks changes across all collections in the database.
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
- hashCode → int
-
The hash code for this object.
no setterinherited
-
name
→ Input<
String?> ? -
The ID to use for the change stream, which will become the final component
of the change stream's resource name.
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
-
retentionPeriod
→ Input<
String> -
The duration for which change stream data is retained.
A duration in seconds with up to nine fractional digits, ending with 's'. Example: "86400s".
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