Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace ListInventoryResourcesRequest

example

Click here to see how to use ListInventoryResourcesRequest.

Properties

compartmentId

compartmentId: string

The ID of the compartment in which to list resources.

Optional definedTagEquals

definedTagEquals: Array<string>

A list of tag filters to apply. Only resources with a defined tag matching the value will be returned. Each item in the list has the format "{namespace}.{tagName}={value}". All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".

Optional displayName

displayName: undefined | string

A filter to return only resources that match the entire display name given.

Optional freeformTagEquals

freeformTagEquals: Array<string>

A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned. The key for each tag is "{tagName}.{value}". All inputs are case-insensitive. Multiple values for the same tag name are interpreted as "OR". Values for different tag names are interpreted as "AND".

Optional inventoryProperties

inventoryProperties: Array<string>

A list of inventory properties filters to apply. The key for each inventory property and value for each resource type is "{resourceType}.{inventoryProperty}={value}".

Optional lifecycleState

lifecycleState: undefined | string

A filter to return only resources their lifecycleState matches the given lifecycleState.

Optional limit

limit: undefined | number

The maximum number of items to return.

Optional matchingCriteria

matchingCriteria: undefined | string

Fetch resources matching matching ANY or ALL criteria passed as params in "tags" and "inventoryProperties"

Optional opcRequestId

opcRequestId: undefined | string

The client request ID for tracing.

Optional page

page: undefined | string

A token representing the position at which to start retrieving results. This must come from the {@code opc-next-page} header field of a previous response.

resourceCompartmentId

resourceCompartmentId: string

Resource Compartment ID

Optional resourceRegion

resourceRegion: undefined | string

Resource Region

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

The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending.

Optional sortOrder

sortOrder: model.SortOrder

The sort order to use, either 'ASC' or 'DESC'.