Package org.azd.artifacts.feedmanagement
Class FeedViewRequestBuilder
java.lang.Object
org.azd.abstractions.BaseRequestBuilder
org.azd.artifacts.feedmanagement.FeedViewRequestBuilder
Feed view request builder to manage feed view Api.
-
Nested Class Summary
Nested classes/interfaces inherited from class org.azd.abstractions.BaseRequestBuilder
BaseRequestBuilder.ProjectExcludeParameter
-
Field Summary
Fields inherited from class org.azd.abstractions.BaseRequestBuilder
accessTokenCredential, apiVersion, area, locationId, organizationUrl, serializer
-
Constructor Summary
ConstructorDescriptionFeedViewRequestBuilder
(String organizationUrl, AccessTokenCredential accessTokenCredential) Instantiates a new RequestBuilder instance and sets the default values. -
Method Summary
Modifier and TypeMethodDescriptionCreate a new view on the referenced feed.createAsync
(String feedId, FeedView feedView) Create a new view on the referenced feed.Delete a feed view.deleteAsync
(String feedId, String viewId) Delete a feed view.Get a view by Id.Get a view by Id.Get all views for a feed.Get all views for a feed.Update a view.updateAsync
(String feedId, String viewId, FeedView feedView) Update a view.Methods inherited from class org.azd.abstractions.BaseRequestBuilder
builder
-
Constructor Details
-
FeedViewRequestBuilder
Instantiates a new RequestBuilder instance and sets the default values.- Parameters:
organizationUrl
- Represents organization location request url.accessTokenCredential
- Access token credential object.
-
-
Method Details
-
createAsync
public CompletableFuture<FeedView> createAsync(String feedId, FeedView feedView) throws AzDException Create a new view on the referenced feed. The project parameter must be supplied if the feed was created in a project.- Parameters:
feedId
- Id of the feed.feedView
- Feed view object to create the feed view.- Returns:
- Feed view object
FeedView
- Throws:
AzDException
- Default Api Exception handler.
-
deleteAsync
Delete a feed view. The project parameter must be supplied if the feed was created in a project.- Parameters:
feedId
- Name or Id of the feedviewId
- Id of the feed view- Throws:
AzDException
- Default Api Exception handler.
-
getAsync
Get a view by Id. The project parameter must be supplied if the feed was created in a project.- Parameters:
feedId
- Name or Id of the feed.viewId
- Name or Id of the view.- Returns:
- feed view
FeedView
- Throws:
AzDException
- Default Api Exception handler.
-
listAsync
Get all views for a feed. The project parameter must be supplied if the feed was created in a project.- Parameters:
feedId
- Name or Id of the feed.- Returns:
- feed view
FeedView
- Throws:
AzDException
- Default Api Exception handler.
-
updateAsync
public CompletableFuture<FeedView> updateAsync(String feedId, String viewId, FeedView feedView) throws AzDException Update a view. The project parameter must be supplied if the feed was created in a project.- Parameters:
feedId
- Name or Id of the feed.viewId
- Name or Id of the view.feedView
- Feed view object to update the settings for.- Returns:
- the updated feed view
FeedView
- Throws:
AzDException
- Default Api Exception handler.
-
create
Create a new view on the referenced feed. The project parameter must be supplied if the feed was created in a project.- Parameters:
feedId
- Id of the feed.feedView
- Feed view object to create the feed view.- Returns:
- Feed view object
FeedView
- Throws:
AzDException
- Default Api Exception handler.
-
delete
Delete a feed view. The project parameter must be supplied if the feed was created in a project.- Parameters:
feedId
- Name or Id of the feedviewId
- Id of the feed view- Throws:
AzDException
- Default Api Exception handler.
-
get
Get a view by Id. The project parameter must be supplied if the feed was created in a project.- Parameters:
feedId
- Name or Id of the feed.viewId
- Name or Id of the view.- Returns:
- feed view
FeedView
- Throws:
AzDException
- Default Api Exception handler.
-
list
Get all views for a feed. The project parameter must be supplied if the feed was created in a project.- Parameters:
feedId
- Name or Id of the feed.- Returns:
- feed view
FeedView
- Throws:
AzDException
- Default Api Exception handler.
-
update
Update a view. The project parameter must be supplied if the feed was created in a project.- Parameters:
feedId
- Name or Id of the feed.viewId
- Name or Id of the view.feedView
- Feed view object to update the settings for.- Returns:
- the updated feed view
FeedView
- Throws:
AzDException
- Default Api Exception handler.
-