com.azure.resourcemanager.securityinsights.fluent.WatchlistsClient Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of azure-resourcemanager-securityinsights Show documentation
This package contains Microsoft Azure SDK for SecurityInsights Management SDK. For documentation on how to use this package, please see https://aka.ms/azsdk/java/mgmt. API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider. Package tag package-preview-2022-09.
The newest version!
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
// Code generated by Microsoft (R) AutoRest Code Generator.

package com.azure.resourcemanager.securityinsights.fluent;

import com.azure.core.annotation.ReturnType;
import com.azure.core.annotation.ServiceMethod;
import com.azure.core.http.rest.PagedIterable;
import com.azure.core.http.rest.Response;
import com.azure.core.util.Context;
import com.azure.resourcemanager.securityinsights.fluent.models.WatchlistInner;
import com.azure.resourcemanager.securityinsights.models.WatchlistsCreateOrUpdateResponse;
import com.azure.resourcemanager.securityinsights.models.WatchlistsDeleteResponse;

/**
 * An instance of this class provides access to all the operations defined in WatchlistsClient.
 */
public interface WatchlistsClient {
    /**
     * Gets all watchlists, without watchlist items.
     * 
     * @param resourceGroupName The name of the resource group. The name is case insensitive.
     * @param workspaceName The name of the workspace.
     * @throws IllegalArgumentException thrown if parameters fail the validation.
     * @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     * @return all watchlists, without watchlist items as paginated response with {@link PagedIterable}.
     */
    @ServiceMethod(returns = ReturnType.COLLECTION)
    PagedIterable list(String resourceGroupName, String workspaceName);

    /**
     * Gets all watchlists, without watchlist items.
     * 
     * @param resourceGroupName The name of the resource group. The name is case insensitive.
     * @param workspaceName The name of the workspace.
     * @param 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.
     * @param context The context to associate with this operation.
     * @throws IllegalArgumentException thrown if parameters fail the validation.
     * @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     * @return all watchlists, without watchlist items as paginated response with {@link PagedIterable}.
     */
    @ServiceMethod(returns = ReturnType.COLLECTION)
    PagedIterable list(String resourceGroupName, String workspaceName, String skipToken,
        Context context);

    /**
     * Gets a watchlist, without its watchlist items.
     * 
     * @param resourceGroupName The name of the resource group. The name is case insensitive.
     * @param workspaceName The name of the workspace.
     * @param watchlistAlias Watchlist Alias.
     * @param context The context to associate with this operation.
     * @throws IllegalArgumentException thrown if parameters fail the validation.
     * @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     * @return a watchlist, without its watchlist items along with {@link Response}.
     */
    @ServiceMethod(returns = ReturnType.SINGLE)
    Response getWithResponse(String resourceGroupName, String workspaceName, String watchlistAlias,
        Context context);

    /**
     * Gets a watchlist, without its watchlist items.
     * 
     * @param resourceGroupName The name of the resource group. The name is case insensitive.
     * @param workspaceName The name of the workspace.
     * @param watchlistAlias Watchlist Alias.
     * @throws IllegalArgumentException thrown if parameters fail the validation.
     * @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     * @return a watchlist, without its watchlist items.
     */
    @ServiceMethod(returns = ReturnType.SINGLE)
    WatchlistInner get(String resourceGroupName, String workspaceName, String watchlistAlias);

    /**
     * Delete a watchlist.
     * 
     * @param resourceGroupName The name of the resource group. The name is case insensitive.
     * @param workspaceName The name of the workspace.
     * @param watchlistAlias Watchlist Alias.
     * @param context The context to associate with this operation.
     * @throws IllegalArgumentException thrown if parameters fail the validation.
     * @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     * @return the response.
     */
    @ServiceMethod(returns = ReturnType.SINGLE)
    WatchlistsDeleteResponse deleteWithResponse(String resourceGroupName, String workspaceName, String watchlistAlias,
        Context context);

    /**
     * Delete a watchlist.
     * 
     * @param resourceGroupName The name of the resource group. The name is case insensitive.
     * @param workspaceName The name of the workspace.
     * @param watchlistAlias Watchlist Alias.
     * @throws IllegalArgumentException thrown if parameters fail the validation.
     * @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     */
    @ServiceMethod(returns = ReturnType.SINGLE)
    void delete(String resourceGroupName, String workspaceName, String watchlistAlias);

    /**
     * Create or update a Watchlist and its Watchlist Items (bulk creation, e.g. through text/csv content type). To
     * create a Watchlist and its Items, we should call this endpoint with either rawContent or a valid SAR URI and
     * contentType properties. The rawContent is mainly used for small watchlist (content size below 3.8 MB). The SAS
     * URI enables the creation of large watchlist, where the content size can go up to 500 MB. The status of processing
     * such large file can be polled through the URL returned in Azure-AsyncOperation header.
     * 
     * @param resourceGroupName The name of the resource group. The name is case insensitive.
     * @param workspaceName The name of the workspace.
     * @param watchlistAlias Watchlist Alias.
     * @param watchlist The watchlist.
     * @param context The context to associate with this operation.
     * @throws IllegalArgumentException thrown if parameters fail the validation.
     * @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     * @return represents a Watchlist in Azure Security Insights.
     */
    @ServiceMethod(returns = ReturnType.SINGLE)
    WatchlistsCreateOrUpdateResponse createOrUpdateWithResponse(String resourceGroupName, String workspaceName,
        String watchlistAlias, WatchlistInner watchlist, Context context);

    /**
     * Create or update a Watchlist and its Watchlist Items (bulk creation, e.g. through text/csv content type). To
     * create a Watchlist and its Items, we should call this endpoint with either rawContent or a valid SAR URI and
     * contentType properties. The rawContent is mainly used for small watchlist (content size below 3.8 MB). The SAS
     * URI enables the creation of large watchlist, where the content size can go up to 500 MB. The status of processing
     * such large file can be polled through the URL returned in Azure-AsyncOperation header.
     * 
     * @param resourceGroupName The name of the resource group. The name is case insensitive.
     * @param workspaceName The name of the workspace.
     * @param watchlistAlias Watchlist Alias.
     * @param watchlist The watchlist.
     * @throws IllegalArgumentException thrown if parameters fail the validation.
     * @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     * @return represents a Watchlist in Azure Security Insights.
     */
    @ServiceMethod(returns = ReturnType.SINGLE)
    WatchlistInner createOrUpdate(String resourceGroupName, String workspaceName, String watchlistAlias,
        WatchlistInner watchlist);
}