Skip to content

Commit

Permalink
docs: Fix formatting of request arg in docstring (#10867)
Browse files Browse the repository at this point in the history
* 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: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWFkdmlzb3J5bm90aWZpY2F0aW9ucy8uT3dsQm90LnlhbWwiLCJoIjoiYjJhYjRiMGEwYWUyOTA3ZTgxMmMyMDkxOThhNzRlMDg5OGFmY2IwNCJ9
Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWFsbG95ZGIvLk93bEJvdC55YW1sIiwiaCI6ImIyYWI0YjBhMGFlMjkwN2U4MTJjMjA5MTk4YTc0ZTA4OThhZmNiMDQifQ==
Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWJpZ3F1ZXJ5LWJpZ2xha2UvLk93bEJvdC55YW1sIiwiaCI6ImIyYWI0YjBhMGFlMjkwN2U4MTJjMjA5MTk4YTc0ZTA4OThhZmNiMDQifQ==
Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWNvbnRlbnR3YXJlaG91c2UvLk93bEJvdC55YW1sIiwiaCI6ImIyYWI0YjBhMGFlMjkwN2U4MTJjMjA5MTk4YTc0ZTA4OThhZmNiMDQifQ==
Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWRhdGFjYXRhbG9nLWxpbmVhZ2UvLk93bEJvdC55YW1sIiwiaCI6ImIyYWI0YjBhMGFlMjkwN2U4MTJjMjA5MTk4YTc0ZTA4OThhZmNiMDQifQ==
Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWRpc2NvdmVyeWVuZ2luZS8uT3dsQm90LnlhbWwiLCJoIjoiYjJhYjRiMGEwYWUyOTA3ZTgxMmMyMDkxOThhNzRlMDg5OGFmY2IwNCJ9
Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWVudGVycHJpc2Vrbm93bGVkZ2VncmFwaC8uT3dsQm90LnlhbWwiLCJoIjoiYjJhYjRiMGEwYWUyOTA3ZTgxMmMyMDkxOThhNzRlMDg5OGFmY2IwNCJ9
Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLXZtd2FyZWVuZ2luZS8uT3dsQm90LnlhbWwiLCJoIjoiYjJhYjRiMGEwYWUyOTA3ZTgxMmMyMDkxOThhNzRlMDg5OGFmY2IwNCJ9
Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLXdvcmtzdGF0aW9ucy8uT3dsQm90LnlhbWwiLCJoIjoiYjJhYjRiMGEwYWUyOTA3ZTgxMmMyMDkxOThhNzRlMDg5OGFmY2IwNCJ9
Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLW1hcHMtYWRkcmVzc3ZhbGlkYXRpb24vLk93bEJvdC55YW1sIiwiaCI6ImIyYWI0YjBhMGFlMjkwN2U4MTJjMjA5MTk4YTc0ZTA4OThhZmNiMDQifQ==
Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLW1hcHMtbWFwc3BsYXRmb3JtZGF0YXNldHMvLk93bEJvdC55YW1sIiwiaCI6ImIyYWI0YjBhMGFlMjkwN2U4MTJjMjA5MTk4YTc0ZTA4OThhZmNiMDQifQ==

* 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: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWFkdmlzb3J5bm90aWZpY2F0aW9ucy8uT3dsQm90LnlhbWwiLCJoIjoiYjJhYjRiMGEwYWUyOTA3ZTgxMmMyMDkxOThhNzRlMDg5OGFmY2IwNCJ9
Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWFsbG95ZGIvLk93bEJvdC55YW1sIiwiaCI6ImIyYWI0YjBhMGFlMjkwN2U4MTJjMjA5MTk4YTc0ZTA4OThhZmNiMDQifQ==
Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWJpZ3F1ZXJ5LWJpZ2xha2UvLk93bEJvdC55YW1sIiwiaCI6ImIyYWI0YjBhMGFlMjkwN2U4MTJjMjA5MTk4YTc0ZTA4OThhZmNiMDQifQ==
Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWNvbnRlbnR3YXJlaG91c2UvLk93bEJvdC55YW1sIiwiaCI6ImIyYWI0YjBhMGFlMjkwN2U4MTJjMjA5MTk4YTc0ZTA4OThhZmNiMDQifQ==
Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWRhdGFjYXRhbG9nLWxpbmVhZ2UvLk93bEJvdC55YW1sIiwiaCI6ImIyYWI0YjBhMGFlMjkwN2U4MTJjMjA5MTk4YTc0ZTA4OThhZmNiMDQifQ==
Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWRpc2NvdmVyeWVuZ2luZS8uT3dsQm90LnlhbWwiLCJoIjoiYjJhYjRiMGEwYWUyOTA3ZTgxMmMyMDkxOThhNzRlMDg5OGFmY2IwNCJ9
Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWVudGVycHJpc2Vrbm93bGVkZ2VncmFwaC8uT3dsQm90LnlhbWwiLCJoIjoiYjJhYjRiMGEwYWUyOTA3ZTgxMmMyMDkxOThhNzRlMDg5OGFmY2IwNCJ9
Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLXZtd2FyZWVuZ2luZS8uT3dsQm90LnlhbWwiLCJoIjoiYjJhYjRiMGEwYWUyOTA3ZTgxMmMyMDkxOThhNzRlMDg5OGFmY2IwNCJ9
Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLXdvcmtzdGF0aW9ucy8uT3dsQm90LnlhbWwiLCJoIjoiYjJhYjRiMGEwYWUyOTA3ZTgxMmMyMDkxOThhNzRlMDg5OGFmY2IwNCJ9
Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLW1hcHMtYWRkcmVzc3ZhbGlkYXRpb24vLk93bEJvdC55YW1sIiwiaCI6ImIyYWI0YjBhMGFlMjkwN2U4MTJjMjA5MTk4YTc0ZTA4OThhZmNiMDQifQ==
Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLW1hcHMtbWFwc3BsYXRmb3JtZGF0YXNldHMvLk93bEJvdC55YW1sIiwiaCI6ImIyYWI0YjBhMGFlMjkwN2U4MTJjMjA5MTk4YTc0ZTA4OThhZmNiMDQifQ==

* 🦉 Updates from OwlBot post-processor

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

* 🦉 Updates from OwlBot post-processor

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

* 🦉 Updates from OwlBot post-processor

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

* 🦉 Updates from OwlBot post-processor

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

* Apply docs fix. Fix proposed upstream in cl/518850192

* Fix build. Fix proposed upstream via cl/509249451

* Fix build. Fix proposed upstream via cl/518859072

---------

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
Co-authored-by: Anthonios Partheniou <partheniou@google.com>
  • Loading branch information
3 people committed Mar 23, 2023
1 parent 2f3fea5 commit d34a425
Show file tree
Hide file tree
Showing 59 changed files with 115 additions and 258 deletions.
Expand Up @@ -347,7 +347,6 @@ def __call__(
request (~.service.ListNotificationsRequest):
The request object. Request for fetching all
notifications for a given parent.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down
Expand Up @@ -938,7 +938,8 @@ async def sample_restore_cluster():
Args:
request (Optional[Union[google.cloud.alloydb_v1.types.RestoreClusterRequest, dict]]):
The request object. Message for restoring a Cluster from
a backup or another cluster at a given point in time.
a backup or another cluster at a given
point in time.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -1788,8 +1789,8 @@ async def sample_failover_instance():
Args:
request (Optional[Union[google.cloud.alloydb_v1.types.FailoverInstanceRequest, dict]]):
The request object. Message for triggering failover on
an Instance
The request object. Message for triggering failover on an
Instance
name (:class:`str`):
Required. The name of the resource.
For the required format, see the comment
Expand Down
Expand Up @@ -1248,7 +1248,8 @@ def sample_restore_cluster():
Args:
request (Union[google.cloud.alloydb_v1.types.RestoreClusterRequest, dict]):
The request object. Message for restoring a Cluster from
a backup or another cluster at a given point in time.
a backup or another cluster at a given
point in time.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -2082,8 +2083,8 @@ def sample_failover_instance():
Args:
request (Union[google.cloud.alloydb_v1.types.FailoverInstanceRequest, dict]):
The request object. Message for triggering failover on
an Instance
The request object. Message for triggering failover on an
Instance
name (str):
Required. The name of the resource.
For the required format, see the comment
Expand Down
Expand Up @@ -984,7 +984,6 @@ def __call__(
request (~.service.BatchCreateInstancesRequest):
The request object. Message for creating a batch of
instances under the specified cluster.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -1639,7 +1638,6 @@ def __call__(
request (~.service.FailoverInstanceRequest):
The request object. Message for triggering failover on an
Instance
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -2007,7 +2005,6 @@ def __call__(
request (~.service.ListBackupsRequest):
The request object. Message for requesting list of
Backups
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -2097,7 +2094,6 @@ def __call__(
request (~.service.ListClustersRequest):
The request object. Message for requesting list of
Clusters
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -2187,7 +2183,6 @@ def __call__(
request (~.service.ListInstancesRequest):
The request object. Message for requesting list of
Instances
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -2278,7 +2273,6 @@ def __call__(
request (~.service.ListSupportedDatabaseFlagsRequest):
The request object. Message for listing the information
about the supported Database flags.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -2469,7 +2463,6 @@ def __call__(
The request object. Message for restoring a Cluster from
a backup or another cluster at a given
point in time.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down
Expand Up @@ -978,10 +978,10 @@ class InstanceType(proto.Enum):

class AvailabilityType(proto.Enum):
r"""The Availability type of an instance. Potential values:
<br><b>ZONAL</b>: The instance serves data from only one zone.
Outages in that zone affect instance availability.
<br><b>REGIONAL</b>: The instance can serve data from more
than one zone in a region (it is highly available).
- ZONAL: The instance serves data from only one zone. Outages in
that zone affect instance availability.
- REGIONAL: The instance can serve data from more than one zone
in a region (it is highly available).
Values:
AVAILABILITY_TYPE_UNSPECIFIED (0):
Expand Down
Expand Up @@ -1063,7 +1063,8 @@ async def sample_restore_cluster():
Args:
request (Optional[Union[google.cloud.alloydb_v1alpha.types.RestoreClusterRequest, dict]]):
The request object. Message for restoring a Cluster from
a backup or another cluster at a given point in time.
a backup or another cluster at a given
point in time.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -2201,8 +2202,8 @@ async def sample_failover_instance():
Args:
request (Optional[Union[google.cloud.alloydb_v1alpha.types.FailoverInstanceRequest, dict]]):
The request object. Message for triggering failover on
an Instance
The request object. Message for triggering failover on an
Instance
name (:class:`str`):
Required. The name of the resource.
For the required format, see the comment
Expand Down Expand Up @@ -3195,7 +3196,8 @@ async def sample_generate_client_certificate():
Args:
request (Optional[Union[google.cloud.alloydb_v1alpha.types.GenerateClientCertificateRequest, dict]]):
The request object. Message for requests to generate a
client certificate signed by the Cluster CA.
client certificate signed by the Cluster
CA.
parent (:class:`str`):
Required. The name of the parent resource. The required
format is:
Expand Down
Expand Up @@ -1393,7 +1393,8 @@ def sample_restore_cluster():
Args:
request (Union[google.cloud.alloydb_v1alpha.types.RestoreClusterRequest, dict]):
The request object. Message for restoring a Cluster from
a backup or another cluster at a given point in time.
a backup or another cluster at a given
point in time.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -2517,8 +2518,8 @@ def sample_failover_instance():
Args:
request (Union[google.cloud.alloydb_v1alpha.types.FailoverInstanceRequest, dict]):
The request object. Message for triggering failover on
an Instance
The request object. Message for triggering failover on an
Instance
name (str):
Required. The name of the resource.
For the required format, see the comment
Expand Down Expand Up @@ -3486,7 +3487,8 @@ def sample_generate_client_certificate():
Args:
request (Union[google.cloud.alloydb_v1alpha.types.GenerateClientCertificateRequest, dict]):
The request object. Message for requests to generate a
client certificate signed by the Cluster CA.
client certificate signed by the Cluster
CA.
parent (str):
Required. The name of the parent resource. The required
format is:
Expand Down
Expand Up @@ -1139,7 +1139,6 @@ def __call__(
request (~.service.BatchCreateInstancesRequest):
The request object. Message for creating a batch of
instances under the specified cluster.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -1635,7 +1634,6 @@ def __call__(
request (~.service.CreateSecondaryInstanceRequest):
The request object. Message for creating a Secondary
Instance
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -1996,7 +1994,6 @@ def __call__(
request (~.service.FailoverInstanceRequest):
The request object. Message for triggering failover on an
Instance
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -2098,7 +2095,6 @@ def __call__(
The request object. Message for requests to generate a
client certificate signed by the Cluster
CA.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -2377,7 +2373,6 @@ def __call__(
request (~.service.GetConnectionInfoRequest):
The request object. Request message for
GetConnectionInfo.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -2559,7 +2554,6 @@ def __call__(
request (~.service.ListBackupsRequest):
The request object. Message for requesting list of
Backups
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -2649,7 +2643,6 @@ def __call__(
request (~.service.ListClustersRequest):
The request object. Message for requesting list of
Clusters
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -2739,7 +2732,6 @@ def __call__(
request (~.service.ListInstancesRequest):
The request object. Message for requesting list of
Instances
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -2830,7 +2822,6 @@ def __call__(
request (~.service.ListSupportedDatabaseFlagsRequest):
The request object. Message for listing the information
about the supported Database flags.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -3117,7 +3108,6 @@ def __call__(
The request object. Message for restoring a Cluster from
a backup or another cluster at a given
point in time.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down
Expand Up @@ -1100,10 +1100,10 @@ class InstanceType(proto.Enum):

class AvailabilityType(proto.Enum):
r"""The Availability type of an instance. Potential values:
<br><b>ZONAL</b>: The instance serves data from only one zone.
Outages in that zone affect instance availability.
<br><b>REGIONAL</b>: The instance can serve data from more
than one zone in a region (it is highly available).
- ZONAL: The instance serves data from only one zone. Outages in
that zone affect instance availability.
- REGIONAL: The instance can serve data from more than one zone
in a region (it is highly available).
Values:
AVAILABILITY_TYPE_UNSPECIFIED (0):
Expand Down
Expand Up @@ -1063,7 +1063,8 @@ async def sample_restore_cluster():
Args:
request (Optional[Union[google.cloud.alloydb_v1beta.types.RestoreClusterRequest, dict]]):
The request object. Message for restoring a Cluster from
a backup or another cluster at a given point in time.
a backup or another cluster at a given
point in time.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -2201,8 +2202,8 @@ async def sample_failover_instance():
Args:
request (Optional[Union[google.cloud.alloydb_v1beta.types.FailoverInstanceRequest, dict]]):
The request object. Message for triggering failover on
an Instance
The request object. Message for triggering failover on an
Instance
name (:class:`str`):
Required. The name of the resource.
For the required format, see the comment
Expand Down Expand Up @@ -3195,7 +3196,8 @@ async def sample_generate_client_certificate():
Args:
request (Optional[Union[google.cloud.alloydb_v1beta.types.GenerateClientCertificateRequest, dict]]):
The request object. Message for requests to generate a
client certificate signed by the Cluster CA.
client certificate signed by the Cluster
CA.
parent (:class:`str`):
Required. The name of the parent resource. The required
format is:
Expand Down
Expand Up @@ -1393,7 +1393,8 @@ def sample_restore_cluster():
Args:
request (Union[google.cloud.alloydb_v1beta.types.RestoreClusterRequest, dict]):
The request object. Message for restoring a Cluster from
a backup or another cluster at a given point in time.
a backup or another cluster at a given
point in time.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -2517,8 +2518,8 @@ def sample_failover_instance():
Args:
request (Union[google.cloud.alloydb_v1beta.types.FailoverInstanceRequest, dict]):
The request object. Message for triggering failover on
an Instance
The request object. Message for triggering failover on an
Instance
name (str):
Required. The name of the resource.
For the required format, see the comment
Expand Down Expand Up @@ -3486,7 +3487,8 @@ def sample_generate_client_certificate():
Args:
request (Union[google.cloud.alloydb_v1beta.types.GenerateClientCertificateRequest, dict]):
The request object. Message for requests to generate a
client certificate signed by the Cluster CA.
client certificate signed by the Cluster
CA.
parent (str):
Required. The name of the parent resource. The required
format is:
Expand Down

0 comments on commit d34a425

Please sign in to comment.