Class: Google::Apis::AdminDirectoryV1::Channel
- Inherits:
-
Object
- Object
- Google::Apis::AdminDirectoryV1::Channel
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- lib/google/apis/admin_directory_v1/classes.rb,
lib/google/apis/admin_directory_v1/representations.rb,
lib/google/apis/admin_directory_v1/representations.rb
Overview
An notification channel used to watch for resource changes.
Instance Attribute Summary collapse
-
#address ⇒ String
The address where notifications are delivered for this channel.
-
#expiration ⇒ Fixnum
Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds.
-
#id ⇒ String
A UUID or similar unique string that identifies this channel.
-
#kind ⇒ String
Identifies this as a notification channel used to watch for changes to a resource, which is
api#channel
. -
#params ⇒ Hash<String,String>
Additional parameters controlling delivery channel behavior.
-
#payload ⇒ Boolean
(also: #payload?)
A Boolean value to indicate whether payload is wanted.
-
#resource_id ⇒ String
An opaque ID that identifies the resource being watched on this channel.
-
#resource_uri ⇒ String
A version-specific identifier for the watched resource.
-
#token ⇒ String
An arbitrary string delivered to the target address with each notification delivered over this channel.
-
#type ⇒ String
The type of delivery mechanism used for this channel.
Instance Method Summary collapse
-
#initialize(**args) ⇒ Channel
constructor
A new instance of Channel.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ Channel
Returns a new instance of Channel.
934 935 936 |
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 934 def initialize(**args) update!(**args) end |
Instance Attribute Details
#address ⇒ String
The address where notifications are delivered for this channel.
Corresponds to the JSON property address
879 880 881 |
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 879 def address @address end |
#expiration ⇒ Fixnum
Date and time of notification channel expiration, expressed as a Unix
timestamp, in milliseconds. Optional.
Corresponds to the JSON property expiration
885 886 887 |
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 885 def expiration @expiration end |
#id ⇒ String
A UUID or similar unique string that identifies this channel.
Corresponds to the JSON property id
890 891 892 |
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 890 def id @id end |
#kind ⇒ String
Identifies this as a notification channel used to watch for changes to a
resource, which is api#channel
.
Corresponds to the JSON property kind
896 897 898 |
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 896 def kind @kind end |
#params ⇒ Hash<String,String>
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.
Corresponds to the JSON property params
904 905 906 |
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 904 def params @params end |
#payload ⇒ Boolean Also known as: payload?
A Boolean value to indicate whether payload is wanted. Optional.
Corresponds to the JSON property payload
909 910 911 |
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 909 def payload @payload end |
#resource_id ⇒ String
An opaque ID that identifies the resource being watched on this channel.
Stable across different API versions.
Corresponds to the JSON property resourceId
916 917 918 |
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 916 def resource_id @resource_id end |
#resource_uri ⇒ String
A version-specific identifier for the watched resource.
Corresponds to the JSON property resourceUri
921 922 923 |
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 921 def resource_uri @resource_uri end |
#token ⇒ String
An arbitrary string delivered to the target address with each notification
delivered over this channel. Optional.
Corresponds to the JSON property token
927 928 929 |
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 927 def token @token end |
#type ⇒ String
The type of delivery mechanism used for this channel.
Corresponds to the JSON property type
932 933 934 |
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 932 def type @type end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
939 940 941 942 943 944 945 946 947 948 949 950 |
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 939 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 |