Interface Bookmarks
-
public interface Bookmarks
Resource collection API of Bookmarks.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Bookmark.DefinitionStages.Blank
define(String name)
Begins definition for a new Bookmark resource.void
delete(String resourceGroupName, String workspaceName, String bookmarkId)
Delete the bookmark.void
deleteById(String id)
Delete the bookmark.com.azure.core.http.rest.Response<Void>
deleteByIdWithResponse(String id, com.azure.core.util.Context context)
Delete the bookmark.com.azure.core.http.rest.Response<Void>
deleteWithResponse(String resourceGroupName, String workspaceName, String bookmarkId, com.azure.core.util.Context context)
Delete the bookmark.Bookmark
get(String resourceGroupName, String workspaceName, String bookmarkId)
Gets a bookmark.Bookmark
getById(String id)
Gets a bookmark.com.azure.core.http.rest.Response<Bookmark>
getByIdWithResponse(String id, com.azure.core.util.Context context)
Gets a bookmark.com.azure.core.http.rest.Response<Bookmark>
getWithResponse(String resourceGroupName, String workspaceName, String bookmarkId, com.azure.core.util.Context context)
Gets a bookmark.com.azure.core.http.rest.PagedIterable<Bookmark>
list(String resourceGroupName, String workspaceName)
Gets all bookmarks.com.azure.core.http.rest.PagedIterable<Bookmark>
list(String resourceGroupName, String workspaceName, com.azure.core.util.Context context)
Gets all bookmarks.
-
-
-
Method Detail
-
list
com.azure.core.http.rest.PagedIterable<Bookmark> list(String resourceGroupName, String workspaceName)
Gets all bookmarks.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.workspaceName
- The name of the workspace.- Returns:
- all bookmarks 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<Bookmark> list(String resourceGroupName, String workspaceName, com.azure.core.util.Context context)
Gets all bookmarks.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.workspaceName
- The name of the workspace.context
- The context to associate with this operation.- Returns:
- all bookmarks 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
Bookmark get(String resourceGroupName, String workspaceName, String bookmarkId)
Gets a bookmark.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.workspaceName
- The name of the workspace.bookmarkId
- Bookmark ID.- Returns:
- a bookmark.
- 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<Bookmark> getWithResponse(String resourceGroupName, String workspaceName, String bookmarkId, com.azure.core.util.Context context)
Gets a bookmark.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.workspaceName
- The name of the workspace.bookmarkId
- Bookmark ID.context
- The context to associate with this operation.- Returns:
- a bookmark 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 bookmarkId)
Delete the bookmark.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.workspaceName
- The name of the workspace.bookmarkId
- Bookmark 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.
-
deleteWithResponse
com.azure.core.http.rest.Response<Void> deleteWithResponse(String resourceGroupName, String workspaceName, String bookmarkId, com.azure.core.util.Context context)
Delete the bookmark.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.workspaceName
- The name of the workspace.bookmarkId
- Bookmark 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.
-
getById
Bookmark getById(String id)
Gets a bookmark.- Parameters:
id
- the resource ID.- Returns:
- a bookmark 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<Bookmark> getByIdWithResponse(String id, com.azure.core.util.Context context)
Gets a bookmark.- Parameters:
id
- the resource ID.context
- The context to associate with this operation.- Returns:
- a bookmark 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 the bookmark.- 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 the bookmark.- 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
Bookmark.DefinitionStages.Blank define(String name)
Begins definition for a new Bookmark resource.- Parameters:
name
- resource name.- Returns:
- the first stage of the new Bookmark definition.
-
-