Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Usually you will work with JSON documents, already loaded into your pipeline most of the time.

But, sometimes you need to load such JSON documents from resources like the cloud, remote endpoints, files or streams before you can use them. Or you have to load other data types like images, PDFs or similar.

...

It depends on the command and use cases which deals deal with the content reference whether to use the outbound or inbound reference.

...

Below you can find the attributes of a content reference and their meanings:

Attribute

Type

Description

name

string

Optional. The name of the resource.

created

long

Optional. The unix timestamp in millis when this resource was created.

lastUpdated

long

Optional. The unix timestamp in millis when this resource was last modified.

contentType

string

The content type of the resource. If null or attribute doesn't exist, it is assumed to be text/plain by default. See here for a list of official content types: https://www.iana.org/assignments/media-types/media-types.xhtml .

If this content reference is a folder, this must be set to application/x-directory.

contentLength

long

Optional. The length of the resource in bytes or -1 or null in case the length cannot be determined.

contentEncoding

string

Optional. The encoding used to encode the content field. Can be base64 or outbound-url.

content

object

Required. The content (data) of the resource. Which format the data has, depends on its content type and encoding. For example, if contentType is application/json, then the data object returns a JSON document which can be encoded as string, node or base64 for example.

In case this content reference is folder, this must be null.

checksum

string

Optional. The checksum of the content (before encoding).

children

Array of Content References

Optional. Contains an array of all children content references which are contained in this “folder”. If this field contains a value, then also contentType must be set to application/x-directory.

parent

Deprecated.

path

Deprecated.

Loading content

In order to work with data from a content reference, you have to load (read) such data first.

...

Note

Do not load big data into memory! A content reference can also bee seen as a "gatekeeper" in order to make sure , big data is only loaded when required and then by default in a streamed way. Not as a whole.

...