Interface Workbooks
public interface Workbooks
Resource collection API of Workbooks.
-
Method Summary
Modifier and TypeMethodDescriptionBegins definition for a new Workbook resource.void
deleteById
(String id) Delete a workbook.com.azure.core.http.rest.Response<Void>
deleteByIdWithResponse
(String id, com.azure.core.util.Context context) Delete a workbook.void
deleteByResourceGroup
(String resourceGroupName, String resourceName) Delete a workbook.com.azure.core.http.rest.Response<Void>
deleteWithResponse
(String resourceGroupName, String resourceName, com.azure.core.util.Context context) Delete a workbook.Get a single workbook by its resourceName.com.azure.core.http.rest.Response<Workbook>
getByIdWithResponse
(String id, Boolean canFetchContent, com.azure.core.util.Context context) Get a single workbook by its resourceName.getByResourceGroup
(String resourceGroupName, String resourceName) Get a single workbook by its resourceName.com.azure.core.http.rest.Response<Workbook>
getByResourceGroupWithResponse
(String resourceGroupName, String resourceName, Boolean canFetchContent, com.azure.core.util.Context context) Get a single workbook by its resourceName.com.azure.core.http.rest.PagedIterable<Workbook>
list
(CategoryType category) Get all Workbooks defined within a specified subscription and category.com.azure.core.http.rest.PagedIterable<Workbook>
list
(CategoryType category, List<String> tags, Boolean canFetchContent, com.azure.core.util.Context context) Get all Workbooks defined within a specified subscription and category.com.azure.core.http.rest.PagedIterable<Workbook>
listByResourceGroup
(String resourceGroupName, CategoryType category) Get all Workbooks defined within a specified resource group and category.com.azure.core.http.rest.PagedIterable<Workbook>
listByResourceGroup
(String resourceGroupName, CategoryType category, List<String> tags, String sourceId, Boolean canFetchContent, com.azure.core.util.Context context) Get all Workbooks defined within a specified resource group and category.revisionGet
(String resourceGroupName, String resourceName, String revisionId) Get a single workbook revision defined by its revisionId.com.azure.core.http.rest.Response<Workbook>
revisionGetWithResponse
(String resourceGroupName, String resourceName, String revisionId, com.azure.core.util.Context context) Get a single workbook revision defined by its revisionId.com.azure.core.http.rest.PagedIterable<Workbook>
revisionsList
(String resourceGroupName, String resourceName) Get the revisions for the workbook defined by its resourceName.com.azure.core.http.rest.PagedIterable<Workbook>
revisionsList
(String resourceGroupName, String resourceName, com.azure.core.util.Context context) Get the revisions for the workbook defined by its resourceName.
-
Method Details
-
list
Get all Workbooks defined within a specified subscription and category.- Parameters:
category
- Category of workbook to return.- Returns:
- all Workbooks defined within a specified subscription and category as paginated response with
PagedIterable
. - Throws:
IllegalArgumentException
- thrown if parameters fail the validation.WorkbookErrorDefinitionException
- 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<Workbook> list(CategoryType category, List<String> tags, Boolean canFetchContent, com.azure.core.util.Context context) Get all Workbooks defined within a specified subscription and category.- Parameters:
category
- Category of workbook to return.tags
- Tags presents on each workbook returned.canFetchContent
- Flag indicating whether or not to return the full content for each applicable workbook. If false, only return summary content for workbooks.context
- The context to associate with this operation.- Returns:
- all Workbooks defined within a specified subscription and category as paginated response with
PagedIterable
. - Throws:
IllegalArgumentException
- thrown if parameters fail the validation.WorkbookErrorDefinitionException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
listByResourceGroup
com.azure.core.http.rest.PagedIterable<Workbook> listByResourceGroup(String resourceGroupName, CategoryType category) Get all Workbooks defined within a specified resource group and category.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.category
- Category of workbook to return.- Returns:
- all Workbooks defined within a specified resource group and category as paginated response with
PagedIterable
. - Throws:
IllegalArgumentException
- thrown if parameters fail the validation.WorkbookErrorDefinitionException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
listByResourceGroup
com.azure.core.http.rest.PagedIterable<Workbook> listByResourceGroup(String resourceGroupName, CategoryType category, List<String> tags, String sourceId, Boolean canFetchContent, com.azure.core.util.Context context) Get all Workbooks defined within a specified resource group and category.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.category
- Category of workbook to return.tags
- Tags presents on each workbook returned.sourceId
- Azure Resource Id that will fetch all linked workbooks.canFetchContent
- Flag indicating whether or not to return the full content for each applicable workbook. If false, only return summary content for workbooks.context
- The context to associate with this operation.- Returns:
- all Workbooks defined within a specified resource group and category as paginated response with
PagedIterable
. - Throws:
IllegalArgumentException
- thrown if parameters fail the validation.WorkbookErrorDefinitionException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
getByResourceGroup
Get a single workbook by its resourceName.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.resourceName
- The name of the resource.- Returns:
- a single workbook by its resourceName.
- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.WorkbookErrorDefinitionException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
getByResourceGroupWithResponse
com.azure.core.http.rest.Response<Workbook> getByResourceGroupWithResponse(String resourceGroupName, String resourceName, Boolean canFetchContent, com.azure.core.util.Context context) Get a single workbook by its resourceName.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.resourceName
- The name of the resource.canFetchContent
- Flag indicating whether or not to return the full content for each applicable workbook. If false, only return summary content for workbooks.context
- The context to associate with this operation.- Returns:
- a single workbook by its resourceName along with
Response
. - Throws:
IllegalArgumentException
- thrown if parameters fail the validation.WorkbookErrorDefinitionException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
deleteByResourceGroup
Delete a workbook.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.resourceName
- The name of the resource.- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.WorkbookErrorDefinitionException
- 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 resourceName, com.azure.core.util.Context context) Delete a workbook.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.resourceName
- The name of the resource.context
- The context to associate with this operation.- Returns:
- the
Response
. - Throws:
IllegalArgumentException
- thrown if parameters fail the validation.WorkbookErrorDefinitionException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
revisionsList
com.azure.core.http.rest.PagedIterable<Workbook> revisionsList(String resourceGroupName, String resourceName) Get the revisions for the workbook defined by its resourceName.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.resourceName
- The name of the resource.- Returns:
- the revisions for the workbook defined by its resourceName as paginated response with
PagedIterable
. - Throws:
IllegalArgumentException
- thrown if parameters fail the validation.WorkbookErrorDefinitionException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
revisionsList
com.azure.core.http.rest.PagedIterable<Workbook> revisionsList(String resourceGroupName, String resourceName, com.azure.core.util.Context context) Get the revisions for the workbook defined by its resourceName.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.resourceName
- The name of the resource.context
- The context to associate with this operation.- Returns:
- the revisions for the workbook defined by its resourceName as paginated response with
PagedIterable
. - Throws:
IllegalArgumentException
- thrown if parameters fail the validation.WorkbookErrorDefinitionException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
revisionGet
Get a single workbook revision defined by its revisionId.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.resourceName
- The name of the resource.revisionId
- The id of the workbook's revision.- Returns:
- a single workbook revision defined by its revisionId.
- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.WorkbookErrorDefinitionException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
revisionGetWithResponse
com.azure.core.http.rest.Response<Workbook> revisionGetWithResponse(String resourceGroupName, String resourceName, String revisionId, com.azure.core.util.Context context) Get a single workbook revision defined by its revisionId.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.resourceName
- The name of the resource.revisionId
- The id of the workbook's revision.context
- The context to associate with this operation.- Returns:
- a single workbook revision defined by its revisionId along with
Response
. - Throws:
IllegalArgumentException
- thrown if parameters fail the validation.WorkbookErrorDefinitionException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
getById
Get a single workbook by its resourceName.- Parameters:
id
- the resource ID.- Returns:
- a single workbook by its resourceName along with
Response
. - Throws:
IllegalArgumentException
- thrown if parameters fail the validation.WorkbookErrorDefinitionException
- 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<Workbook> getByIdWithResponse(String id, Boolean canFetchContent, com.azure.core.util.Context context) Get a single workbook by its resourceName.- Parameters:
id
- the resource ID.canFetchContent
- Flag indicating whether or not to return the full content for each applicable workbook. If false, only return summary content for workbooks.context
- The context to associate with this operation.- Returns:
- a single workbook by its resourceName along with
Response
. - Throws:
IllegalArgumentException
- thrown if parameters fail the validation.WorkbookErrorDefinitionException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
deleteById
Delete a workbook.- Parameters:
id
- the resource ID.- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.WorkbookErrorDefinitionException
- 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 workbook.- Parameters:
id
- the resource ID.context
- The context to associate with this operation.- Returns:
- the
Response
. - Throws:
IllegalArgumentException
- thrown if parameters fail the validation.WorkbookErrorDefinitionException
- 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 Workbook resource.- Parameters:
name
- resource name.- Returns:
- the first stage of the new Workbook definition.
-