Merge pull request #9272 from ballerina-platform/automate-specs-ibm.i…

…bmmq-00c8a539960c166fdad3fb30fcad8110e9155437 [AUTOMATE] Update Ballerina Standard Library (ibm.ibmmq) Specifications
ballerina-platform · Aug 28, 2024 · 1c1084d · 1c1084d
2 parents 00c8a53 + cdf36de
commit 1c1084d
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 2 deletions.
diff --git a/public/spec/ibm.ibmmq/spec.md b/public/spec/ibm.ibmmq/spec.md
@@ -408,14 +408,27 @@ public type Message record {|
 
 ## 4. Client Options
 
-- GetMessageOptions record represents client options which can be used when retrieving messages from an IBM MQ destination.
+- `GetMessageOptions` record represents client options which can be used when retrieving messages from an IBM MQ destination.
 
 ```ballerina
 public type GetMessageOptions record {|
     # Get message option
     int options = MQGMO_NO_WAIT;
     # The maximum time (in seconds) that a `get` call waits for a suitable message to arrive. It is used in conjunction with `ibmmq.MQGMO_WAIT`.
     int waitInterval = 10;
+    # Message selection criteria
+    MatchOptions matchOptions?;
+|};
+```
+
+- `MatchOptions` record represents the selection criteria that determine which message is retrieved.
+
+```ballerina
+public type MatchOptions record {|
+    # The message identifier of the message which needs to be retrieved
+    byte[] messageId?;
+    # The Correlation identifier of the message which needs to be retrieved
+    byte[] correlationId?;
 |};
 ```
 

diff --git a/spec/ibm.ibmmq/spec.md b/spec/ibm.ibmmq/spec.md
@@ -408,14 +408,27 @@ public type Message record {|
 
 ## 4. Client Options
 
-- GetMessageOptions record represents client options which can be used when retrieving messages from an IBM MQ destination.
+- `GetMessageOptions` record represents client options which can be used when retrieving messages from an IBM MQ destination.
 
 ```ballerina
 public type GetMessageOptions record {|
     # Get message option
     int options = MQGMO_NO_WAIT;
     # The maximum time (in seconds) that a `get` call waits for a suitable message to arrive. It is used in conjunction with `ibmmq.MQGMO_WAIT`.
     int waitInterval = 10;
+    # Message selection criteria
+    MatchOptions matchOptions?;
+|};
+```
+
+- `MatchOptions` record represents the selection criteria that determine which message is retrieved.
+
+```ballerina
+public type MatchOptions record {|
+    # The message identifier of the message which needs to be retrieved
+    byte[] messageId?;
+    # The Correlation identifier of the message which needs to be retrieved
+    byte[] correlationId?;
 |};
 ```