Show / Hide Table of Contents

Namespace Oci.StackmonitoringService.Models

Classes

AdditionalConfigurationDetails

Property Details

AgentExtensionHandlerConfiguration

Specific resource mapping configurations for Agent Extension Handlers.

AgentExtensionHandlerConfigurationProperty

Property of handler configuration

AgentExtensionHandlerMetricMappingDetails

Specific metric mapping configurations for Agent Extension Handlers.

AgentReceiverProperties

Properties for agent receiver.

AlarmCondition

The information about template condition in the same monitoringTemplate in a compartment.

AlarmConditionCollection

Results of a Alarm Condition search. Contains list of AlarmConditionCollection items.

AlarmConditionSummary

Alarm condition summary information about alarm condition

AnomalyDataPoint

anomaly evaluation result fo the data point

AnomalyMetricData

Anomaly Metric Details

AssociateMonitoredResourcesDetails

The information required to create new monitored resource association.

AssociatedMonitoredResource

The information about monitored resource.

AssociatedResourcesCollection

Results of a resources search. Contains AssociatedResourcesSummary items.

AssociatedResourcesSummary

The information about monitored resource.

AssociationDetails

The information about monitored resource association.

AssociationResourceDetails

Association Resource Details.

AutoPromoteConfigDetails

A configuration of the AUTO_PROMOTE type, consists of a resource type and a boolean value that determines if this resource needs to be automatically promoted/discovered. For example, when a Management Agent registration event occurs and if isEnabled is TRUE for a HOST resource type, a HOST resource will be automatically discovered using that Management Agent.

AutoPromoteConfigSummary

Summary of an AUTO_PROMOTE config.

AvailabilityMetricsDetails

Availability metrics details.

BaselineableMetric

Summary for the baseline-able metric

BaselineableMetricSummary

Summary for the baseline-able metric

BaselineableMetricSummaryCollection

List summary of Baseline-able metrics

ChangeConfigCompartmentDetails

Details for which compartment to move the resource to.

ChangeMetricExtensionCompartmentDetails

The information to be updated.

ChangeMonitoredResourceCompartmentDetails

The information to be updated.

ChangeMonitoredResourceTaskCompartmentDetails

The information required for change of compartment for stack monitoring resource task.

ChangeProcessSetCompartmentDetails

Payload describing to which compartment the resource should be moved.

CollectdResourceNameConfigurationDetails

Resource name generation overriding configurations for collectd resource types.

ComputeAutoActivatePluginConfigDetails

A configuration of the COMPUTE_AUTO_ACTIVATE_PLUGIN type consists of a boolean value that determines if detection of new or terminated Compute instances should be enabled, and if the Management Agent as a plugin of Oracle Cloud Agent should automatically be activated.

ComputeAutoActivatePluginConfigSummary

Summary of a COMPUTE_AUTO_ACTIVATE_PLUGIN config.

Condition

The Monitoring Template Alarm Condition.

Config

A configuration item that, for example defines whether resources of a specific type should be discovered automatically.
In this case, the 'configType' is set to 'AUTO_PROMOTE' and additional fields like 'resourceType' and 'isEnabled' determine if such resources are to be discovered automatically (also referred to as 'Automatic Promotion').

ConfigCollection

Contains a list of configurations.

ConfigModelConverter

ConfigSummary

Summary of the configuration.

ConfigSummaryModelConverter

ConnectionDetails

Connection details for the database.

CreateAlarmConditionDetails

The information about new alarm condition in the same monitoringTemplate in a compartment.

CreateAutoPromoteConfigDetails

The details of an AUTO_PROMOTE configuration.

CreateBaselineableMetricDetails

Summary for the baseline-able metric

CreateComputeAutoActivatePluginConfigDetails

The details of a COMPUTE_AUTO_ACTIVATE_PLUGIN configuration.

CreateConfigDetails

Create a configuration.

CreateConfigDetailsModelConverter

CreateDiscoveryJobDetails

The request of DiscoveryJob details.

CreateLicenseAutoAssignConfigDetails

The details of a LICENSE_AUTO_ASSIGN configuration.

CreateLicenseEnterpriseExtensibilityConfigDetails

The details of a LICENSE_ENTERPRISE_EXTENSIBILITY configuration.

CreateMaintenanceWindowDetails

Infomation to create a new Maintenance Window.

CreateMaintenanceWindowResourceDetails

List of resource IDs that are part of the Maintenance Window.

CreateMetricExtensionDetails

