Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[CHANGE ME] Re-generated monitoring to pick up changes in the API or client library generator. #10345

Closed
wants to merge 1 commit into from
Closed

[CHANGE ME] Re-generated monitoring to pick up changes in the API or client library generator. #10345

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 9 additions & 8 deletions monitoring/google/cloud/monitoring_v3/gapic/alert_policy_service_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -262,7 +262,8 @@ def list_alert_policies(
... pass

Args:
name (str): The project whose alert policies are to be listed. The format is
name (str): Required. The project whose alert policies are to be listed. The format
is

projects/[PROJECT_ID]

Expand Down Expand Up @@ -372,7 +373,7 @@ def get_alert_policy(
>>> response = client.get_alert_policy(name)

Args:
name (str): The alerting policy to retrieve. The format is
name (str): Required. The alerting policy to retrieve. The format is

projects/[PROJECT_ID]/alertPolicies/[ALERT_POLICY_ID]
retry (Optional[google.api_core.retry.Retry]): A retry object used
Expand Down Expand Up @@ -450,17 +451,17 @@ def create_alert_policy(
>>> response = client.create_alert_policy(name, alert_policy)

Args:
name (str): The project in which to create the alerting policy. The format is
``projects/[PROJECT_ID]``.
name (str): Required. The project in which to create the alerting policy. The format
is ``projects/[PROJECT_ID]``.

Note that this field names the parent container in which the alerting
policy will be written, not the name of the created policy. The alerting
policy that is returned will have a name that contains a normalized
representation of this name as a prefix but adds a suffix of the form
``/alertPolicies/[POLICY_ID]``, identifying the policy in the container.
alert_policy (Union[dict, ~google.cloud.monitoring_v3.types.AlertPolicy]): The requested alerting policy. You should omit the ``name`` field in
this policy. The name will be returned in the new policy, including a
new [ALERT\_POLICY\_ID] value.
alert_policy (Union[dict, ~google.cloud.monitoring_v3.types.AlertPolicy]): Required. The requested alerting policy. You should omit the ``name``
field in this policy. The name will be returned in the new policy,
including a new [ALERT\_POLICY\_ID] value.

If a dict is provided, it must be of the same form as the protobuf
message :class:`~google.cloud.monitoring_v3.types.AlertPolicy`
Expand Down Expand Up @@ -537,7 +538,7 @@ def delete_alert_policy(
>>> client.delete_alert_policy(name)

Args:
name (str): The alerting policy to delete. The format is:
name (str): Required. The alerting policy to delete. The format is:

projects/[PROJECT_ID]/alertPolicies/[ALERT_POLICY_ID]

Expand Down
346 changes: 185 additions & 161 deletions monitoring/google/cloud/monitoring_v3/gapic/enums.py
View file
Open in desktop

Large diffs are not rendered by default.

20 changes: 10 additions & 10 deletions monitoring/google/cloud/monitoring_v3/gapic/group_service_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -256,7 +256,7 @@ def list_groups(
... pass

Args:
name (str): The project whose groups are to be listed. The format is
name (str): Required. The project whose groups are to be listed. The format is
``"projects/{project_id_or_number}"``.
children_of_group (str): A group name: ``"projects/{project_id_or_number}/groups/{group_id}"``.
Returns groups whose ``parentName`` field contains the group name. If no
Expand Down Expand Up @@ -374,7 +374,7 @@ def get_group(
>>> response = client.get_group(name)

Args:
name (str): The group to retrieve. The format is
name (str): Required. The group to retrieve. The format is
``"projects/{project_id_or_number}/groups/{group_id}"``.
retry (Optional[google.api_core.retry.Retry]): A retry object used
to retry requests. If ``None`` is specified, requests will
Expand Down Expand Up @@ -452,10 +452,10 @@ def create_group(
>>> response = client.create_group(name, group)

Args:
name (str): The project in which to create the group. The format is
name (str): Required. The project in which to create the group. The format is
``"projects/{project_id_or_number}"``.
group (Union[dict, ~google.cloud.monitoring_v3.types.Group]): A group definition. It is an error to define the ``name`` field because
the system assigns the name.
group (Union[dict, ~google.cloud.monitoring_v3.types.Group]): Required. A group definition. It is an error to define the ``name``
field because the system assigns the name.

If a dict is provided, it must be of the same form as the protobuf
message :class:`~google.cloud.monitoring_v3.types.Group`
Expand Down Expand Up @@ -536,9 +536,9 @@ def update_group(
>>> response = client.update_group(group)

Args:
group (Union[dict, ~google.cloud.monitoring_v3.types.Group]): The new definition of the group. All fields of the existing group,
excepting ``name``, are replaced with the corresponding fields of this
group.
group (Union[dict, ~google.cloud.monitoring_v3.types.Group]): Required. The new definition of the group. All fields of the existing
group, excepting ``name``, are replaced with the corresponding fields of
this group.

If a dict is provided, it must be of the same form as the protobuf
message :class:`~google.cloud.monitoring_v3.types.Group`
Expand Down Expand Up @@ -617,7 +617,7 @@ def delete_group(
>>> client.delete_group(name)

Args:
name (str): The group to delete. The format is
name (str): Required. The group to delete. The format is
``"projects/{project_id_or_number}/groups/{group_id}"``.
recursive (bool): If this field is true, then the request means to delete a group with all
its descendants. Otherwise, the request means to delete a group only when
Expand Down Expand Up @@ -705,7 +705,7 @@ def list_group_members(
... pass

Args:
name (str): The group whose members are listed. The format is
name (str): Required. The group whose members are listed. The format is
``"projects/{project_id_or_number}/groups/{group_id}"``.
page_size (int): The maximum number of resources contained in the
underlying API response. If page streaming is performed per-
Expand Down
36 changes: 19 additions & 17 deletions monitoring/google/cloud/monitoring_v3/gapic/metric_service_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -260,7 +260,7 @@ def list_monitored_resource_descriptors(
... pass

Args:
name (str): The project on which to execute the request. The format is
name (str): Required. The project on which to execute the request. The format is
``"projects/{project_id_or_number}"``.
filter_ (str): An optional
`filter <https://cloud.google.com/monitoring/api/v3/filters>`__
Expand Down Expand Up @@ -367,7 +367,7 @@ def get_monitored_resource_descriptor(
>>> response = client.get_monitored_resource_descriptor(name)

Args:
name (str): The monitored resource descriptor to get. The format is
name (str): Required. The monitored resource descriptor to get. The format is
``"projects/{project_id_or_number}/monitoredResourceDescriptors/{resource_type}"``.
The ``{resource_type}`` is a predefined type, such as
``cloudsql_database``.
Expand Down Expand Up @@ -460,7 +460,7 @@ def list_metric_descriptors(
... pass

Args:
name (str): The project on which to execute the request. The format is
name (str): Required. The project on which to execute the request. The format is
``"projects/{project_id_or_number}"``.
filter_ (str): If this field is empty, all custom and system-defined metric descriptors
are returned. Otherwise, the
Expand Down Expand Up @@ -564,7 +564,8 @@ def get_metric_descriptor(
>>> response = client.get_metric_descriptor(name)

Args:
name (str): The metric descriptor on which to execute the request. The format is
name (str): Required. The metric descriptor on which to execute the request. The
format is
``"projects/{project_id_or_number}/metricDescriptors/{metric_id}"``. An
example value of ``{metric_id}`` is
``"compute.googleapis.com/instance/disk/read_bytes_count"``.
Expand Down Expand Up @@ -644,9 +645,9 @@ def create_metric_descriptor(
>>> response = client.create_metric_descriptor(name, metric_descriptor)

Args:
name (str): The project on which to execute the request. The format is
name (str): Required. The project on which to execute the request. The format is
``"projects/{project_id_or_number}"``.
metric_descriptor (Union[dict, ~google.cloud.monitoring_v3.types.MetricDescriptor]): The new `custom
metric_descriptor (Union[dict, ~google.cloud.monitoring_v3.types.MetricDescriptor]): Required. The new `custom
metric <https://cloud.google.com/monitoring/custom-metrics>`__
descriptor.

Expand Down Expand Up @@ -727,7 +728,8 @@ def delete_metric_descriptor(
>>> client.delete_metric_descriptor(name)

Args:
name (str): The metric descriptor on which to execute the request. The format is
name (str): Required. The metric descriptor on which to execute the request. The
format is
``"projects/{project_id_or_number}/metricDescriptors/{metric_id}"``. An
example of ``{metric_id}`` is:
``"custom.googleapis.com/my_test_metric"``.
Expand Down Expand Up @@ -827,9 +829,9 @@ def list_time_series(
... pass

Args:
name (str): The project on which to execute the request. The format is
name (str): Required. The project on which to execute the request. The format is
"projects/{project\_id\_or\_number}".
filter_ (str): A `monitoring
filter_ (str): Required. A `monitoring
filter <https://cloud.google.com/monitoring/api/v3/filters>`__ that
specifies which time series should be returned. The filter must specify
a single metric type, and can additionally specify metric labels and
Expand All @@ -839,13 +841,13 @@ def list_time_series(

metric.type = "compute.googleapis.com/instance/cpu/usage_time" AND
metric.labels.instance_name = "my-instance-name"
interval (Union[dict, ~google.cloud.monitoring_v3.types.TimeInterval]): The time interval for which results should be returned. Only time series
interval (Union[dict, ~google.cloud.monitoring_v3.types.TimeInterval]): Required. The time interval for which results should be returned. Only time series
that contain data points in the specified interval are included
in the response.

If a dict is provided, it must be of the same form as the protobuf
message :class:`~google.cloud.monitoring_v3.types.TimeInterval`
view (~google.cloud.monitoring_v3.types.TimeSeriesView): Specifies which information is returned about the time series.
view (~google.cloud.monitoring_v3.types.TimeSeriesView): Required. Specifies which information is returned about the time series.
aggregation (Union[dict, ~google.cloud.monitoring_v3.types.Aggregation]): Specifies the alignment of data points in individual time series as well
as how to combine the retrieved time series across specified labels.

Expand Down Expand Up @@ -961,13 +963,13 @@ def create_time_series(
>>> client.create_time_series(name, time_series)

Args:
name (str): The project on which to execute the request. The format is
name (str): Required. The project on which to execute the request. The format is
``"projects/{project_id_or_number}"``.
time_series (list[Union[dict, ~google.cloud.monitoring_v3.types.TimeSeries]]): The new data to be added to a list of time series. Adds at most one data
point to each of several time series. The new data point must be more
recent than any other point in its time series. Each ``TimeSeries``
value must fully specify a unique time series by supplying all label
values for the metric and the monitored resource.
time_series (list[Union[dict, ~google.cloud.monitoring_v3.types.TimeSeries]]): Required. The new data to be added to a list of time series. Adds at
most one data point to each of several time series. The new data point
must be more recent than any other point in its time series. Each
``TimeSeries`` value must fully specify a unique time series by
supplying all label values for the metric and the monitored resource.

The maximum number of ``TimeSeries`` objects per ``Create`` request is
200.
Expand Down
37 changes: 19 additions & 18 deletions monitoring/google/cloud/monitoring_v3/gapic/notification_channel_service_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -266,8 +266,8 @@ def list_notification_channel_descriptors(
... pass

Args:
name (str): The REST resource name of the parent from which to retrieve the
notification channel descriptors. The expected syntax is:
name (str): Required. The REST resource name of the parent from which to retrieve
the notification channel descriptors. The expected syntax is:

::

Expand Down Expand Up @@ -373,7 +373,8 @@ def get_notification_channel_descriptor(
>>> response = client.get_notification_channel_descriptor(name)

Args:
name (str): The channel type for which to execute the request. The format is
name (str): Required. The channel type for which to execute the request. The format
is
``projects/[PROJECT_ID]/notificationChannelDescriptors/{channel_type}``.
retry (Optional[google.api_core.retry.Retry]): A retry object used
to retry requests. If ``None`` is specified, requests will
Expand Down Expand Up @@ -467,7 +468,7 @@ def list_notification_channels(
... pass

Args:
name (str): The project on which to execute the request. The format is
name (str): Required. The project on which to execute the request. The format is
``projects/[PROJECT_ID]``. That is, this names the container in which to
look for the notification channels; it does not name a specific channel.
To query a specific channel by REST resource name, use the
Expand Down Expand Up @@ -581,7 +582,7 @@ def get_notification_channel(
>>> response = client.get_notification_channel(name)

Args:
name (str): The channel for which to execute the request. The format is
name (str): Required. The channel for which to execute the request. The format is
``projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID]``.
retry (Optional[google.api_core.retry.Retry]): A retry object used
to retry requests. If ``None`` is specified, requests will
Expand Down Expand Up @@ -659,7 +660,7 @@ def create_notification_channel(
>>> response = client.create_notification_channel(name, notification_channel)

Args:
name (str): The project on which to execute the request. The format is:
name (str): Required. The project on which to execute the request. The format is:

::

Expand All @@ -670,7 +671,7 @@ def create_notification_channel(
channel's name will have a normalized version of this field as a prefix,
but will add ``/notificationChannels/[CHANNEL_ID]`` to identify the
channel.
notification_channel (Union[dict, ~google.cloud.monitoring_v3.types.NotificationChannel]): The definition of the ``NotificationChannel`` to create.
notification_channel (Union[dict, ~google.cloud.monitoring_v3.types.NotificationChannel]): Required. The definition of the ``NotificationChannel`` to create.

If a dict is provided, it must be of the same form as the protobuf
message :class:`~google.cloud.monitoring_v3.types.NotificationChannel`
Expand Down Expand Up @@ -752,10 +753,10 @@ def update_notification_channel(
>>> response = client.update_notification_channel(notification_channel)

Args:
notification_channel (Union[dict, ~google.cloud.monitoring_v3.types.NotificationChannel]): A description of the changes to be applied to the specified notification
channel. The description must provide a definition for fields to be
updated; the names of these fields should also be included in the
``update_mask``.
notification_channel (Union[dict, ~google.cloud.monitoring_v3.types.NotificationChannel]): Required. A description of the changes to be applied to the specified
notification channel. The description must provide a definition for
fields to be updated; the names of these fields should also be included
in the ``update_mask``.

If a dict is provided, it must be of the same form as the protobuf
message :class:`~google.cloud.monitoring_v3.types.NotificationChannel`
Expand Down Expand Up @@ -839,7 +840,7 @@ def delete_notification_channel(
>>> client.delete_notification_channel(name)

Args:
name (str): The channel for which to execute the request. The format is
name (str): Required. The channel for which to execute the request. The format is
``projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID]``.
force (bool): If true, the notification channel will be deleted regardless of its
use in alert policies (the policies will be updated to remove the
Expand Down Expand Up @@ -918,7 +919,7 @@ def send_notification_channel_verification_code(
>>> client.send_notification_channel_verification_code(name)

Args:
name (str): The notification channel to which to send a verification code.
name (str): Required. The notification channel to which to send a verification code.
retry (Optional[google.api_core.retry.Retry]): A retry object used
to retry requests. If ``None`` is specified, requests will
be retried using a default configuration.
Expand Down Expand Up @@ -1014,7 +1015,7 @@ def get_notification_channel_verification_code(
>>> response = client.get_notification_channel_verification_code(name)

Args:
name (str): The notification channel for which a verification code is to be generated
name (str): Required. The notification channel for which a verification code is to be generated
and retrieved. This must name a channel that is already verified; if
the specified channel is not verified, the request will fail.
expire_time (Union[dict, ~google.cloud.monitoring_v3.types.Timestamp]): The desired expiration time. If specified, the API will guarantee that
Expand Down Expand Up @@ -1112,10 +1113,10 @@ def verify_notification_channel(
>>> response = client.verify_notification_channel(name, code)

Args:
name (str): The notification channel to verify.
code (str): The verification code that was delivered to the channel as a result of
invoking the ``SendNotificationChannelVerificationCode`` API method or
that was retrieved from a verified channel via
name (str): Required. The notification channel to verify.
code (str): Required. The verification code that was delivered to the channel as a
result of invoking the ``SendNotificationChannelVerificationCode`` API
method or that was retrieved from a verified channel via
``GetNotificationChannelVerificationCode``. For example, one might have
"G-123456" or "TKNZGhhd2EyN3I1MnRnMjRv" (in general, one is only
guaranteed that the code is valid UTF-8; one should not make any
Expand Down
Loading