• API Documentation
Search Results for

    Show / Hide Table of Contents
    • Temporalio
      • IPayloadCodec
      • Refs<T>
      • Refs<T>.IProxy
    • Temporalio.Api.Batch.V1
      • BatchOperationCancellation
      • BatchOperationDeletion
      • BatchOperationInfo
      • BatchOperationSignal
      • BatchOperationTermination
      • MessageReflection
    • Temporalio.Api.Command.V1
      • AcceptWorkflowUpdateCommandAttributes
      • CancelTimerCommandAttributes
      • CancelWorkflowExecutionCommandAttributes
      • Command
      • Command.AttributesOneofCase
      • CompleteWorkflowExecutionCommandAttributes
      • CompleteWorkflowUpdateCommandAttributes
      • ContinueAsNewWorkflowExecutionCommandAttributes
      • FailWorkflowExecutionCommandAttributes
      • MessageReflection
      • ModifyWorkflowPropertiesCommandAttributes
      • RecordMarkerCommandAttributes
      • RejectWorkflowUpdateCommandAttributes
      • RequestCancelActivityTaskCommandAttributes
      • RequestCancelExternalWorkflowExecutionCommandAttributes
      • ScheduleActivityTaskCommandAttributes
      • SignalExternalWorkflowExecutionCommandAttributes
      • StartChildWorkflowExecutionCommandAttributes
      • StartTimerCommandAttributes
      • UpsertWorkflowSearchAttributesCommandAttributes
    • Temporalio.Api.Common.V1
      • ActivityType
      • DataBlob
      • GrpcStatus
      • GrpcStatusReflection
      • Header
      • Memo
      • MessageReflection
      • Payload
      • Payloads
      • RetryPolicy
      • SearchAttributes
      • WorkflowExecution
      • WorkflowType
    • Temporalio.Api.Dependencies.Gogoproto
      • GogoExtensions
      • GogoReflection
    • Temporalio.Api.Enums.V1
      • ArchivalState
      • BatchOperationReflection
      • BatchOperationState
      • BatchOperationType
      • CancelExternalWorkflowExecutionFailedCause
      • CommandType
      • CommandTypeReflection
      • CommonReflection
      • ContinueAsNewInitiator
      • EncodingType
      • EventType
      • EventTypeReflection
      • FailedCauseReflection
      • HistoryEventFilterType
      • IndexedValueType
      • InteractionType
      • InteractionTypeReflection
      • NamespaceReflection
      • NamespaceState
      • ParentClosePolicy
      • PendingActivityState
      • PendingWorkflowTaskState
      • QueryReflection
      • QueryRejectCondition
      • QueryResultType
      • ReplicationState
      • ResetReapplyType
      • ResetReflection
      • ResourceExhaustedCause
      • RetryState
      • ScheduleOverlapPolicy
      • ScheduleReflection
      • Severity
      • SignalExternalWorkflowExecutionFailedCause
      • StartChildWorkflowExecutionFailedCause
      • TaskQueueKind
      • TaskQueueReflection
      • TaskQueueType
      • TimeoutType
      • UpdateReflection
      • WorkflowExecutionStatus
      • WorkflowIdReusePolicy
      • WorkflowReflection
      • WorkflowTaskFailedCause
      • WorkflowUpdateResultAccessStyle
    • Temporalio.Api.ErrorDetails.V1
      • CancellationAlreadyRequestedFailure
      • ClientVersionNotSupportedFailure
      • MessageReflection
      • NamespaceAlreadyExistsFailure
      • NamespaceInvalidStateFailure
      • NamespaceNotActiveFailure
      • NamespaceNotFoundFailure
      • NotFoundFailure
      • PermissionDeniedFailure
      • QueryFailedFailure
      • ResourceExhaustedFailure
      • ServerVersionNotSupportedFailure
      • SystemWorkflowFailure
      • WorkflowExecutionAlreadyStartedFailure
      • WorkflowNotReadyFailure
    • Temporalio.Api.Failure.V1
      • ActivityFailureInfo
      • ApplicationFailureInfo
      • CanceledFailureInfo
      • ChildWorkflowExecutionFailureInfo
      • Failure
      • Failure.FailureInfoOneofCase
      • MessageReflection
      • ResetWorkflowFailureInfo
      • ServerFailureInfo
      • TerminatedFailureInfo
      • TimeoutFailureInfo
    • Temporalio.Api.Filter.V1
      • MessageReflection
      • StartTimeFilter
      • StatusFilter
      • WorkflowExecutionFilter
      • WorkflowTypeFilter
    • Temporalio.Api.History.V1
      • ActivityPropertiesModifiedExternallyEventAttributes
      • ActivityTaskCanceledEventAttributes
      • ActivityTaskCancelRequestedEventAttributes
      • ActivityTaskCompletedEventAttributes
      • ActivityTaskFailedEventAttributes
      • ActivityTaskScheduledEventAttributes
      • ActivityTaskStartedEventAttributes
      • ActivityTaskTimedOutEventAttributes
      • ChildWorkflowExecutionCanceledEventAttributes
      • ChildWorkflowExecutionCompletedEventAttributes
      • ChildWorkflowExecutionFailedEventAttributes
      • ChildWorkflowExecutionStartedEventAttributes
      • ChildWorkflowExecutionTerminatedEventAttributes
      • ChildWorkflowExecutionTimedOutEventAttributes
      • ExternalWorkflowExecutionCancelRequestedEventAttributes
      • ExternalWorkflowExecutionSignaledEventAttributes
      • History
      • HistoryEvent
      • HistoryEvent.AttributesOneofCase
      • MarkerRecordedEventAttributes
      • MessageReflection
      • RequestCancelExternalWorkflowExecutionFailedEventAttributes
      • RequestCancelExternalWorkflowExecutionInitiatedEventAttributes
      • SignalExternalWorkflowExecutionFailedEventAttributes
      • SignalExternalWorkflowExecutionInitiatedEventAttributes
      • StartChildWorkflowExecutionFailedEventAttributes
      • StartChildWorkflowExecutionInitiatedEventAttributes
      • TimerCanceledEventAttributes
      • TimerFiredEventAttributes
      • TimerStartedEventAttributes
      • UpsertWorkflowSearchAttributesEventAttributes
      • WorkflowExecutionCanceledEventAttributes
      • WorkflowExecutionCancelRequestedEventAttributes
      • WorkflowExecutionCompletedEventAttributes
      • WorkflowExecutionContinuedAsNewEventAttributes
      • WorkflowExecutionFailedEventAttributes
      • WorkflowExecutionSignaledEventAttributes
      • WorkflowExecutionStartedEventAttributes
      • WorkflowExecutionTerminatedEventAttributes
      • WorkflowExecutionTimedOutEventAttributes
      • WorkflowPropertiesModifiedEventAttributes
      • WorkflowPropertiesModifiedExternallyEventAttributes
      • WorkflowTaskCompletedEventAttributes
      • WorkflowTaskFailedEventAttributes
      • WorkflowTaskScheduledEventAttributes
      • WorkflowTaskStartedEventAttributes
      • WorkflowTaskTimedOutEventAttributes
      • WorkflowUpdateAcceptedEventAttributes
      • WorkflowUpdateCompletedEventAttributes
      • WorkflowUpdateRejectedEventAttributes
    • Temporalio.Api.Interaction.V1
      • Input
      • Invocation
      • MessageReflection
      • Meta
      • Output
      • Output.ResultOneofCase
    • Temporalio.Api.Namespace.V1
      • BadBinaries
      • BadBinaryInfo
      • MessageReflection
      • NamespaceConfig
      • NamespaceFilter
      • NamespaceInfo
      • UpdateNamespaceInfo
    • Temporalio.Api.OperatorService.V1
      • AddOrUpdateRemoteClusterRequest
      • AddOrUpdateRemoteClusterResponse
      • AddSearchAttributesRequest
      • AddSearchAttributesResponse
      • ClusterMetadata
      • DeleteNamespaceRequest
      • DeleteNamespaceResponse
      • ListClustersRequest
      • ListClustersResponse
      • ListSearchAttributesRequest
      • ListSearchAttributesResponse
      • RemoveRemoteClusterRequest
      • RemoveRemoteClusterResponse
      • RemoveSearchAttributesRequest
      • RemoveSearchAttributesResponse
      • RequestResponseReflection
      • ServiceReflection
    • Temporalio.Api.Query.V1
      • MessageReflection
      • QueryRejected
      • WorkflowQuery
      • WorkflowQueryResult
    • Temporalio.Api.Replication.V1
      • ClusterReplicationConfig
      • FailoverStatus
      • MessageReflection
      • NamespaceReplicationConfig
    • Temporalio.Api.Schedule.V1
      • BackfillRequest
      • CalendarSpec
      • IntervalSpec
      • MessageReflection
      • Range
      • Schedule
      • ScheduleAction
      • ScheduleAction.ActionOneofCase
      • ScheduleActionResult
      • ScheduleInfo
      • ScheduleListEntry
      • ScheduleListInfo
      • SchedulePatch
      • SchedulePolicies
      • ScheduleSpec
      • ScheduleState
      • StructuredCalendarSpec
      • TriggerImmediatelyRequest
    • Temporalio.Api.TaskQueue.V1
      • MessageReflection
      • PollerInfo
      • StickyExecutionAttributes
      • TaskIdBlock
      • TaskQueue
      • TaskQueueMetadata
      • TaskQueuePartitionMetadata
      • TaskQueueStatus
      • VersionId
      • VersionIdNode
    • Temporalio.Api.TestService.V1
      • GetCurrentTimeResponse
      • LockTimeSkippingRequest
      • LockTimeSkippingResponse
      • RequestResponseReflection
      • ServiceReflection
      • SleepRequest
      • SleepResponse
      • SleepUntilRequest
      • UnlockTimeSkippingRequest
      • UnlockTimeSkippingResponse
    • Temporalio.Api.Version.V1
      • Alert
      • MessageReflection
      • ReleaseInfo
      • VersionInfo
    • Temporalio.Api.Workflow.V1
      • MessageReflection
      • NewWorkflowExecutionInfo
      • PendingActivityInfo
      • PendingChildExecutionInfo
      • PendingWorkflowTaskInfo
      • ResetPointInfo
      • ResetPoints
      • WorkflowExecutionConfig
      • WorkflowExecutionInfo
    • Temporalio.Api.WorkflowService.V1
      • CountWorkflowExecutionsRequest
      • CountWorkflowExecutionsResponse
      • CreateScheduleRequest
      • CreateScheduleResponse
      • DeleteScheduleRequest
      • DeleteScheduleResponse
      • DeleteWorkflowExecutionRequest
      • DeleteWorkflowExecutionResponse
      • DeprecateNamespaceRequest
      • DeprecateNamespaceResponse
      • DescribeBatchOperationRequest
      • DescribeBatchOperationResponse
      • DescribeNamespaceRequest
      • DescribeNamespaceResponse
      • DescribeScheduleRequest
      • DescribeScheduleResponse
      • DescribeTaskQueueRequest
      • DescribeTaskQueueResponse
      • DescribeWorkflowExecutionRequest
      • DescribeWorkflowExecutionResponse
      • GetClusterInfoRequest
      • GetClusterInfoResponse
      • GetSearchAttributesRequest
      • GetSearchAttributesResponse
      • GetSystemInfoRequest
      • GetSystemInfoResponse
      • GetSystemInfoResponse.Types
      • GetSystemInfoResponse.Types.Capabilities
      • GetWorkerBuildIdOrderingRequest
      • GetWorkerBuildIdOrderingResponse
      • GetWorkflowExecutionHistoryRequest
      • GetWorkflowExecutionHistoryResponse
      • GetWorkflowExecutionHistoryReverseRequest
      • GetWorkflowExecutionHistoryReverseResponse
      • ListArchivedWorkflowExecutionsRequest
      • ListArchivedWorkflowExecutionsResponse
      • ListBatchOperationsRequest
      • ListBatchOperationsResponse
      • ListClosedWorkflowExecutionsRequest
      • ListClosedWorkflowExecutionsRequest.FiltersOneofCase
      • ListClosedWorkflowExecutionsResponse
      • ListNamespacesRequest
      • ListNamespacesResponse
      • ListOpenWorkflowExecutionsRequest
      • ListOpenWorkflowExecutionsRequest.FiltersOneofCase
      • ListOpenWorkflowExecutionsResponse
      • ListScheduleMatchingTimesRequest
      • ListScheduleMatchingTimesResponse
      • ListSchedulesRequest
      • ListSchedulesResponse
      • ListTaskQueuePartitionsRequest
      • ListTaskQueuePartitionsResponse
      • ListWorkflowExecutionsRequest
      • ListWorkflowExecutionsResponse
      • PatchScheduleRequest
      • PatchScheduleResponse
      • PollActivityTaskQueueRequest
      • PollActivityTaskQueueResponse
      • PollWorkflowTaskQueueRequest
      • PollWorkflowTaskQueueResponse
      • QueryWorkflowRequest
      • QueryWorkflowResponse
      • RecordActivityTaskHeartbeatByIdRequest
      • RecordActivityTaskHeartbeatByIdResponse
      • RecordActivityTaskHeartbeatRequest
      • RecordActivityTaskHeartbeatResponse
      • RegisterNamespaceRequest
      • RegisterNamespaceResponse
      • RequestCancelWorkflowExecutionRequest
      • RequestCancelWorkflowExecutionResponse
      • RequestResponseReflection
      • ResetStickyTaskQueueRequest
      • ResetStickyTaskQueueResponse
      • ResetWorkflowExecutionRequest
      • ResetWorkflowExecutionResponse
      • RespondActivityTaskCanceledByIdRequest
      • RespondActivityTaskCanceledByIdResponse
      • RespondActivityTaskCanceledRequest
      • RespondActivityTaskCanceledResponse
      • RespondActivityTaskCompletedByIdRequest
      • RespondActivityTaskCompletedByIdResponse
      • RespondActivityTaskCompletedRequest
      • RespondActivityTaskCompletedResponse
      • RespondActivityTaskFailedByIdRequest
      • RespondActivityTaskFailedByIdResponse
      • RespondActivityTaskFailedRequest
      • RespondActivityTaskFailedResponse
      • RespondQueryTaskCompletedRequest
      • RespondQueryTaskCompletedResponse
      • RespondWorkflowTaskCompletedRequest
      • RespondWorkflowTaskCompletedResponse
      • RespondWorkflowTaskFailedRequest
      • RespondWorkflowTaskFailedResponse
      • ScanWorkflowExecutionsRequest
      • ScanWorkflowExecutionsResponse
      • ServiceReflection
      • SignalWithStartWorkflowExecutionRequest
      • SignalWithStartWorkflowExecutionResponse
      • SignalWorkflowExecutionRequest
      • SignalWorkflowExecutionResponse
      • StartBatchOperationRequest
      • StartBatchOperationRequest.OperationOneofCase
      • StartBatchOperationResponse
      • StartWorkflowExecutionRequest
      • StartWorkflowExecutionResponse
      • StopBatchOperationRequest
      • StopBatchOperationResponse
      • TerminateWorkflowExecutionRequest
      • TerminateWorkflowExecutionResponse
      • UpdateNamespaceRequest
      • UpdateNamespaceResponse
      • UpdateScheduleRequest
      • UpdateScheduleResponse
      • UpdateWorkerBuildIdOrderingRequest
      • UpdateWorkerBuildIdOrderingResponse
      • UpdateWorkflowRequest
      • UpdateWorkflowResponse
    • Temporalio.Client
      • IBridgeClientProvider
      • ITemporalClient
      • ITemporalClientExtensions
      • ITemporalConnection
      • OperatorService
      • OperatorService.Impl
      • RpcOptions
      • RpcRetryOptions
      • RpcService
      • TemporalClient
      • TemporalClientConnectOptions
      • TemporalClientOptions
      • TemporalConnection
      • TemporalConnectionOptions
      • TestService
      • TestService.Impl
      • TlsOptions
      • WorkflowCancelOptions
      • WorkflowDescribeOptions
      • WorkflowQueryOptions
      • WorkflowService
      • WorkflowService.Impl
      • WorkflowSignalOptions
      • WorkflowStartOptions
      • WorkflowTerminateOptions
    • Temporalio.Client.Interceptors
      • ClientOutboundInterceptor
      • IClientInterceptor
    • Temporalio.Converters
      • BinaryNullConverter
      • BinaryPlainConverter
      • BinaryProtoConverter
      • ConverterExtensions
      • DefaultFailureConverter
      • DefaultFailureConverterOptions
      • DefaultPayloadConverter
      • IEncodingConverter
      • IFailureConverter
      • IPayloadConverter
      • JsonPlainConverter
      • JsonProtoConverter
      • PayloadCodecExtensions
      • WithEncodedCommonAttributes
    • Temporalio.Exceptions
      • ActivityFailureException
      • ApplicationFailureException
      • CancelledFailureException
      • ChildWorkflowFailureException
      • FailureException
      • IFailureDetails
      • RpcException
      • RpcException.StatusCode
      • ServerFailureException
      • TemporalException
      • TerminatedFailureException
      • TimeoutFailureException
      • WorkflowAlreadyStartedException
      • WorkflowContinuedAsNewException
      • WorkflowFailedException
      • WorkflowQueryFailedException
      • WorkflowQueryRejectedException
    • Temporalio.Runtime
      • LoggingOptions
      • MetricsOptions
      • OpenTelemetryOptions
      • PrometheusOptions
      • TelemetryFilterOptions
      • TelemetryFilterOptions.Level
      • TelemetryOptions
      • TemporalRuntime
      • TemporalRuntimeOptions
      • TracingOptions
    • Temporalio.Testing
      • TemporaliteOptions
      • TestServerOptions
      • WorkflowEnvironment
      • WorkflowEnvironmentStartLocalOptions
      • WorkflowEnvironmentStartTimeSkippingOptions
    • Temporalio.Worker
      • IWorkerClient
    • Temporalio.Worker.Interceptors
      • IWorkerInterceptor
    • Temporalio.Workflow
      • WorkflowAttribute
      • WorkflowInitAttribute
      • WorkflowQueryAttribute
      • WorkflowRunAttribute
      • WorkflowSignalAttribute

    Class DefaultPayloadConverter

    Default implementation of a payload converter which iterates over a collection of IEncodingConverter.

    Inheritance
    Object
    DefaultPayloadConverter
    Implements
    IPayloadConverter
    Namespace: Temporalio.Converters
    Assembly: Temporalio.dll
    Syntax
    public class DefaultPayloadConverter : object, IPayloadConverter
    Remarks

    See DefaultPayloadConverter() for the default set of encoding converters used. To create a custom converter, a new class should extend this one.

    Constructors

    DefaultPayloadConverter()

    Initializes a new instance of the DefaultPayloadConverter class.

    Declaration
    public DefaultPayloadConverter()
    Remarks

    The default payload converter uses the following set of payload converters in order:

    • BinaryNullConverter
    • BinaryPlainConverter
    • JsonProtoConverter
    • BinaryProtoConverter
    • JsonPlainConverter

    Each of those converters are tried in that order when converting to payload, stopping at the first one that can convert. This means nulls, byte arrays, and protobuf messages are all have their own encoding and anything else falls through to the JSON converter. The JSON converter will fail on anything it can't convert.

    This also means binary proto converter will never be used when converting to a payload since the JSON proto converter will accept proto objects first. It is present however for converting from payloads which may have its encoding (e.g. from another language that is using binary proto instead of JSON proto).

    DefaultPayloadConverter(IEnumerable<IEncodingConverter>)

    Initializes a new instance of the DefaultPayloadConverter class with a set of encoding converters.

    Declaration
    protected DefaultPayloadConverter(IEnumerable<IEncodingConverter> encodingConverters)
    Parameters
    Type Name Description
    IEnumerable<IEncodingConverter> encodingConverters

    Encoding converters to use. Duplicate encodings not allowed.

    Remarks

    This is protected because payload converters are referenced as class types, not instances, so only subclasses would call this.

    See Also
    DefaultPayloadConverter()

    DefaultPayloadConverter(JsonSerializerOptions)

    Initializes a new instance of the DefaultPayloadConverter class.

    Declaration
    protected DefaultPayloadConverter(JsonSerializerOptions jsonSerializerOptions)
    Parameters
    Type Name Description
    JsonSerializerOptions jsonSerializerOptions

    Custom serializer options.

    Remarks

    This is protected because payload converters are referenced as class types, not instances, so only subclasses would call this.

    See Also
    DefaultPayloadConverter()

    DefaultPayloadConverter(IEncodingConverter[])

    Initializes a new instance of the DefaultPayloadConverter class.

    Declaration
    protected DefaultPayloadConverter(params IEncodingConverter[] encodingConverters)
    Parameters
    Type Name Description
    IEncodingConverter[] encodingConverters

    Encoding converters.

    See Also
    DefaultPayloadConverter(IEnumerable<IEncodingConverter>)

    Properties

    EncodingConverters

    Gets the encoding converters tried, in order, when converting to payload.

    Declaration
    public IReadOnlyCollection<IEncodingConverter> EncodingConverters { get; }
    Property Value
    Type Description
    IReadOnlyCollection<IEncodingConverter>

    Implements

    IPayloadConverter
    In This Article
    Back to top