Class: UU::ObjectStore::ObjectSchema::ObjectSchemaCreate

Inherits:
UU::OS::REST::DTO show all
Defined in:
uu_objectstore-0.6.5/lib/uu/object_store/object_schema/object_schema_create.rb

Overview

DTO for creation of the new object schema.

Instance Attribute Summary (collapse)

Method Summary

Methods inherited from UU::OS::REST::DTO

#initialize, #to_hash, #to_json

Constructor Details

This class inherits a constructor from UU::OS::REST::DTO

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class UU::OS::REST::DTO

Instance Attribute Details

- (String) code

Code of the new object schema. Code must be unique in scope of object store. Attribute is optional, defaults to system generated value.

Returns:

  • (String) 


18
19
20
 
# File 'uu_objectstore-0.6.5/lib/uu/object_store/object_schema/object_schema_create.rb', line 18

def code
  @code
end

- (String) data_key_attribute

Name of alternative data key attribute to be used instead of default data_key attribute of uuObject. Defined attribute must be of type String. If set, data_key attribute of uuObject can still be used, however internally it is mapped to defined attribute (which applies also for queries). Optionally it is possible to add ASC (default) or DESC keyword after attribute name to ensure data key index is created with desired index order. Attribute is optional, defaults to nil.

Returns:

  • (String) 


32
33
34
 
# File 'uu_objectstore-0.6.5/lib/uu/object_store/object_schema/object_schema_create.rb', line 32

def data_key_attribute
  @data_key_attribute
end

- (String) description

Description of the new object schema. Attribute is optional, defaults to nil.

Returns:

  • (String) 


22
23
24
 
# File 'uu_objectstore-0.6.5/lib/uu/object_store/object_schema/object_schema_create.rb', line 22

def description
  @description
end

- (Fixnum) max_object_size

Allows to define maximal size of uuObjects (in bytes) stored within schema. Value must not be higher than maximal size provided by server configuration (which defaults to 4 MB). Attribute is optional, defaults to nil.

Returns:

  • (Fixnum) 


38
39
40
 
# File 'uu_objectstore-0.6.5/lib/uu/object_store/object_schema/object_schema_create.rb', line 38

def max_object_size
  @max_object_size
end

- (Fixnum) max_result_page_size

Allows to define maximal size of result page (number of uuObjects returned by query in single page). Highest possible value depends on defined maximal size of uuObjects within schema. Total size (in terms of memory) must not exceed maximal size limited by server configuration (which defaults to 400 MB = 100 * 4 MB). Attribute is optional, defaults to nil.

Returns:

  • (Fixnum) 


46
47
48
 
# File 'uu_objectstore-0.6.5/lib/uu/object_store/object_schema/object_schema_create.rb', line 46

def max_result_page_size
  @max_result_page_size
end

- (String) name

Name of the new object schema. Attribute is mandatory.

Returns:

  • (String) 


13
14
15
 
# File 'uu_objectstore-0.6.5/lib/uu/object_store/object_schema/object_schema_create.rb', line 13

def name
  @name
end