ResourceSummary

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

Bases: object

A resource that exists in the user's cloud network.

__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.
  • search_context (SearchContext) -- The value to assign to the search_context property of this ResourceSummary.
availability_domain

Gets the availability_domain of this ResourceSummary. The availability domain this resource is located in, 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. The defined tags associated with this resource, if any.

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. The freeform tags associated with this resource, if any.

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
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. Contains search context, such as highlighting, for found resources.

Returns:The search_context of this ResourceSummary.
Return type:SearchContext
time_created

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

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