Class: Google::Apis::CalendarV3::Channel

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
generated/google/apis/calendar_v3/classes.rb,
generated/google/apis/calendar_v3/representations.rb,
generated/google/apis/calendar_v3/representations.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Google::Apis::Core::JsonObjectSupport

#to_json

Methods included from Google::Apis::Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Channel

Returns a new instance of Channel.


530
531
532
# File 'generated/google/apis/calendar_v3/classes.rb', line 530

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#addressString

The address where notifications are delivered for this channel. Corresponds to the JSON property address

Returns:

  • (String)

478
479
480
# File 'generated/google/apis/calendar_v3/classes.rb', line 478

def address
  @address
end

#expirationFixnum

Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional. Corresponds to the JSON property expiration

Returns:

  • (Fixnum)

484
485
486
# File 'generated/google/apis/calendar_v3/classes.rb', line 484

def expiration
  @expiration
end

#idString

A UUID or similar unique string that identifies this channel. Corresponds to the JSON property id

Returns:

  • (String)

489
490
491
# File 'generated/google/apis/calendar_v3/classes.rb', line 489

def id
  @id
end

#kindString

Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel". Corresponds to the JSON property kind

Returns:

  • (String)

495
496
497
# File 'generated/google/apis/calendar_v3/classes.rb', line 495

def kind
  @kind
end

#paramsHash<String,String>

Additional parameters controlling delivery channel behavior. Optional. Corresponds to the JSON property params

Returns:

  • (Hash<String,String>)

500
501
502
# File 'generated/google/apis/calendar_v3/classes.rb', line 500

def params
  @params
end

#payloadBoolean Also known as: payload?

A Boolean value to indicate whether payload is wanted. Optional. Corresponds to the JSON property payload

Returns:

  • (Boolean)

505
506
507
# File 'generated/google/apis/calendar_v3/classes.rb', line 505

def payload
  @payload
end

#resource_idString

An opaque ID that identifies the resource being watched on this channel. Stable across different API versions. Corresponds to the JSON property resourceId

Returns:

  • (String)

512
513
514
# File 'generated/google/apis/calendar_v3/classes.rb', line 512

def resource_id
  @resource_id
end

#resource_uriString

A version-specific identifier for the watched resource. Corresponds to the JSON property resourceUri

Returns:

  • (String)

517
518
519
# File 'generated/google/apis/calendar_v3/classes.rb', line 517

def resource_uri
  @resource_uri
end

#tokenString

An arbitrary string delivered to the target address with each notification delivered over this channel. Optional. Corresponds to the JSON property token

Returns:

  • (String)

523
524
525
# File 'generated/google/apis/calendar_v3/classes.rb', line 523

def token
  @token
end

#typeString

The type of delivery mechanism used for this channel. Corresponds to the JSON property type

Returns:

  • (String)

528
529
530
# File 'generated/google/apis/calendar_v3/classes.rb', line 528

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


535
536
537
538
539
540
541
542
543
544
545
546
# File 'generated/google/apis/calendar_v3/classes.rb', line 535

def update!(**args)
  @address = args[:address] if args.key?(:address)
  @expiration = args[:expiration] if args.key?(:expiration)
  @id = args[:id] if args.key?(:id)
  @kind = args[:kind] if args.key?(:kind)
  @params = args[:params] if args.key?(:params)
  @payload = args[:payload] if args.key?(:payload)
  @resource_id = args[:resource_id] if args.key?(:resource_id)
  @resource_uri = args[:resource_uri] if args.key?(:resource_uri)
  @token = args[:token] if args.key?(:token)
  @type = args[:type] if args.key?(:type)
end