SCM: Remove PageCollection types in favor of using CollectionResult#45961
Merged
Conversation
Collaborator
|
API change check APIView has identified API level changes in this PR and created following API reviews. |
annelo-msft
commented
Sep 13, 2024
annelo-msft
commented
Sep 13, 2024
annelo-msft
commented
Sep 13, 2024
annelo-msft
commented
Sep 13, 2024
annelo-msft
commented
Sep 13, 2024
annelo-msft
commented
Sep 13, 2024
annelo-msft
commented
Sep 13, 2024
annelo-msft
commented
Sep 13, 2024
annelo-msft
commented
Sep 13, 2024
annelo-msft
commented
Sep 13, 2024
annelo-msft
commented
Sep 13, 2024
annelo-msft
commented
Sep 13, 2024
annelo-msft
commented
Sep 16, 2024
KrzysztofCwalina
approved these changes
Sep 16, 2024
jsquire
reviewed
Sep 16, 2024
Contributor
Author
|
/azp run net - openai - ci |
|
Azure Pipelines successfully started running 1 pipeline(s). |
Merged
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Background
Given feedback from partners that SCM
PageCollection<T>and related types were too complex for the convenience layer, we have reworked the client patterns to simplify usage for the simplest use case of paginated service methods -- i.e. the return type now implementsIEnumerable<T>, which means that strongly typed models in a paginated collection can now be enumerated directly. This better aligns the SCM client pattern for pagination with the Azure client pattern as well. One side effect of this is that the implementation of a complex scenario like rehydrating a collection becomes more complex, but this seems like a good tradeoff.What's in this PR?
PageCollection<T>and related types in favor of new APIs onCollectionResult<T>andAsyncCollectionResult<T>CollectionResultandAsyncCollectionResultthat the convenience-layer return types now inherit fromCollectionResult<T>no longer inherits fromClientResult, but instead enables access to the sequence of service responses that deliver the collection items via a newGetRawPagesmethod on theCollectionResultbase typeClientResultrepresents a single HTTP response, this PR removes its parameterless constructor and moves itsSetRawResponsemethod ontoOperationResult, which is the only type that now needs it to update the value returned fromGetRawResponseCollectionResultand related types for both paginated service endpoints and streaming responses.