Skip to content

Commit c6e2f1b

Browse files
allenkim0129allenkim0129
committed
Updated doc strings
1 parent 9549143 commit c6e2f1b

File tree

2 files changed

+12
-12
lines changed

2 files changed

+12
-12
lines changed

‎sdk/cosmos/azure-cosmos/azure/cosmos/aio/_container.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -528,7 +528,7 @@ def query_items_change_feed(
528528
request. Once the user has reached their provisioned throughput, low priority requests are throttled
529529
before high priority requests start getting throttled. Feature must first be enabled at the account level.
530530
:paramtype priority: Optional[Literal["High", "Low"]]
531-
:keyword mode: The change feed mode enum to use when processing change feed items.
531+
:keyword mode: The modes to query change feed. If `continuation` was passed, 'mode' argument will be ignored.
532532
LATEST_VERSION: Query latest items from 'start_time' or 'continuation' token.
533533
ALL_VERSIONS_AND_DELETES: Query all versions and deleted items from either `start_time='Now'`
534534
or 'continuation' token.
@@ -565,7 +565,7 @@ def query_items_change_feed(
565565
request. Once the user has reached their provisioned throughput, low priority requests are throttled
566566
before high priority requests start getting throttled. Feature must first be enabled at the account level.
567567
:paramtype priority: Optional[Literal["High", "Low"]]
568-
:keyword mode: The change feed mode enum to use when processing change feed items.
568+
:keyword mode: The modes to query change feed. If `continuation` was passed, 'mode' argument will be ignored.
569569
LATEST_VERSION: Query latest items from 'start_time' or 'continuation' token.
570570
ALL_VERSIONS_AND_DELETES: Query all versions and deleted items from either `start_time='Now'`
571571
or 'continuation' token.
@@ -588,7 +588,7 @@ def query_items_change_feed(
588588
) -> AsyncItemPaged[Dict[str, Any]]:
589589
"""Get a sorted list of items that were changed, in the order in which they were modified.
590590
591-
:keyword str continuation: The continuation token retrieved from previous response.
591+
:keyword str continuation: The continuation token retrieved from previous response. It contains chang feed mode.
592592
:type continuation: str
593593
:keyword int max_item_count: Max number of items to be returned in the enumeration operation.
594594
:paramtype max_item_count: Optional[int]
@@ -629,7 +629,7 @@ def query_items_change_feed(
629629
request. Once the user has reached their provisioned throughput, low priority requests are throttled
630630
before high priority requests start getting throttled. Feature must first be enabled at the account level.
631631
:paramtype priority: Optional[Literal["High", "Low"]]
632-
:keyword mode: The change feed mode enum to use when processing change feed items.
632+
:keyword mode: The modes to query change feed. If `continuation` was passed, 'mode' argument will be ignored.
633633
LATEST_VERSION: Query latest items from 'start_time' or 'continuation' token.
634634
ALL_VERSIONS_AND_DELETES: Query all versions and deleted items from either `start_time='Now'`
635635
or 'continuation' token.
@@ -649,7 +649,7 @@ def query_items_change_feed( # pylint: disable=unused-argument
649649

650650
"""Get a sorted list of items that were changed, in the order in which they were modified.
651651
652-
:keyword str continuation: The continuation token retrieved from previous response.
652+
:keyword str continuation: The continuation token retrieved from previous response. It contains chang feed mode.
653653
:keyword Dict[str, Any] feed_range: The feed range that is used to define the scope.
654654
:keyword partition_key: The partition key that is used to define the scope
655655
(logical partition or a subset of a container)
@@ -665,7 +665,7 @@ def query_items_change_feed( # pylint: disable=unused-argument
665665
request. Once the user has reached their provisioned throughput, low priority requests are throttled
666666
before high priority requests start getting throttled. Feature must first be enabled at the account level.
667667
:paramtype priority: Optional[Literal["High", "Low"]]
668-
:keyword mode: The change feed mode enum to use when processing change feed items.
668+
:keyword mode: The modes to query change feed. If `continuation` was passed, 'mode' argument will be ignored.
669669
LATEST_VERSION: Query latest items from 'start_time' or 'continuation' token.
670670
ALL_VERSIONS_AND_DELETES: Query all versions and deleted items from either `start_time='Now'`
671671
or 'continuation' token.

‎sdk/cosmos/azure-cosmos/azure/cosmos/container.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -349,7 +349,7 @@ def query_items_change_feed(
349349
request. Once the user has reached their provisioned throughput, low priority requests are throttled
350350
before high priority requests start getting throttled. Feature must first be enabled at the account level.
351351
:paramtype priority: Optional[Literal["High", "Low"]]
352-
:keyword mode: The change feed mode enum to use when processing change feed items.
352+
:keyword mode: The modes to query change feed. If `continuation` was passed, 'mode' argument will be ignored.
353353
LATEST_VERSION: Query latest items from 'start_time' or 'continuation' token.
354354
ALL_VERSIONS_AND_DELETES: Query all versions and deleted items from either `start_time='Now'`
355355
or 'continuation' token.
@@ -387,7 +387,7 @@ def query_items_change_feed(
387387
request. Once the user has reached their provisioned throughput, low priority requests are throttled
388388
before high priority requests start getting throttled. Feature must first be enabled at the account level.
389389
:paramtype priority: Optional[Literal["High", "Low"]]
390-
:keyword mode: The change feed mode enum to use when processing change feed items.
390+
:keyword mode: The modes to query change feed. If `continuation` was passed, 'mode' argument will be ignored.
391391
LATEST_VERSION: Query latest items from 'start_time' or 'continuation' token.
392392
ALL_VERSIONS_AND_DELETES: Query all versions and deleted items from either `start_time='Now'`
393393
or 'continuation' token.
@@ -410,7 +410,7 @@ def query_items_change_feed(
410410
) -> ItemPaged[Dict[str, Any]]:
411411
"""Get a sorted list of items that were changed, in the order in which they were modified.
412412
413-
:keyword str continuation: The continuation token retrieved from previous response.
413+
:keyword str continuation: The continuation token retrieved from previous response. It contains chang feed mode.
414414
:paramtype continuation: str
415415
:keyword int max_item_count: Max number of items to be returned in the enumeration operation.
416416
:paramtype max_item_count: Optional[int]
@@ -450,7 +450,7 @@ def query_items_change_feed(
450450
request. Once the user has reached their provisioned throughput, low priority requests are throttled
451451
before high priority requests start getting throttled. Feature must first be enabled at the account level.
452452
:paramtype priority: Optional[Literal["High", "Low"]]
453-
:keyword mode: The change feed mode enum to use when processing change feed items.
453+
:keyword mode: The modes to query change feed. If `continuation` was passed, 'mode' argument will be ignored.
454454
LATEST_VERSION: Query latest items from 'start_time' or 'continuation' token.
455455
ALL_VERSIONS_AND_DELETES: Query all versions and deleted items from either `start_time='Now'`
456456
or 'continuation' token.
@@ -471,7 +471,7 @@ def query_items_change_feed(
471471

472472
"""Get a sorted list of items that were changed, in the order in which they were modified.
473473
474-
:keyword str continuation: The continuation token retrieved from previous response.
474+
:keyword str continuation: The continuation token retrieved from previous response. It contains chang feed mode.
475475
:keyword Dict[str, Any] feed_range: The feed range that is used to define the scope.
476476
:keyword partition_key: The partition key that is used to define the scope
477477
(logical partition or a subset of a container)
@@ -486,7 +486,7 @@ def query_items_change_feed(
486486
:keyword Literal["High", "Low"] priority: Priority based execution allows users to set a priority for each
487487
request. Once the user has reached their provisioned throughput, low priority requests are throttled
488488
before high priority requests start getting throttled. Feature must first be enabled at the account level.
489-
:keyword mode: The change feed mode enum to use when processing change feed items.
489+
:keyword mode: The modes to query change feed. If `continuation` was passed, 'mode' argument will be ignored.
490490
LATEST_VERSION: Query latest items from 'start_time' or 'continuation' token.
491491
ALL_VERSIONS_AND_DELETES: Query all versions and deleted items from either `start_time='Now'`
492492
or 'continuation' token.

0 commit comments

Comments
 (0)