ResourceSummary¶

class oci.resource_search.models.ResourceSummary(**kwargs)¶

Bases: object

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

Methods

__init__(**kwargs) Initializes a new ResourceSummary object with values from keyword arguments.

Attributes

`additional_details`	Gets the additional_details of this ResourceSummary.
`availability_domain`	Gets the availability_domain of this ResourceSummary.
`compartment_id`	[Required] Gets the compartment_id of this ResourceSummary.
`defined_tags`	Gets the defined_tags of this ResourceSummary.
`display_name`	Gets the display_name of this ResourceSummary.
`freeform_tags`	Gets the freeform_tags of this ResourceSummary.
`identifier`	[Required] Gets the identifier of this ResourceSummary.
`identity_context`	Gets the identity_context of this ResourceSummary.
`lifecycle_state`	Gets the lifecycle_state of this ResourceSummary.
`resource_type`	[Required] Gets the resource_type of this ResourceSummary.
`search_context`	Gets the search_context of this ResourceSummary.
`system_tags`	Gets the system_tags of this ResourceSummary.
`time_created`	Gets the time_created of this ResourceSummary.

__init__(**kwargs)¶

Initializes a new ResourceSummary object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

resource_type (str) – The value to assign to the resource_type property of this ResourceSummary.
identifier (str) – The value to assign to the identifier property of this ResourceSummary.
compartment_id (str) – The value to assign to the compartment_id property of this ResourceSummary.
time_created (datetime) – The value to assign to the time_created property of this ResourceSummary.
display_name (str) – The value to assign to the display_name property of this ResourceSummary.
availability_domain (str) – The value to assign to the availability_domain property of this ResourceSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this ResourceSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this ResourceSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this ResourceSummary.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this ResourceSummary.
search_context (oci.resource_search.models.SearchContext) – The value to assign to the search_context property of this ResourceSummary.
identity_context (dict(str, object)) – The value to assign to the identity_context property of this ResourceSummary.
additional_details (dict(str, object)) – The value to assign to the additional_details property of this ResourceSummary.

additional_details¶

Gets the additional_details of this ResourceSummary. 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.

Returns:	The additional_details of this ResourceSummary.
Return type:	dict(str, object)

availability_domain¶

Gets the availability_domain of this ResourceSummary. The availability domain where this resource exists, if applicable.

Returns:	The availability_domain of this ResourceSummary.
Return type:	str

compartment_id¶

[Required] Gets the compartment_id of this ResourceSummary. The OCID of the compartment that contains this resource.

Returns:	The compartment_id of this ResourceSummary.
Return type:	str

defined_tags¶

Gets the defined_tags of this ResourceSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {“Operations”: {“CostCenter”: “42”}}

Returns:	The defined_tags of this ResourceSummary.
Return type:	dict(str, dict(str, object))

display_name¶

Gets the display_name of this ResourceSummary. The display name (or name) of this resource, if one exists.

Returns:	The display_name of this ResourceSummary.
Return type:	str

freeform_tags¶

Gets the freeform_tags of this ResourceSummary. 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”}

Returns:	The freeform_tags of this ResourceSummary.
Return type:	dict(str, str)

identifier¶

[Required] Gets the identifier of this ResourceSummary. The unique identifier for this particular resource, usually an OCID.

Returns:	The identifier of this ResourceSummary.
Return type:	str

identity_context¶

Gets the identity_context of this ResourceSummary. 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.

Returns:	The identity_context of this ResourceSummary.
Return type:	dict(str, object)

lifecycle_state¶

Gets the lifecycle_state of this ResourceSummary. The lifecycle state of this resource, if applicable.

Returns:	The lifecycle_state of this ResourceSummary.
Return type:	str

resource_type¶

[Required] Gets the resource_type of this ResourceSummary. The resource type name.

Returns:	The resource_type of this ResourceSummary.
Return type:	str

search_context¶

Gets the search_context of this ResourceSummary.

Returns:	The search_context of this ResourceSummary.
Return type:	oci.resource_search.models.SearchContext

system_tags¶

Gets the system_tags of this ResourceSummary. 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}}

Returns:	The system_tags of this ResourceSummary.
Return type:	dict(str, dict(str, object))

time_created¶

Gets the time_created of this ResourceSummary. The time that this resource was created.

Returns:	The time_created of this ResourceSummary.
Return type:	datetime