Class GoogleFirestoreAdminV1ChangeStream

A Change Stream is a resource that allows users to receive change notifications from a Firestore database.

Inheritance
object
GoogleFirestoreAdminV1ChangeStream
Implements
Inherited Members
Namespace: Google.Apis.Firestore.v1.Data
Assembly: Google.Apis.Firestore.v1.dll
Syntax
public class GoogleFirestoreAdminV1ChangeStream : IDirectResponseSchema

Properties

CollectionGroupScope

If set, the change stream is scoped to a collection group.

Declaration
[JsonProperty("collectionGroupScope")]
public virtual GoogleFirestoreAdminV1CollectionGroupScope CollectionGroupScope { get; set; }
Property Value
Type Description
GoogleFirestoreAdminV1CollectionGroupScope

CreateTime

object representation of CreateTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use CreateTimeDateTimeOffset instead.")]
public virtual object CreateTime { get; set; }
Property Value
Type Description
object

CreateTimeDateTimeOffset

DateTimeOffset representation of CreateTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? CreateTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

CreateTimeRaw

Output only. The time the Change Stream was created.

Declaration
[JsonProperty("createTime")]
public virtual string CreateTimeRaw { get; set; }
Property Value
Type Description
string

DatabaseScope

If set, the change stream is scoped to the entire database.

Declaration
[JsonProperty("databaseScope")]
public virtual GoogleFirestoreAdminV1DatabaseScope DatabaseScope { get; set; }
Property Value
Type Description
GoogleFirestoreAdminV1DatabaseScope

ETag

Optional. An etag used to determine which version of the configuration is being edited.

Declaration
[JsonProperty("etag")]
public virtual string ETag { get; set; }
Property Value
Type Description
string

Name

Identifier. The external resource name of the change stream. Format projects/{project}/databases/{database}/changeStreams/{change_stream}

Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type Description
string

RetentionPeriod

Required. The retention period of the change stream. This is the amount of time a change event is available on the change stream. Must be from 1 to 7 days, inclusive. The retention_period must be in day granularity, i.e. it must be a multiple of 24 hours.

Declaration
[JsonProperty("retentionPeriod")]
public virtual object RetentionPeriod { get; set; }
Property Value
Type Description
object

StartTime

object representation of StartTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use StartTimeDateTimeOffset instead.")]
public virtual object StartTime { get; set; }
Property Value
Type Description
object

StartTimeDateTimeOffset

DateTimeOffset representation of StartTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? StartTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

StartTimeRaw

Output only. The time the Change Stream started recording events.

Declaration
[JsonProperty("startTime")]
public virtual string StartTimeRaw { get; set; }
Property Value
Type Description
string

UpdateTime

object representation of UpdateTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use UpdateTimeDateTimeOffset instead.")]
public virtual object UpdateTime { get; set; }
Property Value
Type Description
object

UpdateTimeDateTimeOffset

DateTimeOffset representation of UpdateTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? UpdateTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

UpdateTimeRaw

Output only. The time the Change Stream was last updated.

Declaration
[JsonProperty("updateTime")]
public virtual string UpdateTimeRaw { get; set; }
Property Value
Type Description
string

Implements