Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace ResourceSummary

A resource that exists in the cloud network that you're querying.

Properties

Optional additionalDetails

additionalDetails: undefined | object

Additional resource attribute fields of this resource that match queries with a return clause, if any. For example, if you ran a query to find the private IP addresses, public IP addresses, and isPrimary field of the VNIC attachment on instance resources, that field would be included in the ResourceSummary object as: {"additionalDetails": {"attachedVnic": [{"publicIP" : "172.110.110.110","privateIP" : "10.10.10.10","isPrimary" : true}, {"publicIP" : "172.110.110.111","privateIP" : "10.10.10.11","isPrimary" : false}]}. The structure of the additional details attribute fields depends on the matching resource.

Optional availabilityDomain

availabilityDomain: undefined | string

The availability domain where this resource exists, if applicable.

compartmentId

compartmentId: string

The OCID of the compartment that contains this resource.

Optional definedTags

definedTags: undefined | object

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {@code {"Operations": {"CostCenter": "42"}}}

Optional displayName

displayName: undefined | string

The display name (or name) of this resource, if one exists.

Optional freeformTags

freeformTags: undefined | object

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {@code {"Department": "Finance"}}

identifier

identifier: string

The unique identifier for this particular resource, usually an OCID.

Optional identityContext

identityContext: undefined | object

Additional identifiers to use together in a "Get" request for a specified resource, only required for resource types that explicitly cannot be retrieved by using a single identifier, such as the resource's OCID.

Optional lifecycleState

lifecycleState: undefined | string

The lifecycle state of this resource, if applicable.

resourceType

resourceType: string

The resource type name.

Optional searchContext

searchContext: model.SearchContext

Optional systemTags

systemTags: undefined | object

System tags associated with this resource, if any. System tags are set by Oracle Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {@code {orcl-cloud: {free-tier-retain: true}}}

Optional timeCreated

timeCreated: Date

The time that this resource was created.

Functions

getDeserializedJsonObj

getJsonObj