class OvirtSDK4::OpenstackVolumeProviderService

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 17638
def initialize(connection, path)
  @connection = connection
  @path = path
end

Public Instance Methods

authentication_keys_service() click to toggle source

Locates the `authentication_keys` service.

@return [OpenstackVolumeAuthenticationKeysService] A reference to `authentication_keys` service.

# File lib/ovirtsdk4/services.rb, line 17789
def authentication_keys_service
  OpenstackVolumeAuthenticationKeysService.new(@connection, "#{@path}/authenticationkeys")
end
certificates_service() click to toggle source

Locates the `certificates` service.

@return [ExternalProviderCertificatesService] A reference to `certificates` service.

# File lib/ovirtsdk4/services.rb, line 17798
def certificates_service
  ExternalProviderCertificatesService.new(@connection, "#{@path}/certificates")
end
get(opts = {}) click to toggle source

Returns the representation of the object managed by this service.

@param opts [Hash] Additional options.

@return [OpenStackVolumeProvider]

# File lib/ovirtsdk4/services.rb, line 17650
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 OpenStackVolumeProviderReader.read_one(reader)
    ensure
      reader.close
    end
  else
    check_fault(response)
  end
end
import_certificates(opts = {}) click to toggle source

Executes the `import_certificates` method.

@param opts [Hash] Additional options.

@option opts [Array<Certificate>] :certificates

# File lib/ovirtsdk4/services.rb, line 17674
def import_certificates(opts = {})
  action = Action.new(opts)
  writer = XmlWriter.new(nil, true)
  ActionWriter.write_one(action, writer)
  body = writer.string
  writer.close
  request = HttpRequest.new(
    method: :POST,
    url: "#{@path}/importcertificates",
    body: body
  )
  response = @connection.send(request)
  case response.code
  when 200
    action = check_action(response)
  else
    check_action(response)
  end
end
remove(opts = {}) click to toggle source

Deletes the object managed by this service.

@param opts [Hash] Additional options.

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

# File lib/ovirtsdk4/services.rb, line 17700
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 17818
def service(path)
  if path.nil? || path == ''
    return self
  end
  if path == 'authenticationkeys'
    return authentication_keys_service
  end
  if path.start_with?('authenticationkeys/')
    return authentication_keys_service.service(path[19..-1])
  end
  if path == 'certificates'
    return certificates_service
  end
  if path.start_with?('certificates/')
    return certificates_service.service(path[13..-1])
  end
  if path == 'volumetypes'
    return volume_types_service
  end
  if path.start_with?('volumetypes/')
    return volume_types_service.service(path[12..-1])
  end
  raise Error.new("The path \"#{path}\" doesn't correspond to any service")
end
test_connectivity(opts = {}) click to toggle source

Executes the `test_connectivity` method.

@param opts [Hash] Additional options.

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

# File lib/ovirtsdk4/services.rb, line 17721
def test_connectivity(opts = {})
  action = Action.new(opts)
  writer = XmlWriter.new(nil, true)
  ActionWriter.write_one(action, writer)
  body = writer.string
  writer.close
  request = HttpRequest.new(
    method: :POST,
    url: "#{@path}/testconnectivity",
    body: body
  )
  response = @connection.send(request)
  case response.code
  when 200
    action = check_action(response)
  else
    check_action(response)
  end
end
to_s() click to toggle source

Returns an string representation of this service.

@return [String]

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

Updates the `provider`.

@param provider [OpenStackVolumeProvider] The `provider` to update. @param opts [Hash] Additional options.

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

@return [OpenStackVolumeProvider]

# File lib/ovirtsdk4/services.rb, line 17751
def update(provider, opts = {})
  if provider.is_a?(Hash)
    provider = OvirtSDK4::OpenStackVolumeProvider.new(provider)
  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)
    OpenStackVolumeProviderWriter.write_one(provider, 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 OpenStackVolumeProviderReader.read_one(reader)
    ensure
      reader.close
    end
    return result
  else
    check_fault(response)
  end
end
volume_types_service() click to toggle source

Locates the `volume_types` service.

@return [OpenstackVolumeTypesService] A reference to `volume_types` service.

# File lib/ovirtsdk4/services.rb, line 17807
def volume_types_service
  OpenstackVolumeTypesService.new(@connection, "#{@path}/volumetypes")
end