Interface WatchlistItems


public interface WatchlistItems
Resource collection API of WatchlistItems.
  • Method Details

    • list

      com.azure.core.http.rest.PagedIterable<WatchlistItem> list(String resourceGroupName, String workspaceName, String watchlistAlias)
      Gets all watchlist Items.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      workspaceName - The name of the workspace.
      watchlistAlias - Watchlist Alias.
      Returns:
      all watchlist Items as paginated response with PagedIterable.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • list

      com.azure.core.http.rest.PagedIterable<WatchlistItem> list(String resourceGroupName, String workspaceName, String watchlistAlias, String skipToken, com.azure.core.util.Context context)
      Gets all watchlist Items.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      workspaceName - The name of the workspace.
      watchlistAlias - Watchlist Alias.
      skipToken - Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls. Optional.
      context - The context to associate with this operation.
      Returns:
      all watchlist Items as paginated response with PagedIterable.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • get

      WatchlistItem get(String resourceGroupName, String workspaceName, String watchlistAlias, String watchlistItemId)
      Gets a watchlist, without its watchlist items.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      workspaceName - The name of the workspace.
      watchlistAlias - Watchlist Alias.
      watchlistItemId - Watchlist Item Id (GUID).
      Returns:
      a watchlist, without its watchlist items.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • getWithResponse

      com.azure.core.http.rest.Response<WatchlistItem> getWithResponse(String resourceGroupName, String workspaceName, String watchlistAlias, String watchlistItemId, com.azure.core.util.Context context)
      Gets a watchlist, without its watchlist items.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      workspaceName - The name of the workspace.
      watchlistAlias - Watchlist Alias.
      watchlistItemId - Watchlist Item Id (GUID).
      context - The context to associate with this operation.
      Returns:
      a watchlist, without its watchlist items along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • delete

      void delete(String resourceGroupName, String workspaceName, String watchlistAlias, String watchlistItemId)
      Delete a watchlist item.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      workspaceName - The name of the workspace.
      watchlistAlias - Watchlist Alias.
      watchlistItemId - Watchlist Item Id (GUID).
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • deleteWithResponse

      com.azure.core.http.rest.Response<Void> deleteWithResponse(String resourceGroupName, String workspaceName, String watchlistAlias, String watchlistItemId, com.azure.core.util.Context context)
      Delete a watchlist item.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      workspaceName - The name of the workspace.
      watchlistAlias - Watchlist Alias.
      watchlistItemId - Watchlist Item Id (GUID).
      context - The context to associate with this operation.
      Returns:
      the Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • getById

      WatchlistItem getById(String id)
      Gets a watchlist, without its watchlist items.
      Parameters:
      id - the resource ID.
      Returns:
      a watchlist, without its watchlist items along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • getByIdWithResponse

      com.azure.core.http.rest.Response<WatchlistItem> getByIdWithResponse(String id, com.azure.core.util.Context context)
      Gets a watchlist, without its watchlist items.
      Parameters:
      id - the resource ID.
      context - The context to associate with this operation.
      Returns:
      a watchlist, without its watchlist items along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • deleteById

      void deleteById(String id)
      Delete a watchlist item.
      Parameters:
      id - the resource ID.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • deleteByIdWithResponse

      com.azure.core.http.rest.Response<Void> deleteByIdWithResponse(String id, com.azure.core.util.Context context)
      Delete a watchlist item.
      Parameters:
      id - the resource ID.
      context - The context to associate with this operation.
      Returns:
      the Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • define

      Begins definition for a new WatchlistItem resource.
      Parameters:
      name - resource name.
      Returns:
      the first stage of the new WatchlistItem definition.