Skip to content
This repository was archived by the owner on Dec 31, 2023. It is now read-only.

Commit e10167f

Browse files
docs: Fix formatting of request arg in docstring (#535)
* feat: added overrides_by_request_protocol to backend.proto feat: added field proto_reference_documentation_uri to proto reference documentation. feat: added SERVICE_NOT_VISIBLE and GCP_SUSPENDED into error reason PiperOrigin-RevId: 517437454 Source-Link: googleapis/googleapis@ecb1cf0 Source-Link: https://github.com/googleapis/googleapis-gen/commit/8731b8fd2044a93c32309d633dfc2e836bf13cbf Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiODczMWI4ZmQyMDQ0YTkzYzMyMzA5ZDYzM2RmYzJlODM2YmYxM2NiZiJ9 * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * docs: Fix formatting of request arg in docstring chore: Update gapic-generator-python to v1.9.1 PiperOrigin-RevId: 518604533 Source-Link: googleapis/googleapis@8a085ae Source-Link: https://github.com/googleapis/googleapis-gen/commit/b2ab4b0a0ae2907e812c209198a74e0898afcb04 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiYjJhYjRiMGEwYWUyOTA3ZTgxMmMyMDkxOThhNzRlMDg5OGFmY2IwNCJ9 * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
1 parent 8a08d74 commit e10167f

File tree

16 files changed

+166
-214
lines changed

16 files changed

+166
-214
lines changed

google/cloud/monitoring_v3/services/alert_policy_service/async_client.py

+5-10
Original file line numberDiff line numberDiff line change
@@ -277,8 +277,7 @@ async def sample_list_alert_policies():
277277
278278
Args:
279279
request (Optional[Union[google.cloud.monitoring_v3.types.ListAlertPoliciesRequest, dict]]):
280-
The request object. The protocol for the
281-
`ListAlertPolicies` request.
280+
The request object. The protocol for the ``ListAlertPolicies`` request.
282281
name (:class:`str`):
283282
Required. The
284283
`project <https://cloud.google.com/monitoring/api/v3#project_name>`__
@@ -410,8 +409,7 @@ async def sample_get_alert_policy():
410409
411410
Args:
412411
request (Optional[Union[google.cloud.monitoring_v3.types.GetAlertPolicyRequest, dict]]):
413-
The request object. The protocol for the
414-
`GetAlertPolicy` request.
412+
The request object. The protocol for the ``GetAlertPolicy`` request.
415413
name (:class:`str`):
416414
Required. The alerting policy to retrieve. The format
417415
is:
@@ -529,8 +527,7 @@ async def sample_create_alert_policy():
529527
530528
Args:
531529
request (Optional[Union[google.cloud.monitoring_v3.types.CreateAlertPolicyRequest, dict]]):
532-
The request object. The protocol for the
533-
`CreateAlertPolicy` request.
530+
The request object. The protocol for the ``CreateAlertPolicy`` request.
534531
name (:class:`str`):
535532
Required. The
536533
`project <https://cloud.google.com/monitoring/api/v3#project_name>`__
@@ -657,8 +654,7 @@ async def sample_delete_alert_policy():
657654
658655
Args:
659656
request (Optional[Union[google.cloud.monitoring_v3.types.DeleteAlertPolicyRequest, dict]]):
660-
The request object. The protocol for the
661-
`DeleteAlertPolicy` request.
657+
The request object. The protocol for the ``DeleteAlertPolicy`` request.
662658
name (:class:`str`):
663659
Required. The alerting policy to delete. The format is:
664660
@@ -768,8 +764,7 @@ async def sample_update_alert_policy():
768764
769765
Args:
770766
request (Optional[Union[google.cloud.monitoring_v3.types.UpdateAlertPolicyRequest, dict]]):
771-
The request object. The protocol for the
772-
`UpdateAlertPolicy` request.
767+
The request object. The protocol for the ``UpdateAlertPolicy`` request.
773768
update_mask (:class:`google.protobuf.field_mask_pb2.FieldMask`):
774769
Optional. A list of alerting policy field names. If this
775770
field is not empty, each listed field in the existing

google/cloud/monitoring_v3/services/alert_policy_service/client.py

+5-10
Original file line numberDiff line numberDiff line change
@@ -514,8 +514,7 @@ def sample_list_alert_policies():
514514
515515
Args:
516516
request (Union[google.cloud.monitoring_v3.types.ListAlertPoliciesRequest, dict]):
517-
The request object. The protocol for the
518-
`ListAlertPolicies` request.
517+
The request object. The protocol for the ``ListAlertPolicies`` request.
519518
name (str):
520519
Required. The
521520
`project <https://cloud.google.com/monitoring/api/v3#project_name>`__
@@ -638,8 +637,7 @@ def sample_get_alert_policy():
638637
639638
Args:
640639
request (Union[google.cloud.monitoring_v3.types.GetAlertPolicyRequest, dict]):
641-
The request object. The protocol for the
642-
`GetAlertPolicy` request.
640+
The request object. The protocol for the ``GetAlertPolicy`` request.
643641
name (str):
644642
Required. The alerting policy to retrieve. The format
645643
is:
@@ -748,8 +746,7 @@ def sample_create_alert_policy():
748746
749747
Args:
750748
request (Union[google.cloud.monitoring_v3.types.CreateAlertPolicyRequest, dict]):
751-
The request object. The protocol for the
752-
`CreateAlertPolicy` request.
749+
The request object. The protocol for the ``CreateAlertPolicy`` request.
753750
name (str):
754751
Required. The
755752
`project <https://cloud.google.com/monitoring/api/v3#project_name>`__
@@ -876,8 +873,7 @@ def sample_delete_alert_policy():
876873
877874
Args:
878875
request (Union[google.cloud.monitoring_v3.types.DeleteAlertPolicyRequest, dict]):
879-
The request object. The protocol for the
880-
`DeleteAlertPolicy` request.
876+
The request object. The protocol for the ``DeleteAlertPolicy`` request.
881877
name (str):
882878
Required. The alerting policy to delete. The format is:
883879
@@ -978,8 +974,7 @@ def sample_update_alert_policy():
978974
979975
Args:
980976
request (Union[google.cloud.monitoring_v3.types.UpdateAlertPolicyRequest, dict]):
981-
The request object. The protocol for the
982-
`UpdateAlertPolicy` request.
977+
The request object. The protocol for the ``UpdateAlertPolicy`` request.
983978
update_mask (google.protobuf.field_mask_pb2.FieldMask):
984979
Optional. A list of alerting policy field names. If this
985980
field is not empty, each listed field in the existing

google/cloud/monitoring_v3/services/group_service/async_client.py

+8-8
Original file line numberDiff line numberDiff line change
@@ -265,7 +265,7 @@ async def sample_list_groups():
265265
266266
Args:
267267
request (Optional[Union[google.cloud.monitoring_v3.types.ListGroupsRequest, dict]]):
268-
The request object. The `ListGroup` request.
268+
The request object. The ``ListGroup`` request.
269269
name (:class:`str`):
270270
Required. The
271271
`project <https://cloud.google.com/monitoring/api/v3#project_name>`__
@@ -391,7 +391,7 @@ async def sample_get_group():
391391
392392
Args:
393393
request (Optional[Union[google.cloud.monitoring_v3.types.GetGroupRequest, dict]]):
394-
The request object. The `GetGroup` request.
394+
The request object. The ``GetGroup`` request.
395395
name (:class:`str`):
396396
Required. The group to retrieve. The format is:
397397
@@ -536,7 +536,7 @@ async def sample_create_group():
536536
537537
Args:
538538
request (Optional[Union[google.cloud.monitoring_v3.types.CreateGroupRequest, dict]]):
539-
The request object. The `CreateGroup` request.
539+
The request object. The ``CreateGroup`` request.
540540
name (:class:`str`):
541541
Required. The
542542
`project <https://cloud.google.com/monitoring/api/v3#project_name>`__
@@ -682,7 +682,7 @@ async def sample_update_group():
682682
683683
Args:
684684
request (Optional[Union[google.cloud.monitoring_v3.types.UpdateGroupRequest, dict]]):
685-
The request object. The `UpdateGroup` request.
685+
The request object. The ``UpdateGroup`` request.
686686
group (:class:`google.cloud.monitoring_v3.types.Group`):
687687
Required. The new definition of the group. All fields of
688688
the existing group, excepting ``name``, are replaced
@@ -823,9 +823,9 @@ async def sample_delete_group():
823823
824824
Args:
825825
request (Optional[Union[google.cloud.monitoring_v3.types.DeleteGroupRequest, dict]]):
826-
The request object. The `DeleteGroup` request. The
827-
default behavior is to be able to delete a single group
828-
without any descendants.
826+
The request object. The ``DeleteGroup`` request. The default behavior is to
827+
be able to delete a single group without any
828+
descendants.
829829
name (:class:`str`):
830830
Required. The group to delete. The format is:
831831
@@ -931,7 +931,7 @@ async def sample_list_group_members():
931931
932932
Args:
933933
request (Optional[Union[google.cloud.monitoring_v3.types.ListGroupMembersRequest, dict]]):
934-
The request object. The `ListGroupMembers` request.
934+
The request object. The ``ListGroupMembers`` request.
935935
name (:class:`str`):
936936
Required. The group whose members are listed. The format
937937
is:

google/cloud/monitoring_v3/services/group_service/client.py

+8-8
Original file line numberDiff line numberDiff line change
@@ -489,7 +489,7 @@ def sample_list_groups():
489489
490490
Args:
491491
request (Union[google.cloud.monitoring_v3.types.ListGroupsRequest, dict]):
492-
The request object. The `ListGroup` request.
492+
The request object. The ``ListGroup`` request.
493493
name (str):
494494
Required. The
495495
`project <https://cloud.google.com/monitoring/api/v3#project_name>`__
@@ -606,7 +606,7 @@ def sample_get_group():
606606
607607
Args:
608608
request (Union[google.cloud.monitoring_v3.types.GetGroupRequest, dict]):
609-
The request object. The `GetGroup` request.
609+
The request object. The ``GetGroup`` request.
610610
name (str):
611611
Required. The group to retrieve. The format is:
612612
@@ -742,7 +742,7 @@ def sample_create_group():
742742
743743
Args:
744744
request (Union[google.cloud.monitoring_v3.types.CreateGroupRequest, dict]):
745-
The request object. The `CreateGroup` request.
745+
The request object. The ``CreateGroup`` request.
746746
name (str):
747747
Required. The
748748
`project <https://cloud.google.com/monitoring/api/v3#project_name>`__
@@ -888,7 +888,7 @@ def sample_update_group():
888888
889889
Args:
890890
request (Union[google.cloud.monitoring_v3.types.UpdateGroupRequest, dict]):
891-
The request object. The `UpdateGroup` request.
891+
The request object. The ``UpdateGroup`` request.
892892
group (google.cloud.monitoring_v3.types.Group):
893893
Required. The new definition of the group. All fields of
894894
the existing group, excepting ``name``, are replaced
@@ -1020,9 +1020,9 @@ def sample_delete_group():
10201020
10211021
Args:
10221022
request (Union[google.cloud.monitoring_v3.types.DeleteGroupRequest, dict]):
1023-
The request object. The `DeleteGroup` request. The
1024-
default behavior is to be able to delete a single group
1025-
without any descendants.
1023+
The request object. The ``DeleteGroup`` request. The default behavior is to
1024+
be able to delete a single group without any
1025+
descendants.
10261026
name (str):
10271027
Required. The group to delete. The format is:
10281028
@@ -1119,7 +1119,7 @@ def sample_list_group_members():
11191119
11201120
Args:
11211121
request (Union[google.cloud.monitoring_v3.types.ListGroupMembersRequest, dict]):
1122-
The request object. The `ListGroupMembers` request.
1122+
The request object. The ``ListGroupMembers`` request.
11231123
name (str):
11241124
Required. The group whose members are listed. The format
11251125
is:

google/cloud/monitoring_v3/services/metric_service/async_client.py

+17-19
Original file line numberDiff line numberDiff line change
@@ -272,8 +272,7 @@ async def sample_list_monitored_resource_descriptors():
272272
273273
Args:
274274
request (Optional[Union[google.cloud.monitoring_v3.types.ListMonitoredResourceDescriptorsRequest, dict]]):
275-
The request object. The
276-
`ListMonitoredResourceDescriptors` request.
275+
The request object. The ``ListMonitoredResourceDescriptors`` request.
277276
name (:class:`str`):
278277
Required. The
279278
`project <https://cloud.google.com/monitoring/api/v3#project_name>`__
@@ -402,8 +401,7 @@ async def sample_get_monitored_resource_descriptor():
402401
403402
Args:
404403
request (Optional[Union[google.cloud.monitoring_v3.types.GetMonitoredResourceDescriptorRequest, dict]]):
405-
The request object. The `GetMonitoredResourceDescriptor`
406-
request.
404+
The request object. The ``GetMonitoredResourceDescriptor`` request.
407405
name (:class:`str`):
408406
Required. The monitored resource descriptor to get. The
409407
format is:
@@ -426,12 +424,14 @@ async def sample_get_monitored_resource_descriptor():
426424
427425
Returns:
428426
google.api.monitored_resource_pb2.MonitoredResourceDescriptor:
429-
An object that describes the schema of a [MonitoredResource][google.api.MonitoredResource] object using a
430-
type name and a set of labels. For example, the
431-
monitored resource descriptor for Google Compute
432-
Engine VM instances has a type of "gce_instance" and
433-
specifies the use of the labels "instance_id" and
434-
"zone" to identify particular VM instances.
427+
An object that describes the schema of a
428+
[MonitoredResource][google.api.MonitoredResource]
429+
object using a type name and a set of labels. For
430+
example, the monitored resource descriptor for Google
431+
Compute Engine VM instances has a type of
432+
"gce_instance" and specifies the use of the labels
433+
"instance_id" and "zone" to identify particular VM
434+
instances.
435435
436436
Different APIs can support different monitored
437437
resource types. APIs generally provide a list method
@@ -533,7 +533,7 @@ async def sample_list_metric_descriptors():
533533
534534
Args:
535535
request (Optional[Union[google.cloud.monitoring_v3.types.ListMetricDescriptorsRequest, dict]]):
536-
The request object. The `ListMetricDescriptors` request.
536+
The request object. The ``ListMetricDescriptors`` request.
537537
name (:class:`str`):
538538
Required. The
539539
`project <https://cloud.google.com/monitoring/api/v3#project_name>`__
@@ -662,7 +662,7 @@ async def sample_get_metric_descriptor():
662662
663663
Args:
664664
request (Optional[Union[google.cloud.monitoring_v3.types.GetMetricDescriptorRequest, dict]]):
665-
The request object. The `GetMetricDescriptor` request.
665+
The request object. The ``GetMetricDescriptor`` request.
666666
name (:class:`str`):
667667
Required. The metric descriptor on which to execute the
668668
request. The format is:
@@ -789,8 +789,7 @@ async def sample_create_metric_descriptor():
789789
790790
Args:
791791
request (Optional[Union[google.cloud.monitoring_v3.types.CreateMetricDescriptorRequest, dict]]):
792-
The request object. The `CreateMetricDescriptor`
793-
request.
792+
The request object. The ``CreateMetricDescriptor`` request.
794793
name (:class:`str`):
795794
Required. The
796795
`project <https://cloud.google.com/monitoring/api/v3#project_name>`__
@@ -907,8 +906,7 @@ async def sample_delete_metric_descriptor():
907906
908907
Args:
909908
request (Optional[Union[google.cloud.monitoring_v3.types.DeleteMetricDescriptorRequest, dict]]):
910-
The request object. The `DeleteMetricDescriptor`
911-
request.
909+
The request object. The ``DeleteMetricDescriptor`` request.
912910
name (:class:`str`):
913911
Required. The metric descriptor on which to execute the
914912
request. The format is:
@@ -1023,7 +1021,7 @@ async def sample_list_time_series():
10231021
10241022
Args:
10251023
request (Optional[Union[google.cloud.monitoring_v3.types.ListTimeSeriesRequest, dict]]):
1026-
The request object. The `ListTimeSeries` request.
1024+
The request object. The ``ListTimeSeries`` request.
10271025
name (:class:`str`):
10281026
Required. The
10291027
`project <https://cloud.google.com/monitoring/api/v3#project_name>`__,
@@ -1193,7 +1191,7 @@ async def sample_create_time_series():
11931191
11941192
Args:
11951193
request (Optional[Union[google.cloud.monitoring_v3.types.CreateTimeSeriesRequest, dict]]):
1196-
The request object. The `CreateTimeSeries` request.
1194+
The request object. The ``CreateTimeSeries`` request.
11971195
name (:class:`str`):
11981196
Required. The
11991197
`project <https://cloud.google.com/monitoring/api/v3#project_name>`__
@@ -1313,7 +1311,7 @@ async def sample_create_service_time_series():
13131311
13141312
Args:
13151313
request (Optional[Union[google.cloud.monitoring_v3.types.CreateTimeSeriesRequest, dict]]):
1316-
The request object. The `CreateTimeSeries` request.
1314+
The request object. The ``CreateTimeSeries`` request.
13171315
name (:class:`str`):
13181316
Required. The
13191317
`project <https://cloud.google.com/monitoring/api/v3#project_name>`__

0 commit comments

Comments
 (0)