Description

A GSearchIndex provides information about an index. Basic naming and identification information is provided as well as limits on index size and a snapshot of current size.

Field Name Required? Rules Description

@datatype

False

must be "GSearchIndex" if present

@version

False

must be "2017-09-01" if present

display_name

True

String

A common name for the index suitable for display in user interfaces.

id

True

String

A UUID uniquely identifying this index.

description

True

String

A description of the index

creation_date

True

String

A timestamp indicating when the index was created. A string containing an ISO 8601 formatted time.

max_size_in_mb

True

String

An integer indicating the maximum size the index will be permitted to grow to in units of Megabytes (1MB = 1,000,000 bytes)

size_in_mb

True

String

An integer with the current size of the index rounded down to the closest Megabyte value.

num_subjects

True

String

An integer containing the number of unique subjects which have been added to the index.

num_entries

True

String

An integer containing the number of GMetaEntries stored in the index.


© 2010- The University of Chicago Legal