View Source GoogleApi.Storage.V1.Model.Channel (google_api_storage v0.46.0)

An notification channel used to watch for resource changes.

Attributes

  • address (type: String.t, default: nil) - The address where notifications are delivered for this channel.
  • expiration (type: String.t, default: nil) - Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
  • id (type: String.t, default: nil) - A UUID or similar unique string that identifies this channel.
  • kind (type: String.t, default: api#channel) - Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel".
  • params (type: map(), default: nil) - Additional parameters controlling delivery channel behavior. Optional.
  • payload (type: boolean(), default: nil) - A Boolean value to indicate whether payload is wanted. Optional.
  • resourceId (type: String.t, default: nil) - An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
  • resourceUri (type: String.t, default: nil) - A version-specific identifier for the watched resource.
  • token (type: String.t, default: nil) - An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
  • type (type: String.t, default: nil) - The type of delivery mechanism used for this channel.

Summary

Types

t()

Functions

decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.Storage.V1.Model.Channel{
  address: String.t() | nil,
  expiration: String.t() | nil,
  id: String.t() | nil,
  kind: String.t() | nil,
  params: map() | nil,
  payload: boolean() | nil,
  resourceId: String.t() | nil,
  resourceUri: String.t() | nil,
  token: String.t() | nil,
  type: String.t() | nil
}

Functions

decode(value, options)

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.