Package com.oracle.bmc.stackmonitoring.model

Class ImportOciTelemetryResourcesTaskDetails

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20210330")
public final class ImportOciTelemetryResourcesTaskDetails
extends MonitoredResourceTaskDetails
    Request details for importing resources from Telemetry like resources from OCI Native Services and prometheus.
    Note: Objects should always be created or deserialized using the ImportOciTelemetryResourcesTaskDetails.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the ImportOciTelemetryResourcesTaskDetails.Builder, which maintain a set of all explicitly set fields called ImportOciTelemetryResourcesTaskDetails.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

    • Method Detail

      • getSource

        public ImportOciTelemetryResourcesTaskDetails.Source getSource()
        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.

        Returns:
        the value

      • getNamespace

        public String getNamespace()
        Name space to be used for OCI Native service resources discovery.
        Returns:
        the value

      • getResourceGroup

        public String getResourceGroup()
        The resource group to use while fetching metrics from telemetry.

        If not specified, resource group will be skipped in the list metrics request.

        Returns:
        the value

      • getShouldUseMetricsFlowForStatus

        public Boolean getShouldUseMetricsFlowForStatus()
        Flag to indicate whether status is calculated using metrics or LifeCycleState attribute of the resource in OCI service.
        Returns:
        the value

      • getServiceBaseUrl

        public String getServiceBaseUrl()
        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.

        Returns:
        the value

      • getConsolePathPrefix

        public String getConsolePathPrefix()
        The console path prefix to use for providing service home url page navigation.

        For example if the prefix provided is ‘security/bastion/bastions’, the URL used for navigation will be https:///security/bastion/bastions/. If not provided, service home page link will not be shown in the stack monitoring home page.

        Returns:
        the value

      • getLifecycleStatusMappingsForUpStatus

        public List<String> getLifecycleStatusMappingsForUpStatus()
        Lifecycle states of the external resource which reflects the status of the resource being up.
        Returns:
        the value

      • getResourceNameMapping

        public String getResourceNameMapping()
        The resource name property in the metric dimensions.

        Resources imported will be using this property value for resource name.

        Returns:
        the value

      • getExternalIdMapping

        public String getExternalIdMapping()
        The external resource identifier property in the metric dimensions.

        Resources imported will be using this property value for external id.

        Returns:
        the value

      • getResourceTypeMapping

        public String getResourceTypeMapping()
        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.

        Returns:
        the value

      • getResourceNameFilter

        public String getResourceNameFilter()
        The resource name filter.

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

        Returns:
        the value

      • getResourceTypeFilter

        public String getResourceTypeFilter()
        The resource type filter.

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

        Returns:
        the value

      • getAvailabilityProxyMetrics

        public List<String> getAvailabilityProxyMetrics()
        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.

        Returns:
        the value

      • getAvailabilityProxyMetricCollectionInterval

        public Integer getAvailabilityProxyMetricCollectionInterval()
        Metrics collection interval in seconds used when calculating the availability of the resource based on metrics specified using the property ‘availabilityProxyMetrics’.
        Returns:
        the value

      • toString

        public String toString​(boolean includeByteArrayContents)
        Return a string representation of the object.
        Overrides:
        toString in class MonitoredResourceTaskDetails
        Parameters:
        includeByteArrayContents - true to include the full contents of byte arrays
        Returns:
        string representation