Class: IControl::Management::EventSubscription::SubscriptionDetails

Inherits:
Base::Struct
  • Object
show all
Defined in:
lib/icontrol/management/event_subscription.rb,
lib/icontrol/management/event_subscription.rb

Overview

The configuration of a specific Event Subscription. This includes the name, registered events, the enabled state, and delivery configuration values. Event messages will be queued up and sent in a bulk manner as described by the min_events_per_timeslice and max_timeslice variables.

Instance Attribute Summary collapse

Instance Attribute Details

#enabled_state ⇒ IControl::Common::EnabledState

Whether the subscription is enabled or disabled.

Returns:



337
338
339
 
# File 'lib/icontrol/management/event_subscription.rb', line 337

def enabled_state
  @enabled_state
end

#event_type_list ⇒ IControl::Management::EventSubscription::EventTypeSequence

A list of event types to be notified of.

Returns:



337
338
339
 
# File 'lib/icontrol/management/event_subscription.rb', line 337

def event_type_list
  @event_type_list
end

#max_timeslice ⇒ Numeric

This maximum time to wait (in seconds) before event notifications are sent to the notification endpoint. If this value is 30, then after 30 seconds a notification will be sent with the events in the subscription queue.

Returns:

  • (Numeric) —

    the current value of max_timeslice



337
338
339
 
# File 'lib/icontrol/management/event_subscription.rb', line 337

def max_timeslice
  @max_timeslice
end

#min_events_per_timeslice ⇒ Numeric

The minimum number of events needed to trigger a notification. If this value is 50, then this means that when 50 events are queued up they will be sent to the notification endpoint no matter what the max_timeslice is set to.

Returns:

  • (Numeric) —

    the current value of min_events_per_timeslice



337
338
339
 
# File 'lib/icontrol/management/event_subscription.rb', line 337

def min_events_per_timeslice
  @min_events_per_timeslice
end

#name ⇒ String

A user friendly name for the subscription.

Returns:

  • (String) —

    the current value of name



337
338
339
 
# File 'lib/icontrol/management/event_subscription.rb', line 337

def name
  @name
end

#ttl ⇒ Numeric

The time to live (in seconds) for this subscription. After the ttl is reached, the subscription will be removed from the system. A value of -1 indicates an infinite life time.

Returns:

  • (Numeric) —

    the current value of ttl



337
338
339
 
# File 'lib/icontrol/management/event_subscription.rb', line 337

def ttl
  @ttl
end

#url ⇒ String

The url endpoint for the EventNotification inteface to receive event notifications.

Returns:

  • (String) —

    the current value of url



337
338
339
 
# File 'lib/icontrol/management/event_subscription.rb', line 337

def url
  @url
end

#url_credentials ⇒ IControl::Management::EventSubscription::UserCredential

The credenials for the url endpoint.

Returns:



337
338
339
 
# File 'lib/icontrol/management/event_subscription.rb', line 337

def url_credentials
  @url_credentials
end