Class: Google::Apis::AdminDirectoryV1::Channel

Inherits:
Object
  • Object
show all
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

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Channel

Returns a new instance of Channel.



800
801
802
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 800

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

Returns:

  • (String) 


745
746
747
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 745

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

Returns:

  • (Fixnum) 


751
752
753
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 751

def expiration
  @expiration
end

#id ⇒ String

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

Returns:

  • (String) 


756
757
758
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 756

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

Returns:

  • (String) 


762
763
764
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 762

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

Returns:

  • (Hash<String,String>) 


770
771
772
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 770

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

Returns:

  • (Boolean) 


775
776
777
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 775

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

Returns:

  • (String) 


782
783
784
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 782

def resource_id
  @resource_id
end

#resource_uri ⇒ String

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

Returns:

  • (String) 


787
788
789
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 787

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

Returns:

  • (String) 


793
794
795
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 793

def token
  @token
end

#type ⇒ String

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

Returns:

  • (String) 


798
799
800
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 798

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



805
806
807
808
809
810
811
812
813
814
815
816
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 805

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