Interface TableUsageOpt

Options passed to getTableUsage and tableUsageIterable.

Hierarchy

Properties

compartment? endTime? limit? startIndex? startTime? timeout?

Properties

Optional compartment

compartment?: string

Cloud service only. Compartment id or name to use for this operation.

Default Value

Config.compartment.

See

compartment

Optional endTime

endTime?: string | number | Date

End time for the time period, represented same as startTime.

Optional limit

limit?: number

Limit to the number of usage records desired. If not specified or value is 0, there is no limit, but not all usage records may be returned due to size limitations.

Optional startIndex

startIndex?: number

Index at which to start returning table usage records. To page table usage records, set this value to nextIndex returned from previous call to getTableUsage. These operations are best done in a loop. See the example at getTableUsage. This option is not used for tableUsageIterable.

Default Value

0

Optional startTime

startTime?: string | number | Date

Start time for the time period. Can be Date, string representing date and time or number of milliseconds since epoch (January 1, 1970, 00:00:00 UTC). For string representation see Date.parse(). If time range is not specified, the most recent complete usage record is returned.

Optional timeout

timeout?: number

Timeout for the operation in milliseconds.

Default Value

Config.timeout

Settings

Member Visibility

Theme

Generated using TypeDoc