Skip to content

Commit

Permalink
docs: [google-cloud-monitoring] Various updates (#12569)
Browse files Browse the repository at this point in the history
- [ ] Regenerate this pull request now.

PiperOrigin-RevId: 624233552

Source-Link:
googleapis/googleapis@1413b13

Source-Link:
googleapis/googleapis-gen@fa02723
Copy-Tag:
eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLW1vbml0b3JpbmcvLk93bEJvdC55YW1sIiwiaCI6ImZhMDI3MjNjZGJjZjBkYjQ0ZWJkZmU0MTg1OGQwZmU0MTAwOTQ1YWQifQ==

---------

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
  • Loading branch information
gcf-owl-bot[bot] and gcf-owl-bot[bot] committed Apr 12, 2024
1 parent e3bfbc6 commit 54b593d
Show file tree
Hide file tree
Showing 52 changed files with 220 additions and 175 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@
except AttributeError: # pragma: NO COVER
OptionalRetry = Union[retries.AsyncRetry, object, None] # type: ignore

from google.longrunning import operations_pb2 # type: ignore
from google.protobuf import field_mask_pb2 # type: ignore
from google.protobuf import wrappers_pb2 # type: ignore
from google.rpc import status_pb2 # type: ignore
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@
except AttributeError: # pragma: NO COVER
OptionalRetry = Union[retries.Retry, object, None] # type: ignore

from google.longrunning import operations_pb2 # type: ignore
from google.protobuf import field_mask_pb2 # type: ignore
from google.protobuf import wrappers_pb2 # type: ignore
from google.rpc import status_pb2 # type: ignore
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
from google.api_core import retry as retries
import google.auth # type: ignore
from google.auth import credentials as ga_credentials # type: ignore
from google.longrunning import operations_pb2 # type: ignore
from google.oauth2 import service_account # type: ignore
from google.protobuf import empty_pb2 # type: ignore

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
import google.auth # type: ignore
from google.auth import credentials as ga_credentials # type: ignore
from google.auth.transport.grpc import SslCredentials # type: ignore
from google.longrunning import operations_pb2 # type: ignore
from google.protobuf import empty_pb2 # type: ignore
import grpc # type: ignore

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
from google.api_core import gapic_v1, grpc_helpers_async
from google.auth import credentials as ga_credentials # type: ignore
from google.auth.transport.grpc import SslCredentials # type: ignore
from google.longrunning import operations_pb2 # type: ignore
from google.protobuf import empty_pb2 # type: ignore
import grpc # type: ignore
from grpc.experimental import aio # type: ignore
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@
OptionalRetry = Union[retries.AsyncRetry, object, None] # type: ignore

from google.api import monitored_resource_pb2 # type: ignore
from google.longrunning import operations_pb2 # type: ignore

from google.cloud.monitoring_v3.services.group_service import pagers
from google.cloud.monitoring_v3.types import group
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@
OptionalRetry = Union[retries.Retry, object, None] # type: ignore

from google.api import monitored_resource_pb2 # type: ignore
from google.longrunning import operations_pb2 # type: ignore

from google.cloud.monitoring_v3.services.group_service import pagers
from google.cloud.monitoring_v3.types import group
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
from google.api_core import retry as retries
import google.auth # type: ignore
from google.auth import credentials as ga_credentials # type: ignore
from google.longrunning import operations_pb2 # type: ignore
from google.oauth2 import service_account # type: ignore
from google.protobuf import empty_pb2 # type: ignore

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
import google.auth # type: ignore
from google.auth import credentials as ga_credentials # type: ignore
from google.auth.transport.grpc import SslCredentials # type: ignore
from google.longrunning import operations_pb2 # type: ignore
from google.protobuf import empty_pb2 # type: ignore
import grpc # type: ignore

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
from google.api_core import gapic_v1, grpc_helpers_async
from google.auth import credentials as ga_credentials # type: ignore
from google.auth.transport.grpc import SslCredentials # type: ignore
from google.longrunning import operations_pb2 # type: ignore
from google.protobuf import empty_pb2 # type: ignore
import grpc # type: ignore
from grpc.experimental import aio # type: ignore
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@
from google.api import launch_stage_pb2 # type: ignore
from google.api import metric_pb2 # type: ignore
from google.api import monitored_resource_pb2 # type: ignore
from google.longrunning import operations_pb2 # type: ignore

from google.cloud.monitoring_v3.services.metric_service import pagers
from google.cloud.monitoring_v3.types import common
Expand Down Expand Up @@ -283,7 +284,7 @@ async def list_monitored_resource_descriptors(
metadata: Sequence[Tuple[str, str]] = (),
) -> pagers.ListMonitoredResourceDescriptorsAsyncPager:
r"""Lists monitored resource descriptors that match a
filter. This method does not require a Workspace.
filter.
.. code-block:: python
Expand Down Expand Up @@ -415,8 +416,7 @@ async def get_monitored_resource_descriptor(
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
metadata: Sequence[Tuple[str, str]] = (),
) -> monitored_resource_pb2.MonitoredResourceDescriptor:
r"""Gets a single monitored resource descriptor. This
method does not require a Workspace.
r"""Gets a single monitored resource descriptor.
.. code-block:: python
Expand Down Expand Up @@ -549,8 +549,7 @@ async def list_metric_descriptors(
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
metadata: Sequence[Tuple[str, str]] = (),
) -> pagers.ListMetricDescriptorsAsyncPager:
r"""Lists metric descriptors that match a filter. This
method does not require a Workspace.
r"""Lists metric descriptors that match a filter.
.. code-block:: python
Expand Down Expand Up @@ -682,8 +681,7 @@ async def get_metric_descriptor(
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
metadata: Sequence[Tuple[str, str]] = (),
) -> metric_pb2.MetricDescriptor:
r"""Gets a single metric descriptor. This method does not
require a Workspace.
r"""Gets a single metric descriptor.
.. code-block:: python
Expand Down Expand Up @@ -810,10 +808,10 @@ async def create_metric_descriptor(
metadata: Sequence[Tuple[str, str]] = (),
) -> metric_pb2.MetricDescriptor:
r"""Creates a new metric descriptor. The creation is executed
asynchronously and callers may check the returned operation to
track its progress. User-created metric descriptors define
`custom
asynchronously. User-created metric descriptors define `custom
metrics <https://cloud.google.com/monitoring/custom-metrics>`__.
The metric descriptor is updated if it already exists, except
that metric labels are never removed.
.. code-block:: python
Expand Down Expand Up @@ -1047,8 +1045,7 @@ async def list_time_series(
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
metadata: Sequence[Tuple[str, str]] = (),
) -> pagers.ListTimeSeriesAsyncPager:
r"""Lists time series that match a filter. This method
does not require a Workspace.
r"""Lists time series that match a filter.
.. code-block:: python
Expand Down Expand Up @@ -1223,11 +1220,12 @@ async def create_time_series(
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
metadata: Sequence[Tuple[str, str]] = (),
) -> None:
r"""Creates or adds data to one or more time series.
The response is empty if all time series in the request
were written. If any time series could not be written, a
corresponding failure message is included in the error
response.
r"""Creates or adds data to one or more time series. The response is
empty if all time series in the request were written. If any
time series could not be written, a corresponding failure
message is included in the error response. This method does not
support `resource locations constraint of an organization
policy <https://cloud.google.com/resource-manager/docs/organization-policy/defining-locations#setting_the_organization_policy>`__.
.. code-block:: python
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@
from google.api import launch_stage_pb2 # type: ignore
from google.api import metric_pb2 # type: ignore
from google.api import monitored_resource_pb2 # type: ignore
from google.longrunning import operations_pb2 # type: ignore

from google.cloud.monitoring_v3.services.metric_service import pagers
from google.cloud.monitoring_v3.types import common
Expand Down Expand Up @@ -719,7 +720,7 @@ def list_monitored_resource_descriptors(
metadata: Sequence[Tuple[str, str]] = (),
) -> pagers.ListMonitoredResourceDescriptorsPager:
r"""Lists monitored resource descriptors that match a
filter. This method does not require a Workspace.
filter.
.. code-block:: python
Expand Down Expand Up @@ -846,8 +847,7 @@ def get_monitored_resource_descriptor(
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
metadata: Sequence[Tuple[str, str]] = (),
) -> monitored_resource_pb2.MonitoredResourceDescriptor:
r"""Gets a single monitored resource descriptor. This
method does not require a Workspace.
r"""Gets a single monitored resource descriptor.
.. code-block:: python
Expand Down Expand Up @@ -975,8 +975,7 @@ def list_metric_descriptors(
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
metadata: Sequence[Tuple[str, str]] = (),
) -> pagers.ListMetricDescriptorsPager:
r"""Lists metric descriptors that match a filter. This
method does not require a Workspace.
r"""Lists metric descriptors that match a filter.
.. code-block:: python
Expand Down Expand Up @@ -1099,8 +1098,7 @@ def get_metric_descriptor(
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
metadata: Sequence[Tuple[str, str]] = (),
) -> metric_pb2.MetricDescriptor:
r"""Gets a single metric descriptor. This method does not
require a Workspace.
r"""Gets a single metric descriptor.
.. code-block:: python
Expand Down Expand Up @@ -1218,10 +1216,10 @@ def create_metric_descriptor(
metadata: Sequence[Tuple[str, str]] = (),
) -> metric_pb2.MetricDescriptor:
r"""Creates a new metric descriptor. The creation is executed
asynchronously and callers may check the returned operation to
track its progress. User-created metric descriptors define
`custom
asynchronously. User-created metric descriptors define `custom
metrics <https://cloud.google.com/monitoring/custom-metrics>`__.
The metric descriptor is updated if it already exists, except
that metric labels are never removed.
.. code-block:: python
Expand Down Expand Up @@ -1446,8 +1444,7 @@ def list_time_series(
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
metadata: Sequence[Tuple[str, str]] = (),
) -> pagers.ListTimeSeriesPager:
r"""Lists time series that match a filter. This method
does not require a Workspace.
r"""Lists time series that match a filter.
.. code-block:: python
Expand Down Expand Up @@ -1613,11 +1610,12 @@ def create_time_series(
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
metadata: Sequence[Tuple[str, str]] = (),
) -> None:
r"""Creates or adds data to one or more time series.
The response is empty if all time series in the request
were written. If any time series could not be written, a
corresponding failure message is included in the error
response.
r"""Creates or adds data to one or more time series. The response is
empty if all time series in the request were written. If any
time series could not be written, a corresponding failure
message is included in the error response. This method does not
support `resource locations constraint of an organization
policy <https://cloud.google.com/resource-manager/docs/organization-policy/defining-locations#setting_the_organization_policy>`__.
.. code-block:: python
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
from google.api_core import retry as retries
import google.auth # type: ignore
from google.auth import credentials as ga_credentials # type: ignore
from google.longrunning import operations_pb2 # type: ignore
from google.oauth2 import service_account # type: ignore
from google.protobuf import empty_pb2 # type: ignore

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
import google.auth # type: ignore
from google.auth import credentials as ga_credentials # type: ignore
from google.auth.transport.grpc import SslCredentials # type: ignore
from google.longrunning import operations_pb2 # type: ignore
from google.protobuf import empty_pb2 # type: ignore
import grpc # type: ignore

Expand Down Expand Up @@ -243,7 +244,7 @@ def list_monitored_resource_descriptors(
descriptors method over gRPC.
Lists monitored resource descriptors that match a
filter. This method does not require a Workspace.
filter.
Returns:
Callable[[~.ListMonitoredResourceDescriptorsRequest],
Expand Down Expand Up @@ -275,8 +276,7 @@ def get_monitored_resource_descriptor(
r"""Return a callable for the get monitored resource
descriptor method over gRPC.
Gets a single monitored resource descriptor. This
method does not require a Workspace.
Gets a single monitored resource descriptor.
Returns:
Callable[[~.GetMonitoredResourceDescriptorRequest],
Expand Down Expand Up @@ -307,8 +307,7 @@ def list_metric_descriptors(
]:
r"""Return a callable for the list metric descriptors method over gRPC.
Lists metric descriptors that match a filter. This
method does not require a Workspace.
Lists metric descriptors that match a filter.
Returns:
Callable[[~.ListMetricDescriptorsRequest],
Expand Down Expand Up @@ -336,8 +335,7 @@ def get_metric_descriptor(
]:
r"""Return a callable for the get metric descriptor method over gRPC.
Gets a single metric descriptor. This method does not
require a Workspace.
Gets a single metric descriptor.
Returns:
Callable[[~.GetMetricDescriptorRequest],
Expand Down Expand Up @@ -366,10 +364,10 @@ def create_metric_descriptor(
r"""Return a callable for the create metric descriptor method over gRPC.
Creates a new metric descriptor. The creation is executed
asynchronously and callers may check the returned operation to
track its progress. User-created metric descriptors define
`custom
asynchronously. User-created metric descriptors define `custom
metrics <https://cloud.google.com/monitoring/custom-metrics>`__.
The metric descriptor is updated if it already exists, except
that metric labels are never removed.
Returns:
Callable[[~.CreateMetricDescriptorRequest],
Expand Down Expand Up @@ -425,8 +423,7 @@ def list_time_series(
]:
r"""Return a callable for the list time series method over gRPC.
Lists time series that match a filter. This method
does not require a Workspace.
Lists time series that match a filter.
Returns:
Callable[[~.ListTimeSeriesRequest],
Expand All @@ -452,11 +449,12 @@ def create_time_series(
) -> Callable[[metric_service.CreateTimeSeriesRequest], empty_pb2.Empty]:
r"""Return a callable for the create time series method over gRPC.
Creates or adds data to one or more time series.
The response is empty if all time series in the request
were written. If any time series could not be written, a
corresponding failure message is included in the error
response.
Creates or adds data to one or more time series. The response is
empty if all time series in the request were written. If any
time series could not be written, a corresponding failure
message is included in the error response. This method does not
support `resource locations constraint of an organization
policy <https://cloud.google.com/resource-manager/docs/organization-policy/defining-locations#setting_the_organization_policy>`__.
Returns:
Callable[[~.CreateTimeSeriesRequest],
Expand Down
Loading

0 comments on commit 54b593d

Please sign in to comment.