Class ContainerMetaPage

Paging attributes.

Hierarchy

  • ContainerMetaPage

Constructors

constructor

Properties

additionalProperties? cursor? limit? nextCursor? prevCursor? total? type?

Constructors

constructor

Properties

Optional additionalProperties

additionalProperties?: {
    [key: string]: any;
}

A container for additional, undeclared properties. This is a holder for any undeclared properties as specified with the 'additionalProperties' keyword in the OAS document.

Type declaration

  • [key: string]: any

Optional cursor

cursor?: string

The cursor used to get the current results, if any.

Optional limit

limit?: number

Maximum number of results requested.

Optional nextCursor

nextCursor?: string

The cursor used to get the next results, if any. To make the next request, use the same parameters with the addition of the page[cursor]. Empty for grouped results.

Optional prevCursor

prevCursor?: string

The cursor used to get the previous results, if any.

Optional total

total?: number

Total number of containers that match the query. Always 0 for grouped results.

Optional type

type?: ContainerMetaPageType

Type of Container pagination.

Settings

Member Visibility

Theme

Generated using TypeDoc