Skip to content

Commit

Permalink
Update API reference doc
Browse files Browse the repository at this point in the history
  • Loading branch information
devOpsHelm committed Jan 30, 2024
1 parent e849129 commit 5787778
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions docs/modules/ROOT/pages/api-ref.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ TIP: This document was generated from comments in the Go code in the api/ direct
* <<AcknowledgementType,AcknowledgementType>>
* <<AdvancedNetwork,AdvancedNetwork>>
* <<AgentConfiguration,AgentConfiguration>>
* <<AttributeConfig,AttributeConfig>>
* <<BatchSetting,BatchSetting>>
* <<BitmapIndexOptionsConfig,BitmapIndexOptionsConfig>>
* <<BucketConfiguration,BucketConfiguration>>
Expand Down Expand Up @@ -204,6 +205,19 @@ m| version | Version of Hazelcast Platform Operator Agent. m| string | false | "

<<Table of Contents,Back to TOC>>

=== AttributeConfig



[cols="4,8,4,2,4"options="header"]
|===
| Field | Description | Type | Required | Default
m| name | Name of the attribute https://docs.hazelcast.com/hazelcast/latest/query/predicate-overview#creating-custom-query-attributes m| string | true | -
m| extractorClassName | Name of the extractor class https://docs.hazelcast.com/hazelcast/latest/query/predicate-overview#implementing-a-valueextractor m| string | true | -
|===

<<Table of Contents,Back to TOC>>

=== BatchSetting


Expand Down Expand Up @@ -1244,6 +1258,7 @@ m| timeToLiveSeconds | Maximum time in seconds for each entry to stay in the map
m| maxIdleSeconds | Maximum time in seconds for each entry to stay idle in the map. Entries that are idle for more than this time are evicted automatically. It can be updated. m| int32 | false | 0
m| eviction | Configuration for removing data from the map when it reaches its max size. It can be updated. m| <<EvictionConfig,EvictionConfig>> | false | {maxSize: 0, evictionPolicy: NONE, maxSizePolicy: PER_NODE}
m| indexes | Indexes to be created for the map data. You can learn more at https://docs.hazelcast.com/hazelcast/latest/query/indexing-maps. It cannot be updated after map config is created successfully. m| []<<IndexConfig,IndexConfig>> | false | -
m| attributes | Attributes to be used with Predicates API. You can learn more at https://docs.hazelcast.com/hazelcast/latest/query/predicate-overview#creating-custom-query-attributes m| []<<AttributeConfig,AttributeConfig>> | false | -
m| persistenceEnabled | When enabled, map data will be persisted. It cannot be updated after map config is created successfully. m| bool | false | false
m| mapStore | Configuration options when you want to load/store the map entries from/to a persistent data store such as a relational database You can learn more at https://docs.hazelcast.com/hazelcast/latest/data-structures/working-with-external-data m| &#42;<<MapStoreConfig,MapStoreConfig>> | false | -
m| inMemoryFormat | InMemoryFormat specifies in which format data will be stored in your map m| <<InMemoryFormatType,InMemoryFormatType>> | false | BINARY
Expand Down

0 comments on commit 5787778

Please sign in to comment.