Class: Google::Apis::ClassroomV1::Registration

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

Overview

An instruction to Classroom to send notifications from the feed to the provided destination.

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) ⇒ Registration

Returns a new instance of Registration



1682
1683
1684
 
# File 'generated/google/apis/classroom_v1/classes.rb', line 1682

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

Instance Attribute Details

#cloud_pubsub_topic ⇒ Google::Apis::ClassroomV1::CloudPubsubTopic

A reference to a Cloud Pub/Sub topic. To register for notifications, the owner of the topic must grant classroom-notifications@system.gserviceaccount.com the projects.topics.publish permission. Corresponds to the JSON property cloudPubsubTopic

Returns:



1662
1663
1664
 
# File 'generated/google/apis/classroom_v1/classes.rb', line 1662

def cloud_pubsub_topic
  @cloud_pubsub_topic
end

#expiry_time ⇒ String

The time until which the Registration is effective. This is a read-only field assigned by the server. Corresponds to the JSON property expiryTime

Returns:

  • (String) 


1668
1669
1670
 
# File 'generated/google/apis/classroom_v1/classes.rb', line 1668

def expiry_time
  @expiry_time
end

#feed ⇒ Google::Apis::ClassroomV1::Feed

A class of notifications that an application can register to receive. For example: "all roster changes for a domain". Corresponds to the JSON property feed

Returns:



1674
1675
1676
 
# File 'generated/google/apis/classroom_v1/classes.rb', line 1674

def feed
  @feed
end

#registration_id ⇒ String

A server-generated unique identifier for this Registration. Read-only. Corresponds to the JSON property registrationId

Returns:

  • (String) 


1680
1681
1682
 
# File 'generated/google/apis/classroom_v1/classes.rb', line 1680

def registration_id
  @registration_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1687
1688
1689
1690
1691
1692
 
# File 'generated/google/apis/classroom_v1/classes.rb', line 1687

def update!(**args)
  @cloud_pubsub_topic = args[:cloud_pubsub_topic] if args.key?(:cloud_pubsub_topic)
  @expiry_time = args[:expiry_time] if args.key?(:expiry_time)
  @feed = args[:feed] if args.key?(:feed)
  @registration_id = args[:registration_id] if args.key?(:registration_id)
end