The information about new metric extension resource. The combination of metric extension name and resource type should be unique in a compartment.

CreateMonitoredResourceDetails

The information about new monitored resource to be created. The combination of monitored resource name and type should be unique across tenancy.

CreateMonitoredResourceTaskDetails

The request details for the stack monitoring resource task.

CreateMonitoredResourceTypeDetails

The information about new monitored resource type. The resource type name should be unique across tenancy. A set of resource types are created by the service by default. These resource types are available for all tenancies. Service provided resource types can not be duplicated or overwritten in any tenancy.

CreateMonitoringTemplateDetails

The information about new monitoring template. The monitoring template name should be unique in a compartment.

CreateOnboardConfigDetails

A configuration of the ONBOARD type, contains fields describing Onboarding customization: policies, dynamic groups, user groups.

CreateProcessSetDetails

Process Set create payload model.

CredentialCollection

List of DiscoveryJOb Credential Details.

CredentialDetails

DiscoveryJob Credential Details.

CredentialProperty

Monitored resource credential property.

DataPoint

metric data point

DefinedAlarmCondition

Defined Alarm Condition.

DefinedMonitoringTemplateCollection

List of defined Monitoring Template for specified resourceType

DefinedMonitoringTemplateSummary

Summary information about defined Monitoring Template for specified resourceType.

DisableMetricExtensionDetails

The Resource IDs for which metric extension will be disabled

DisassociateMonitoredResourcesDetails

The information required to create new monitored resource association.

DiscoveryDetails

The request of DiscoveryJob Resource details.

DiscoveryJob

The DiscoveryJob details.

DiscoveryJobCollection

Result of the discovery Job search

DiscoveryJobLogCollection

List of logs of a job

DiscoveryJobLogSummary

Log of a specific job

DiscoveryJobSummary

The Summary of DiscoveryJob details.

DynamicGroupDetails

Dynamic Group object

EnableMetricExtensionDetails

The Resource IDs for which metric extension will be enabled

EnabledResourceDetails

Details of a resource on which Metric Extension is enabled

EncryptedCredentials

Encrypted credentials [indicated by the type property in CredentialStore].

EvaluateBaselineableMetricDetails

Details for Baseline Metric Data to evaluate

EvaluateBaselineableMetricResult

Result for Baseline Metric Data evaluation

GroupDetails

User Group object

HttpQueryProperties

Query properties applicable to HTTP type of collection method

HttpScriptFileDetails

JavaScript file details which is used to convert http(s) response into metric data

HttpUpdateQueryProperties

Query properties applicable to HTTP type of collection method

ImportOciTelemetryResourcesTaskDetails

Request details for importing resources from Telemetry like resources from OCI Native Services and prometheus.

JmxQueryProperties

Query Properties applicable to JMX type of collection method

JmxUpdateQueryProperties

Query Properties applicable to JMX type of collection method

LicenseAutoAssignConfigDetails

A configuration of the LICENSE_AUTO_ASSIGN type, consists of an enumeration value which indicates which license should be assigned by default to new resources.

LicenseAutoAssignConfigSummary

Summary of a LICENSE_AUTO_ASSIGN configuration.

LicenseEnterpriseExtensibilityConfigDetails

A configuration of the LICENSE_ENTERPRISE_EXTENSIBILITY type, consists of a boolean which determines whether enterprise extensibility is enabled.

LicenseEnterpriseExtensibilityConfigSummary

Summary of a LICENSE_ENTERPRISE_EXTENSIBILITY configuration.

MaintenanceWindow

Maintenance Window object. It contains all the information of the Maintenance window. Used in the Create and Get operations.

MaintenanceWindowCollection

Result of List of maintenance window. Contains MaintenanceWindowSummary items and other data.

MaintenanceWindowSchedule

Schedule information of the Maintenance Window

MaintenanceWindowScheduleModelConverter

MaintenanceWindowSummary

General information of a Maintenance Window

ManageLicenseDetails

License information for a given resource.

MemberReference

The Member Reference details

Metric

Details of a metric which is part of this metric extension

MetricData

Metric Details

MetricExtension

Detailed information of the Metric Extension resource

MetricExtensionCollection

Results of a metric extension search. Contains list of MetricExtension items.

MetricExtensionMetricAggregationCollection

Count of metrics and other properties of metric extensions filtered by given criteria.

MetricExtensionQueryProperties

Collection method and query properties details of metric extension

MetricExtensionQueryPropertiesModelConverter

