Class: OvirtSDK4::OpenstackVolumeAuthenticationKeysService

Inherits:

Service

• Object
• Service
• OvirtSDK4::OpenstackVolumeAuthenticationKeysService

Defined in:

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

Instance Method Summary

• #add(key, opts = {}) ⇒ OpenstackVolumeAuthenticationKey

  Add a new authentication key to the OpenStack volume provider.

• #key_service(id) ⇒ OpenstackVolumeAuthenticationKeyService

  Locates the key service.

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

  Returns the list of authentication keys.

• #service(path) ⇒ Service

  Locates the service corresponding to the given path.

Methods inherited from Service

#inspect, #to_s

Instance Method Details

#add(key, opts = {}) ⇒ OpenstackVolumeAuthenticationKey

Add a new authentication key to the OpenStack volume provider.

Parameters:

• key (OpenstackVolumeAuthenticationKey) —

  The key to add.

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

• (OpenstackVolumeAuthenticationKey)

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

def add(key, opts = {})
  internal_add(key, OpenstackVolumeAuthenticationKey, ADD, opts)
end

#key_service(id) ⇒ OpenstackVolumeAuthenticationKeyService

Locates the key service.

Parameters:

• id (String) —

  The identifier of the key.

Returns:

• (OpenstackVolumeAuthenticationKeyService) —

  A reference to the key service.

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

def key_service(id)
  OpenstackVolumeAuthenticationKeyService.new(self, id)
end

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

Returns the list of authentication keys.

The order of the returned list of authentication keys isn’t guaranteed.

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 keys to return. If not specified all the keys 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<OpenstackVolumeAuthenticationKey>)

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

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 18163

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