Class Subscription
A subscription to receive events about a Google Workspace resource. To learn more about subscriptions, see the Google Workspace Events API overview.
Implements
Inherited Members
Namespace: Google.Apis.WorkspaceEvents.v1.Data
Assembly: Google.Apis.WorkspaceEvents.v1.dll
Syntax
public class Subscription : IDirectResponseSchemaProperties
Authority
Output only. The user who authorized the creation of the subscription. Format: users/{user} For Google
Workspace users, the {user} value is the
user.id field
from the Directory API.
Declaration
[JsonProperty("authority")]
public virtual string Authority { get; set; }Property Value
| Type | Description | 
|---|---|
| string | 
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 when the subscription is created.
Declaration
[JsonProperty("createTime")]
public virtual string CreateTimeRaw { get; set; }Property Value
| Type | Description | 
|---|---|
| string | 
ETag
Optional. This checksum is computed by the server based on the value of other fields, and might be sent on update requests to ensure the client has an up-to-date value before proceeding.
Declaration
[JsonProperty("etag")]
public virtual string ETag { get; set; }Property Value
| Type | Description | 
|---|---|
| string | 
EventTypes
Required. Unordered list. Input for creating a subscription. Otherwise, output only. One or more types of
events to receive about the target resource. Formatted according to the CloudEvents specification. The
supported event types depend on the target resource of your subscription. For details, see Supported Google
Workspace events. By default, you
also receive events about the lifecycle of your
subscription. You don't need to
specify lifecycle events for this field. If you specify an event type that doesn't exist for the target
resource, the request returns an HTTP 400 Bad Request status code.
Declaration
[JsonProperty("eventTypes")]
public virtual IList<string> EventTypes { get; set; }Property Value
| Type | Description | 
|---|---|
| IList<string> | 
ExpireTime
object representation of ExpireTimeRaw.
Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use ExpireTimeDateTimeOffset instead.")]
public virtual object ExpireTime { get; set; }Property Value
| Type | Description | 
|---|---|
| object | 
ExpireTimeDateTimeOffset
DateTimeOffset representation of ExpireTimeRaw.
Declaration
[JsonIgnore]
public virtual DateTimeOffset? ExpireTimeDateTimeOffset { get; set; }Property Value
| Type | Description | 
|---|---|
| DateTimeOffset? | 
ExpireTimeRaw
Non-empty default. The timestamp in UTC when the subscription expires. Always displayed on output, regardless of what was used on input.
Declaration
[JsonProperty("expireTime")]
public virtual string ExpireTimeRaw { get; set; }Property Value
| Type | Description | 
|---|---|
| string | 
Name
Identifier. Resource name of the subscription. Format: subscriptions/{subscription}
Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }Property Value
| Type | Description | 
|---|---|
| string | 
NotificationEndpoint
Required. Immutable. The endpoint where the subscription delivers events, such as a Pub/Sub topic.
Declaration
[JsonProperty("notificationEndpoint")]
public virtual NotificationEndpoint NotificationEndpoint { get; set; }Property Value
| Type | Description | 
|---|---|
| NotificationEndpoint | 
PayloadOptions
Optional. Options about what data to include in the event payload. Only supported for Google Chat events.
Declaration
[JsonProperty("payloadOptions")]
public virtual PayloadOptions PayloadOptions { get; set; }Property Value
| Type | Description | 
|---|---|
| PayloadOptions | 
Reconciling
Output only. If true, the subscription is in the process of being updated.
Declaration
[JsonProperty("reconciling")]
public virtual bool? Reconciling { get; set; }Property Value
| Type | Description | 
|---|---|
| bool? | 
State
Output only. The state of the subscription. Determines whether the subscription can receive events and deliver them to the notification endpoint.
Declaration
[JsonProperty("state")]
public virtual string State { get; set; }Property Value
| Type | Description | 
|---|---|
| string | 
SuspensionReason
Output only. The error that suspended the subscription. To reactivate the subscription, resolve the error
and call the ReactivateSubscription method.
Declaration
[JsonProperty("suspensionReason")]
public virtual string SuspensionReason { get; set; }Property Value
| Type | Description | 
|---|---|
| string | 
TargetResource
Required. Immutable. The Google Workspace resource that's monitored for events, formatted as the full
resource name. To learn about target resources and the
events that they support, see Supported Google Workspace
events. A user can only authorize your app
to create one subscription for a given target resource. If your app tries to create another subscription
with the same user credentials, the request returns an ALREADY_EXISTS error.
Declaration
[JsonProperty("targetResource")]
public virtual string TargetResource { get; set; }Property Value
| Type | Description | 
|---|---|
| string | 
Ttl
Input only. The time-to-live (TTL) or duration for the subscription. If unspecified or set to 0, uses the
maximum possible duration.
Declaration
[JsonProperty("ttl")]
public virtual object Ttl { get; set; }Property Value
| Type | Description | 
|---|---|
| object | 
Uid
Output only. System-assigned unique identifier for the subscription.
Declaration
[JsonProperty("uid")]
public virtual string Uid { 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 last time that the subscription is updated.
Declaration
[JsonProperty("updateTime")]
public virtual string UpdateTimeRaw { get; set; }Property Value
| Type | Description | 
|---|---|
| string |