WorkflowsClient Interface

Package:

com.azure.resourcemanager.logic.fluent

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-logic:1.0.0

public interface WorkflowsClient

An instance of this class provides access to all the operations defined in WorkflowsClient.

Method Summary

Modifier and Type	Method and Description
abstract SyncPoller<PollResult<Void>,Void>	beginMove(String resourceGroupName, String workflowName, WorkflowReference move) Moves an existing workflow.
abstract SyncPoller<PollResult<Void>,Void>	beginMove(String resourceGroupName, String workflowName, WorkflowReference move, Context context) Moves an existing workflow.
abstract WorkflowInner	createOrUpdate(String resourceGroupName, String workflowName, WorkflowInner workflow) Creates or updates a workflow.
abstract Response<WorkflowInner>	createOrUpdateWithResponse(String resourceGroupName, String workflowName, WorkflowInner workflow, Context context) Creates or updates a workflow.
abstract void	delete(String resourceGroupName, String workflowName) Deletes a workflow.
abstract Response<Void>	deleteWithResponse(String resourceGroupName, String workflowName, Context context) Deletes a workflow.
abstract void	disable(String resourceGroupName, String workflowName) Disables a workflow.
abstract Response<Void>	disableWithResponse(String resourceGroupName, String workflowName, Context context) Disables a workflow.
abstract void	enable(String resourceGroupName, String workflowName) Enables a workflow.
abstract Response<Void>	enableWithResponse(String resourceGroupName, String workflowName, Context context) Enables a workflow.
abstract Object	generateUpgradedDefinition(String resourceGroupName, String workflowName, GenerateUpgradedDefinitionParameters parameters) Generates the upgraded definition for a workflow.
abstract Response<Object>	generateUpgradedDefinitionWithResponse(String resourceGroupName, String workflowName, GenerateUpgradedDefinitionParameters parameters, Context context) Generates the upgraded definition for a workflow.
abstract WorkflowInner	getByResourceGroup(String resourceGroupName, String workflowName) Gets a workflow.
abstract Response<WorkflowInner>	getByResourceGroupWithResponse(String resourceGroupName, String workflowName, Context context) Gets a workflow.
abstract PagedIterable<WorkflowInner>	list() Gets a list of workflows by subscription.
abstract PagedIterable<WorkflowInner>	list(Integer top, String filter, Context context) Gets a list of workflows by subscription.
abstract PagedIterable<WorkflowInner>	listByResourceGroup(String resourceGroupName) Gets a list of workflows by resource group.
abstract PagedIterable<WorkflowInner>	listByResourceGroup(String resourceGroupName, Integer top, String filter, Context context) Gets a list of workflows by resource group.
abstract WorkflowTriggerCallbackUrlInner	listCallbackUrl(String resourceGroupName, String workflowName, GetCallbackUrlParameters listCallbackUrl) Get the workflow callback Url.
abstract Response<WorkflowTriggerCallbackUrlInner>	listCallbackUrlWithResponse(String resourceGroupName, String workflowName, GetCallbackUrlParameters listCallbackUrl, Context context) Get the workflow callback Url.
abstract Object	listSwagger(String resourceGroupName, String workflowName) Gets an OpenAPI definition for the workflow.
abstract Response<Object>	listSwaggerWithResponse(String resourceGroupName, String workflowName, Context context) Gets an OpenAPI definition for the workflow.
abstract void	move(String resourceGroupName, String workflowName, WorkflowReference move) Moves an existing workflow.
abstract void	move(String resourceGroupName, String workflowName, WorkflowReference move, Context context) Moves an existing workflow.
abstract void	regenerateAccessKey(String resourceGroupName, String workflowName, RegenerateActionParameter keyType) Regenerates the callback URL access key for request triggers.
abstract Response<Void>	regenerateAccessKeyWithResponse(String resourceGroupName, String workflowName, RegenerateActionParameter keyType, Context context) Regenerates the callback URL access key for request triggers.
abstract WorkflowInner	update(String resourceGroupName, String workflowName) Updates a workflow.
abstract Response<WorkflowInner>	updateWithResponse(String resourceGroupName, String workflowName, Context context) Updates a workflow.
abstract void	validateByLocation(String resourceGroupName, String location, String workflowName, WorkflowInner validate) Validates the workflow definition.
abstract Response<Void>	validateByLocationWithResponse(String resourceGroupName, String location, String workflowName, WorkflowInner validate, Context context) Validates the workflow definition.
abstract void	validateByResourceGroup(String resourceGroupName, String workflowName, WorkflowInner validate) Validates the workflow.
abstract Response<Void>	validateByResourceGroupWithResponse(String resourceGroupName, String workflowName, WorkflowInner validate, Context context) Validates the workflow.

Method Details

beginMove

public abstract SyncPoller<PollResult<Void>,Void> beginMove(String resourceGroupName, String workflowName, WorkflowReference move)

Moves an existing workflow.

