Package org.azd.artifacts.feedmanagement

Class FeedManagementRequestBuilder

java.lang.Object
org.azd.abstractions.BaseRequestBuilder
org.azd.artifacts.feedmanagement.FeedManagementRequestBuilder
public class FeedManagementRequestBuilder extends BaseRequestBuilder
Provides functionality to manage Artifacts Feed Management Api.

  • Constructor Details

    • FeedManagementRequestBuilder

      public FeedManagementRequestBuilder(String organizationUrl, AccessTokenCredential accessTokenCredential)
      Instantiates a new RequestBuilder instance and sets the default values.
      Parameters:
      organizationUrl - Represents organization location request url.
      accessTokenCredential - Access token credential object.

  • Method Details

    • view

      public FeedViewRequestBuilder view()

    • permissions

      public FeedPermissionsRequestBuilder permissions()

    • createAsync

      public CompletableFuture<Feed> createAsync(Feed feed) throws AzDException
      Create a feed, a container for various package types. Feeds can be created in a project if the project parameter is included when instantiating the class. This can be done by injecting the instance of AzDDefaultParameters with project name. If the project parameter is omitted, the feed will not be associated with a project and will be created at the organization level.
      Parameters:
      feed - Provide feed object to create a new feed.
      Returns:
      Feed object Feed
      Throws:
      AzDException - Default Api Exception handler.

    • deleteAsync

      public CompletableFuture<Void> deleteAsync(String feedId) throws AzDException
      Remove a feed and all its packages. The feed moves to the recycle bin and is reversible. The project parameter must be supplied if the feed was created in a project. If the feed is not associated with any project, omit the project parameter from the request.
      Parameters:
      feedId - Name or Id of the feed.
      Throws:
      AzDException - Default Api Exception handler.

    • getAsync

      public CompletableFuture<Feed> getAsync(String feedId) throws AzDException
      Get the settings for a specific feed. The project parameter must be supplied if the feed was created in a project. If the feed is not associated with any project, omit the project parameter from the request.
      Parameters:
      feedId - Name of id of the feed
      Returns:
      Feed Feed
      Throws:
      AzDException - Default Api Exception handler.

    • getAsync

      public CompletableFuture<Feed> getAsync(String feedId, boolean includeDeletedUpstreams) throws AzDException
      Get the settings for a specific feed. The project parameter must be supplied if the feed was created in a project. If the feed is not associated with any project, omit the project parameter from the request.
      Parameters:
      feedId - Name of id of the feed
      includeDeletedUpstreams - Include upstreams that have been deleted in the response.
      Returns:
      Feed Feed
      Throws:
      AzDException - Default Api Exception handler.

    • listAsync

      public CompletableFuture<Feeds> listAsync() throws AzDException
      Get all feeds in an account where you have the provided role access. If the project parameter is present, gets all feeds in the given project. If omitted, gets all feeds in the organization.
      Returns:
      array of feeds Feeds
      Throws:
      AzDException - Default Api Exception handler.

    • listAsync

      public CompletableFuture<Feeds> listAsync(Consumer<FeedManagementRequestBuilder.RequestConfiguration> requestConfiguration) throws AzDException
      Get all feeds in an account where you have the provided role access. If the project parameter is present, gets all feeds in the given project. If omitted, gets all feeds in the organization.
      Returns:
      array of feeds Feeds
      Throws:
      AzDException - Default Api Exception handler.

    • updateAsync

      public CompletableFuture<Feed> updateAsync(String feedId, Feed feed) throws AzDException
      Change the attributes of a feed. The project parameter must be supplied if the feed was created in a project. If the feed is not associated with any project, omit the project parameter from the request.
      Parameters:
      feedId - Name or Id of the feed.
      feed - Feed object to update the settings for
      Returns:
      feed Feed
      Throws:
      AzDException - Default Api Exception handler.

    • create

      public Feed create(Feed feed) throws AzDException
      Create a feed, a container for various package types. Feeds can be created in a project if the project parameter is included when instantiating the class. This can be done by injecting the instance of AzDDefaultParameters with project name. If the project parameter is omitted, the feed will not be associated with a project and will be created at the organization level.
      Parameters:
      feed - Provide feed object to create a new feed.
      Returns:
      Feed object Feed
      Throws:
      AzDException - Default Api Exception handler.

    • delete

      public Void delete(String feedId) throws AzDException
      Remove a feed and all its packages. The feed moves to the recycle bin and is reversible. The project parameter must be supplied if the feed was created in a project. If the feed is not associated with any project, omit the project parameter from the request.
      Parameters:
      feedId - Name or Id of the feed.
      Throws:
      AzDException - Default Api Exception handler.

    • get

      public Feed get(String feedId) throws AzDException
      Get the settings for a specific feed. The project parameter must be supplied if the feed was created in a project. If the feed is not associated with any project, omit the project parameter from the request.
      Parameters:
      feedId - Name of id of the feed
      Returns:
      Feed Feed
      Throws:
      AzDException - Default Api Exception handler.

    • get

      public Feed get(String feedId, boolean includeDeletedUpstreams) throws AzDException
      Get the settings for a specific feed. The project parameter must be supplied if the feed was created in a project. If the feed is not associated with any project, omit the project parameter from the request.
      Parameters:
      feedId - Name of id of the feed
      includeDeletedUpstreams - Include upstreams that have been deleted in the response.
      Returns:
      Feed Feed
      Throws:
      AzDException - Default Api Exception handler.

    • list

      public Feeds list() throws AzDException
      Get all feeds in an account where you have the provided role access. If the project parameter is present, gets all feeds in the given project. If omitted, gets all feeds in the organization.
      Returns:
      array of feeds Feeds
      Throws:
      AzDException - Default Api Exception handler.

    • list

      public Feeds list(Consumer<FeedManagementRequestBuilder.RequestConfiguration> requestConfiguration) throws AzDException
      Get all feeds in an account where you have the provided role access. If the project parameter is present, gets all feeds in the given project. If omitted, gets all feeds in the organization.
      Returns:
      array of feeds Feeds
      Throws:
      AzDException - Default Api Exception handler.

    • update

      public Feed update(String feedId, Feed feed) throws AzDException
      Change the attributes of a feed. The project parameter must be supplied if the feed was created in a project. If the feed is not associated with any project, omit the project parameter from the request.
      Parameters:
      feedId - Name or Id of the feed.
      feed - Feed object to update the settings for
      Returns:
      feed Feed
      Throws:
      AzDException - Default Api Exception handler.