Deprecated API

Contents

• Classes
• Enum Classes
• Fields
• Methods
• Constructors

Deprecated Classes

Class	Description
io.temporal.client.BuildIdOperation
io.temporal.client.WorkerBuildIdVersionSets	Worker Versioning is now deprecated please migrate to the Worker Deployment API.
io.temporal.common.SearchAttribute	typed search attributes should be used instead.
io.temporal.internal.common.WorkflowExecutionHistory	use WorkflowExecutionHistory instead.

Deprecated Enum Classes

Enum Class	Description
io.temporal.common.VersioningIntent

Deprecated Fields

Field	Description
io.temporal.worker.MetricsType.ACTIVITY_CANCELED_COUNTER	use MetricsType.ACTIVITY_EXEC_CANCELLED_COUNTER
io.temporal.worker.MetricsType.LOCAL_ACTIVITY_CANCELED_COUNTER	use MetricsType.LOCAL_ACTIVITY_EXEC_CANCELLED_COUNTER
io.temporal.worker.MetricsType.LOCAL_ACTIVITY_FAILED_COUNTER	use MetricsType.LOCAL_ACTIVITY_EXEC_FAILED_COUNTER
io.temporal.worker.MetricsType.STICKY_CACHE_TOTAL_FORCED_EVICTION

Deprecated Methods