MetricExtensionResourceAggregation

The count of metric extensions for specified dimension.

MetricExtensionResourceAggregationCollection

The metric extension resources count filtered by given criteria.

MetricExtensionSummary

Summary information about metric extension resources

MetricExtensionUpdateQueryProperties

Collection method and query properties details of metric extension during update

MetricExtensionUpdateQueryPropertiesModelConverter

MetricExtensionsMetricAggregation

The count of metrics and other properties of metric extensions for specified dimensions.

MetricNameConfigurationDetails

Metric name generation overriding configurations.

MonitoredResource

The response object for create monitored resource and get monitored resource operations. This contains information about the monitored resource. Credentials and credential aliases attributes will be returned as null due to security reasons.

MonitoredResourceAliasCredential

Monitored Resource Alias Credential Details

MonitoredResourceAliasSourceCredential

Monitored Resource Alias Reference Source Credential.

MonitoredResourceAssociation

Association details between two monitored resources.

MonitoredResourceAssociationSummary

Summary of the monitored resource association.

MonitoredResourceAssociationsCollection

List of MonitoredResourceAssociationSummary elements.

MonitoredResourceCollection

Results of a resources search. Contains MonitoredResourceSummary items and other data.

MonitoredResourceCredential

Monitored Resource Credential Details.

MonitoredResourceCredentialModelConverter

MonitoredResourceDetails

Details of the Resource that are part of the Maintenance Window.

MonitoredResourceMemberSummary

Monitored resource member details.

MonitoredResourceMembersCollection

Results of a member search.

MonitoredResourceProperty

Property of monitored resource.

MonitoredResourceSummary

The information about monitored resource.

MonitoredResourceTask

The request details for importing resources from Telemetry.

MonitoredResourceTaskDetails

The request details for the performing the task.

MonitoredResourceTaskDetailsModelConverter

MonitoredResourceTaskSummary

The summary details for the task.

MonitoredResourceTasksCollection

A Collection of stack monitoring resource task summaries.

MonitoredResourceType

The response object for create monitored resource type and get monitored resource type operations.

MonitoredResourceTypeSummary

The summary of monitored resource type.

MonitoredResourceTypesCollection

A Collection of monitored resource type summaries.

MonitoredResourcesCountAggregation

The count of resources for specified dimension.

MonitoredResourcesCountAggregationCollection

The resource count grouped by given criteria.

MonitoringTemplate

Detailed information of the Monitoring Template

MonitoringTemplateCollection

Results of a Monitoring Template search. Contains list of MonitoringTemplateCollection items.

MonitoringTemplateSummary

Summary information about Monitoring Template.

OnboardConfigDetails

A configuration of the ONBOARD type, contains fields describing Onboarding customization: policies, dynamic groups, user groups.

OnboardConfigSummary

A configuration of the ONBOARD type, contains fields describing Onboarding customization: policies, dynamic groups, user groups.

OneTimeMaintenanceWindowSchedule

Schedule information for the Maintenance Window that is executed only once.

OsCommandQueryProperties

Query Properties applicable to OS_COMMAND type of collection method

OsCommandUpdateQueryProperties

Query Properties applicable to OS_COMMAND type of collection method

PlainTextCredentials

Plain text credentials [indicated by the type property in CredentialStore].

PreExistingCredentials

Pre existing credentials [indicated by the type property in CredentialStore].

ProcessSet

The Process Set details.

ProcessSetCollection

Result of the Process Set fetch.

ProcessSetSpecification

Collection of regular expression specifications used to identify the processes to be monitored.

ProcessSetSpecificationDetails

Details of a single regular expression specification in a Process Set.

ProcessSetSummary

Summary of a Process Set, used to construct a list of Process Sets when fetching all Process Sets in a compartment.

PropertyDetails

Property Details

RecurrentMaintenanceWindowSchedule

Schedule information for the Maintenance Window that is executed multiple times.

RequestSummarizedMetricExtensionsMetricsDetails

Filtering criteria data to be specified in the request. Either metricExtensionId or compartmentId must be passed even when no other filter property is passed.

RequestSummarizedMetricExtensionsResourcesDetails

Filtering criteria data to be specified in the request. Either metricExtensionId or compartmentId must be passed even when no other filter property is passed.

ResourceTypeConfigDetails

Resource type configuration details.

ResourceTypeMetadataDetails

The metadata details for resource type.

ResourceTypeMetadataDetailsModelConverter

ScriptFileDetails

