class OvirtSDK4::QuotaService

Public Class Methods

new(connection, path) click to toggle source

Creates a new implementation of the service.

@param connection [Connection] The connection to be used by this service.

@param path [String] The relative path of this service, for example `vms/123/disks`.

@api private

# File lib/ovirtsdk4/services.rb, line 18919
def initialize(connection, path)
  @connection = connection
  @path = path
end

Public Instance Methods

get(opts = {}) click to toggle source

Retrieves a quota.

An example of retrieving a quota:

source

GET /ovirt-engine/api/datacenters/123/quotas/456


source,xml

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


@param opts [Hash] Additional options.

@return [Quota]

# File lib/ovirtsdk4/services.rb, line 18950
def get(opts = {})
  query = {}
  request = HttpRequest.new(method: :GET, url: @path, query: query)
  response = @connection.send(request)
  case response.code
  when 200
    begin
      reader = XmlReader.new(response.body)
      return QuotaReader.read_one(reader)
    ensure
      reader.close
    end
  else
    check_fault(response)
  end
end
permissions_service() click to toggle source

Locates the `permissions` service.

@return [AssignedPermissionsService] A reference to `permissions` service.

# File lib/ovirtsdk4/services.rb, line 19062
def permissions_service
  AssignedPermissionsService.new(@connection, "#{@path}/permissions")
end
quota_cluster_limits_service() click to toggle source

Locates the `quota_cluster_limits` service.

@return [QuotaClusterLimitsService] A reference to `quota_cluster_limits` service.

# File lib/ovirtsdk4/services.rb, line 19071
def quota_cluster_limits_service
  QuotaClusterLimitsService.new(@connection, "#{@path}/quotaclusterlimits")
end
quota_storage_limits_service() click to toggle source

Locates the `quota_storage_limits` service.

@return [QuotaStorageLimitsService] A reference to `quota_storage_limits` service.

# File lib/ovirtsdk4/services.rb, line 19080
def quota_storage_limits_service
  QuotaStorageLimitsService.new(@connection, "#{@path}/quotastoragelimits")
end
remove(opts = {}) click to toggle source

Delete a quota.

An example of deleting a quota:

source

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


@param opts [Hash] Additional options.

@option opts [Boolean] :async Indicates if the remove should be performed asynchronously.

# File lib/ovirtsdk4/services.rb, line 18983
def remove(opts = {})
  query = {}
  value = opts[:async]
  unless value.nil?
    value = Writer.render_boolean(value)
    query['async'] = value
  end
  request = HttpRequest.new(method: :DELETE, url: @path, query: query)
  response = @connection.send(request)
  unless response.code == 200
    check_fault(response)
  end
end
service(path) click to toggle source

Locates the service corresponding to the given path.

@param path [String] The path of the service.

@return [Service] A reference to the service.

# File lib/ovirtsdk4/services.rb, line 19091
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
to_s() click to toggle source

Returns an string representation of this service.

@return [String]

# File lib/ovirtsdk4/services.rb, line 19121
def to_s
  "#<#{QuotaService}:#{@path}>"
end
update(quota, opts = {}) click to toggle source

Updates a quota.

An example of updating a quota:

source

PUT /ovirt-engine/api/datacenters/123/quotas/456


source,xml

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


@param quota [Quota] The `quota` to update. @param opts [Hash] Additional options.

@option opts [Boolean] :async Indicates if the update should be performed asynchronously.

@return [Quota]

# File lib/ovirtsdk4/services.rb, line 19024
def update(quota, opts = {})
  if quota.is_a?(Hash)
    quota = OvirtSDK4::Quota.new(quota)
  end
  query = {}
  value = opts[:async]
  unless value.nil?
    value = Writer.render_boolean(value)
    query['async'] = value
  end
  request = HttpRequest.new(method: :PUT, url: @path, query: query)
  begin
    writer = XmlWriter.new(nil, true)
    QuotaWriter.write_one(quota, writer)
    request.body = writer.string
  ensure
    writer.close
  end
  response = @connection.send(request)
  case response.code
  when 200
    begin
      reader = XmlReader.new(response.body)
      return QuotaReader.read_one(reader)
    ensure
      reader.close
    end
    return result
  else
    check_fault(response)
  end
end