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.



587
588
589
 
# File 'lib/google/apis/admin_reports_v1/classes.rb', line 587

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) 


532
533
534
 
# File 'lib/google/apis/admin_reports_v1/classes.rb', line 532

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) 


538
539
540
 
# File 'lib/google/apis/admin_reports_v1/classes.rb', line 538

def expiration
  @expiration
end

#id ⇒ String

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

Returns:

  • (String) 


543
544
545
 
# File 'lib/google/apis/admin_reports_v1/classes.rb', line 543

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) 


549
550
551
 
# File 'lib/google/apis/admin_reports_v1/classes.rb', line 549

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


554
555
556
 
# File 'lib/google/apis/admin_reports_v1/classes.rb', line 554

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) 


561
562
563
 
# File 'lib/google/apis/admin_reports_v1/classes.rb', line 561

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) 


568
569
570
 
# File 'lib/google/apis/admin_reports_v1/classes.rb', line 568

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) 


573
574
575
 
# File 'lib/google/apis/admin_reports_v1/classes.rb', line 573

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) 


579
580
581
 
# File 'lib/google/apis/admin_reports_v1/classes.rb', line 579

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) 


585
586
587
 
# File 'lib/google/apis/admin_reports_v1/classes.rb', line 585

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



592
593
594
595
596
597
598
599
600
601
602
603
 
# File 'lib/google/apis/admin_reports_v1/classes.rb', line 592

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