Method	Description
io.temporal.activity.ActivityInfo.getActivityNamespace()	use ActivityInfo.getNamespace()
io.temporal.activity.ActivityInfo.getRunId()	use ActivityInfo.getWorkflowRunId()
io.temporal.activity.ActivityInfo.getWorkflowNamespace()	use ActivityInfo.getNamespace()
io.temporal.activity.ActivityOptions.Builder.setVersioningIntent(VersioningIntent)	Use Worker Deployments
io.temporal.activity.ActivityOptions.getDefaultInstance()
io.temporal.activity.ActivityOptions.getVersioningIntent()	Worker Versioning is now deprecated please migrate to the Worker Deployment API.
io.temporal.client.schedules.ScheduleDescription.getSearchAttributes()	use ScheduleDescription.getTypedSearchAttributes() instead.
io.temporal.client.schedules.ScheduleOptions.Builder.setSearchAttributes(Map<String, ?>)	use ScheduleOptions.Builder.setTypedSearchAttributes(io.temporal.common.SearchAttributes) instead.
io.temporal.client.schedules.ScheduleOptions.getSearchAttributes()	use ScheduleOptions.getTypedSearchAttributes() instead.
io.temporal.client.WorkflowClient.getWorkerBuildIdCompatability(String)	Worker Versioning is now deprecated please migrate to the Worker Deployment API.
io.temporal.client.WorkflowClient.getWorkerTaskReachability(Iterable<String>, Iterable<String>, TaskReachability)	Worker Versioning is now deprecated please migrate to the Worker Deployment API.
io.temporal.client.WorkflowClient.newUntypedWorkflowStub(WorkflowExecution, Optional<String>)	Use WorkflowClient.newUntypedWorkflowStub(WorkflowTargetOptions, Optional) instead. This method is deprecated because the returned stub does not properly account for the runId.
io.temporal.client.WorkflowClient.newUntypedWorkflowStub(String, Optional<String>, Optional<String>)	Use WorkflowClient.newUntypedWorkflowStub(WorkflowTargetOptions, Optional) instead. This method is deprecated because the returned stub does not properly account for the runId.
io.temporal.client.WorkflowClient.newWorkflowStub(Class<T>, String, Optional<String>)	Use WorkflowClient.newWorkflowStub(Class, WorkflowTargetOptions) instead. This method is deprecated because the returned stub does not properly account for the runId.
io.temporal.client.WorkflowClient.updateWorkerBuildIdCompatability(String, BuildIdOperation)	Worker Versioning is now deprecated please migrate to the Worker Deployment API.
io.temporal.client.WorkflowClientOptions.Builder.setBinaryChecksum(String)	use WorkerOptions.Builder.setBuildId(String) instead.
io.temporal.client.WorkflowClientOptions.getBinaryChecksum()
io.temporal.client.WorkflowExecutionMetadata.getSearchAttributes()	use WorkflowExecutionMetadata.getTypedSearchAttributes() instead.
io.temporal.client.WorkflowOptions.Builder.setSearchAttributes(Map<String, ?>)	use WorkflowOptions.Builder.setTypedSearchAttributes(io.temporal.common.SearchAttributes) instead.
io.temporal.client.WorkflowOptions.getSearchAttributes()	use WorkflowOptions.getTypedSearchAttributes() instead.
io.temporal.common.converter.DataConverter.arrayFromPayloads(DataConverter, Optional<Payloads>, Class<?>[], Type[])	use DataConverter.fromPayloads(int, Optional, Class, Type). This is an SDK implementation detail and never was expected to be exposed to users.
io.temporal.common.converter.DataConverter.getDefaultInstance()	use GlobalDataConverter.get()
io.temporal.common.converter.DefaultDataConverter.setDefaultDataConverter(DataConverter)	use GlobalDataConverter.register(DataConverter)
io.temporal.common.interceptors.WorkflowClientInterceptor.newUntypedWorkflowStub(WorkflowExecution, Optional<String>, WorkflowStub)	consider implementing all intercepting functionality using WorkflowClientCallsInterceptor that is produced in WorkflowClientInterceptor.workflowClientCallsInterceptor(io.temporal.common.interceptors.WorkflowClientCallsInterceptor). This method has to stay temporary because TimeLockingInterceptor has to intercept top level WorkflowStub methods.
io.temporal.common.interceptors.WorkflowClientInterceptor.newUntypedWorkflowStub(String, WorkflowOptions, WorkflowStub)	consider implementing all intercepting functionality using WorkflowClientCallsInterceptor that is produced in WorkflowClientInterceptor.workflowClientCallsInterceptor(io.temporal.common.interceptors.WorkflowClientCallsInterceptor). This method has to stay temporary because TimeLockingInterceptor has to intercept top level WorkflowStub methods.
io.temporal.common.interceptors.WorkflowClientInterceptorBase.newUntypedWorkflowStub(WorkflowExecution, Optional<String>, WorkflowStub)
io.temporal.common.interceptors.WorkflowClientInterceptorBase.newUntypedWorkflowStub(String, WorkflowOptions, WorkflowStub)
io.temporal.common.metadata.POJOWorkflowInterfaceMetadata.newInstanceSkipWorkflowAnnotationCheck(Class<?>)	use POJOWorkflowInterfaceMetadata.newInstance(Class, boolean) with validateWorkflowAnnotation==false.
io.temporal.internal.client.external.GenericWorkflowClient.getWorkerBuildIdCompatability(GetWorkerBuildIdCompatibilityRequest)
io.temporal.internal.client.external.GenericWorkflowClient.GetWorkerTaskReachability(GetWorkerTaskReachabilityRequest)
io.temporal.internal.client.external.GenericWorkflowClient.updateWorkerBuildIdCompatability(UpdateWorkerBuildIdCompatibilityRequest)
io.temporal.internal.sync.WorkflowInternal.newQueue(int)	this method created a deprecated implementation of the queue that has some methods implemented incorrectly. Please use WorkflowInternal.newWorkflowQueue(int) instead.
io.temporal.internal.worker.SingleWorkerOptions.Builder.setBinaryChecksum(String)
io.temporal.internal.worker.SingleWorkerOptions.getBinaryChecksum()
io.temporal.worker.Worker.addWorkflowImplementationFactory(WorkflowImplementationOptions, Class<R>, Functions.Func<R>)	use Worker.registerWorkflowImplementationFactory(Class, Func, WorkflowImplementationOptions) instead
io.temporal.worker.Worker.addWorkflowImplementationFactory(Class<R>, Functions.Func<R>)	Use Worker.registerWorkflowImplementationFactory(Class, Func, WorkflowImplementationOptions) with WorkflowImplementationOptions.newBuilder().setFailWorkflowExceptionTypes(Throwable.class).build() as a 3rd parameter to preserve the unexpected behavior of this method. Or use Worker.registerWorkflowImplementationFactory(Class, Func) with an expected behavior - Workflow Execution is failed only when a TemporalFailure subtype is thrown.
io.temporal.worker.WorkerFactoryOptions.Builder.setWorkflowHostLocalPollThreadCount(int)	not used anymore by JavaSDK, this value doesn't have any effect
io.temporal.worker.WorkerFactoryOptions.Builder.setWorkflowHostLocalTaskQueueScheduleToStartTimeout(Duration)	use WorkerOptions.Builder.setStickyQueueScheduleToStartTimeout(Duration) to specify this value per-worker instead
io.temporal.worker.WorkerFactoryOptions.getWorkflowHostLocalPollThreadCount()	not used anymore by JavaSDK, this value doesn't have any effect
io.temporal.worker.WorkerOptions.Builder.setActivityPollThreadCount(int)	Use WorkerOptions.Builder.setMaxConcurrentActivityTaskPollers(int)
io.temporal.worker.WorkerOptions.Builder.setBuildId(String)	Worker Versioning is now deprecated please migrate to the Worker Deployment API.
io.temporal.worker.WorkerOptions.Builder.setUseBuildIdForVersioning(boolean)	Worker Versioning is now deprecated please migrate to the Worker Deployment API.
io.temporal.worker.WorkerOptions.Builder.setWorkflowPollThreadCount(int)	Use WorkerOptions.Builder.setMaxConcurrentWorkflowTaskPollers(int)
io.temporal.worker.WorkerOptions.getActivityPollThreadCount()	use WorkerOptions.getMaxConcurrentActivityTaskPollers()
io.temporal.worker.WorkerOptions.getWorkflowPollThreadCount()	use WorkerOptions.getMaxConcurrentWorkflowTaskPollers()
io.temporal.workflow.ChildWorkflowOptions.Builder.setNamespace(String)	Cross-namespace child workflow execution is disabled by default in Temporal Server since version 1.30.1 (via system.enableCrossNamespaceCommands dynamic config flag). Setting this option will fail unless that flag is explicitly re-enabled on the server. This field may be removed at some point in the future.
io.temporal.workflow.ChildWorkflowOptions.Builder.setSearchAttributes(Map<String, Object>)	use ChildWorkflowOptions.Builder.setTypedSearchAttributes(io.temporal.common.SearchAttributes) instead.
io.temporal.workflow.ChildWorkflowOptions.Builder.setVersioningIntent(VersioningIntent)	Worker Versioning is now deprecated please migrate to the Worker Deployment API.
io.temporal.workflow.ChildWorkflowOptions.getNamespace()	Cross-namespace child workflow execution is disabled by default in Temporal Server since version 1.30.1 (via system.enableCrossNamespaceCommands dynamic config flag). Setting this option will fail unless that flag is explicitly re-enabled on the server. This field may be removed at some point in the future.
io.temporal.workflow.ChildWorkflowOptions.getSearchAttributes()	use ChildWorkflowOptions.getTypedSearchAttributes() instead.
io.temporal.workflow.ChildWorkflowOptions.getVersioningIntent()	Worker Versioning is now deprecated please migrate to the Worker Deployment API.
io.temporal.workflow.ContinueAsNewOptions.Builder.setSearchAttributes(Map<String, Object>)	use ContinueAsNewOptions.Builder.setTypedSearchAttributes(io.temporal.common.SearchAttributes) instead.
io.temporal.workflow.ContinueAsNewOptions.Builder.setVersioningIntent(VersioningIntent)	Worker Versioning is now deprecated please migrate to the Worker Deployment API.
io.temporal.workflow.ContinueAsNewOptions.getSearchAttributes()	use ContinueAsNewOptions.getSearchAttributes() instead.
io.temporal.workflow.ContinueAsNewOptions.getVersioningIntent()	Worker Versioning is now deprecated please migrate to the Worker Deployment API.
io.temporal.workflow.Workflow.continueAsNew(Optional<String>, Optional<ContinueAsNewOptions>, Object...)	use Workflow.continueAsNew(String, ContinueAsNewOptions, Object...)
io.temporal.workflow.Workflow.getSearchAttribute(String)	use Workflow.getTypedSearchAttributes() instead.
io.temporal.workflow.Workflow.getSearchAttributes()	use Workflow.getTypedSearchAttributes() instead.
io.temporal.workflow.Workflow.getSearchAttributeValues(String)	use Workflow.getTypedSearchAttributes() instead.
io.temporal.workflow.Workflow.isReplaying()	use WorkflowUnsafe.isReplaying()
io.temporal.workflow.Workflow.newQueue(int)	use Workflow.newWorkflowQueue(int) instead. An implementation returned by this method has a bug.
io.temporal.workflow.Workflow.setActivityOptions(Map<String, ActivityOptions>)	use Workflow.applyActivityOptions(Map)
io.temporal.workflow.Workflow.upsertSearchAttributes(Map<String, ?>)	use Workflow.upsertTypedSearchAttributes(io.temporal.common.SearchAttributeUpdate<?>...) instead.
io.temporal.workflow.WorkflowInfo.getSearchAttributes()	use Workflow.getTypedSearchAttributes() instead.
io.temporal.workflow.WorkflowLocal.withInitial(Supplier<? extends S>)	Because the non-caching behavior of this API is typically not desirable, it's recommend to use WorkflowLocal.withCachedInitial(Supplier) instead.
io.temporal.workflow.WorkflowThreadLocal.withInitial(Supplier<? extends S>)	Because the non-caching behavior of this API is typically not desirable, it's recommend to use WorkflowThreadLocal.withCachedInitial(Supplier) instead.

Deprecated Constructors

Constructor	Description
io.temporal.common.interceptors.WorkflowClientCallsInterceptor.CancelInput(WorkflowExecution)	Use CancelInput(WorkflowExecution, String) to provide a cancellation reason instead.
io.temporal.common.interceptors.WorkflowOutboundCallsInterceptor.CancelWorkflowInput(WorkflowExecution)
io.temporal.workflow.ContinueAsNewOptions(Duration, String, RetryOptions, Duration, Map<String, Object>, Map<String, Object>, SearchAttributes, List<ContextPropagator>, VersioningIntent, InitialVersioningBehavior)	This constructor doesn't include all options. Use the builder instead.