Script details applicable to any OS Command based Metric Extension which needs to run a script to collect data. For removing it during update, set its "content" property to an empty string. In that case, "name" property value is ignored.

SearchAssociatedResourcesDetails

The criteria for searching associated monitored resources.

SearchMonitoredResourceAssociationsDetails

The information required to search monitored resource associations.

SearchMonitoredResourceMembersDetails

The search criteria for listing monitored resource member targets.

SearchMonitoredResourcesDetails

The property search criteria for listing monitored resources.

SqlDetails

Details of Sql content which needs to execute to collect Metric Extension data

SqlInParamDetails

Position and value for an IN parameter of PL/SQL statement

SqlOutParamDetails

Position and SQL Type of PL/SQL OUT parameter

SqlQueryProperties

Query Properties applicable to SQL type of collection method

SqlUpdateQueryProperties

Query Properties applicable to SQL type of collection method

SystemFormatResourceTypeMetadataDetails

The resource type metadata is defined in machine friendly format.

TelegrafResourceNameConfigurationDetails

Resource name generation overriding configurations for telegraf resource types.

TestMetricExtensionData

The Test result details

TestMetricExtensionDetails

The resource Id on which test will be run

UniquePropertySet

List of properties.

UpdateAgentReceiverTaskDetails

Request details for enabling/disabling the metric receiver on the management agent.

UpdateAlarmConditionDetails

The information about updating a alarm condition in the same monitoringTemplate in a compartment.

UpdateAndPropagateTagsDetails

The information about monitored resource tags. Request will fail if at least one of freeformTags or definedTags are not specified. Provided tags will be added or updated in the existing list of tags for the affected resources. Resources to be updated are identified based on association types specified. If association types are not specified, then tags will be updated only for the current resource.

UpdateAutoPromoteConfigDetails

Change the details of an AUTO_PROMOTE config

UpdateBaselineableMetricDetails

Summary for the baseline-able metric

UpdateComputeAutoActivatePluginConfigDetails

Change the details of a COMPUTE_AUTO_ACTIVATE_PLUGIN config.

UpdateConfigDetails

Change the configuration.

UpdateConfigDetailsModelConverter

UpdateHttpScriptFileDetails

JavaScript file details which is used to convert http(s) response into metric data

UpdateLicenseAutoAssignConfigDetails

Change the details of a LICENSE_AUTO_ASSIGN configuration.

UpdateLicenseEnterpriseExtensibilityConfigDetails

Change the details of a LICENSE_ENTERPRISE_EXTENSIBILITY configuration.

UpdateMaintenanceWindowDetails

Infomation to create a new Maintenance Window.

UpdateMetricExtensionDetails

The information about updating a metric extension resource

UpdateMonitoredResourceDetails

The information about updating a monitored resource.

UpdateMonitoredResourceTaskDetails

The request details for the stack monitoring resource task.

UpdateMonitoredResourceTypeDetails

The information to be updated for the monitored resource type.

UpdateMonitoringTemplateDetails

The information about updating a monitoring template. The monitoring template displayName should be unique in a compartment.

UpdateOnboardConfigDetails

Update configuration object, contains fields describing Onboarding customization: policies, dynamic groups, user groups.

UpdateProcessSetDetails

Process Set update payload model.

UpdateResourceTypeConfigTaskDetails

Update the availability metrics and the handler configuration for the telegraf/collectd resource types.

WorkRequest

A description of workrequest status

WorkRequestError

An error encountered while executing a work request.

WorkRequestErrorCollection

Results of a workRequestError search. Contains both WorkRequestError items and other information, such as metadata.

WorkRequestLogEntry

A log message from the execution of a work request.

WorkRequestLogEntryCollection

Results of a workRequestLog search. Contains both workRequestLog items and other information, such as metadata.

WorkRequestResource

A resource created or operated on by a work request.

WorkRequestSummary

A summary of the status of a work request.

WorkRequestSummaryCollection

Results of a workRequest search. Contains both WorkRequest items and other information, such as metadata.

Enums

ActionType

Possible types of actions.

AlarmConditionLifeCycleDetails

The current status of the alarm condition i.e. whether it is Applied, Not Applied or Partial_Applied.

AlarmConditionLifeCycleStates

The current lifecycle state of the alarm condition.

AlarmConditionSeverity

Alarm condition severity.

AutoPromoteConfigDetails.ResourceTypeEnum

AutoPromoteConfigSummary.ResourceTypeEnum

