Package com.azure.resourcemanager.logic.models

Interface Workflow

public interface Workflow
An immutable client-side representation of Workflow.

  • Method Details

    • id

      String id()
      Gets the id property: Fully qualified resource Id for the resource.
      Returns:
      the id value.

    • name

      String name()
      Gets the name property: The name of the resource.
      Returns:
      the name value.

    • type

      String type()
      Gets the type property: The type of the resource.
      Returns:
      the type value.

    • location

      String location()
      Gets the location property: The geo-location where the resource lives.
      Returns:
      the location value.

    • tags

      Map<String,String> tags()
      Gets the tags property: Resource tags.
      Returns:
      the tags value.

    • identity

      ManagedServiceIdentity identity()
      Gets the identity property: Managed service identity properties.
      Returns:
      the identity value.

    • provisioningState

      WorkflowProvisioningState provisioningState()
      Gets the provisioningState property: Gets the provisioning state.
      Returns:
      the provisioningState value.

    • createdTime

      OffsetDateTime createdTime()
      Gets the createdTime property: Gets the created time.
      Returns:
      the createdTime value.

    • changedTime

      OffsetDateTime changedTime()
      Gets the changedTime property: Gets the changed time.
      Returns:
      the changedTime value.

    • state

      WorkflowState state()
      Gets the state property: The state.
      Returns:
      the state value.

    • version

      String version()
      Gets the version property: Gets the version.
      Returns:
      the version value.

    • accessEndpoint

      String accessEndpoint()
      Gets the accessEndpoint property: Gets the access endpoint.
      Returns:
      the accessEndpoint value.

    • endpointsConfiguration

      FlowEndpointsConfiguration endpointsConfiguration()
      Gets the endpointsConfiguration property: The endpoints configuration.
      Returns:
      the endpointsConfiguration value.

    • accessControl

      FlowAccessControlConfiguration accessControl()
      Gets the accessControl property: The access control configuration.
      Returns:
      the accessControl value.

    • sku

      Sku sku()
      Gets the sku property: The sku.
      Returns:
      the sku value.

    • integrationAccount

      ResourceReference integrationAccount()
      Gets the integrationAccount property: The integration account.
      Returns:
      the integrationAccount value.

    • integrationServiceEnvironment

      ResourceReference integrationServiceEnvironment()
      Gets the integrationServiceEnvironment property: The integration service environment.
      Returns:
      the integrationServiceEnvironment value.

    • definition

      Object definition()
      Gets the definition property: The definition.
      Returns:
      the definition value.

    • parameters

      Map<String,WorkflowParameter> parameters()
      Gets the parameters property: The parameters.
      Returns:
      the parameters value.

    • region

      com.azure.core.management.Region region()
      Gets the region of the resource.
      Returns:
      the region of the resource.

    • regionName

      String regionName()
      Gets the name of the resource region.
      Returns:
      the name of the resource region.

    • resourceGroupName

      String resourceGroupName()
      Gets the name of the resource group.
      Returns:
      the name of the resource group.

    • innerModel

      WorkflowInner innerModel()
      Gets the inner com.azure.resourcemanager.logic.fluent.models.WorkflowInner object.
      Returns:
      the inner object.

    • update

      Workflow.Update update()
      Begins update for the Workflow resource.
      Returns:
      the stage of resource update.

    • refresh

      Workflow refresh()
      Refreshes the resource to sync with Azure.
      Returns:
      the refreshed resource.

    • refresh

      Workflow refresh(com.azure.core.util.Context context)
      Refreshes the resource to sync with Azure.
      Parameters:
      context - The context to associate with this operation.
      Returns:
      the refreshed resource.

    • disableWithResponse

      com.azure.core.http.rest.Response<Void> disableWithResponse(com.azure.core.util.Context context)
      Disables a workflow.
      Parameters:
      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.

    • disable

      void disable()
      Disables a workflow.
      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.

    • enableWithResponse

      com.azure.core.http.rest.Response<Void> enableWithResponse(com.azure.core.util.Context context)
      Enables a workflow.
      Parameters:
      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.

    • enable

      void enable()
      Enables a workflow.
      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.

    • generateUpgradedDefinitionWithResponse

      com.azure.core.http.rest.Response<Object> generateUpgradedDefinitionWithResponse(GenerateUpgradedDefinitionParameters parameters, com.azure.core.util.Context context)
      Generates the upgraded definition for a workflow.
      Parameters:
      parameters - Parameters for generating an upgraded definition.
      context - The context to associate with this operation.
      Returns:
      any object 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.

    • generateUpgradedDefinition

      Object generateUpgradedDefinition(GenerateUpgradedDefinitionParameters parameters)
      Generates the upgraded definition for a workflow.
      Parameters:
      parameters - Parameters for generating an upgraded definition.
      Returns:
      any object.
      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.

    • listCallbackUrlWithResponse

      com.azure.core.http.rest.Response<WorkflowTriggerCallbackUrl> listCallbackUrlWithResponse(GetCallbackUrlParameters listCallbackUrl, com.azure.core.util.Context context)
      Get the workflow callback Url.
      Parameters:
      listCallbackUrl - Which callback url to list.
      context - The context to associate with this operation.
      Returns:
      the workflow callback Url 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.

    • listCallbackUrl

      WorkflowTriggerCallbackUrl listCallbackUrl(GetCallbackUrlParameters listCallbackUrl)
      Get the workflow callback Url.
      Parameters:
      listCallbackUrl - Which callback url to list.
      Returns:
      the workflow callback Url.
      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.

    • listSwaggerWithResponse

      com.azure.core.http.rest.Response<Object> listSwaggerWithResponse(com.azure.core.util.Context context)
      Gets an OpenAPI definition for the workflow.
      Parameters:
      context - The context to associate with this operation.
      Returns:
      an OpenAPI definition for the 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.

    • listSwagger

      Object listSwagger()
      Gets an OpenAPI definition for the workflow.
      Returns:
      an OpenAPI definition for the workflow.
      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.

    • move

      void move(WorkflowReference move)
      Moves an existing workflow.
      Parameters:
      move - The workflow to move.
      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.

    • move

      void move(WorkflowReference move, com.azure.core.util.Context context)
      Moves an existing workflow.
      Parameters:
      move - The workflow to move.
      context - The context to associate with this 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.

    • regenerateAccessKeyWithResponse

      com.azure.core.http.rest.Response<Void> regenerateAccessKeyWithResponse(RegenerateActionParameter keyType, com.azure.core.util.Context context)
      Regenerates the callback URL access key for request triggers.
      Parameters:
      keyType - The access key type.
      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.

    • regenerateAccessKey

      void regenerateAccessKey(RegenerateActionParameter keyType)
      Regenerates the callback URL access key for request triggers.
      Parameters:
      keyType - The access key type.
      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.

    • validateByResourceGroupWithResponse

      com.azure.core.http.rest.Response<Void> validateByResourceGroupWithResponse(WorkflowInner validate, com.azure.core.util.Context context)
      Validates the workflow.
      Parameters:
      validate - The workflow.
      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.

    • validateByResourceGroup

      void validateByResourceGroup(WorkflowInner validate)
      Validates the workflow.
      Parameters:
      validate - The 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.