Class ResourceSummary
A resource that exists in the cloud network that you're querying.
Inherited Members
Namespace: Oci.ResourcesearchService.Models
Assembly: OCI.DotNetSDK.Resourcesearch.dll
Syntax
public class ResourceSummary
Properties
AdditionalDetails
Declaration
[JsonProperty(PropertyName = "additionalDetails")]
public Dictionary<string, object> AdditionalDetails { get; set; }
Property Value
Type | Description |
---|---|
Dictionary<string, 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. |
AvailabilityDomain
Declaration
[JsonProperty(PropertyName = "availabilityDomain")]
public string AvailabilityDomain { get; set; }
Property Value
Type | Description |
---|---|
string | The availability domain where this resource exists, if applicable. |
CompartmentId
Declaration
[Required(ErrorMessage = "CompartmentId is required.")]
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }
Property Value
Type | Description |
---|---|
string | The OCID of the compartment that contains this resource. |
Remarks
Required
DefinedTags
Declaration
[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }
Property Value
Type | Description |
---|---|
Dictionary<string, Dictionary<string, object>> | Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations": {"CostCenter": "42"}} |
DisplayName
Declaration
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }
Property Value
Type | Description |
---|---|
string | The display name (or name) of this resource, if one exists. |
FreeformTags
Declaration
[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }
Property Value
Type | Description |
---|---|
Dictionary<string, string> | 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: {"Department": "Finance"} |
Identifier
Declaration
[Required(ErrorMessage = "Identifier is required.")]
[JsonProperty(PropertyName = "identifier")]
public string Identifier { get; set; }
Property Value
Type | Description |
---|---|
string | The unique identifier for this particular resource, usually an OCID. |
Remarks
Required
IdentityContext
Declaration
[JsonProperty(PropertyName = "identityContext")]
public Dictionary<string, object> IdentityContext { get; set; }
Property Value
Type | Description |
---|---|
Dictionary<string, 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. |
LifecycleState
Declaration
[JsonProperty(PropertyName = "lifecycleState")]
public string LifecycleState { get; set; }
Property Value
Type | Description |
---|---|
string | The lifecycle state of this resource, if applicable. |
ResourceType
Declaration
[Required(ErrorMessage = "ResourceType is required.")]
[JsonProperty(PropertyName = "resourceType")]
public string ResourceType { get; set; }
Property Value
Type | Description |
---|---|
string | The resource type name. |
Remarks
Required
SearchContext
Declaration
[JsonProperty(PropertyName = "searchContext")]
public SearchContext SearchContext { get; set; }
Property Value
Type | Description |
---|---|
SearchContext |
SystemTags
Declaration
[JsonProperty(PropertyName = "systemTags")]
public Dictionary<string, Dictionary<string, object>> SystemTags { get; set; }
Property Value
Type | Description |
---|---|
Dictionary<string, Dictionary<string, 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: {orcl-cloud: {free-tier-retain: true}} |
TimeCreated
Declaration
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }
Property Value
Type | Description |
---|---|
DateTime? | The time that this resource was created. |