Parameters:

resourceGroupName - The resource group name.

workflowName - The workflow name.

move - The workflow to move.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

beginMove

public abstract SyncPoller<PollResult<Void>,Void> beginMove(String resourceGroupName, String workflowName, WorkflowReference move, Context context)

Moves an existing workflow.

Parameters:

resourceGroupName - The resource group name.

workflowName - The workflow name.

move - The workflow to move.

context - The context to associate with this operation.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

createOrUpdate

public abstract WorkflowInner createOrUpdate(String resourceGroupName, String workflowName, WorkflowInner workflow)

Creates or updates a workflow.

Parameters:

resourceGroupName - The resource group name.

workflowName - The workflow name.

workflow - The workflow.

Returns:

the workflow type.

createOrUpdateWithResponse

public abstract Response<WorkflowInner> createOrUpdateWithResponse(String resourceGroupName, String workflowName, WorkflowInner workflow, Context context)

Creates or updates a workflow.

Parameters:

resourceGroupName - The resource group name.

workflowName - The workflow name.

workflow - The workflow.

context - The context to associate with this operation.

Returns:

the workflow type along with Response<T>.

delete

public abstract void delete(String resourceGroupName, String workflowName)

Deletes a workflow.

Parameters:

resourceGroupName - The resource group name.

workflowName - The workflow name.

deleteWithResponse

public abstract Response<Void> deleteWithResponse(String resourceGroupName, String workflowName, Context context)

Deletes a workflow.

Parameters:

resourceGroupName - The resource group name.

workflowName - The workflow name.

context - The context to associate with this operation.

Returns:

the Response<T>.

disable

public abstract void disable(String resourceGroupName, String workflowName)

Disables a workflow.

Parameters:

resourceGroupName - The resource group name.

workflowName - The workflow name.

disableWithResponse

public abstract Response<Void> disableWithResponse(String resourceGroupName, String workflowName, Context context)

Disables a workflow.

Parameters:

resourceGroupName - The resource group name.

workflowName - The workflow name.

context - The context to associate with this operation.

Returns:

the Response<T>.

enable

public abstract void enable(String resourceGroupName, String workflowName)

Enables a workflow.

Parameters:

resourceGroupName - The resource group name.

workflowName - The workflow name.

enableWithResponse

public abstract Response<Void> enableWithResponse(String resourceGroupName, String workflowName, Context context)

Enables a workflow.

Parameters:

resourceGroupName - The resource group name.

workflowName - The workflow name.

context - The context to associate with this operation.

Returns:

the Response<T>.

generateUpgradedDefinition

public abstract Object generateUpgradedDefinition(String resourceGroupName, String workflowName, GenerateUpgradedDefinitionParameters parameters)

Generates the upgraded definition for a workflow.

Parameters:

resourceGroupName - The resource group name.

workflowName - The workflow name.

parameters - Parameters for generating an upgraded definition.

Returns:

any object.

generateUpgradedDefinitionWithResponse

public abstract Response<Object> generateUpgradedDefinitionWithResponse(String resourceGroupName, String workflowName, GenerateUpgradedDefinitionParameters parameters, Context context)

Generates the upgraded definition for a workflow.

Parameters:

resourceGroupName - The resource group name.

workflowName - The workflow name.

parameters - Parameters for generating an upgraded definition.

context - The context to associate with this operation.

Returns:

any object along with Response<T>.

getByResourceGroup

public abstract WorkflowInner getByResourceGroup(String resourceGroupName, String workflowName)

Gets a workflow.

Parameters:

resourceGroupName - The resource group name.

workflowName - The workflow name.

Returns:

a workflow.

getByResourceGroupWithResponse

public abstract Response<WorkflowInner> getByResourceGroupWithResponse(String resourceGroupName, String workflowName, Context context)

Gets a workflow.

Parameters:

resourceGroupName - The resource group name.

workflowName - The workflow name.

context - The context to associate with this operation.

Returns:

a workflow along with Response<T>.

list

public abstract PagedIterable<WorkflowInner> list()

Gets a list of workflows by subscription.

Returns:

a list of workflows by subscription as paginated response with PagedIterable<T>.

list

public abstract PagedIterable<WorkflowInner> list(Integer top, String filter, Context context)

Gets a list of workflows by subscription.

Parameters:

top - The number of items to be included in the result.

filter - The filter to apply on the operation. Options for filters include: State, Trigger, and ReferencedResourceId.

context - The context to associate with this operation.

Returns:

a list of workflows by subscription as paginated response with PagedIterable<T>.

listByResourceGroup

public abstract PagedIterable<WorkflowInner> listByResourceGroup(String resourceGroupName)

Gets a list of workflows by resource group.

Parameters:

resourceGroupName - The resource group name.

Returns:

a list of workflows by resource group as paginated response with PagedIterable<T>.

listByResourceGroup

public abstract PagedIterable<WorkflowInner> listByResourceGroup(String resourceGroupName, Integer top, String filter, Context context)

