Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace ListBudgetsRequest

example

Click here to see how to use ListBudgetsRequest.

Properties

compartmentId

compartmentId: string

The ID of the compartment in which to list resources.

Optional displayName

displayName: undefined | string

A user-friendly name. This does not have to be unique, and it's changeable.

Example: {@code My new resource}

Optional lifecycleState

lifecycleState: model.LifecycleState

The current state of the resource to filter by.

Optional limit

limit: undefined | number

The maximum number of items to return.

Optional opcRequestId

opcRequestId: undefined | string

The client request ID for tracing.

Optional page

page: undefined | string

The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

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: model.SortBy

The field to sort by. If not specified, the default is timeCreated. The default sort order for timeCreated is DESC. The default sort order for displayName is ASC in alphanumeric order.

Optional sortOrder

sortOrder: model.SortOrder

The sort order to use, either 'asc' or 'desc'.

Optional targetType

targetType: TargetType

The type of target to filter by:

  • ALL - List all budgets
  • COMPARTMENT - List all budgets with targetType == "COMPARTMENT"
  • TAG - List all budgets with targetType == "TAG"