Class SearchMonitoredResourcesDetails

The property search criteria for listing monitored resources.

Inheritance

object

SearchMonitoredResourcesDetails

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.StackmonitoringService.Models

Assembly: OCI.DotNetSDK.Stackmonitoring.dll

Syntax

public class SearchMonitoredResourcesDetails

Properties

CompartmentId

Declaration

[Required(ErrorMessage = "CompartmentId is required.")]
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }

Property Value

Type	Description
string	Compartment Identifier OCID.

Remarks

Required

CompartmentIds

Declaration

[JsonProperty(PropertyName = "compartmentIds")]
public List<string> CompartmentIds { get; set; }

Property Value

Type	Description
List<string>	Multiple compartment identifiers OCID.

ExternalId

Declaration

[JsonProperty(PropertyName = "externalId")]
public string ExternalId { get; set; }

Property Value

Type	Description
string	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.

HostName

Declaration

[JsonProperty(PropertyName = "hostName")]
public string HostName { get; set; }

Property Value

Type	Description
string	A filter to return resources with host name match.

HostNameContains

Declaration

[JsonProperty(PropertyName = "hostNameContains")]
public string HostNameContains { get; set; }

Property Value

Type	Description
string	A filter to return resources with host name pattern.

License

Declaration

[JsonProperty(PropertyName = "license")]
[JsonConverter(typeof(StringEnumConverter))]
public LicenseType? License { get; set; }

Property Value

Type	Description
LicenseType?	License edition of the monitored resource.

LifecycleState

Declaration

[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(StringEnumConverter))]
public ResourceLifecycleState? LifecycleState { get; set; }

Property Value

Type	Description
ResourceLifecycleState?	A filter to return resources with matching lifecycle state.

LifecycleStates

Declaration

[JsonProperty(PropertyName = "lifecycleStates")]
public List<ResourceLifecycleState> LifecycleStates { get; set; }

Property Value

Type	Description
List<ResourceLifecycleState>	Multiple lifecycle states filter.

ManagementAgentId

Declaration

[JsonProperty(PropertyName = "managementAgentId")]
public string ManagementAgentId { get; set; }

Property Value

Type	Description
string	A filter to return resources with matching management agent id.

Name

Declaration

[JsonProperty(PropertyName = "name")]
public string Name { get; set; }

Property Value

Type	Description
string	A filter to return resources that match exact resource name.

NameContains

Declaration

[JsonProperty(PropertyName = "nameContains")]
public string NameContains { get; set; }

Property Value

Type	Description
string	A filter to return resources that match resource name pattern given. The match is not case sensitive.

PropertyEquals

Declaration

[JsonProperty(PropertyName = "propertyEquals")]
public Dictionary<string, string> PropertyEquals { get; set; }

Property Value

Type	Description
Dictionary<string, string>	Criteria based on resource property.

ResourceCategory

Declaration

[JsonProperty(PropertyName = "resourceCategory")]
[JsonConverter(typeof(StringEnumConverter))]
public ResourceCategory? ResourceCategory { get; set; }

Property Value

Type	Description
ResourceCategory?	Resource category filter.

ResourceTimeZone

Declaration

[JsonProperty(PropertyName = "resourceTimeZone")]
public string ResourceTimeZone { get; set; }

Property Value

Type	Description
string	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

SortBy

Declaration

[JsonProperty(PropertyName = "sortBy")]
[JsonConverter(typeof(StringEnumConverter))]
public SearchMonitoredResourcesDetails.SortByEnum? SortBy { get; set; }

Property Value

Type	Description
SearchMonitoredResourcesDetails.SortByEnum?	The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for resources is ascending.

SortOrder

Declaration

[JsonProperty(PropertyName = "sortOrder")]
[JsonConverter(typeof(StringEnumConverter))]
public SortOrder? SortOrder { get; set; }

Property Value

Type	Description
SortOrder?	The sort order to use, either 'ASC' or 'DESC'.

SourceType

Declaration

[JsonProperty(PropertyName = "sourceType")]
[JsonConverter(typeof(StringEnumConverter))]
public SourceType? SourceType { get; set; }

Property Value

Type	Description
SourceType?	Source type filter.

TimeCreatedGreaterThanOrEqualTo

Declaration

[JsonProperty(PropertyName = "timeCreatedGreaterThanOrEqualTo")]
public DateTime? TimeCreatedGreaterThanOrEqualTo { get; set; }

Property Value

Type

Description

DateTime?

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

TimeCreatedLessThan

Declaration

[JsonProperty(PropertyName = "timeCreatedLessThan")]
public DateTime? TimeCreatedLessThan { get; set; }

Property Value

Type

Description

DateTime?

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

TimeUpdatedGreaterThanOrEqualTo

Declaration

[JsonProperty(PropertyName = "timeUpdatedGreaterThanOrEqualTo")]
public DateTime? TimeUpdatedGreaterThanOrEqualTo { get; set; }

Property Value

Type

Description

DateTime?

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

TimeUpdatedLessThan

Declaration

[JsonProperty(PropertyName = "timeUpdatedLessThan")]
public DateTime? TimeUpdatedLessThan { get; set; }

Property Value

Type

Description

DateTime?

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

Type

Declaration

[JsonProperty(PropertyName = "type")]
public string Type { get; set; }

Property Value

Type	Description
string	A filter to return resources that match resource type.