Class Channel
An notification channel used to watch for resource changes.
Implements
Inherited Members
Namespace: Google.Apis.Admin.Directory.directory_v1.Data
Assembly: Google.Apis.Admin.Directory.directory_v1.dll
Syntax
public class Channel : IDirectResponseSchema
Properties
Address
The address where notifications are delivered for this channel.
Declaration
[JsonProperty("address")]
public virtual string Address { get; set; }
Property Value
Type | Description |
---|---|
string |
ETag
The ETag of the item.
Declaration
public virtual string ETag { get; set; }
Property Value
Type | Description |
---|---|
string |
Expiration
Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
Declaration
[JsonProperty("expiration")]
public virtual long? Expiration { get; set; }
Property Value
Type | Description |
---|---|
long? |
Id
A UUID or similar unique string that identifies this channel.
Declaration
[JsonProperty("id")]
public virtual string Id { get; set; }
Property Value
Type | Description |
---|---|
string |
Kind
Identifies this as a notification channel used to watch for changes to a resource, which is api#channel
.
Declaration
[JsonProperty("kind")]
public virtual string Kind { get; set; }
Property Value
Type | Description |
---|---|
string |
Params__
Additional parameters controlling delivery channel behavior. Optional. For example, params.ttl
specifies
the time-to-live in seconds for the notification channel, where the default is 2 hours and the maximum TTL
is 2 days.
Declaration
[JsonProperty("params")]
public virtual IDictionary<string, string> Params__ { get; set; }
Property Value
Type | Description |
---|---|
IDictionary<string, string> |
Payload
A Boolean value to indicate whether payload is wanted. Optional.
Declaration
[JsonProperty("payload")]
public virtual bool? Payload { get; set; }
Property Value
Type | Description |
---|---|
bool? |
ResourceId
An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
Declaration
[JsonProperty("resourceId")]
public virtual string ResourceId { get; set; }
Property Value
Type | Description |
---|---|
string |
ResourceUri
A version-specific identifier for the watched resource.
Declaration
[JsonProperty("resourceUri")]
public virtual string ResourceUri { get; set; }
Property Value
Type | Description |
---|---|
string |
Token
An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
Declaration
[JsonProperty("token")]
public virtual string Token { get; set; }
Property Value
Type | Description |
---|---|
string |
Type
The type of delivery mechanism used for this channel.
Declaration
[JsonProperty("type")]
public virtual string Type { get; set; }
Property Value
Type | Description |
---|---|
string |