Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace ListSqlCollectionAnalyticsRequest

example

Click here to see how to use ListSqlCollectionAnalyticsRequest.

Properties

Optional accessLevel

accessLevel: AccessLevel

Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.

compartmentId

compartmentId: string

A filter to return only resources that match the specified compartment OCID.

Optional compartmentIdInSubtree

compartmentIdInSubtree: undefined | false | true

Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.

Optional groupBy

groupBy: Array<GroupBy>

The group by parameter to summarize SQL collection aggregation.

Optional lifecycleState

lifecycleState: model.SqlCollectionLifecycleState

The current state of the SQL collection.

Optional limit

limit: undefined | number

For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

Optional opcRequestId

opcRequestId: undefined | string

Unique identifier for the request.

Optional page

page: undefined | string

For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

Optional retryConfiguration

retryConfiguration: RetryConfiguration

RetryConfiguration to be used for the request NOTE : Retries are not supported for requests that have binary or stream bodies this also affects UploadManager operations For all requests with binary/stream bodies, retry attempts are not made

Optional targetId

targetId: undefined | string

A filter to return only items related to a specific target OCID.

Optional timeEnded

timeEnded: Date

An optional filter to return the stats of the SQL collection logs collected before the date-time specified, in the format defined by RFC3339.

Optional timeStarted

timeStarted: Date

An optional filter to return the stats of the SQL collection logs collected after the date-time specified, in the format defined by RFC3339.