Class: Google::Apis::AdminReportsV1::Channel

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/admin_reports_v1/classes.rb,
lib/google/apis/admin_reports_v1/representations.rb,
lib/google/apis/admin_reports_v1/representations.rb

Overview

A 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.



417
418
419
 
# File 'lib/google/apis/admin_reports_v1/classes.rb', line 417

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) 


362
363
364
 
# File 'lib/google/apis/admin_reports_v1/classes.rb', line 362

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) 


368
369
370
 
# File 'lib/google/apis/admin_reports_v1/classes.rb', line 368

def expiration
  @expiration
end

#id ⇒ String

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

Returns:

  • (String) 


373
374
375
 
# File 'lib/google/apis/admin_reports_v1/classes.rb', line 373

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) 


379
380
381
 
# File 'lib/google/apis/admin_reports_v1/classes.rb', line 379

def kind
  @kind
end

#params ⇒ Hash<String,String>

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

Returns:

  • (Hash<String,String>) 


384
385
386
 
# File 'lib/google/apis/admin_reports_v1/classes.rb', line 384

def params
  @params
end

#payload ⇒ Boolean Also known as: payload?

A Boolean value to indicate whether payload is wanted. A payload is data that is sent in the body of an HTTP POST, PUT, or PATCH message and contains important information about the request. Optional. Corresponds to the JSON property payload

Returns:

  • (Boolean) 


391
392
393
 
# File 'lib/google/apis/admin_reports_v1/classes.rb', line 391

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) 


398
399
400
 
# File 'lib/google/apis/admin_reports_v1/classes.rb', line 398

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) 


403
404
405
 
# File 'lib/google/apis/admin_reports_v1/classes.rb', line 403

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) 


409
410
411
 
# File 'lib/google/apis/admin_reports_v1/classes.rb', line 409

def token
  @token
end

#type ⇒ String

The type of delivery mechanism used for this channel. The value should be set to "web_hook". Corresponds to the JSON property type

Returns:

  • (String) 


415
416
417
 
# File 'lib/google/apis/admin_reports_v1/classes.rb', line 415

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



422
423
424
425
426
427
428
429
430
431
432
433
 
# File 'lib/google/apis/admin_reports_v1/classes.rb', line 422

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