Class: OvirtSDK4::QuotaService

Inherits:
Service
  • Object
show all
Defined in:
lib/ovirtsdk4/services.rb,
lib/ovirtsdk4/services.rb

Instance Method Summary collapse

Methods inherited from Service

#inspect, #to_s

Instance Method Details

#get(opts = {}) ⇒ Quota

Retrieves a quota.

An example of retrieving a quota:

GET /ovirt-engine/api/datacenters/123/quotas/456
<quota id="456">
  <name>myquota</name>
  <description>My new quota for virtual machines</description>
  <cluster_hard_limit_pct>20</cluster_hard_limit_pct>
  <cluster_soft_limit_pct>80</cluster_soft_limit_pct>
  <storage_hard_limit_pct>20</storage_hard_limit_pct>
  <storage_soft_limit_pct>80</storage_soft_limit_pct>
</quota>

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.

  • :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:


19224
19225
19226
# File 'lib/ovirtsdk4/services.rb', line 19224

def get(opts = {})
  internal_get(GET, opts)
end

#permissions_serviceAssignedPermissionsService

Locates the permissions service.

Returns:


19314
19315
19316
# File 'lib/ovirtsdk4/services.rb', line 19314

def permissions_service
  @permissions_service ||= AssignedPermissionsService.new(self, 'permissions')
end

#quota_cluster_limits_serviceQuotaClusterLimitsService

Locates the quota_cluster_limits service.

Returns:


19323
19324
19325
# File 'lib/ovirtsdk4/services.rb', line 19323

def quota_cluster_limits_service
  @quota_cluster_limits_service ||= QuotaClusterLimitsService.new(self, 'quotaclusterlimits')
end

#quota_storage_limits_serviceQuotaStorageLimitsService

Locates the quota_storage_limits service.

Returns:


19332
19333
19334
# File 'lib/ovirtsdk4/services.rb', line 19332

def quota_storage_limits_service
  @quota_storage_limits_service ||= QuotaStorageLimitsService.new(self, 'quotastoragelimits')
end

#remove(opts = {}) ⇒ Object

Delete a quota.

An example of deleting a quota:

DELETE /ovirt-engine/api/datacenters/123-456/quotas/654-321
-0472718ab224 HTTP/1.1
Accept: application/xml
Content-type: application/xml

Parameters:

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

    Additional options.

Options Hash (opts):

  • :async (Boolean)

    Indicates if the remove should be performed asynchronously.

  • :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.


19259
19260
19261
# File 'lib/ovirtsdk4/services.rb', line 19259

def remove(opts = {})
  internal_remove(REMOVE, 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.

Raises:


19343
19344
19345
19346
19347
19348
19349
19350
19351
19352
19353
19354
19355
19356
19357
19358
19359
19360
19361
19362
19363
19364
19365
19366
# File 'lib/ovirtsdk4/services.rb', line 19343

def service(path)
  if path.nil? || path == ''
    return self
  end
  if path == 'permissions'
    return permissions_service
  end
  if path.start_with?('permissions/')
    return permissions_service.service(path[12..-1])
  end
  if path == 'quotaclusterlimits'
    return quota_cluster_limits_service
  end
  if path.start_with?('quotaclusterlimits/')
    return quota_cluster_limits_service.service(path[19..-1])
  end
  if path == 'quotastoragelimits'
    return quota_storage_limits_service
  end
  if path.start_with?('quotastoragelimits/')
    return quota_storage_limits_service.service(path[19..-1])
  end
  raise Error.new("The path \"#{path}\" doesn't correspond to any service")
end

#update(quota, opts = {}) ⇒ Quota

Updates a quota.

An example of updating a quota:

PUT /ovirt-engine/api/datacenters/123/quotas/456
<quota>
  <cluster_hard_limit_pct>30</cluster_hard_limit_pct>
  <cluster_soft_limit_pct>70</cluster_soft_limit_pct>
  <storage_hard_limit_pct>20</storage_hard_limit_pct>
  <storage_soft_limit_pct>80</storage_soft_limit_pct>
</quota>

Parameters:

  • quota (Quota)

    The quota to update.

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

    Additional options.

Options Hash (opts):

  • :async (Boolean)

    Indicates if the update should be performed asynchronously.

  • :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:


19305
19306
19307
# File 'lib/ovirtsdk4/services.rb', line 19305

def update(quota, opts = {})
  internal_update(quota, Quota, UPDATE, opts)
end