googleapis / googleapis/google-cloud-python

monitoring_dashboard: DashboardFilter adding new fields into proto.

Abierto
#17,951 1 comentario 1 reacción 0 asignados Ver en GitHub
api: monitoring priority: p3 type: feature request
Lenguaje dominante
Python
Estrellas
5.4k
Forks
1.8k
Merge medio
3 d 4 h
PR fusionados (30 d)
122

Descripción

### Determine this is the right repository

- [x] I determined this is the correct repository in which to report this feature request.

### Summary of the feature request

DashboardFilter only exposes label_key, template_variable, string_value, and filter_type:
https://github.com/googleapis/google-cloud-python/blob/google-cloud-monitoring-dashboards-v2.22.0/packages/google-cloud-monitoring-dashboards/google/cloud/monitoring_dashboard_v1/types/dashboard_filter.py

However:

The REST API supports valueType (STRING / STRING_ARRAY) and stringArrayValue for value-only dashboard variables that accept multiple values — documented here: https://docs.cloud.google.com/monitoring/api/ref_v3/rest/v1/projects.dashboards#DashboardFilter

This mismatch means the generated proto/client is behind the actual API surface, and there's no way to construct or parse a STRING_ARRAY-type dashboard filter/variable using the typed Python client — only via raw REST calls.

### Desired code experience

file: dashboard_filter.py
```python
class ValueType(proto.Enum):
r"""The type of the filter value
Values:
VALUE_TYPE_UNSPECIFIED (0):
Value type is unspecified
STRING (1):
String type
STRING_ARRAY (2):
String array type
"""

VALUE_TYPE_UNSPECIFIED = 0
STRING = 1
STRING_ARRAY = 2

value_type: ValueType = proto.Field(
proto.ENUM,
number=6,
enum=ValueType,
)
stringArrayValue: StringArray = proto.Field(
proto.MESSAGE,
number=7,
message=StringArray,
)
```

### Expected results

_e.g. `dashboardFilter.stringArrayValue` should return { values: [] }

### API client name and version

google-cloud-monitoring-dashboards v2.22.0

### Use case

This feature will allow users to retrieve stored values saved in Dashboard Settings -> Filters/Variables.

### Additional context

_No response_

Guía de contribución

Abrir la guía de contribución

Línea de trabajo

Start with packages/google-cloud-monitoring-dashboards/google/cloud/monitoring_dashboard_v1/types/dashboard_filter.py and compare DashboardFilter with the linked REST API documentation. Verify how the existing fields are defined and how generated types are tested; done means valueType and stringArrayValue can be constructed, serialized, parsed, and expose the expected STRING_ARRAY values.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
python
Área
api
Tipo de issue
Nueva funcionalidad
Dificultad
3/5
Tiempo estimado
1-2 días
Estado de actividad
Tranquilo
Claridad
Bastante claro
Aptitud para principiantes
62/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.