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

Interface CommandWithOneOrMoreTenantsStep<T>

All Superinterfaces:
CommandWithTenantStep<T>
All Known Subinterfaces:
ActivateJobsCommandStep1.ActivateJobsCommandStep3, JobWorkerBuilderStep1.JobWorkerBuilderStep3, StreamJobsCommandStep1.StreamJobsCommandStep3
All Known Implementing Classes:
ActivateJobsCommandImpl, JobWorkerBuilderImpl, StreamJobsCommandImpl
public interface CommandWithOneOrMoreTenantsStep<T> extends CommandWithTenantStep<T>

  • Method Details

    • tenantId

      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 CommandWithTenantStep.DEFAULT_TENANT_IDENTIFIER.

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

      One or more tenants

      This method can be called multiple times to specify multiple tenants.

      This can be useful when requesting jobs for multiple tenants at once. Each of the activated jobs will be owned by the tenant that owns the corresponding process instance.

      Specified by:
      tenantId in interface CommandWithTenantStep<T>
      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

    • tenantIds

      T tenantIds(List<String> tenantIds)
      Specifies the tenants that may own any entities (e.g. process definition, process instances, etc.) resulting from this command.

      One or more tenants

      This can be useful when requesting jobs for multiple tenants at once. Each of the activated jobs will be owned by the tenant that owns the corresponding process instance.

      Parameters:
      tenantIds - the identifiers of the tenants to specify for this command, e.g. ["ACME", "OTHER"]
      Returns:
      the builder for this command with the tenants specified
      Since:
      8.3
      See Also:

    • tenantIds

      T tenantIds(String... tenantIds)
      Shorthand method for tenantIds(List).
      Parameters:
      tenantIds - the identifiers of the tenants to specify for this command, e.g. ["ACME", "OTHER"]
      Returns:
      the builder for this command with the tenants specified
      Since:
      8.3
      See Also: