Show / Hide Table of Contents

Class ImportOciTelemetryResourcesTaskDetails

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

Inheritance
object
MonitoredResourceTaskDetails
ImportOciTelemetryResourcesTaskDetails
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 ImportOciTelemetryResourcesTaskDetails : MonitoredResourceTaskDetails

Properties

AvailabilityProxyMetricCollectionInterval

Declaration
[JsonProperty(PropertyName = "availabilityProxyMetricCollectionInterval")]
public int? AvailabilityProxyMetricCollectionInterval { get; set; }
Property Value
Type Description
int?

Metrics collection interval in seconds used when calculating the availability of the resource based on metrics specified using the property 'availabilityProxyMetrics'.

AvailabilityProxyMetrics

Declaration
[JsonProperty(PropertyName = "availabilityProxyMetrics")]
public List<string> AvailabilityProxyMetrics { get; set; }
Property Value
Type Description
List<string>

List of metrics to be used to calculate the availability of the resource. Resource is considered to be up if at least one of the specified metrics is available for the resource during the specified interval using the property 'availabilityProxyMetricCollectionInterval'. If no metrics are specified, availability will not be calculated for the resource.

ConsolePathPrefix

Declaration
[JsonProperty(PropertyName = "consolePathPrefix")]
public string ConsolePathPrefix { get; set; }
Property Value
Type Description
string

ExternalIdMapping

Declaration
[JsonProperty(PropertyName = "externalIdMapping")]
public string ExternalIdMapping { get; set; }
Property Value
Type Description
string

The external resource identifier property in the metric dimensions. Resources imported will be using this property value for external id.

LifecycleStatusMappingsForUpStatus

Declaration
[JsonProperty(PropertyName = "lifecycleStatusMappingsForUpStatus")]
public List<string> LifecycleStatusMappingsForUpStatus { get; set; }
Property Value
Type Description
List<string>

Lifecycle states of the external resource which reflects the status of the resource being up.

Namespace

Declaration
[Required(ErrorMessage = "Namespace is required.")]
[JsonProperty(PropertyName = "namespace")]
public string Namespace { get; set; }
Property Value
Type Description
string

Name space to be used for OCI Native service resources discovery.

Remarks

Required

ResourceGroup

Declaration
[JsonProperty(PropertyName = "resourceGroup")]
public string ResourceGroup { get; set; }
Property Value
Type Description
string

The resource group to use while fetching metrics from telemetry. If not specified, resource group will be skipped in the list metrics request.

ResourceNameFilter

Declaration
[JsonProperty(PropertyName = "resourceNameFilter")]
public string ResourceNameFilter { get; set; }
Property Value
Type Description
string

The resource name filter. Resources matching with the resource name filter will be imported. Regular expressions will be accepted.

ResourceNameMapping

Declaration
[JsonProperty(PropertyName = "resourceNameMapping")]
public string ResourceNameMapping { get; set; }
Property Value
Type Description
string

The resource name property in the metric dimensions. Resources imported will be using this property value for resource name.

ResourceTypeFilter

Declaration
[JsonProperty(PropertyName = "resourceTypeFilter")]
public string ResourceTypeFilter { get; set; }
Property Value
Type Description
string

The resource type filter. Resources matching with the resource type filter will be imported. Regular expressions will be accepted.

ResourceTypeMapping

Declaration
[JsonProperty(PropertyName = "resourceTypeMapping")]
public string ResourceTypeMapping { get; set; }
Property Value
Type Description
string

The resource type property in the metric dimensions. Resources imported will be using this property value for resource type. If not specified, namespace will be used for resource type.

ServiceBaseUrl

Declaration
[JsonProperty(PropertyName = "serviceBaseUrl")]
public string ServiceBaseUrl { get; set; }
Property Value
Type Description
string

The base URL of the OCI service to which the resource belongs to. Also this property is applicable only when source is OCI_TELEMETRY_NATIVE.

ShouldUseMetricsFlowForStatus

Declaration
[JsonProperty(PropertyName = "shouldUseMetricsFlowForStatus")]
public bool? ShouldUseMetricsFlowForStatus { get; set; }
Property Value
Type Description
bool?

Flag to indicate whether status is calculated using metrics or LifeCycleState attribute of the resource in OCI service.

Source

Declaration
[Required(ErrorMessage = "Source is required.")]
[JsonProperty(PropertyName = "source")]
[JsonConverter(typeof(ResponseEnumConverter))]
public ImportOciTelemetryResourcesTaskDetails.SourceEnum? Source { get; set; }
Property Value
Type Description
ImportOciTelemetryResourcesTaskDetails.SourceEnum?

Source from where the metrics pushed to telemetry. Possible values:

  • OCI_TELEMETRY_NATIVE - The metrics are pushed to telemetry from OCI Native Services.
  • OCI_TELEMETRY_PROMETHEUS - The metrics are pushed to telemetry from Prometheus.
  • OCI_TELEMETRY_TELEGRAF - The metrics are pushed to telemetry from Telegraf receiver.
  • OCI_TELEMETRY_COLLECTD - The metrics are pushed to telemetry from CollectD receiver.
Remarks

Required

In this article
Back to top