Understanding the BrokerAdminTypeDef

Many of the BrokerAdminClient methods described in this chapter use BrokerAdminTypeDef objects as a parameter or a returned value. The BrokerTypeDef class provides your client application with a read-only description of an event type definition. In contrast, the BrokerAdminTypeDef class allows your client application to both query and modify the properties of an event type definition.

Method	Description
clearField clearFields	Clears one or all fields in the type definition.
renameField	Renames a field within a BrokerAdminTypeDef object.
clearModificationFlag hasBeenModified setModificationFlag	Manages the modification flag, which is used to track changes made to the event type definition.
getBaseTypeName	Returns the event type name, without any event scope qualifier.
getScopeTypeName	Returns the event type's scope name.
getTypeName	Returns the event type's fully-qualified name.
setTypeName	Sets the fully-qualified name for the event type.
getDescription setDescription	Manages the description for the event type.
getFieldDef setFieldDef	Given a field name, obtains or sets the field's definition.
getFieldNames	Returns the names of the fields within an event or structure field.
getFieldType setFieldType	Manages the data type of an event field's value.
getStorageType setStorageType	Manages the event's storage type property.
getTimeToLive setTimeToLive	Manages the event's time-to-live property, which determines how long an event type will be available after being published before it expires and is destroyed.
insertFieldDef	Adds a field to an event type or a structure field.
isSystemDefined	Returns true if the event type is a system-defined type that may not be altered.
orderFields	Manages the order of the fields in an event type or structure field.
toString	Returns a string containing the type definition administration object in a human-readable format.