Class: UU::OperationRegistry::UUEE

Inherits:
Object
  • Object
show all
Defined in:
lib/uu/operation_registry/uuee.rb

Overview

UueeWhitelist

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(session = nil) ⇒ UUEE

Creates a new instance of UueeWhitelist.

Parameters:

  • session (UU::OS::Security::Session) (defaults to: nil) —

    Session to use for remote calls.



17
18
19
20
 
# File 'lib/uu/operation_registry/uuee.rb', line 17

def initialize(session = nil)
  UU::OperationRegistry::BaseMethods._init_command_client(PATH)
  @client = UU::OS::CMD::CommandClient.new(PATH, session)
end

Class Method Details

.add_entry(cloud_uri, parameters = {}) ⇒ String

Add new entry.

Parameters:

  • cloud_uri (String, UU::OS::UESURI) —

    Cloud URI.

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

    Entry attributes.

Options Hash (parameters):

  • app (String) —

    vendor - app code of application. Must be set.

  • tenant (String) —

    Tenant code. Possible to use wildcard character. For example: If you want to use all tenant codes starts with “DEV”, you can set “DEV*”.

  • uuEEs (Array<String>) —

    List of entry uuEEs. Minimal one uuEE must be set.

  • appIdentity (String) —

    uuEE used as application identity. First uuEE from uuEE list will be used if appIdentity wasn’t set. May be nil.

Returns:

  • (String) —

    New entry URI.



52
53
54
 
# File 'lib/uu/operation_registry/uuee.rb', line 52

def self.add_entry(cloud_uri, parameters = {})
  self.new(UU::OS::Security::Session.current_session).add_entry(cloud_uri, parameters)
end

.get_entry_list(cloud_uri, criteria = {}) ⇒ Hash

Returns hash of entries paged and filtered by criteria.

Parameters:

  • cloud_uri (String, UU::OS::UESURI) —

    Cloud URI.

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

    List criteria.

Options Hash (criteria):

  • pageSize (Fixnum) —

    Result set page size.

  • pageIndex (Fixnum) —

    Result set page index.

  • query (String) —

    Mongo Query to filter the result set. See Mongo Query tutorial. Allowed query filter document fields: code, cloudUri, app, tenant, appIdentity

Returns:

  • (Hash) —

    List of entries.

See Also:



103
104
105
 
# File 'lib/uu/operation_registry/uuee.rb', line 103

def self.get_entry_list(cloud_uri, criteria = {})
  self.new(UU::OS::Security::Session.current_session).get_entry_list(cloud_uri, criteria)
end

.remove_entry(entry_uri) ⇒ String

Remove entry.

Parameters:

  • entry_uri (String, UU::OS::UESURI) —

    Cloud URI.

Returns:

  • (String) —

    URI of removed entry.



117
118
119
 
# File 'lib/uu/operation_registry/uuee.rb', line 117

def self.remove_entry(entry_uri)
  self.new(UU::OS::Security::Session.current_session).remove_entry(entry_uri)
end

Instance Method Details

#add_entry(cloud_uri, parameters = {}) ⇒ String

Add new entry.

Parameters:

  • cloud_uri (String, UU::OS::UESURI) —

    Cloud URI.

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

    Entry attributes.

Options Hash (parameters):

  • app (String) —

    vendor - app code of application. Must be set.

  • tenant (String) —

    Tenant code. Possible to use wildcard character. For example: If you want to use all tenant codes starts with “DEV”, you can set “DEV*”.

  • uuEEs (Array<String>) —

    List of entry uuEEs. Minimal one uuEE must be set.

  • appIdentity (String) —

    uuEE used as application identity. First uuEE from uuEE list will be used if appIdentity wasn’t set. May be nil.

Returns:

  • (String) —

    New entry URI.



35
36
37
 
# File 'lib/uu/operation_registry/uuee.rb', line 35

def add_entry(cloud_uri, parameters = {})
  @client.invoke(:addEntry, cloud_uri, :parameters => parameters)
end

#get_entry_list(cloud_uri, criteria = {}) ⇒ Hash

Returns hash of entries paged and filtered by criteria.

Examples:

Example of returned hash structure.

{
    :pageEntries => [
        {
            :app => "TEST.APP",
            :tenant => "DEV",
            :appIdentity => "1-2",
            :uuEEs => [
                "1-2"
            ],
            :creationTime => "2017-03-03T09:30:46Z",
            :creationStamp => "Josef Novák (24-36-1)",
            :modificationTime => "2017-03-03T09:30:46Z",
            :modificationStamp => "Josef Novák (24-36-1)",
            :uri => "ues:OT-BT[0]:PLUS4U_CLOUD[58b937c6b47a229158e9a100]:58b937c7b47a229158e9a102[58b937c7b47a229158e9a102]"
        }
    ],
    :criteria => {
        :pageIndex => 0,
        :pageSize => 1000
    },
    :totalSize => 1
}

Parameters:

  • cloud_uri (String, UU::OS::UESURI) —

    Cloud URI.

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

    List criteria.

Options Hash (criteria):

  • pageSize (Fixnum) —

    Result set page size.

  • pageIndex (Fixnum) —

    Result set page index.

  • query (String) —

    Mongo Query to filter the result set. See Mongo Query tutorial. Allowed query filter document fields: code, cloudUri, app, tenant, appIdentity

Returns:

  • (Hash) —

    List of entries.



88
89
90
 
# File 'lib/uu/operation_registry/uuee.rb', line 88

def get_entry_list(cloud_uri, criteria = {})
  @client.invoke(:getEntryList, cloud_uri, :parameters => criteria)
end

#remove_entry(entry_uri) ⇒ String

Remove entry.

Parameters:

  • entry_uri (String, UU::OS::UESURI) —

    Cloud URI.

Returns:

  • (String) —

    URI of removed entry.



110
111
112
 
# File 'lib/uu/operation_registry/uuee.rb', line 110

def remove_entry(entry_uri)
  @client.invoke(:removeEntry, entry_uri)
end