Class: Evernote::EDAM::Type::LazyMap
- Inherits:
-
Object
- Object
- Evernote::EDAM::Type::LazyMap
- Includes:
- Thrift::Struct, Thrift::Struct_Union
- Defined in:
- lib/Evernote/EDAM/types_types.rb
Overview
always present in the structure in order to reduce space when obtaining batches of entities that contain the map.
When the server provides the client with a LazyMap, it will fill in either the keysOnly field or the fullMap field, but never both, based on the API and parameters.
When a client provides a LazyMap to the server as part of an update to an object, the server will only update the LazyMap if the fullMap field is set. If the fullMap field is not set, the server will not make any changes to the map.
Check the API documentation of the individual calls involving the LazyMap for full details including the constraints of the names and values of the map.
<dl> <dt>keysOnly</dt>
<dd>The set of keys for the map. This field is ignored by the
server when set.
</dd>
<dt>fullMap</dt>
<dd>The complete map, including all keys and values.
</dd>
</dl>
Constant Summary collapse
- KEYSONLY =
1
- FULLMAP =
2
- FIELDS =
{ KEYSONLY => {:type => ::Thrift::Types::SET, :name => 'keysOnly', :element => {:type => ::Thrift::Types::STRING}, :optional => true}, FULLMAP => {:type => ::Thrift::Types::MAP, :name => 'fullMap', :key => {:type => ::Thrift::Types::STRING}, :value => {:type => ::Thrift::Types::STRING}, :optional => true} }
Constants included from Thrift::Struct_Union
Thrift::Struct_Union::CONTAINER_TYPES
Instance Method Summary collapse
Methods included from Thrift::Struct
#<=>, #==, #differences, #eql?, field_accessor, #fields_with_default_values, generate_accessors, #hash, #initialize, #inspect, qmark_isset_method, #read, #write
Methods included from Thrift::Struct_Union
#each_field, #field_info, #inspect_collection, #inspect_field, #is_container?, #name_to_id, #read_field, #sorted_field_ids, #write_container, #write_data
Instance Method Details
#struct_fields ⇒ Object
938 |
# File 'lib/Evernote/EDAM/types_types.rb', line 938 def struct_fields; FIELDS; end |
#validate ⇒ Object
940 941 |
# File 'lib/Evernote/EDAM/types_types.rb', line 940 def validate end |