Gets a list of workflows by resource group.

Parameters:

resourceGroupName - The resource group name.

top - The number of items to be included in the result.

filter - The filter to apply on the operation. Options for filters include: State, Trigger, and ReferencedResourceId.

context - The context to associate with this operation.

Returns:

a list of workflows by resource group as paginated response with PagedIterable<T>.

listCallbackUrl

public abstract WorkflowTriggerCallbackUrlInner listCallbackUrl(String resourceGroupName, String workflowName, GetCallbackUrlParameters listCallbackUrl)

Get the workflow callback Url.

Parameters:

resourceGroupName - The resource group name.

workflowName - The workflow name.

listCallbackUrl - Which callback url to list.

Returns:

the workflow callback Url.

listCallbackUrlWithResponse

public abstract Response<WorkflowTriggerCallbackUrlInner> listCallbackUrlWithResponse(String resourceGroupName, String workflowName, GetCallbackUrlParameters listCallbackUrl, Context context)

Get the workflow callback Url.

Parameters:

resourceGroupName - The resource group name.

workflowName - The workflow name.

listCallbackUrl - Which callback url to list.

context - The context to associate with this operation.

Returns:

the workflow callback Url along with Response<T>.

listSwagger

public abstract Object listSwagger(String resourceGroupName, String workflowName)

Gets an OpenAPI definition for the workflow.

Parameters:

resourceGroupName - The resource group name.

workflowName - The workflow name.

Returns:

an OpenAPI definition for the workflow.

listSwaggerWithResponse

public abstract Response<Object> listSwaggerWithResponse(String resourceGroupName, String workflowName, Context context)

Gets an OpenAPI definition for the workflow.

Parameters:

resourceGroupName - The resource group name.

workflowName - The workflow name.

context - The context to associate with this operation.

Returns:

an OpenAPI definition for the workflow along with Response<T>.

move

public abstract void move(String resourceGroupName, String workflowName, WorkflowReference move)

Moves an existing workflow.

Parameters:

resourceGroupName - The resource group name.

workflowName - The workflow name.

move - The workflow to move.

move

public abstract void move(String resourceGroupName, String workflowName, WorkflowReference move, Context context)

Moves an existing workflow.

Parameters:

resourceGroupName - The resource group name.

workflowName - The workflow name.

move - The workflow to move.

context - The context to associate with this operation.

regenerateAccessKey

public abstract void regenerateAccessKey(String resourceGroupName, String workflowName, RegenerateActionParameter keyType)

Regenerates the callback URL access key for request triggers.

Parameters:

resourceGroupName - The resource group name.

workflowName - The workflow name.

keyType - The access key type.

regenerateAccessKeyWithResponse

public abstract Response<Void> regenerateAccessKeyWithResponse(String resourceGroupName, String workflowName, RegenerateActionParameter keyType, Context context)

Regenerates the callback URL access key for request triggers.

Parameters:

resourceGroupName - The resource group name.

workflowName - The workflow name.

keyType - The access key type.

context - The context to associate with this operation.

Returns:

the Response<T>.

update

public abstract WorkflowInner update(String resourceGroupName, String workflowName)

Updates a workflow.

Parameters:

resourceGroupName - The resource group name.

workflowName - The workflow name.

Returns:

the workflow type.

updateWithResponse

public abstract Response<WorkflowInner> updateWithResponse(String resourceGroupName, String workflowName, Context context)

Updates a workflow.

Parameters:

resourceGroupName - The resource group name.

workflowName - The workflow name.

context - The context to associate with this operation.

Returns:

the workflow type along with Response<T>.

validateByLocation

public abstract void validateByLocation(String resourceGroupName, String location, String workflowName, WorkflowInner validate)

Validates the workflow definition.

Parameters:

resourceGroupName - The resource group name.

location - The workflow location.

workflowName - The workflow name.

validate - The workflow.

validateByLocationWithResponse

public abstract Response<Void> validateByLocationWithResponse(String resourceGroupName, String location, String workflowName, WorkflowInner validate, Context context)

Validates the workflow definition.

Parameters:

resourceGroupName - The resource group name.

location - The workflow location.

workflowName - The workflow name.

validate - The workflow.

context - The context to associate with this operation.

Returns:

the Response<T>.

validateByResourceGroup

public abstract void validateByResourceGroup(String resourceGroupName, String workflowName, WorkflowInner validate)

Validates the workflow.

Parameters:

resourceGroupName - The resource group name.

workflowName - The workflow name.

validate - The workflow.

validateByResourceGroupWithResponse

public abstract Response<Void> validateByResourceGroupWithResponse(String resourceGroupName, String workflowName, WorkflowInner validate, Context context)

Validates the workflow.

Parameters:

resourceGroupName - The resource group name.

workflowName - The workflow name.

validate - The workflow.

context - The context to associate with this operation.

Returns:

the Response<T>.