SearchMonitoredResourcesDetails¶

class oci.stack_monitoring.models.SearchMonitoredResourcesDetails(**kwargs)¶

Bases: object

The property search criteria for listing monitored resources.

Attributes

`LICENSE_ENTERPRISE_EDITION`	A constant which can be used with the license property of a SearchMonitoredResourcesDetails.
`LICENSE_STANDARD_EDITION`	A constant which can be used with the license property of a SearchMonitoredResourcesDetails.
`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a SearchMonitoredResourcesDetails.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a SearchMonitoredResourcesDetails.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a SearchMonitoredResourcesDetails.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a SearchMonitoredResourcesDetails.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a SearchMonitoredResourcesDetails.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a SearchMonitoredResourcesDetails.
`RESOURCE_CATEGORY_APPLICATION`	A constant which can be used with the resource_category property of a SearchMonitoredResourcesDetails.
`RESOURCE_CATEGORY_DATABASE`	A constant which can be used with the resource_category property of a SearchMonitoredResourcesDetails.
`RESOURCE_CATEGORY_MIDDLEWARE`	A constant which can be used with the resource_category property of a SearchMonitoredResourcesDetails.
`RESOURCE_CATEGORY_UNKNOWN`	A constant which can be used with the resource_category property of a SearchMonitoredResourcesDetails.
`SORT_BY_RESOURCE_NAME`	A constant which can be used with the sort_by property of a SearchMonitoredResourcesDetails.
`SORT_BY_TIME_CREATED`	A constant which can be used with the sort_by property of a SearchMonitoredResourcesDetails.
`SORT_ORDER_ASC`	A constant which can be used with the sort_order property of a SearchMonitoredResourcesDetails.
`SORT_ORDER_DESC`	A constant which can be used with the sort_order property of a SearchMonitoredResourcesDetails.
`SOURCE_TYPE_COLLECTD`	A constant which can be used with the source_type property of a SearchMonitoredResourcesDetails.
`SOURCE_TYPE_OCI_NATIVE`	A constant which can be used with the source_type property of a SearchMonitoredResourcesDetails.
`SOURCE_TYPE_PROMETHEUS`	A constant which can be used with the source_type property of a SearchMonitoredResourcesDetails.
`SOURCE_TYPE_SM_MGMT_AGENT_MONITORED`	A constant which can be used with the source_type property of a SearchMonitoredResourcesDetails.
`SOURCE_TYPE_SM_REPO_ONLY`	A constant which can be used with the source_type property of a SearchMonitoredResourcesDetails.
`SOURCE_TYPE_TELEGRAF`	A constant which can be used with the source_type property of a SearchMonitoredResourcesDetails.
`compartment_id`	[Required] Gets the compartment_id of this SearchMonitoredResourcesDetails.
`compartment_ids`	Gets the compartment_ids of this SearchMonitoredResourcesDetails.
`external_id`	Gets the external_id of this SearchMonitoredResourcesDetails.
`host_name`	Gets the host_name of this SearchMonitoredResourcesDetails.
`host_name_contains`	Gets the host_name_contains of this SearchMonitoredResourcesDetails.
`license`	Gets the license of this SearchMonitoredResourcesDetails.
`lifecycle_state`	Gets the lifecycle_state of this SearchMonitoredResourcesDetails.
`lifecycle_states`	Gets the lifecycle_states of this SearchMonitoredResourcesDetails.
`management_agent_id`	Gets the management_agent_id of this SearchMonitoredResourcesDetails.
`name`	Gets the name of this SearchMonitoredResourcesDetails.
`name_contains`	Gets the name_contains of this SearchMonitoredResourcesDetails.
`property_equals`	Gets the property_equals of this SearchMonitoredResourcesDetails.
`resource_category`	Gets the resource_category of this SearchMonitoredResourcesDetails.
`resource_time_zone`	Gets the resource_time_zone of this SearchMonitoredResourcesDetails.
`sort_by`	Gets the sort_by of this SearchMonitoredResourcesDetails.
`sort_order`	Gets the sort_order of this SearchMonitoredResourcesDetails.
`source_type`	Gets the source_type of this SearchMonitoredResourcesDetails.
`time_created_greater_than_or_equal_to`	Gets the time_created_greater_than_or_equal_to of this SearchMonitoredResourcesDetails.
`time_created_less_than`	Gets the time_created_less_than of this SearchMonitoredResourcesDetails.
`time_updated_greater_than_or_equal_to`	Gets the time_updated_greater_than_or_equal_to of this SearchMonitoredResourcesDetails.
`time_updated_less_than`	Gets the time_updated_less_than of this SearchMonitoredResourcesDetails.
`type`	Gets the type of this SearchMonitoredResourcesDetails.

Methods

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

LICENSE_ENTERPRISE_EDITION = 'ENTERPRISE_EDITION'¶: A constant which can be used with the license property of a SearchMonitoredResourcesDetails. This constant has a value of “ENTERPRISE_EDITION”

LICENSE_STANDARD_EDITION = 'STANDARD_EDITION'¶: A constant which can be used with the license property of a SearchMonitoredResourcesDetails. This constant has a value of “STANDARD_EDITION”

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a SearchMonitoredResourcesDetails. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a SearchMonitoredResourcesDetails. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a SearchMonitoredResourcesDetails. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a SearchMonitoredResourcesDetails. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a SearchMonitoredResourcesDetails. This constant has a value of “FAILED”

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶: A constant which can be used with the lifecycle_state property of a SearchMonitoredResourcesDetails. This constant has a value of “UPDATING”

RESOURCE_CATEGORY_APPLICATION = 'APPLICATION'¶: A constant which can be used with the resource_category property of a SearchMonitoredResourcesDetails. This constant has a value of “APPLICATION”

RESOURCE_CATEGORY_DATABASE = 'DATABASE'¶: A constant which can be used with the resource_category property of a SearchMonitoredResourcesDetails. This constant has a value of “DATABASE”

RESOURCE_CATEGORY_MIDDLEWARE = 'MIDDLEWARE'¶: A constant which can be used with the resource_category property of a SearchMonitoredResourcesDetails. This constant has a value of “MIDDLEWARE”

RESOURCE_CATEGORY_UNKNOWN = 'UNKNOWN'¶: A constant which can be used with the resource_category property of a SearchMonitoredResourcesDetails. This constant has a value of “UNKNOWN”

SORT_BY_RESOURCE_NAME = 'RESOURCE_NAME'¶: A constant which can be used with the sort_by property of a SearchMonitoredResourcesDetails. This constant has a value of “RESOURCE_NAME”

SORT_BY_TIME_CREATED = 'TIME_CREATED'¶: A constant which can be used with the sort_by property of a SearchMonitoredResourcesDetails. This constant has a value of “TIME_CREATED”

SORT_ORDER_ASC = 'ASC'¶: A constant which can be used with the sort_order property of a SearchMonitoredResourcesDetails. This constant has a value of “ASC”

SORT_ORDER_DESC = 'DESC'¶: A constant which can be used with the sort_order property of a SearchMonitoredResourcesDetails. This constant has a value of “DESC”

SOURCE_TYPE_COLLECTD = 'COLLECTD'¶: A constant which can be used with the source_type property of a SearchMonitoredResourcesDetails. This constant has a value of “COLLECTD”

SOURCE_TYPE_OCI_NATIVE = 'OCI_NATIVE'¶: A constant which can be used with the source_type property of a SearchMonitoredResourcesDetails. This constant has a value of “OCI_NATIVE”

SOURCE_TYPE_PROMETHEUS = 'PROMETHEUS'¶: A constant which can be used with the source_type property of a SearchMonitoredResourcesDetails. This constant has a value of “PROMETHEUS”

SOURCE_TYPE_SM_MGMT_AGENT_MONITORED = 'SM_MGMT_AGENT_MONITORED'¶: A constant which can be used with the source_type property of a SearchMonitoredResourcesDetails. This constant has a value of “SM_MGMT_AGENT_MONITORED”

SOURCE_TYPE_SM_REPO_ONLY = 'SM_REPO_ONLY'¶: A constant which can be used with the source_type property of a SearchMonitoredResourcesDetails. This constant has a value of “SM_REPO_ONLY”

SOURCE_TYPE_TELEGRAF = 'TELEGRAF'¶: A constant which can be used with the source_type property of a SearchMonitoredResourcesDetails. This constant has a value of “TELEGRAF”

__init__(**kwargs)¶

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

Parameters:

compartment_id (str) – The value to assign to the compartment_id property of this SearchMonitoredResourcesDetails.
compartment_ids (list[str]) – The value to assign to the compartment_ids property of this SearchMonitoredResourcesDetails.
lifecycle_states (list[oci.stack_monitoring.models.ResourceLifecycleState]) – The value to assign to the lifecycle_states property of this SearchMonitoredResourcesDetails.
source_type (str) – The value to assign to the source_type property of this SearchMonitoredResourcesDetails. Allowed values for this property are: “SM_MGMT_AGENT_MONITORED”, “SM_REPO_ONLY”, “OCI_NATIVE”, “PROMETHEUS”, “TELEGRAF”, “COLLECTD”
resource_category (str) – The value to assign to the resource_category property of this SearchMonitoredResourcesDetails. Allowed values for this property are: “APPLICATION”, “DATABASE”, “MIDDLEWARE”, “UNKNOWN”
name (str) – The value to assign to the name property of this SearchMonitoredResourcesDetails.
name_contains (str) – The value to assign to the name_contains property of this SearchMonitoredResourcesDetails.
type (str) – The value to assign to the type property of this SearchMonitoredResourcesDetails.
host_name (str) – The value to assign to the host_name property of this SearchMonitoredResourcesDetails.
external_id (str) – The value to assign to the external_id property of this SearchMonitoredResourcesDetails.
host_name_contains (str) – The value to assign to the host_name_contains property of this SearchMonitoredResourcesDetails.
management_agent_id (str) – The value to assign to the management_agent_id property of this SearchMonitoredResourcesDetails.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this SearchMonitoredResourcesDetails. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”
license (str) – The value to assign to the license property of this SearchMonitoredResourcesDetails. Allowed values for this property are: “STANDARD_EDITION”, “ENTERPRISE_EDITION”
time_created_greater_than_or_equal_to (datetime) – The value to assign to the time_created_greater_than_or_equal_to property of this SearchMonitoredResourcesDetails.
time_created_less_than (datetime) – The value to assign to the time_created_less_than property of this SearchMonitoredResourcesDetails.
time_updated_greater_than_or_equal_to (datetime) – The value to assign to the time_updated_greater_than_or_equal_to property of this SearchMonitoredResourcesDetails.
time_updated_less_than (datetime) – The value to assign to the time_updated_less_than property of this SearchMonitoredResourcesDetails.
resource_time_zone (str) – The value to assign to the resource_time_zone property of this SearchMonitoredResourcesDetails.
sort_order (str) – The value to assign to the sort_order property of this SearchMonitoredResourcesDetails. Allowed values for this property are: “ASC”, “DESC”
sort_by (str) – The value to assign to the sort_by property of this SearchMonitoredResourcesDetails. Allowed values for this property are: “TIME_CREATED”, “RESOURCE_NAME”
property_equals (dict(str, str)) – The value to assign to the property_equals property of this SearchMonitoredResourcesDetails.

compartment_id¶

[Required] Gets the compartment_id of this SearchMonitoredResourcesDetails. Compartment Identifier OCID.

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

compartment_ids¶

Gets the compartment_ids of this SearchMonitoredResourcesDetails. Multiple compartment identifiers OCID.

Returns:	The compartment_ids of this SearchMonitoredResourcesDetails.
Return type:	list[str]

external_id¶

Gets the external_id of this SearchMonitoredResourcesDetails. 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.

Returns:	The external_id of this SearchMonitoredResourcesDetails.
Return type:	str

host_name¶

Gets the host_name of this SearchMonitoredResourcesDetails. A filter to return resources with host name match.

Returns:	The host_name of this SearchMonitoredResourcesDetails.
Return type:	str

host_name_contains¶

Gets the host_name_contains of this SearchMonitoredResourcesDetails. A filter to return resources with host name pattern.

Returns:	The host_name_contains of this SearchMonitoredResourcesDetails.
Return type:	str

license¶

Gets the license of this SearchMonitoredResourcesDetails. License edition of the monitored resource.

Allowed values for this property are: “STANDARD_EDITION”, “ENTERPRISE_EDITION”

Returns:	The license of this SearchMonitoredResourcesDetails.
Return type:	str

lifecycle_state¶

Gets the lifecycle_state of this SearchMonitoredResourcesDetails. A filter to return resources with matching lifecycle state.

Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”

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

lifecycle_states¶

Gets the lifecycle_states of this SearchMonitoredResourcesDetails. Multiple lifecycle states filter.

Returns:	The lifecycle_states of this SearchMonitoredResourcesDetails.
Return type:	list[oci.stack_monitoring.models.ResourceLifecycleState]

management_agent_id¶

Gets the management_agent_id of this SearchMonitoredResourcesDetails. A filter to return resources with matching management agent id.

Returns:	The management_agent_id of this SearchMonitoredResourcesDetails.
Return type:	str

name¶

Gets the name of this SearchMonitoredResourcesDetails. A filter to return resources that match exact resource name.

Returns:	The name of this SearchMonitoredResourcesDetails.
Return type:	str

name_contains¶

Gets the name_contains of this SearchMonitoredResourcesDetails. A filter to return resources that match resource name pattern given. The match is not case sensitive.

Returns:	The name_contains of this SearchMonitoredResourcesDetails.
Return type:	str

property_equals¶

Gets the property_equals of this SearchMonitoredResourcesDetails. Criteria based on resource property.

Returns:	The property_equals of this SearchMonitoredResourcesDetails.
Return type:	dict(str, str)

resource_category¶

Gets the resource_category of this SearchMonitoredResourcesDetails. Resource category filter.

Allowed values for this property are: “APPLICATION”, “DATABASE”, “MIDDLEWARE”, “UNKNOWN”

Returns:	The resource_category of this SearchMonitoredResourcesDetails.
Return type:	str

resource_time_zone¶

Gets the resource_time_zone of this SearchMonitoredResourcesDetails. 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

Returns:	The resource_time_zone of this SearchMonitoredResourcesDetails.
Return type:	str

sort_by¶

Gets the sort_by of this SearchMonitoredResourcesDetails. The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for resources is ascending.

Allowed values for this property are: “TIME_CREATED”, “RESOURCE_NAME”

Returns:	The sort_by of this SearchMonitoredResourcesDetails.
Return type:	str

sort_order¶

Gets the sort_order of this SearchMonitoredResourcesDetails. The sort order to use, either ‘ASC’ or ‘DESC’.

Allowed values for this property are: “ASC”, “DESC”

Returns:	The sort_order of this SearchMonitoredResourcesDetails.
Return type:	str

source_type¶

Gets the source_type of this SearchMonitoredResourcesDetails. Source type filter.

Allowed values for this property are: “SM_MGMT_AGENT_MONITORED”, “SM_REPO_ONLY”, “OCI_NATIVE”, “PROMETHEUS”, “TELEGRAF”, “COLLECTD”

Returns:	The source_type of this SearchMonitoredResourcesDetails.
Return type:	str

time_created_greater_than_or_equal_to¶

Gets the time_created_greater_than_or_equal_to of this SearchMonitoredResourcesDetails. 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 timeCreatedLessThan parameter will retrieve resources created from the given 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

Returns:	The time_created_greater_than_or_equal_to of this SearchMonitoredResourcesDetails.
Return type:	datetime

time_created_less_than¶

Gets the time_created_less_than of this SearchMonitoredResourcesDetails. 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 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

Returns:	The time_created_less_than of this SearchMonitoredResourcesDetails.
Return type:	datetime

time_updated_greater_than_or_equal_to¶

Gets the time_updated_greater_than_or_equal_to of this SearchMonitoredResourcesDetails. 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 timeUpdatedLessThan parameter will retrieve resources updated from the given 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

Returns:	The time_updated_greater_than_or_equal_to of this SearchMonitoredResourcesDetails.
Return type:	datetime

time_updated_less_than¶

Gets the time_updated_less_than of this SearchMonitoredResourcesDetails. 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 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

Returns:	The time_updated_less_than of this SearchMonitoredResourcesDetails.
Return type:	datetime

type¶

Gets the type of this SearchMonitoredResourcesDetails. A filter to return resources that match resource type.

Returns:	The type of this SearchMonitoredResourcesDetails.
Return type:	str