Interface Workflows
public interface Workflows
Resource collection API of Workflows.
-
Method Summary
Modifier and TypeMethodDescriptionBegins definition for a new Workflow resource.deleteById
(String id) Deletes a workflow.com.azure.core.http.rest.Response<DeleteWorkflowResponse>
deleteByIdWithResponse
(String id, com.azure.core.util.Context context) Deletes a workflow.deleteByResourceGroup
(String resourceGroupName, String workflowName) Deletes a workflow.com.azure.core.http.rest.Response<DeleteWorkflowResponse>
deleteWithResponse
(String resourceGroupName, String workflowName, com.azure.core.util.Context context) Deletes a workflow.Gets a workflow.com.azure.core.http.rest.Response<Workflow>
getByIdWithResponse
(String id, com.azure.core.util.Context context) Gets a workflow.getByResourceGroup
(String resourceGroupName, String workflowName) Gets a workflow.com.azure.core.http.rest.Response<Workflow>
getByResourceGroupWithResponse
(String resourceGroupName, String workflowName, com.azure.core.util.Context context) Gets a workflow.com.azure.core.http.rest.PagedIterable<Workflow>
list()
Gets a list of workflows associated with the specified subscription.com.azure.core.http.rest.PagedIterable<Workflow>
list
(com.azure.core.util.Context context) Gets a list of workflows associated with the specified subscription.com.azure.core.http.rest.PagedIterable<Workflow>
listByResourceGroup
(String resourceGroupName) Gets a list of workflows within a resource group.com.azure.core.http.rest.PagedIterable<Workflow>
listByResourceGroup
(String resourceGroupName, String managedClusterResource, com.azure.core.util.Context context) Gets a list of workflows within a resource group.
-
Method Details
-
list
com.azure.core.http.rest.PagedIterable<Workflow> list()Gets a list of workflows associated with the specified subscription.- Returns:
- a list of workflows associated with the specified subscription as paginated response with
PagedIterable
. - Throws:
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
Gets a list of workflows associated with the specified subscription.- Parameters:
context
- The context to associate with this operation.- Returns:
- a list of workflows associated with the specified subscription 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.
-
listByResourceGroup
Gets a list of workflows within a resource group.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.- Returns:
- a list of workflows within a resource group 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.
-
listByResourceGroup
com.azure.core.http.rest.PagedIterable<Workflow> listByResourceGroup(String resourceGroupName, String managedClusterResource, com.azure.core.util.Context context) Gets a list of workflows within a resource group.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.managedClusterResource
- The ManagedCluster resource associated with the workflows.context
- The context to associate with this operation.- Returns:
- a list of workflows within a resource group 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.
-
getByResourceGroup
Gets a workflow.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.workflowName
- The name of the workflow resource.- Returns:
- a workflow.
- 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.
-
getByResourceGroupWithResponse
com.azure.core.http.rest.Response<Workflow> getByResourceGroupWithResponse(String resourceGroupName, String workflowName, com.azure.core.util.Context context) Gets a workflow.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.workflowName
- The name of the workflow resource.context
- The context to associate with this operation.- Returns:
- a workflow 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.
-
deleteByResourceGroup
Deletes a workflow.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.workflowName
- The name of the workflow resource.- Returns:
- delete response if content must be provided on delete operation.
- 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<DeleteWorkflowResponse> deleteWithResponse(String resourceGroupName, String workflowName, com.azure.core.util.Context context) Deletes a workflow.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.workflowName
- The name of the workflow resource.context
- The context to associate with this operation.- Returns:
- delete response if content must be provided on delete operation 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.
-
getById
Gets a workflow.- Parameters:
id
- the resource ID.- Returns:
- a workflow 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<Workflow> getByIdWithResponse(String id, com.azure.core.util.Context context) Gets a workflow.- Parameters:
id
- the resource ID.context
- The context to associate with this operation.- Returns:
- a workflow 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
Deletes a workflow.- Parameters:
id
- the resource ID.- Returns:
- delete response if content must be provided on delete operation 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.
-
deleteByIdWithResponse
com.azure.core.http.rest.Response<DeleteWorkflowResponse> deleteByIdWithResponse(String id, com.azure.core.util.Context context) Deletes a workflow.- Parameters:
id
- the resource ID.context
- The context to associate with this operation.- Returns:
- delete response if content must be provided on delete operation 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.
-
define
Begins definition for a new Workflow resource.- Parameters:
name
- resource name.- Returns:
- the first stage of the new Workflow definition.
-