String

class ansys.dynamicreporting.core.serverless.item.String(*args, **kwargs)

Bases: SimplePayloadMixin, Item

Item representing a plain string payload.

Methods

String.add_tag(tag[, value])	Add or update a single tag.
String.as_dict([recursive])	Serialize the model into a plain dictionary.
String.create(**kwargs)	Factory-style creation that dispatches to the correct subclass.
String.delete()	Delete this object from the database.
String.filter(**kwargs)	Return a collection of items, scoped by subclass type.
String.find([query])	Search for items using an ADR query string.
String.get(**kwargs)	Retrieve a single item instance, scoped by subclass type.
String.get_tags()	Return the raw tag string stored on this object.
String.reinit()	Reset the in-memory ORM state for this object.
String.rem_tag(tag)	Remove a tag by key, if it exists.
String.remove_tag(tag)	Alias for rem_tag() for backwards compatibility.
String.render(*[, context, request])	Render the item as HTML.
String.save(**kwargs)	Serialize the current content into the ORM payloaddata field.
String.set_tags(tag_str)	Replace all tags with the given tag string.

Attributes

String.content	Validated string content for this item.
String.dataset	Dataset associated with this item.
String.db	Database alias in which this object is stored.
String.name	Human-readable name for the item.
String.saved	Whether this object has been successfully saved to the database.
String.sequence	Sequence index for ordering items within a dataset/session.
String.session	Session that owns this item.
String.source	Optional free-form source identifier for this item.
String.tags	Tag string used to group and filter objects.
String.type	Item type identifier for string items.
String.date	Timestamp when the item was created.
String.guid	Globally unique identifier for this object.

exception DoesNotExist(extra_detail: str = None)

Bases: DoesNotExist

exception IntegrityError(extra_detail: str = None)

Bases: IntegrityError

exception MultipleObjectsReturned(extra_detail: str = None)

Bases: MultipleObjectsReturned

exception NotSaved(extra_detail: str = None)

Bases: NotSaved

content: StringContent = None

Validated string content for this item.

type: str = 'string'

Item type identifier for string items.