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

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/admin_directory_v1/classes.rb,
generated/google/apis/admin_directory_v1/representations.rb,
generated/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

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Channel

Returns a new instance of Channel.


583
584
585
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 583

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

Instance Attribute Details

#addressString

The address where notifications are delivered for this channel. Corresponds to the JSON property address

Returns:

  • (String)

531
532
533
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 531

def address
  @address
end

#expirationFixnum

Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional. Corresponds to the JSON property expiration

Returns:

  • (Fixnum)

537
538
539
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 537

def expiration
  @expiration
end

#idString

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

Returns:

  • (String)

542
543
544
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 542

def id
  @id
end

#kindString

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)

548
549
550
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 548

def kind
  @kind
end

#paramsHash<String,String>

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

Returns:

  • (Hash<String,String>)

553
554
555
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 553

def params
  @params
end

#payloadBoolean Also known as: payload?

A Boolean value to indicate whether payload is wanted. Optional. Corresponds to the JSON property payload

Returns:

  • (Boolean)

558
559
560
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 558

def payload
  @payload
end

#resource_idString

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)

565
566
567
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 565

def resource_id
  @resource_id
end

#resource_uriString

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

Returns:

  • (String)

570
571
572
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 570

def resource_uri
  @resource_uri
end

#tokenString

An arbitrary string delivered to the target address with each notification delivered over this channel. Optional. Corresponds to the JSON property token

Returns:

  • (String)

576
577
578
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 576

def token
  @token
end

#typeString

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

Returns:

  • (String)

581
582
583
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 581

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


588
589
590
591
592
593
594
595
596
597
598
599
# File 'generated/google/apis/admin_directory_v1/classes.rb', line 588

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