Qbusiness  >  Unions  >  DocumentAttributeValue

DocumentAttributeValue

Union Type

DocumentAttributeValue module-attribute

DocumentAttributeValue = Union[DocumentAttributeValueStringValue | DocumentAttributeValueStringListValue | DocumentAttributeValueLongValue | DocumentAttributeValueDateValue | DocumentAttributeValueUnknown]

The value of a document attribute. You can only provide one value for a document attribute.

Union Member Types

DocumentAttributeValueStringValue dataclass

A string.

Attributes

value instance-attribute

value: str

DocumentAttributeValueStringListValue dataclass

A list of strings.

Attributes

value instance-attribute

value: list[str]

DocumentAttributeValueLongValue dataclass

A long integer value.

Attributes

value instance-attribute

value: int

DocumentAttributeValueDateValue dataclass

A date expressed as an ISO 8601 string.

It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

Attributes

value instance-attribute

value: datetime

DocumentAttributeValueUnknown dataclass

Represents an unknown variant.

If you receive this value, you will need to update your library to receive the parsed value.

This value may not be deliberately sent.

Attributes

tag instance-attribute

tag: str