Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace ListRulesRequest

example

Click here to see how to use ListRulesRequest.

Properties

compartmentId

compartmentId: string

The OCID of the compartment to which this rule belongs.

Optional displayName

displayName: undefined | string

A filter to return only rules with descriptions that match the displayName string in this parameter.

Example: {@code \"This rule sends a notification upon completion of DbaaS backup.\"}

Optional lifecycleState

lifecycleState: undefined | string

A filter to return only rules that match the lifecycle state in this parameter.

Example: {@code Creating}

Optional limit

limit: undefined | number

The maximum number of items to return. 1 is the minimum, 50 is the maximum. Default: 10

Optional opcRequestId

opcRequestId: undefined | string

The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Optional page

page: undefined | string

For list pagination. The value of the opc-next-page response header from the previous "List" call. For important 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 sortBy

sortBy: SortBy

Specifies the attribute with which to sort the rules.

Default: {@code timeCreated}

**TIME_CREATED:** Sorts by timeCreated. * **DISPLAY_NAME:** Sorts by displayName. * **ID:** Sorts by id.

Optional sortOrder

sortOrder: SortOrder

Specifies sort order.

**ASC:** Ascending sort order. * **DESC:** Descending sort order.