Interface Watchlists
public interface Watchlists
Resource collection API of Watchlists.
-
Method Summary
Modifier and TypeMethodDescriptionBegins definition for a new Watchlist resource.void
Delete a watchlist.void
deleteById
(String id) Delete a watchlist.deleteByIdWithResponse
(String id, com.azure.core.util.Context context) Delete a watchlist.deleteWithResponse
(String resourceGroupName, String workspaceName, String watchlistAlias, com.azure.core.util.Context context) Delete a watchlist.Gets a watchlist, without its watchlist items.Gets a watchlist, without its watchlist items.com.azure.core.http.rest.Response<Watchlist>
getByIdWithResponse
(String id, com.azure.core.util.Context context) Gets a watchlist, without its watchlist items.com.azure.core.http.rest.Response<Watchlist>
getWithResponse
(String resourceGroupName, String workspaceName, String watchlistAlias, com.azure.core.util.Context context) Gets a watchlist, without its watchlist items.com.azure.core.http.rest.PagedIterable<Watchlist>
Gets all watchlists, without watchlist items.com.azure.core.http.rest.PagedIterable<Watchlist>
list
(String resourceGroupName, String workspaceName, String skipToken, com.azure.core.util.Context context) Gets all watchlists, without watchlist items.
-
Method Details
-
list
com.azure.core.http.rest.PagedIterable<Watchlist> list(String resourceGroupName, String workspaceName) Gets all watchlists, without watchlist items.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.workspaceName
- The name of the workspace.- Returns:
- all watchlists, without 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<Watchlist> list(String resourceGroupName, String workspaceName, String skipToken, com.azure.core.util.Context context) Gets all watchlists, without watchlist items.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.workspaceName
- The name of the workspace.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 watchlists, without 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
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.- 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<Watchlist> getWithResponse(String resourceGroupName, String workspaceName, String watchlistAlias, 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.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
Delete a watchlist.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.workspaceName
- The name of the workspace.watchlistAlias
- Watchlist Alias.- 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
WatchlistsDeleteResponse deleteWithResponse(String resourceGroupName, String workspaceName, String watchlistAlias, com.azure.core.util.Context context) Delete a watchlist.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.workspaceName
- The name of the workspace.watchlistAlias
- Watchlist Alias.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
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<Watchlist> 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
Delete a watchlist.- 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
Delete a watchlist.- 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 Watchlist resource.- Parameters:
name
- resource name.- Returns:
- the first stage of the new Watchlist definition.
-