Class: Sequence::Key::ClientModule

Inherits:
ClientModule show all
Defined in:
lib/sequence/key.rb

Instance Attribute Summary

Attributes inherited from ClientModule

#client

Instance Method Summary collapse

Methods inherited from ClientModule

#initialize

Constructor Details

This class inherits a constructor from Sequence::ClientModule

Instance Method Details

#create(opts = {}) ⇒ Key

Creates a key.

Parameters:

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

    Options hash

Options Hash (opts):

  • id (String) —

    Unique, user-specified identifier of the key.

  • alias (String) —

    Deprecated. Use :id instead. Unique, user-specified identifier of the key.

Returns:



32
33
34
35
 
# File 'lib/sequence/key.rb', line 32

def create(opts = {})
  validate_inclusion_of!(opts, :alias, :id)
  Key.new(client.session.request('create-key', opts))
end

#list ⇒ Query

Lists all keys. Executes a query, returning an enumerable over individual keys.

Returns:



58
59
60
 
# File 'lib/sequence/key.rb', line 58

def list
  Query.new(client)
end

#query(opts = {}) ⇒ Query

Deprecated.

Use list instead.

Executes a query, returning an enumerable over individual keys.

Parameters:

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

    Options hash

Options Hash (opts):

  • aliases (Array<String>) —

    Deprecated. Use :ids instead. A list of aliases of keys to retrieve.

  • ids (Array<String>) —

    A list of ids of keys to retrieve.

  • ] (Integer) —

    page_size Deprecated. Use list.page(size: size) instead. The number of items to return in the result set.

Returns:



50
51
52
53
 
# File 'lib/sequence/key.rb', line 50

def query(opts = {})
  validate_inclusion_of!(opts, :aliases, :ids, :page_size, :after)
  Query.new(client, opts)
end