metric_pb2.pyi 7.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186
  1. # Copyright 2025 Google LLC
  2. #
  3. # Licensed under the Apache License, Version 2.0 (the "License");
  4. # you may not use this file except in compliance with the License.
  5. # You may obtain a copy of the License at
  6. #
  7. # http://www.apache.org/licenses/LICENSE-2.0
  8. #
  9. # Unless required by applicable law or agreed to in writing, software
  10. # distributed under the License is distributed on an "AS IS" BASIS,
  11. # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12. # See the License for the specific language governing permissions and
  13. # limitations under the License.
  14. from typing import ClassVar as _ClassVar
  15. from typing import Iterable as _Iterable
  16. from typing import Mapping as _Mapping
  17. from typing import Optional as _Optional
  18. from typing import Union as _Union
  19. from google.protobuf import descriptor as _descriptor
  20. from google.protobuf import duration_pb2 as _duration_pb2
  21. from google.protobuf import message as _message
  22. from google.protobuf.internal import containers as _containers
  23. from google.protobuf.internal import enum_type_wrapper as _enum_type_wrapper
  24. from google.api import label_pb2 as _label_pb2
  25. from google.api import launch_stage_pb2 as _launch_stage_pb2
  26. DESCRIPTOR: _descriptor.FileDescriptor
  27. class MetricDescriptor(_message.Message):
  28. __slots__ = (
  29. "name",
  30. "type",
  31. "labels",
  32. "metric_kind",
  33. "value_type",
  34. "unit",
  35. "description",
  36. "display_name",
  37. "metadata",
  38. "launch_stage",
  39. "monitored_resource_types",
  40. )
  41. class MetricKind(int, metaclass=_enum_type_wrapper.EnumTypeWrapper):
  42. __slots__ = ()
  43. METRIC_KIND_UNSPECIFIED: _ClassVar[MetricDescriptor.MetricKind]
  44. GAUGE: _ClassVar[MetricDescriptor.MetricKind]
  45. DELTA: _ClassVar[MetricDescriptor.MetricKind]
  46. CUMULATIVE: _ClassVar[MetricDescriptor.MetricKind]
  47. METRIC_KIND_UNSPECIFIED: MetricDescriptor.MetricKind
  48. GAUGE: MetricDescriptor.MetricKind
  49. DELTA: MetricDescriptor.MetricKind
  50. CUMULATIVE: MetricDescriptor.MetricKind
  51. class ValueType(int, metaclass=_enum_type_wrapper.EnumTypeWrapper):
  52. __slots__ = ()
  53. VALUE_TYPE_UNSPECIFIED: _ClassVar[MetricDescriptor.ValueType]
  54. BOOL: _ClassVar[MetricDescriptor.ValueType]
  55. INT64: _ClassVar[MetricDescriptor.ValueType]
  56. DOUBLE: _ClassVar[MetricDescriptor.ValueType]
  57. STRING: _ClassVar[MetricDescriptor.ValueType]
  58. DISTRIBUTION: _ClassVar[MetricDescriptor.ValueType]
  59. MONEY: _ClassVar[MetricDescriptor.ValueType]
  60. VALUE_TYPE_UNSPECIFIED: MetricDescriptor.ValueType
  61. BOOL: MetricDescriptor.ValueType
  62. INT64: MetricDescriptor.ValueType
  63. DOUBLE: MetricDescriptor.ValueType
  64. STRING: MetricDescriptor.ValueType
  65. DISTRIBUTION: MetricDescriptor.ValueType
  66. MONEY: MetricDescriptor.ValueType
  67. class MetricDescriptorMetadata(_message.Message):
  68. __slots__ = (
  69. "launch_stage",
  70. "sample_period",
  71. "ingest_delay",
  72. "time_series_resource_hierarchy_level",
  73. )
  74. class TimeSeriesResourceHierarchyLevel(
  75. int, metaclass=_enum_type_wrapper.EnumTypeWrapper
  76. ):
  77. __slots__ = ()
  78. TIME_SERIES_RESOURCE_HIERARCHY_LEVEL_UNSPECIFIED: _ClassVar[
  79. MetricDescriptor.MetricDescriptorMetadata.TimeSeriesResourceHierarchyLevel
  80. ]
  81. PROJECT: _ClassVar[
  82. MetricDescriptor.MetricDescriptorMetadata.TimeSeriesResourceHierarchyLevel
  83. ]
  84. ORGANIZATION: _ClassVar[
  85. MetricDescriptor.MetricDescriptorMetadata.TimeSeriesResourceHierarchyLevel
  86. ]
  87. FOLDER: _ClassVar[
  88. MetricDescriptor.MetricDescriptorMetadata.TimeSeriesResourceHierarchyLevel
  89. ]
  90. TIME_SERIES_RESOURCE_HIERARCHY_LEVEL_UNSPECIFIED: MetricDescriptor.MetricDescriptorMetadata.TimeSeriesResourceHierarchyLevel
  91. PROJECT: MetricDescriptor.MetricDescriptorMetadata.TimeSeriesResourceHierarchyLevel
  92. ORGANIZATION: MetricDescriptor.MetricDescriptorMetadata.TimeSeriesResourceHierarchyLevel
  93. FOLDER: MetricDescriptor.MetricDescriptorMetadata.TimeSeriesResourceHierarchyLevel
  94. LAUNCH_STAGE_FIELD_NUMBER: _ClassVar[int]
  95. SAMPLE_PERIOD_FIELD_NUMBER: _ClassVar[int]
  96. INGEST_DELAY_FIELD_NUMBER: _ClassVar[int]
  97. TIME_SERIES_RESOURCE_HIERARCHY_LEVEL_FIELD_NUMBER: _ClassVar[int]
  98. launch_stage: _launch_stage_pb2.LaunchStage
  99. sample_period: _duration_pb2.Duration
  100. ingest_delay: _duration_pb2.Duration
  101. time_series_resource_hierarchy_level: _containers.RepeatedScalarFieldContainer[
  102. MetricDescriptor.MetricDescriptorMetadata.TimeSeriesResourceHierarchyLevel
  103. ]
  104. def __init__(
  105. self,
  106. launch_stage: _Optional[_Union[_launch_stage_pb2.LaunchStage, str]] = ...,
  107. sample_period: _Optional[_Union[_duration_pb2.Duration, _Mapping]] = ...,
  108. ingest_delay: _Optional[_Union[_duration_pb2.Duration, _Mapping]] = ...,
  109. time_series_resource_hierarchy_level: _Optional[
  110. _Iterable[
  111. _Union[
  112. MetricDescriptor.MetricDescriptorMetadata.TimeSeriesResourceHierarchyLevel,
  113. str,
  114. ]
  115. ]
  116. ] = ...,
  117. ) -> None: ...
  118. NAME_FIELD_NUMBER: _ClassVar[int]
  119. TYPE_FIELD_NUMBER: _ClassVar[int]
  120. LABELS_FIELD_NUMBER: _ClassVar[int]
  121. METRIC_KIND_FIELD_NUMBER: _ClassVar[int]
  122. VALUE_TYPE_FIELD_NUMBER: _ClassVar[int]
  123. UNIT_FIELD_NUMBER: _ClassVar[int]
  124. DESCRIPTION_FIELD_NUMBER: _ClassVar[int]
  125. DISPLAY_NAME_FIELD_NUMBER: _ClassVar[int]
  126. METADATA_FIELD_NUMBER: _ClassVar[int]
  127. LAUNCH_STAGE_FIELD_NUMBER: _ClassVar[int]
  128. MONITORED_RESOURCE_TYPES_FIELD_NUMBER: _ClassVar[int]
  129. name: str
  130. type: str
  131. labels: _containers.RepeatedCompositeFieldContainer[_label_pb2.LabelDescriptor]
  132. metric_kind: MetricDescriptor.MetricKind
  133. value_type: MetricDescriptor.ValueType
  134. unit: str
  135. description: str
  136. display_name: str
  137. metadata: MetricDescriptor.MetricDescriptorMetadata
  138. launch_stage: _launch_stage_pb2.LaunchStage
  139. monitored_resource_types: _containers.RepeatedScalarFieldContainer[str]
  140. def __init__(
  141. self,
  142. name: _Optional[str] = ...,
  143. type: _Optional[str] = ...,
  144. labels: _Optional[
  145. _Iterable[_Union[_label_pb2.LabelDescriptor, _Mapping]]
  146. ] = ...,
  147. metric_kind: _Optional[_Union[MetricDescriptor.MetricKind, str]] = ...,
  148. value_type: _Optional[_Union[MetricDescriptor.ValueType, str]] = ...,
  149. unit: _Optional[str] = ...,
  150. description: _Optional[str] = ...,
  151. display_name: _Optional[str] = ...,
  152. metadata: _Optional[
  153. _Union[MetricDescriptor.MetricDescriptorMetadata, _Mapping]
  154. ] = ...,
  155. launch_stage: _Optional[_Union[_launch_stage_pb2.LaunchStage, str]] = ...,
  156. monitored_resource_types: _Optional[_Iterable[str]] = ...,
  157. ) -> None: ...
  158. class Metric(_message.Message):
  159. __slots__ = ("type", "labels")
  160. class LabelsEntry(_message.Message):
  161. __slots__ = ("key", "value")
  162. KEY_FIELD_NUMBER: _ClassVar[int]
  163. VALUE_FIELD_NUMBER: _ClassVar[int]
  164. key: str
  165. value: str
  166. def __init__(
  167. self, key: _Optional[str] = ..., value: _Optional[str] = ...
  168. ) -> None: ...
  169. TYPE_FIELD_NUMBER: _ClassVar[int]
  170. LABELS_FIELD_NUMBER: _ClassVar[int]
  171. type: str
  172. labels: _containers.ScalarMap[str, str]
  173. def __init__(
  174. self, type: _Optional[str] = ..., labels: _Optional[_Mapping[str, str]] = ...
  175. ) -> None: ...