From 537076b9e23c773c7024c2872685945a588ca381 Mon Sep 17 00:00:00 2001 From: devOpsHelm Date: Thu, 1 Feb 2024 10:24:16 +0000 Subject: [PATCH] Update API reference doc --- docs/modules/ROOT/pages/api-ref.adoc | 103 +++++++++++++++++++++++++++ 1 file changed, 103 insertions(+) diff --git a/docs/modules/ROOT/pages/api-ref.adoc b/docs/modules/ROOT/pages/api-ref.adoc index 310f76d1..1e38218d 100644 --- a/docs/modules/ROOT/pages/api-ref.adoc +++ b/docs/modules/ROOT/pages/api-ref.adoc @@ -113,6 +113,7 @@ TIP: This document was generated from comments in the Go code in the api/ direct * <> * <> * <> +* <> * <> * <> * <> @@ -164,6 +165,12 @@ TIP: This document was generated from comments in the Go code in the api/ direct * <> * <> * <> +* <> +* <> +* <> +* <> +* <> +* <> === AcknowledgementSetting @@ -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| []<> | false | - m| nearCache | InMemoryFormat specifies near cache configuration for map m| *<> | false | - m| eventJournal | EventJournal specifies event journal configuration of the Map m| *<> | false | - +m| merkleTree | MerkleTree defines the configuration for the Merkle tree data structure. m| *<> | false | - |=== <> @@ -1301,6 +1309,18 @@ m| propertiesSecretName | Properties can be used for giving information to the M <
> +=== 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 +|=== + +<
> + === MultiMap MultiMap is the Schema for the multimaps API @@ -1893,6 +1913,74 @@ m| wanReplicationMapsStatus | WanReplicationMapsStatus is the WAN Replication st <
> +=== WanSync + +WanSync is the Schema for the wansyncs API + +[cols="4,8,4,2,4"options="header"] +|=== +| Field | Description | Type | Required | Default +m| metadata |   m| https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#objectmeta-v1-meta[metav1.ObjectMeta] | false | - +m| spec |   m| <> | false | - +m| status |   m| <> | false | - +|=== + +<
> + +=== WanSyncList + +WanSyncList contains a list of WanSync + +[cols="4,8,4,2,4"options="header"] +|=== +| Field | Description | Type | Required | Default +m| metadata |   m| https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#listmeta-v1-meta[metav1.ListMeta] | false | - +m| items |   m| []<> | true | - +|=== + +<
> + +=== 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| <> | false | - +m| message | Message is the field to show detail information or error m| string | false | - +|=== + +<
> + +=== 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 | - +|=== + +<
> + +=== 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| <> | 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]<> | false | - +|=== + +<
> + === AcknowledgementType @@ -2408,3 +2496,18 @@ m| "Terminating" |   |=== <
> + +=== WanSyncPhase + + + +[cols="5,10"options="header"] +|=== +| Value | Description +m| "NotStarted" |   +m| "Failed" |   +m| "Pending" |   +m| "Completed" |   +|=== + +<
>