BaselineableMetricLifeCycleStates

Lifecycle state value of Baselineable Metric like ACTIVE or DELETED

ConditionType

Sort By.

Config.ConfigTypeEnum

Config.LifecycleStateEnum

ConnectionDetails.ProtocolEnum

CreateAutoPromoteConfigDetails.ResourceTypeEnum

CreateDiscoveryJobDetails.DiscoveryTypeEnum

DiscoveryDetails.ResourceTypeEnum

DiscoveryJob.DiscoveryTypeEnum

DiscoveryJob.StatusEnum

DiscoveryJobLogSummary.LogTypeEnum

DiscoveryJobSummary.DiscoveryTypeEnum

DiscoveryJobSummary.ResourceTypeEnum

DiscoveryJobSummary.StatusEnum

DynamicGroupDetails.StackMonitoringAssignmentEnum

HandlerType

Handler type.

HttpProtocolTypes

Possible protocol types of HTTP collection method

HttpResponseContentTypes

Possible response content types of HTTP collection method

ImportOciTelemetryResourcesTaskDetails.SourceEnum

LicenseType

License edition.

LifecycleState

Possible lifecycle states.

MaintenanceWindowLifecycleDetails

Lifecycle details of Maintenance Windows

MaintenanceWindowLifecycleState

Possible lifecycle states.

MaintenanceWindowOperationStatus

Possible lifecycle states.

MaintenanceWindowOperationType

Possible operation performed in Maintenance Window.

MaintenanceWindowSchedule.ScheduleTypeEnum

MaintenanceWindowSortBy

Sort By.

MemberReferenceType

Member Reference types of Monitoring template like RESOURCE_INSTANCE or RESOURCE_TYPE or RESOURCE_GROUP

MessageFormat

Monitoring Template message format.

Metric.DataTypeEnum

Metric.MetricCategoryEnum

MetricExtensionCollectionMethods

Possible collection methods.

MetricExtensionLifeCycleDetails

Lifecycle Detail value of Metric Extension like DRAFT or PUBLISHED

MetricExtensionLifeCycleStates

Lifecycle state value of Metric Extension like ACTIVE or DELETED or NEEDS_ATTENTION

MetricExtensionSortBy

Sort By.

MonitoredResourceAssociation.CategoryEnum

MonitoredResourceCredential.CredentialTypeEnum

MonitoredResourceSortBy

Sort By.

MonitoredResourceTaskDetails.TypeEnum

MonitoredResourceTaskLifecycleState

Possible lifecycle states for stack monitoring resource task.

MonitoringTemplateLifeCycleDetails

The current status of the monitoring template i.e. whether it is Applied, Not Applied or Partial Applied

MonitoringTemplateLifeCycleStates

The current lifecycle state of the monitoringTemplate

OperationStatus

Possible operation status.

OperationType

Possible operation types.

RequestSummarizedMetricExtensionsMetricsDetails.SortByEnum

RequestSummarizedMetricExtensionsMetricsDetails.SortOrderEnum

RequestSummarizedMetricExtensionsResourcesDetails.AssociationStatusEnum

RequestSummarizedMetricExtensionsResourcesDetails.GroupByEnum

RequestSummarizedMetricExtensionsResourcesDetails.SortByEnum

RequestSummarizedMetricExtensionsResourcesDetails.SortOrderEnum

ResourceCategory

Resource Category.

ResourceLifecycleState

Possible lifecycle states for monitored resource.

ResourceTypeLifecycleState

Possible lifecycle states for monitored resource type.

ResourceTypeMetadataDetails.FormatEnum

SearchMonitoredResourceAssociationsDetails.SortByEnum

SearchMonitoredResourcesDetails.SortByEnum

SortOrder

Sort orders.

SourceType

Source Type of the resource.

  1. SM_MGMT_AGENT_MONITORED - Management agent monitored stack monitoring discovered resources.
  2. SM_REPO_ONLY - Repository only stack monitoring discovered resources.
  3. OCI_NATIVE - OCI Native resources imported from OCI Monitoring Service.
  4. PROMETHEUS - Prometheus resources imported from OCI Monitoring Service.
  5. TELEGRAF - Telegraf based resources.
  6. COLLECTD - Collectd based resources.

SqlOutParamTypes

Possible out parameter types of SQL collection method. During the update, to completely remove the out parameter, use the value NO_OUT_PARAM

SqlQueryTypes

Type of SQL data collection method i.e. either a Statement or SQL Script File

In this article
Back to top