Package io.camunda.zeebe.client.api.command

Interface CommandWithTenantStep<T>

All Known Subinterfaces:
ActivateJobsCommandStep1.ActivateJobsCommandStep3, BroadcastSignalCommandStep1.BroadcastSignalCommandStep2, CommandWithOneOrMoreTenantsStep<T>, CreateProcessInstanceCommandStep1.CreateProcessInstanceCommandStep3, CreateProcessInstanceCommandStep1.CreateProcessInstanceWithResultCommandStep1, DeployResourceCommandStep1.DeployResourceCommandStep2, EvaluateDecisionCommandStep1.EvaluateDecisionCommandStep2, JobWorkerBuilderStep1.JobWorkerBuilderStep3, PublishMessageCommandStep1.PublishMessageCommandStep3, StreamJobsCommandStep1.StreamJobsCommandStep3
All Known Implementing Classes:
ActivateJobsCommandImpl, BroadcastSignalCommandImpl, CreateProcessInstanceCommandImpl, CreateProcessInstanceWithResultCommandImpl, DeployResourceCommandImpl, EvaluateDecisionCommandImpl, JobWorkerBuilderImpl, PublishMessageCommandImpl, StreamJobsCommandImpl
public interface CommandWithTenantStep<T>

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    DEFAULT_TENANT_IDENTIFIER
    This identifier is used for entities that are created before multi-tenancy is enabled in the Zeebe cluster.

  • Method Summary

    Modifier and Type
    Method
    Description
    T
    tenantId(String tenantId)
    Experimental: This method is under development, and as such using it may have no effect on the command builder when called.

  • Field Details

    • DEFAULT_TENANT_IDENTIFIER

      static final String DEFAULT_TENANT_IDENTIFIER
      This identifier is used for entities that are created before multi-tenancy is enabled in the Zeebe cluster. After enabling multi-tenancy, these entities can still be interacted by using this identifier explicitly.
      See Also:

  • Method Details

    • tenantId

      @ExperimentalApi("https://github.com/camunda/zeebe/issues/12653") T tenantId(String tenantId)
      Experimental: This method is under development, and as such using it may have no effect on the command builder when called. While unimplemented, it simply returns the command builder instance unchanged. This method already exists for software that is building support for multi-tenancy, and already wants to use this API during its development. As support for multi-tenancy is added to Zeebe, each of the commands that implement this method may start to take effect. Until this warning is removed, anything described below may not yet have taken effect, and the interface and its description are subject to change.

      Specifies the tenant that will own any entities (e.g. process definition, process instances, etc.) resulting from this command, or that owns any entities (e.g. jobs) referred to from this command.

      Multi-tenancy

      Multiple tenants can share a Zeebe cluster. Entities can be assigned to a specific tenant using an identifier. Only that tenant can access these entities.

      Any entities created before multi-tenancy has been enabled in the Zeebe cluster, are assigned to the DEFAULT_TENANT_IDENTIFIER.

      If no tenant is explicitly specified, then the command is rejected.

      Parameters:
      tenantId - the identifier of the tenant to specify for this command, e.g. "ACME"
      Returns:
      the builder for this command with the tenant specified
      Since:
      8.3