oci 2.128.0__py3-none-any.whl → 2.128.2__py3-none-any.whl

oci/apm_config/models/__init__.py

@@ -18,6 +18,7 @@ from .create_metric_group_details import CreateMetricGroupDetails
 from .create_options_details import CreateOptionsDetails
 from .create_span_filter_details import CreateSpanFilterDetails
 from .dimension import Dimension
+from .filter_text_or_id import FilterTextOrId
 from .metric import Metric
 from .metric_group import MetricGroup
 from .metric_group_summary import MetricGroupSummary
@@ -31,6 +32,10 @@ from .retrieve_namespace_metrics_details import RetrieveNamespaceMetricsDetails
 from .span_filter import SpanFilter
 from .span_filter_reference import SpanFilterReference
 from .span_filter_summary import SpanFilterSummary
+from .test_details import TestDetails
+from .test_output import TestOutput
+from .test_span_enrichment_details import TestSpanEnrichmentDetails
+from .test_span_enrichment_output import TestSpanEnrichmentOutput
 from .update_apdex_rules_details import UpdateApdexRulesDetails
 from .update_config_details import UpdateConfigDetails
 from .update_metric_group_details import UpdateMetricGroupDetails
@@ -52,6 +57,7 @@ apm_config_type_mapping = {
     "CreateOptionsDetails": CreateOptionsDetails,
     "CreateSpanFilterDetails": CreateSpanFilterDetails,
     "Dimension": Dimension,
+    "FilterTextOrId": FilterTextOrId,
     "Metric": Metric,
     "MetricGroup": MetricGroup,
     "MetricGroupSummary": MetricGroupSummary,
@@ -65,6 +71,10 @@ apm_config_type_mapping = {
     "SpanFilter": SpanFilter,
     "SpanFilterReference": SpanFilterReference,
     "SpanFilterSummary": SpanFilterSummary,
+    "TestDetails": TestDetails,
+    "TestOutput": TestOutput,
+    "TestSpanEnrichmentDetails": TestSpanEnrichmentDetails,
+    "TestSpanEnrichmentOutput": TestSpanEnrichmentOutput,
     "UpdateApdexRulesDetails": UpdateApdexRulesDetails,
     "UpdateConfigDetails": UpdateConfigDetails,
     "UpdateMetricGroupDetails": UpdateMetricGroupDetails,

oci/apm_config/models/filter_text_or_id.py

@@ -0,0 +1,112 @@
+# coding: utf-8
+# Copyright (c) 2016, 2024, Oracle and/or its affiliates.  All rights reserved.
+# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
+
+# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20210201
+
+
+from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel  # noqa: F401
+from oci.decorators import init_model_state_from_kwargs
+
+
+@init_model_state_from_kwargs
+class FilterTextOrId(object):
+    """
+    A span filter written in text, or as the `OCID`__ of a
+    SpanFilter resource. If both are given, the filterText is used.
+
+    __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new FilterTextOrId object with values from keyword arguments.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param filter_id:
+            The value to assign to the filter_id property of this FilterTextOrId.
+        :type filter_id: str
+
+        :param filter_text:
+            The value to assign to the filter_text property of this FilterTextOrId.
+        :type filter_text: str
+
+        """
+        self.swagger_types = {
+            'filter_id': 'str',
+            'filter_text': 'str'
+        }
+
+        self.attribute_map = {
+            'filter_id': 'filterId',
+            'filter_text': 'filterText'
+        }
+
+        self._filter_id = None
+        self._filter_text = None
+
+    @property
+    def filter_id(self):
+        """
+        Gets the filter_id of this FilterTextOrId.
+        The `OCID`__ of a Span Filter. The filterId is mandatory for the creation
+        of MetricGroups. A filterId is generated when a Span Filter is created.
+
+        __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
+
+
+        :return: The filter_id of this FilterTextOrId.
+        :rtype: str
+        """
+        return self._filter_id
+
+    @filter_id.setter
+    def filter_id(self, filter_id):
+        """
+        Sets the filter_id of this FilterTextOrId.
+        The `OCID`__ of a Span Filter. The filterId is mandatory for the creation
+        of MetricGroups. A filterId is generated when a Span Filter is created.
+
+        __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
+
+
+        :param filter_id: The filter_id of this FilterTextOrId.
+        :type: str
+        """
+        self._filter_id = filter_id
+
+    @property
+    def filter_text(self):
+        """
+        Gets the filter_text of this FilterTextOrId.
+        The string that defines the Span Filter expression.
+
+
+        :return: The filter_text of this FilterTextOrId.
+        :rtype: str
+        """
+        return self._filter_text
+
+    @filter_text.setter
+    def filter_text(self, filter_text):
+        """
+        Sets the filter_text of this FilterTextOrId.
+        The string that defines the Span Filter expression.
+
+
+        :param filter_text: The filter_text of this FilterTextOrId.
+        :type: str
+        """
+        self._filter_text = filter_text
+
+    def __repr__(self):
+        return formatted_flat_dict(self)
+
+    def __eq__(self, other):
+        if other is None:
+            return False
+
+        return self.__dict__ == other.__dict__
+
+    def __ne__(self, other):
+        return not self == other

oci/apm_config/models/test_details.py

@@ -0,0 +1,101 @@
+# coding: utf-8
+# Copyright (c) 2016, 2024, Oracle and/or its affiliates.  All rights reserved.
+# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
+
+# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20210201
+
+
+from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel  # noqa: F401
+from oci.decorators import init_model_state_from_kwargs
+
+
+@init_model_state_from_kwargs
+class TestDetails(object):
+    """
+    The request body used to execute a test.
+    """
+
+    #: A constant which can be used with the test_type property of a TestDetails.
+    #: This constant has a value of "SPAN_ENRICHMENT"
+    TEST_TYPE_SPAN_ENRICHMENT = "SPAN_ENRICHMENT"
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new TestDetails object with values from keyword arguments. This class has the following subclasses and if you are using this class as input
+        to a service operations then you should favor using a subclass over the base class:
+
+        * :class:`~oci.apm_config.models.TestSpanEnrichmentDetails`
+
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param test_type:
+            The value to assign to the test_type property of this TestDetails.
+            Allowed values for this property are: "SPAN_ENRICHMENT"
+        :type test_type: str
+
+        """
+        self.swagger_types = {
+            'test_type': 'str'
+        }
+
+        self.attribute_map = {
+            'test_type': 'testType'
+        }
+
+        self._test_type = None
+
+    @staticmethod
+    def get_subtype(object_dictionary):
+        """
+        Given the hash representation of a subtype of this class,
+        use the info in the hash to return the class of the subtype.
+        """
+        type = object_dictionary['testType']
+
+        if type == 'SPAN_ENRICHMENT':
+            return 'TestSpanEnrichmentDetails'
+        else:
+            return 'TestDetails'
+
+    @property
+    def test_type(self):
+        """
+        **[Required]** Gets the test_type of this TestDetails.
+        The kind of test to run.
+
+        Allowed values for this property are: "SPAN_ENRICHMENT"
+
+
+        :return: The test_type of this TestDetails.
+        :rtype: str
+        """
+        return self._test_type
+
+    @test_type.setter
+    def test_type(self, test_type):
+        """
+        Sets the test_type of this TestDetails.
+        The kind of test to run.
+
+
+        :param test_type: The test_type of this TestDetails.
+        :type: str
+        """
+        allowed_values = ["SPAN_ENRICHMENT"]
+        if not value_allowed_none_or_none_sentinel(test_type, allowed_values):
+            raise ValueError(
+                f"Invalid value for `test_type`, must be None or one of {allowed_values}"
+            )
+        self._test_type = test_type
+
+    def __repr__(self):
+        return formatted_flat_dict(self)
+
+    def __eq__(self, other):
+        if other is None:
+            return False
+
+        return self.__dict__ == other.__dict__
+
+    def __ne__(self, other):
+        return not self == other

oci/apm_config/models/test_output.py

@@ -0,0 +1,101 @@
+# coding: utf-8
+# Copyright (c) 2016, 2024, Oracle and/or its affiliates.  All rights reserved.
+# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
+
+# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20210201
+
+
+from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel  # noqa: F401
+from oci.decorators import init_model_state_from_kwargs
+
+
+@init_model_state_from_kwargs
+class TestOutput(object):
+    """
+    The result of running a test.
+    """
+
+    #: A constant which can be used with the test_type property of a TestOutput.
+    #: This constant has a value of "SPAN_ENRICHMENT"
+    TEST_TYPE_SPAN_ENRICHMENT = "SPAN_ENRICHMENT"
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new TestOutput object with values from keyword arguments. This class has the following subclasses and if you are using this class as input
+        to a service operations then you should favor using a subclass over the base class:
+
+        * :class:`~oci.apm_config.models.TestSpanEnrichmentOutput`
+
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param test_type:
+            The value to assign to the test_type property of this TestOutput.
+            Allowed values for this property are: "SPAN_ENRICHMENT", 'UNKNOWN_ENUM_VALUE'.
+            Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
+        :type test_type: str
+
+        """
+        self.swagger_types = {
+            'test_type': 'str'
+        }
+
+        self.attribute_map = {
+            'test_type': 'testType'
+        }
+
+        self._test_type = None
+
+    @staticmethod
+    def get_subtype(object_dictionary):
+        """
+        Given the hash representation of a subtype of this class,
+        use the info in the hash to return the class of the subtype.
+        """
+        type = object_dictionary['testType']
+
+        if type == 'SPAN_ENRICHMENT':
+            return 'TestSpanEnrichmentOutput'
+        else:
+            return 'TestOutput'
+
+    @property
+    def test_type(self):
+        """
+        **[Required]** Gets the test_type of this TestOutput.
+        The kind of test output.
+
+        Allowed values for this property are: "SPAN_ENRICHMENT", 'UNKNOWN_ENUM_VALUE'.
+        Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
+
+
+        :return: The test_type of this TestOutput.
+        :rtype: str
+        """
+        return self._test_type
+
+    @test_type.setter
+    def test_type(self, test_type):
+        """
+        Sets the test_type of this TestOutput.
+        The kind of test output.
+
+
+        :param test_type: The test_type of this TestOutput.
+        :type: str
+        """
+        allowed_values = ["SPAN_ENRICHMENT"]
+        if not value_allowed_none_or_none_sentinel(test_type, allowed_values):
+            test_type = 'UNKNOWN_ENUM_VALUE'
+        self._test_type = test_type
+
+    def __repr__(self):
+        return formatted_flat_dict(self)
+
+    def __eq__(self, other):
+        if other is None:
+            return False
+
+        return self.__dict__ == other.__dict__
+
+    def __ne__(self, other):
+        return not self == other

oci/apm_config/models/test_span_enrichment_details.py

@@ -0,0 +1,148 @@
+# coding: utf-8
+# Copyright (c) 2016, 2024, Oracle and/or its affiliates.  All rights reserved.
+# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
+
+# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20210201
+
+from .test_details import TestDetails
+from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel  # noqa: F401
+from oci.decorators import init_model_state_from_kwargs
+
+
+@init_model_state_from_kwargs
+class TestSpanEnrichmentDetails(TestDetails):
+    """
+    Run a set of span enrichment rules on a given span to see the result.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new TestSpanEnrichmentDetails object with values from keyword arguments. The default value of the :py:attr:`~oci.apm_config.models.TestSpanEnrichmentDetails.test_type` attribute
+        of this class is ``SPAN_ENRICHMENT`` and it should not be changed.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param test_type:
+            The value to assign to the test_type property of this TestSpanEnrichmentDetails.
+            Allowed values for this property are: "SPAN_ENRICHMENT"
+        :type test_type: str
+
+        :param options:
+            The value to assign to the options property of this TestSpanEnrichmentDetails.
+        :type options: object
+
+        :param filters:
+            The value to assign to the filters property of this TestSpanEnrichmentDetails.
+        :type filters: list[oci.apm_config.models.FilterTextOrId]
+
+        :param span:
+            The value to assign to the span property of this TestSpanEnrichmentDetails.
+        :type span: object
+
+        """
+        self.swagger_types = {
+            'test_type': 'str',
+            'options': 'object',
+            'filters': 'list[FilterTextOrId]',
+            'span': 'object'
+        }
+
+        self.attribute_map = {
+            'test_type': 'testType',
+            'options': 'options',
+            'filters': 'filters',
+            'span': 'span'
+        }
+
+        self._test_type = None
+        self._options = None
+        self._filters = None
+        self._span = None
+        self._test_type = 'SPAN_ENRICHMENT'
+
+    @property
+    def options(self):
+        """
+        **[Required]** Gets the options of this TestSpanEnrichmentDetails.
+        The span enrichment rules to test in the format of an Options resource.
+
+
+        :return: The options of this TestSpanEnrichmentDetails.
+        :rtype: object
+        """
+        return self._options
+
+    @options.setter
+    def options(self, options):
+        """
+        Sets the options of this TestSpanEnrichmentDetails.
+        The span enrichment rules to test in the format of an Options resource.
+
+
+        :param options: The options of this TestSpanEnrichmentDetails.
+        :type: object
+        """
+        self._options = options
+
+    @property
+    def filters(self):
+        """
+        Gets the filters of this TestSpanEnrichmentDetails.
+        A list of filters to try against the given span.
+
+
+        :return: The filters of this TestSpanEnrichmentDetails.
+        :rtype: list[oci.apm_config.models.FilterTextOrId]
+        """
+        return self._filters
+
+    @filters.setter
+    def filters(self, filters):
+        """
+        Sets the filters of this TestSpanEnrichmentDetails.
+        A list of filters to try against the given span.
+
+
+        :param filters: The filters of this TestSpanEnrichmentDetails.
+        :type: list[oci.apm_config.models.FilterTextOrId]
+        """
+        self._filters = filters
+
+    @property
+    def span(self):
+        """
+        **[Required]** Gets the span of this TestSpanEnrichmentDetails.
+        The span to test the rules on. This should be a valid JSON object that follows one
+        of the formats used by distributed tracing frameworks, such as OpenTelemetry, Zipkin, or
+        Oracle Application Performance Monitoring.
+
+
+        :return: The span of this TestSpanEnrichmentDetails.
+        :rtype: object
+        """
+        return self._span
+
+    @span.setter
+    def span(self, span):
+        """
+        Sets the span of this TestSpanEnrichmentDetails.
+        The span to test the rules on. This should be a valid JSON object that follows one
+        of the formats used by distributed tracing frameworks, such as OpenTelemetry, Zipkin, or
+        Oracle Application Performance Monitoring.
+
+
+        :param span: The span of this TestSpanEnrichmentDetails.
+        :type: object
+        """
+        self._span = span
+
+    def __repr__(self):
+        return formatted_flat_dict(self)
+
+    def __eq__(self, other):
+        if other is None:
+            return False
+
+        return self.__dict__ == other.__dict__
+
+    def __ne__(self, other):
+        return not self == other

oci/apm_config/models/test_span_enrichment_output.py

@@ -0,0 +1,113 @@
+# coding: utf-8
+# Copyright (c) 2016, 2024, Oracle and/or its affiliates.  All rights reserved.
+# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
+
+# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20210201
+
+from .test_output import TestOutput
+from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel  # noqa: F401
+from oci.decorators import init_model_state_from_kwargs
+
+
+@init_model_state_from_kwargs
+class TestSpanEnrichmentOutput(TestOutput):
+    """
+    Output of running a set of span enrichment rules against a span.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new TestSpanEnrichmentOutput object with values from keyword arguments. The default value of the :py:attr:`~oci.apm_config.models.TestSpanEnrichmentOutput.test_type` attribute
+        of this class is ``SPAN_ENRICHMENT`` and it should not be changed.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param test_type:
+            The value to assign to the test_type property of this TestSpanEnrichmentOutput.
+            Allowed values for this property are: "SPAN_ENRICHMENT"
+        :type test_type: str
+
+        :param span:
+            The value to assign to the span property of this TestSpanEnrichmentOutput.
+        :type span: object
+
+        :param filters:
+            The value to assign to the filters property of this TestSpanEnrichmentOutput.
+        :type filters: list[bool]
+
+        """
+        self.swagger_types = {
+            'test_type': 'str',
+            'span': 'object',
+            'filters': 'list[bool]'
+        }
+
+        self.attribute_map = {
+            'test_type': 'testType',
+            'span': 'span',
+            'filters': 'filters'
+        }
+
+        self._test_type = None
+        self._span = None
+        self._filters = None
+        self._test_type = 'SPAN_ENRICHMENT'
+
+    @property
+    def span(self):
+        """
+        Gets the span of this TestSpanEnrichmentOutput.
+        The span after applying enrichment rules.
+
+
+        :return: The span of this TestSpanEnrichmentOutput.
+        :rtype: object
+        """
+        return self._span
+
+    @span.setter
+    def span(self, span):
+        """
+        Sets the span of this TestSpanEnrichmentOutput.
+        The span after applying enrichment rules.
+
+
+        :param span: The span of this TestSpanEnrichmentOutput.
+        :type: object
+        """
+        self._span = span
+
+    @property
+    def filters(self):
+        """
+        Gets the filters of this TestSpanEnrichmentOutput.
+        A list of booleans indicating whether the corresponding filter in the input matched the input span.
+
+
+        :return: The filters of this TestSpanEnrichmentOutput.
+        :rtype: list[bool]
+        """
+        return self._filters
+
+    @filters.setter
+    def filters(self, filters):
+        """
+        Sets the filters of this TestSpanEnrichmentOutput.
+        A list of booleans indicating whether the corresponding filter in the input matched the input span.
+
+
+        :param filters: The filters of this TestSpanEnrichmentOutput.
+        :type: list[bool]
+        """
+        self._filters = filters
+
+    def __repr__(self):
+        return formatted_flat_dict(self)
+
+    def __eq__(self, other):
+        if other is None:
+            return False
+
+        return self.__dict__ == other.__dict__
+
+    def __ne__(self, other):
+        return not self == other