Class: OvirtSDK4::EventSubscriptionsService

Inherits:

Service

• Object
• Service
• OvirtSDK4::EventSubscriptionsService

Defined in:

lib/ovirtsdk4/services.rb,
lib/ovirtsdk4/services.rb

Instance Method Summary

• #add(event_subscription, opts = {}) ⇒ EventSubscription

  Add a new event-subscription to the system.

• #event_subscription_service(id) ⇒ EventSubscriptionService

  Reference to the service that manages a specific event-subscription.

• #list(opts = {}) ⇒ Array<EventSubscription>

  List the event-subscriptions for the provided user.

• #service(path) ⇒ Service

  Locates the service corresponding to the given path.

Methods inherited from Service

#inspect, #to_s

Instance Method Details

#add(event_subscription, opts = {}) ⇒ EventSubscription

Add a new event-subscription to the system.

An event-subscription is always added in the context of a user. For example, to add new event-subscription for host_high_cpu_use for user 123, and have the notification sent to the e-mail address: a@b.com, send a request like this:

POST /ovirt-engine/api/users/123/eventsubscriptions HTTP/1.1

With a request body like this:

<event_subscription>
    <event>host_high_cpu_use</event>
    <address>a@b.com</address>
</event_subscription>

The event name will become the ID of the new event-subscription entity: GET …​/api/users/123/eventsubscriptions/host_high_cpu_use

Note that no user id is provided in the request body. This is because the user-id (in this case 123) is already known to the API from the context. Note also that event-subscription entity contains notification-method field, but it is not provided either in the request body. This is because currently it’s always set to SMTP as SNMP notifications are still unsupported by the API layer.

Parameters:

• event_subscription (EventSubscription) —

  The added event-subscription.

• opts (Hash) (defaults to: {}) —

  Additional options.

Options Hash (opts):

• :headers (Hash) — default: {} —

  Additional HTTP headers.

• :query (Hash) — default: {} —

  Additional URL query parameters.

• :timeout (Integer) — default: nil —

  The timeout for this request, in seconds. If no value is explicitly given then the timeout set globally for the connection will be used.

• :wait (Boolean) — default: true —

  If true wait for the response.

Returns:

• (EventSubscription)

# File 'lib/ovirtsdk4/services.rb', line 8743

def add(event_subscription, opts = {})
  internal_add(event_subscription, EventSubscription, ADD, opts)
end

#event_subscription_service(id) ⇒ EventSubscriptionService

Reference to the service that manages a specific event-subscription.

Parameters:

• id (String) —

  The identifier of the event_subscription.

Returns:

• (EventSubscriptionService) —

  A reference to the event_subscription service.

# File 'lib/ovirtsdk4/services.rb', line 8810

def event_subscription_service(id)
  EventSubscriptionService.new(self, id)
end

#list(opts = {}) ⇒ Array<EventSubscription>

List the event-subscriptions for the provided user.

For example to list event-subscriptions for user 123:

GET /ovirt-engine/api/users/123/event-subscriptions HTTP/1.1

<event-subscriptions>
  <event-subscription href="/ovirt-engine/api/users/123/event-subscriptions/host_install_failed">
    <event>host_install_failed</event>
    <notification_method>smtp</notification_method>
    <user href="/ovirt-engine/api/users/123" id="123"/>
    <address>a@b.com</address>
  </event-subscription>
  <event-subscription href="/ovirt-engine/api/users/123/event-subscriptions/vm_paused">
    <event>vm_paused</event>
    <notification_method>smtp</notification_method>
    <user href="/ovirt-engine/api/users/123" id="123"/>
    <address>a@b.com</address>
  </event-subscription>
</event-subscriptions>

Parameters:

• opts (Hash) (defaults to: {}) —

  Additional options.

Options Hash (opts):

• :follow (String) —

  Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.

• :max (Integer) —

  Sets the maximum number of event-subscriptions to return. If not specified all the event-subscriptions are returned.

• :headers (Hash) — default: {} —

  Additional HTTP headers.

• :query (Hash) — default: {} —

  Additional URL query parameters.

• :timeout (Integer) — default: nil —

  The timeout for this request, in seconds. If no value is explicitly given then the timeout set globally for the connection will be used.

• :wait (Boolean) — default: true —

  If true wait for the response.

Returns:

• (Array<EventSubscription>)

# File 'lib/ovirtsdk4/services.rb', line 8799

def list(opts = {})
  internal_get(LIST, opts)
end

#service(path) ⇒ Service

Locates the service corresponding to the given path.

Parameters:

• path (String) —

  The path of the service.

Returns:

• (Service) —

  A reference to the service.

# File 'lib/ovirtsdk4/services.rb', line 8821

def service(path)
  if path.nil? || path == ''
    return self
  end
  index = path.index('/')
  if index.nil?
    return event_subscription_service(path)
  end
  return event_subscription_service(path[0..(index - 1)]).service(path[(index + 1)..-1])
end