Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace SearchMonitoredResourcesDetails

The property search criteria for listing monitored resources.

Properties

compartmentId

compartmentId: string

Compartment Identifier OCID.

Optional compartmentIds

compartmentIds: Array<string>

Multiple compartment identifiers OCID.

Optional externalId

externalId: undefined | string

External resource is any OCI resource identifier OCID which is not a Stack Monitoring service resource. Currently supports only following resource types - Container database, non-container database, pluggable database and OCI compute instance.

Optional hostName

hostName: undefined | string

A filter to return resources with host name match.

Optional hostNameContains

hostNameContains: undefined | string

A filter to return resources with host name pattern.

Optional license

license: model.LicenseType

License edition of the monitored resource.

Optional lifecycleState

lifecycleState: model.ResourceLifecycleState

A filter to return resources with matching lifecycle state.

Optional lifecycleStates

lifecycleStates: Array<ResourceLifecycleState>

Multiple lifecycle states filter.

Optional managementAgentId

managementAgentId: undefined | string

A filter to return resources with matching management agent id.

Optional name

name: undefined | string

A filter to return resources that match exact resource name.

Optional nameContains

nameContains: undefined | string

A filter to return resources that match resource name pattern given. The match is not case sensitive.

Optional propertyEquals

propertyEquals: undefined | object

Criteria based on resource property.

Optional resourceCategory

resourceCategory: model.ResourceCategory

Resource category filter.

Optional resourceTimeZone

resourceTimeZone: undefined | string

Time zone in the form of tz database canonical zone ID. Specifies the preference with a value that uses the IANA Time Zone Database format (x-obmcs-time-zone). For example - America/Los_Angeles

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 resources is ascending.

Optional sortOrder

sortOrder: model.SortOrder

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

Optional sourceType

sourceType: model.SourceType

Source type filter.

Optional timeCreatedGreaterThanOrEqualTo

timeCreatedGreaterThanOrEqualTo: Date

Search for resources that were created within a specific date range, using this parameter to specify the earliest creation date for the returned list (inclusive). Specifying this parameter without the corresponding {@code timeCreatedLessThan} parameter will retrieve resources created from the given {@code timeCreatedGreaterThanOrEqualTo} to the current time, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.

*Example:** 2016-12-19T16:39:57.600Z

Optional timeCreatedLessThan

timeCreatedLessThan: Date

Search for resources that were created within a specific date range, using this parameter to specify the latest creation date for the returned list (exclusive). Specifying this parameter without the corresponding {@code timeCreatedGreaterThanOrEqualTo} parameter will retrieve all resources created before the specified end date, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.

*Example:** 2016-12-19T16:39:57.600Z

Optional timeUpdatedGreaterThanOrEqualTo

timeUpdatedGreaterThanOrEqualTo: Date

Search for resources that were updated within a specific date range, using this parameter to specify the earliest update date for the returned list (inclusive). Specifying this parameter without the corresponding {@code timeUpdatedLessThan} parameter will retrieve resources updated from the given {@code timeUpdatedGreaterThanOrEqualTo} to the current time, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.

*Example:** 2016-12-19T16:39:57.600Z

Optional timeUpdatedLessThan

timeUpdatedLessThan: Date

Search for resources that were updated within a specific date range, using this parameter to specify the latest creation date for the returned list (exclusive). Specifying this parameter without the corresponding {@code timeUpdatedGreaterThanOrEqualTo} parameter will retrieve all resources updated before the specified end date, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.

*Example:** 2016-12-19T16:39:57.600Z

Optional type

type: undefined | string

A filter to return resources that match resource type.

Functions

getDeserializedJsonObj

getJsonObj