a !f?.@sddZddlZddlmZGdddeZGdddeZGdd d eZGd d d ed d Z dS) zMetric Descriptors for the `Google Stackdriver Monitoring API (V3)`_. .. _Google Stackdriver Monitoring API (V3): https://cloud.google.com/monitoring/api/ref_v3/rest/v3/ projects.metricDescriptors N)LabelDescriptorc@s eZdZdZdZdZdZdZdS) MetricKindzChoices for the `kind of measurement`_. .. _kind of measurement: https://cloud.google.com/monitoring/api/ref_v3/rest/v3/ projects.metricDescriptors#MetricKind METRIC_KIND_UNSPECIFIEDGAUGEDELTA CUMULATIVEN)__name__ __module__ __qualname____doc__rrrrr r Y/var/www/html/python-backend/venv/lib/python3.9/site-packages/gcloud/monitoring/metric.pyrs rc@s(eZdZdZdZdZdZdZdZdZ dS) ValueTypezChoices for the `metric value type`_. .. _metric value type: https://cloud.google.com/monitoring/api/ref_v3/rest/v3/ projects.metricDescriptors#ValueType VALUE_TYPE_UNSPECIFIEDBOOLINT64DOUBLESTRING DISTRIBUTIONN) rr r r rrrrrrr r r r r+src@szeZdZdZejejdddddfddZddZ d d Z e d d Z e dd dZ e ddZddZddZddZdS)MetricDescriptoraSpecification of a metric type and its schema. The preferred way to construct a metric descriptor object is using the :meth:`~gcloud.monitoring.client.Client.metric_descriptor` factory method of the :class:`~gcloud.monitoring.client.Client` class. :type client: :class:`gcloud.monitoring.client.Client` :param client: A client for operating on the metric descriptor. :type type_: string :param type_: The metric type including a DNS name prefix. For example: ``"compute.googleapis.com/instance/cpu/utilization"`` :type metric_kind: string :param metric_kind: The kind of measurement. It must be one of :data:`MetricKind.GAUGE`, :data:`MetricKind.DELTA`, or :data:`MetricKind.CUMULATIVE`. See :class:`MetricKind`. :type value_type: string :param value_type: The value type of the metric. It must be one of :data:`ValueType.BOOL`, :data:`ValueType.INT64`, :data:`ValueType.DOUBLE`, :data:`ValueType.STRING`, or :data:`ValueType.DISTRIBUTION`. See :class:`ValueType`. :type labels: list of :class:`~gcloud.monitoring.label.LabelDescriptor` :param labels: A sequence of zero or more label descriptors specifying the labels used to identify a specific instance of this metric. :type unit: string :param unit: An optional unit in which the metric value is reported. :type description: string :param description: An optional detailed description of the metric. :type display_name: string :param display_name: An optional concise name for the metric. :type name: string or None :param name: The "resource name" of the metric descriptor. For example: ``"projects//metricDescriptors/"``. As retrieved from the service, this will always be specified. You can and should omit it when constructing an instance for the purpose of creating a new metric descriptor. r Nc Cs:||_| |_||_||_||_||_||_||_||_dSN) clientnametypelabels metric_kind value_typeunit description display_name) selfrtype_rrrrrr rr r r __init__qszMetricDescriptor.__init__cCs6dj|jjd}|jjjd||d}||dS)aCreate a new metric descriptor based on this object. Example:: >>> descriptor = client.metric_descriptor( ... 'custom.googleapis.com/my_metric', ... metric_kind=MetricKind.GAUGE, ... value_type=ValueType.DOUBLE, ... description='This is a simple example of a custom metric.') >>> descriptor.create() The metric kind must not be :data:`MetricKind.METRIC_KIND_UNSPECIFIED`, and the value type must not be :data:`ValueType.VALUE_TYPE_UNSPECIFIED`. The ``name`` attribute is ignored in preparing the creation request. All attributes are overwritten by the values received in the response (normally affecting only ``name``). &/projects/{project}/metricDescriptors/projectPOST)methodpathdataN)formatrr& connection api_request_to_dict_init_from_dict)r!r)responser r r creates zMetricDescriptor.createcCs*dj|jj|jd}|jjjd|ddS)a%Delete the metric descriptor identified by this object. Example:: >>> descriptor = client.metric_descriptor( ... 'custom.googleapis.com/my_metric') >>> descriptor.delete() Only the ``client`` and ``type`` attributes are used. ,/projects/{project}/metricDescriptors/{type}r&rDELETEr(r)N)r+rr&rr,r-)r!r)r r r deletes zMetricDescriptor.deletecCs,dj|j|d}|jjd|d}|||S)aLook up a metric descriptor by type. :type client: :class:`gcloud.monitoring.client.Client` :param client: The client to use. :type metric_type: string :param metric_type: The metric type name. :rtype: :class:`MetricDescriptor` :returns: The metric descriptor instance. :raises: :class:`gcloud.exceptions.NotFound` if the metric descriptor is not found. r2r3GETr5)r+r&r,r- _from_dict)clsrZ metric_typer)infor r r _fetchs zMetricDescriptor._fetchc Csdj|jd}g}|dur$|||dur>|dj|dg}d}i}|r\d||d<|durl||d<|jjd ||d } | d d D]} |||| q| d }|sFqqF|S)aList all metric descriptors for the project. :type client: :class:`gcloud.monitoring.client.Client` :param client: The client to use. :type filter_string: string or None :param filter_string: An optional filter expression describing the metric descriptors to be returned. See the `filter documentation`_. :type type_prefix: string or None :param type_prefix: An optional prefix constraining the selected metric types. This adds ``metric.type = starts_with("")`` to the filter. :rtype: list of :class:`MetricDescriptor` :returns: A list of metric descriptor instances. .. _filter documentation: https://cloud.google.com/monitoring/api/v3/filters r$r%Nz%metric.type = starts_with("{prefix}"))prefixz AND filterZ pageTokenr7)r(r)Z query_paramsZmetricDescriptorsr Z nextPageToken)r+r&appendjoinr,r-getr8) r9rZ filter_stringZ type_prefixr)filtersZ descriptorsZ page_tokenparamsr0r:r r r _lists4  zMetricDescriptor._listcCs||d}|||S)aConstruct a metric descriptor from the parsed JSON representation. :type client: :class:`gcloud.monitoring.client.Client` :param client: A client to be included in the returned object. :type info: dict :param info: A ``dict`` parsed from the JSON wire-format representation. :rtype: :class:`MetricDescriptor` :returns: A metric descriptor. N)r/)r9rr:Z descriptorr r r r8s  zMetricDescriptor._from_dictcCsr|d|_|d|_tdd|dgD|_|d|_|d|_|dd |_|d d |_|d d |_ d S) zInitialize attributes from the parsed JSON representation. :type info: dict :param info: A ``dict`` parsed from the JSON wire-format representation. rrcss|]}t|VqdSr)rr8.0labelr r r sz3MetricDescriptor._init_from_dict..r metricKind valueTyperrr displayNameN) rrtupler@rrrrrr r!r:r r r r/ s     z MetricDescriptor._init_from_dictcCs`|j|j|jd}|jr,dd|jD|d<|jr<|j|d<|jrL|j|d<|jr\|j|d<|S)zBuild a dictionary ready to be serialized to the JSON wire format. :rtype: dict :returns: A dictionary. )rrHrIcSsg|] }|qSr )r.rDr r r )z-MetricDescriptor._to_dict..rrrrJ)rrrrrrr rLr r r r.s   zMetricDescriptor._to_dictcCsdjfi|jS)Nz)r+__dict__)r!r r r __repr__3szMetricDescriptor.__repr__)NN)rr r r rrrrr#r1r6 classmethodr;rCr8r/r.rPr r r r r=s$4   7 rc@s eZdZdZdZeddZdS)Metrica/A specific metric identified by specifying values for all labels. :type type: string :param type: The metric type name. :type labels: dict :param labels: A mapping from label names to values for all labels enumerated in the associated :class:`MetricDescriptor`. r cCs||d|didS)aConstruct a metric object from the parsed JSON representation. :type info: dict :param info: A ``dict`` parsed from the JSON wire-format representation. :rtype: :class:`Metric` :returns: A metric object. rr)rr)r@)r9r:r r r r8Ks  zMetric._from_dictN)rr r r __slots__rQr8r r r r rR?s rRz type labels) r collectionsZgcloud.monitoring.labelrobjectrrr namedtuplerRr r r r s