Skip to content

Commit

Permalink
docs: Fix formatting of request arg in docstring (#535)
Browse files Browse the repository at this point in the history
* 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: googleapis/googleapis-gen@8731b8f
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: googleapis/googleapis-gen@b2ab4b0
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>
  • Loading branch information
gcf-owl-bot[bot] and gcf-owl-bot[bot] authored Mar 23, 2023
1 parent 02e342f commit a7909c3
Show file tree
Hide file tree
Showing 16 changed files with 166 additions and 214 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -277,8 +277,7 @@ async def sample_list_alert_policies():
Args:
request (Optional[Union[google.cloud.monitoring_v3.types.ListAlertPoliciesRequest, dict]]):
The request object. The protocol for the
`ListAlertPolicies` request.
The request object. The protocol for the ``ListAlertPolicies`` request.
name (:class:`str`):
Required. The
`project <https://cloud.google.com/monitoring/api/v3#project_name>`__
Expand Down Expand Up @@ -410,8 +409,7 @@ async def sample_get_alert_policy():
Args:
request (Optional[Union[google.cloud.monitoring_v3.types.GetAlertPolicyRequest, dict]]):
The request object. The protocol for the
`GetAlertPolicy` request.
The request object. The protocol for the ``GetAlertPolicy`` request.
name (:class:`str`):
Required. The alerting policy to retrieve. The format
is:
Expand Down Expand Up @@ -529,8 +527,7 @@ async def sample_create_alert_policy():
Args:
request (Optional[Union[google.cloud.monitoring_v3.types.CreateAlertPolicyRequest, dict]]):
The request object. The protocol for the
`CreateAlertPolicy` request.
The request object. The protocol for the ``CreateAlertPolicy`` request.
name (:class:`str`):
Required. The
`project <https://cloud.google.com/monitoring/api/v3#project_name>`__
Expand Down Expand Up @@ -657,8 +654,7 @@ async def sample_delete_alert_policy():
Args:
request (Optional[Union[google.cloud.monitoring_v3.types.DeleteAlertPolicyRequest, dict]]):
The request object. The protocol for the
`DeleteAlertPolicy` request.
The request object. The protocol for the ``DeleteAlertPolicy`` request.
name (:class:`str`):
Required. The alerting policy to delete. The format is:
Expand Down Expand Up @@ -768,8 +764,7 @@ async def sample_update_alert_policy():
Args:
request (Optional[Union[google.cloud.monitoring_v3.types.UpdateAlertPolicyRequest, dict]]):
The request object. The protocol for the
`UpdateAlertPolicy` request.
The request object. The protocol for the ``UpdateAlertPolicy`` request.
update_mask (:class:`google.protobuf.field_mask_pb2.FieldMask`):
Optional. A list of alerting policy field names. If this
field is not empty, each listed field in the existing
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -514,8 +514,7 @@ def sample_list_alert_policies():
Args:
request (Union[google.cloud.monitoring_v3.types.ListAlertPoliciesRequest, dict]):
The request object. The protocol for the
`ListAlertPolicies` request.
The request object. The protocol for the ``ListAlertPolicies`` request.
name (str):
Required. The
`project <https://cloud.google.com/monitoring/api/v3#project_name>`__
Expand Down Expand Up @@ -638,8 +637,7 @@ def sample_get_alert_policy():
Args:
request (Union[google.cloud.monitoring_v3.types.GetAlertPolicyRequest, dict]):
The request object. The protocol for the
`GetAlertPolicy` request.
The request object. The protocol for the ``GetAlertPolicy`` request.
name (str):
Required. The alerting policy to retrieve. The format
is:
Expand Down Expand Up @@ -748,8 +746,7 @@ def sample_create_alert_policy():
Args:
request (Union[google.cloud.monitoring_v3.types.CreateAlertPolicyRequest, dict]):
The request object. The protocol for the
`CreateAlertPolicy` request.
The request object. The protocol for the ``CreateAlertPolicy`` request.
name (str):
Required. The
`project <https://cloud.google.com/monitoring/api/v3#project_name>`__
Expand Down Expand Up @@ -876,8 +873,7 @@ def sample_delete_alert_policy():
Args:
request (Union[google.cloud.monitoring_v3.types.DeleteAlertPolicyRequest, dict]):
The request object. The protocol for the
`DeleteAlertPolicy` request.
The request object. The protocol for the ``DeleteAlertPolicy`` request.
name (str):
Required. The alerting policy to delete. The format is:
Expand Down Expand Up @@ -978,8 +974,7 @@ def sample_update_alert_policy():
Args:
request (Union[google.cloud.monitoring_v3.types.UpdateAlertPolicyRequest, dict]):
The request object. The protocol for the
`UpdateAlertPolicy` request.
The request object. The protocol for the ``UpdateAlertPolicy`` request.
update_mask (google.protobuf.field_mask_pb2.FieldMask):
Optional. A list of alerting policy field names. If this
field is not empty, each listed field in the existing
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -265,7 +265,7 @@ async def sample_list_groups():
Args:
request (Optional[Union[google.cloud.monitoring_v3.types.ListGroupsRequest, dict]]):
The request object. The `ListGroup` request.
The request object. The ``ListGroup`` request.
name (:class:`str`):
Required. The
`project <https://cloud.google.com/monitoring/api/v3#project_name>`__
Expand Down Expand Up @@ -391,7 +391,7 @@ async def sample_get_group():
Args:
request (Optional[Union[google.cloud.monitoring_v3.types.GetGroupRequest, dict]]):
The request object. The `GetGroup` request.
The request object. The ``GetGroup`` request.
name (:class:`str`):
Required. The group to retrieve. The format is:
Expand Down Expand Up @@ -536,7 +536,7 @@ async def sample_create_group():
Args:
request (Optional[Union[google.cloud.monitoring_v3.types.CreateGroupRequest, dict]]):
The request object. The `CreateGroup` request.
The request object. The ``CreateGroup`` request.
name (:class:`str`):
Required. The
`project <https://cloud.google.com/monitoring/api/v3#project_name>`__
Expand Down Expand Up @@ -682,7 +682,7 @@ async def sample_update_group():
Args:
request (Optional[Union[google.cloud.monitoring_v3.types.UpdateGroupRequest, dict]]):
The request object. The `UpdateGroup` request.
The request object. The ``UpdateGroup`` request.
group (:class:`google.cloud.monitoring_v3.types.Group`):
Required. The new definition of the group. All fields of
the existing group, excepting ``name``, are replaced
Expand Down Expand Up @@ -823,9 +823,9 @@ async def sample_delete_group():
Args:
request (Optional[Union[google.cloud.monitoring_v3.types.DeleteGroupRequest, dict]]):
The request object. The `DeleteGroup` request. The
default behavior is to be able to delete a single group
without any descendants.
The request object. The ``DeleteGroup`` request. The default behavior is to
be able to delete a single group without any
descendants.
name (:class:`str`):
Required. The group to delete. The format is:
Expand Down Expand Up @@ -931,7 +931,7 @@ async def sample_list_group_members():
Args:
request (Optional[Union[google.cloud.monitoring_v3.types.ListGroupMembersRequest, dict]]):
The request object. The `ListGroupMembers` request.
The request object. The ``ListGroupMembers`` request.
name (:class:`str`):
Required. The group whose members are listed. The format
is:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -489,7 +489,7 @@ def sample_list_groups():
Args:
request (Union[google.cloud.monitoring_v3.types.ListGroupsRequest, dict]):
The request object. The `ListGroup` request.
The request object. The ``ListGroup`` request.
name (str):
Required. The
`project <https://cloud.google.com/monitoring/api/v3#project_name>`__
Expand Down Expand Up @@ -606,7 +606,7 @@ def sample_get_group():
Args:
request (Union[google.cloud.monitoring_v3.types.GetGroupRequest, dict]):
The request object. The `GetGroup` request.
The request object. The ``GetGroup`` request.
name (str):
Required. The group to retrieve. The format is:
Expand Down Expand Up @@ -742,7 +742,7 @@ def sample_create_group():
Args:
request (Union[google.cloud.monitoring_v3.types.CreateGroupRequest, dict]):
The request object. The `CreateGroup` request.
The request object. The ``CreateGroup`` request.
name (str):
Required. The
`project <https://cloud.google.com/monitoring/api/v3#project_name>`__
Expand Down Expand Up @@ -888,7 +888,7 @@ def sample_update_group():
Args:
request (Union[google.cloud.monitoring_v3.types.UpdateGroupRequest, dict]):
The request object. The `UpdateGroup` request.
The request object. The ``UpdateGroup`` request.
group (google.cloud.monitoring_v3.types.Group):
Required. The new definition of the group. All fields of
the existing group, excepting ``name``, are replaced
Expand Down Expand Up @@ -1020,9 +1020,9 @@ def sample_delete_group():
Args:
request (Union[google.cloud.monitoring_v3.types.DeleteGroupRequest, dict]):
The request object. The `DeleteGroup` request. The
default behavior is to be able to delete a single group
without any descendants.
The request object. The ``DeleteGroup`` request. The default behavior is to
be able to delete a single group without any
descendants.
name (str):
Required. The group to delete. The format is:
Expand Down Expand Up @@ -1119,7 +1119,7 @@ def sample_list_group_members():
Args:
request (Union[google.cloud.monitoring_v3.types.ListGroupMembersRequest, dict]):
The request object. The `ListGroupMembers` request.
The request object. The ``ListGroupMembers`` request.
name (str):
Required. The group whose members are listed. The format
is:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -272,8 +272,7 @@ async def sample_list_monitored_resource_descriptors():
Args:
request (Optional[Union[google.cloud.monitoring_v3.types.ListMonitoredResourceDescriptorsRequest, dict]]):
The request object. The
`ListMonitoredResourceDescriptors` request.
The request object. The ``ListMonitoredResourceDescriptors`` request.
name (:class:`str`):
Required. The
`project <https://cloud.google.com/monitoring/api/v3#project_name>`__
Expand Down Expand Up @@ -402,8 +401,7 @@ async def sample_get_monitored_resource_descriptor():
Args:
request (Optional[Union[google.cloud.monitoring_v3.types.GetMonitoredResourceDescriptorRequest, dict]]):
The request object. The `GetMonitoredResourceDescriptor`
request.
The request object. The ``GetMonitoredResourceDescriptor`` request.
name (:class:`str`):
Required. The monitored resource descriptor to get. The
format is:
Expand All @@ -426,12 +424,14 @@ async def sample_get_monitored_resource_descriptor():
Returns:
google.api.monitored_resource_pb2.MonitoredResourceDescriptor:
An object that describes the schema of a [MonitoredResource][google.api.MonitoredResource] object using a
type name and a set of labels. For example, the
monitored resource descriptor for Google Compute
Engine VM instances has a type of "gce_instance" and
specifies the use of the labels "instance_id" and
"zone" to identify particular VM instances.
An object that describes the schema of a
[MonitoredResource][google.api.MonitoredResource]
object using a type name and a set of labels. For
example, the monitored resource descriptor for Google
Compute Engine VM instances has a type of
"gce_instance" and specifies the use of the labels
"instance_id" and "zone" to identify particular VM
instances.
Different APIs can support different monitored
resource types. APIs generally provide a list method
Expand Down Expand Up @@ -533,7 +533,7 @@ async def sample_list_metric_descriptors():
Args:
request (Optional[Union[google.cloud.monitoring_v3.types.ListMetricDescriptorsRequest, dict]]):
The request object. The `ListMetricDescriptors` request.
The request object. The ``ListMetricDescriptors`` request.
name (:class:`str`):
Required. The
`project <https://cloud.google.com/monitoring/api/v3#project_name>`__
Expand Down Expand Up @@ -662,7 +662,7 @@ async def sample_get_metric_descriptor():
Args:
request (Optional[Union[google.cloud.monitoring_v3.types.GetMetricDescriptorRequest, dict]]):
The request object. The `GetMetricDescriptor` request.
The request object. The ``GetMetricDescriptor`` request.
name (:class:`str`):
Required. The metric descriptor on which to execute the
request. The format is:
Expand Down Expand Up @@ -789,8 +789,7 @@ async def sample_create_metric_descriptor():
Args:
request (Optional[Union[google.cloud.monitoring_v3.types.CreateMetricDescriptorRequest, dict]]):
The request object. The `CreateMetricDescriptor`
request.
The request object. The ``CreateMetricDescriptor`` request.
name (:class:`str`):
Required. The
`project <https://cloud.google.com/monitoring/api/v3#project_name>`__
Expand Down Expand Up @@ -907,8 +906,7 @@ async def sample_delete_metric_descriptor():
Args:
request (Optional[Union[google.cloud.monitoring_v3.types.DeleteMetricDescriptorRequest, dict]]):
The request object. The `DeleteMetricDescriptor`
request.
The request object. The ``DeleteMetricDescriptor`` request.
name (:class:`str`):
Required. The metric descriptor on which to execute the
request. The format is:
Expand Down Expand Up @@ -1023,7 +1021,7 @@ async def sample_list_time_series():
Args:
request (Optional[Union[google.cloud.monitoring_v3.types.ListTimeSeriesRequest, dict]]):
The request object. The `ListTimeSeries` request.
The request object. The ``ListTimeSeries`` request.
name (:class:`str`):
Required. The
`project <https://cloud.google.com/monitoring/api/v3#project_name>`__,
Expand Down Expand Up @@ -1193,7 +1191,7 @@ async def sample_create_time_series():
Args:
request (Optional[Union[google.cloud.monitoring_v3.types.CreateTimeSeriesRequest, dict]]):
The request object. The `CreateTimeSeries` request.
The request object. The ``CreateTimeSeries`` request.
name (:class:`str`):
Required. The
`project <https://cloud.google.com/monitoring/api/v3#project_name>`__
Expand Down Expand Up @@ -1313,7 +1311,7 @@ async def sample_create_service_time_series():
Args:
request (Optional[Union[google.cloud.monitoring_v3.types.CreateTimeSeriesRequest, dict]]):
The request object. The `CreateTimeSeries` request.
The request object. The ``CreateTimeSeries`` request.
name (:class:`str`):
Required. The
`project <https://cloud.google.com/monitoring/api/v3#project_name>`__
Expand Down
Loading

0 comments on commit a7909c3

Please sign in to comment.