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 Feb 1, 2024
1 parent 6ea6545 commit 537076b
Showing 1 changed file with 103 additions and 0 deletions.
103 changes: 103 additions & 0 deletions docs/modules/ROOT/pages/api-ref.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,7 @@ TIP: This document was generated from comments in the Go code in the api/ direct
* <<MapStoreConfig,MapStoreConfig>>
* <<MaxSizePolicyType,MaxSizePolicyType>>
* <<MemberAccess,MemberAccess>>
* <<MerkleTreeConfig,MerkleTreeConfig>>
* <<MultiMap,MultiMap>>
* <<MultiMapList,MultiMapList>>
* <<MultiMapSpec,MultiMapSpec>>
Expand Down Expand Up @@ -164,6 +165,12 @@ TIP: This document was generated from comments in the Go code in the api/ direct
* <<WanReplicationSpec,WanReplicationSpec>>
* <<WanReplicationStatus,WanReplicationStatus>>
* <<WanStatus,WanStatus>>
* <<WanSync,WanSync>>
* <<WanSyncList,WanSyncList>>
* <<WanSyncMapStatus,WanSyncMapStatus>>
* <<WanSyncPhase,WanSyncPhase>>
* <<WanSyncSpec,WanSyncSpec>>
* <<WanSyncStatus,WanSyncStatus>>

=== AcknowledgementSetting

Expand Down Expand Up @@ -1266,6 +1273,7 @@ m| inMemoryFormat | InMemoryFormat specifies in which format data will be stored
m| entryListeners | EntryListeners contains the configuration for the map-level or entry-based events listeners provided by the Hazelcast’s eventing framework. You can learn more at https://docs.hazelcast.com/hazelcast/latest/events/object-events. m| []<<EntryListenerConfiguration,EntryListenerConfiguration>> | false | -
m| nearCache | InMemoryFormat specifies near cache configuration for map m| &#42;<<NearCache,NearCache>> | false | -
m| eventJournal | EventJournal specifies event journal configuration of the Map m| &#42;<<EventJournal,EventJournal>> | false | -
m| merkleTree | MerkleTree defines the configuration for the Merkle tree data structure. m| &#42;<<MerkleTreeConfig,MerkleTreeConfig>> | false | -
|===

<<Table of Contents,Back to TOC>>
Expand Down Expand Up @@ -1301,6 +1309,18 @@ m| propertiesSecretName | Properties can be used for giving information to the M

<<Table of Contents,Back to TOC>>

=== MerkleTreeConfig



[cols="4,8,4,2,4"options="header"]
|===
| Field | Description | Type | Required | Default
m| depth | Depth of the merkle tree. m| int32 | false | 10
|===

<<Table of Contents,Back to TOC>>

=== MultiMap

MultiMap is the Schema for the multimaps API
Expand Down Expand Up @@ -1893,6 +1913,74 @@ m| wanReplicationMapsStatus | WanReplicationMapsStatus is the WAN Replication st

<<Table of Contents,Back to TOC>>

=== WanSync

WanSync is the Schema for the wansyncs API

[cols="4,8,4,2,4"options="header"]
|===
| Field | Description | Type | Required | Default
m| metadata | &#160; m| https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#objectmeta-v1-meta[metav1.ObjectMeta] | false | -
m| spec | &#160; m| <<WanSyncSpec,WanSyncSpec>> | false | -
m| status | &#160; m| <<WanSyncStatus,WanSyncStatus>> | false | -
|===

<<Table of Contents,Back to TOC>>

=== WanSyncList

WanSyncList contains a list of WanSync

[cols="4,8,4,2,4"options="header"]
|===
| Field | Description | Type | Required | Default
m| metadata | &#160; m| https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#listmeta-v1-meta[metav1.ListMeta] | false | -
m| items | &#160; m| []<<WanSync,WanSync>> | true | -
|===

<<Table of Contents,Back to TOC>>

=== WanSyncMapStatus



[cols="4,8,4,2,4"options="header"]
|===
| Field | Description | Type | Required | Default
m| resourceName | ResourceName is the name of the Map Custom Resource. m| string | false | -
m| publisherId | PublisherId is the ID used for WAN publisher ID m| string | false | -
m| phase | Status is the status of the resource WAN sync m| <<WanSyncPhase,WanSyncPhase>> | false | -
m| message | Message is the field to show detail information or error m| string | false | -
|===

<<Table of Contents,Back to TOC>>

=== WanSyncSpec

WanSyncSpec defines the desired state of WanSync

[cols="4,8,4,2,4"options="header"]
|===
| Field | Description | Type | Required | Default
m| wanReplicationResourceName | WanReplicationResourceName is the name of WanReplication CR that contains the WAN publisher configuration. If specified the Sync operation will use existing WAN publisher. m| string | true | -
|===

<<Table of Contents,Back to TOC>>

=== WanSyncStatus

WanSyncStatus defines the observed state of WanSync

[cols="4,8,4,2,4"options="header"]
|===
| Field | Description | Type | Required | Default
m| status | Status is the status of WAN Sync m| <<WanSyncPhase,WanSyncPhase>> | false | -
m| message | Message is the field to show detail information or error m| string | false | -
m| wanSyncMapsStatus | WanSyncMapStatus is the WAN Sync status of the Maps given in the spec directly or indirectly by Hazelcast resource. m| map[string]<<WanSyncMapStatus,WanSyncMapStatus>> | false | -
|===

<<Table of Contents,Back to TOC>>

=== AcknowledgementType


Expand Down Expand Up @@ -2408,3 +2496,18 @@ m| "Terminating" | &#160;
|===

<<Table of Contents,Back to TOC>>

=== WanSyncPhase



[cols="5,10"options="header"]
|===
| Value | Description
m| "NotStarted" | &#160;
m| "Failed" | &#160;
m| "Pending" | &#160;
m| "Completed" | &#160;
|===

<<Table of Contents,Back to TOC>>

0 comments on commit 537076b

Please sign in to comment.