Class: Temporalio::Converters::PayloadCodec

Inherits:

Object

• Object
• Temporalio::Converters::PayloadCodec

Defined in:

lib/temporalio/converters/payload_codec.rb

Overview

Base class for encoding and decoding payloads. Commonly used for encryption.

Instance Method Summary

• #decode(payloads) ⇒ Array<Api::Common::V1::Payload>

  Decode the given payloads into a new set of payloads.

• #encode(payloads) ⇒ Array<Api::Common::V1::Payload>

  Encode the given payloads into a new set of payloads.

Instance Method Details

#decode(payloads) ⇒ Array<Api::Common::V1::Payload>

Decode the given payloads into a new set of payloads.

Parameters:

• payloads (Enumerable<Api::Common::V1::Payload>) —

  Payloads to decode. This value should not be mutated.

Returns:

• (Array<Api::Common::V1::Payload>) —

  Decoded payloads. Note, this does not have to be the same number as payloads given, but it must be at least one and cannot be more than was given.

Raises:

• (NotImplementedError)

# File 'lib/temporalio/converters/payload_codec.rb', line 21

def decode(payloads)
  raise NotImplementedError
end

#encode(payloads) ⇒ Array<Api::Common::V1::Payload>

Encode the given payloads into a new set of payloads.

Parameters:

• payloads (Enumerable<Api::Common::V1::Payload>) —

  Payloads to encode. This value should not be mutated.

Returns:

• (Array<Api::Common::V1::Payload>) —

  Encoded payloads. Note, this does not have to be the same number as payloads given, but it must be at least one and cannot be more than was given.

Raises:

• (NotImplementedError)

# File 'lib/temporalio/converters/payload_codec.rb', line 12

def encode(payloads)
  raise NotImplementedError
end