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

Commit d10ac7e

Browse files
gcf-owl-bot[bot]gcf-owl-bot[bot]
authored
docs: Fix formatting of request arg in docstring (#359)
* 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 e07d013 commit d10ac7e

File tree

4 files changed

+118
-88
lines changed

4 files changed

+118
-88
lines changed

‎google/cloud/container_v1/services/cluster_manager/async_client.py‎

Lines changed: 28 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -2616,11 +2616,11 @@ async def sample_get_json_web_keys():
26162616
26172617
Args:
26182618
request (Optional[Union[google.cloud.container_v1.types.GetJSONWebKeysRequest, dict]]):
2619-
The request object. GetJSONWebKeysRequest gets the
2620-
public component of the keys used by the cluster to sign
2621-
token requests. This will be the jwks_uri for the
2622-
discover document returned by getOpenIDConfig. See the
2623-
OpenID Connect Discovery 1.0 specification for details.
2619+
The request object. GetJSONWebKeysRequest gets the public component of the
2620+
keys used by the cluster to sign token requests. This
2621+
will be the jwks_uri for the discover document returned
2622+
by getOpenIDConfig. See the OpenID Connect Discovery 1.0
2623+
specification for details.
26242624
retry (google.api_core.retry.Retry): Designation of what errors, if any,
26252625
should be retried.
26262626
timeout (float): The timeout for this request.
@@ -3325,7 +3325,8 @@ async def sample_complete_node_pool_upgrade():
33253325
Args:
33263326
request (Optional[Union[google.cloud.container_v1.types.CompleteNodePoolUpgradeRequest, dict]]):
33273327
The request object. CompleteNodePoolUpgradeRequest sets
3328-
the name of target node pool to complete upgrade.
3328+
the name of target node pool to complete
3329+
upgrade.
33293330
retry (google.api_core.retry.Retry): Designation of what errors, if any,
33303331
should be retried.
33313332
timeout (float): The timeout for this request.
@@ -3404,9 +3405,10 @@ async def sample_rollback_node_pool_upgrade():
34043405
Args:
34053406
request (Optional[Union[google.cloud.container_v1.types.RollbackNodePoolUpgradeRequest, dict]]):
34063407
The request object. RollbackNodePoolUpgradeRequest
3407-
rollbacks the previously Aborted or Failed NodePool
3408-
upgrade. This will be an no-op if the last upgrade
3409-
successfully completed.
3408+
rollbacks the previously Aborted or
3409+
Failed NodePool upgrade. This will be an
3410+
no-op if the last upgrade successfully
3411+
completed.
34103412
project_id (:class:`str`):
34113413
Deprecated. The Google Developers Console `project ID or
34123414
project
@@ -3556,8 +3558,9 @@ async def sample_set_node_pool_management():
35563558
35573559
Args:
35583560
request (Optional[Union[google.cloud.container_v1.types.SetNodePoolManagementRequest, dict]]):
3559-
The request object. SetNodePoolManagementRequest sets
3560-
the node management properties of a node pool.
3561+
The request object. SetNodePoolManagementRequest sets the
3562+
node management properties of a node
3563+
pool.
35613564
retry (google.api_core.retry.Retry): Designation of what errors, if any,
35623565
should be retried.
35633566
timeout (float): The timeout for this request.
@@ -3639,9 +3642,10 @@ async def sample_set_labels():
36393642
Args:
36403643
request (Optional[Union[google.cloud.container_v1.types.SetLabelsRequest, dict]]):
36413644
The request object. SetLabelsRequest sets the Google
3642-
Cloud Platform labels on a Google Container Engine
3643-
cluster, which will in turn set them for Google Compute
3644-
Engine resources used by that cluster
3645+
Cloud Platform labels on a Google
3646+
Container Engine cluster, which will in
3647+
turn set them for Google Compute Engine
3648+
resources used by that cluster
36453649
retry (google.api_core.retry.Retry): Designation of what errors, if any,
36463650
should be retried.
36473651
timeout (float): The timeout for this request.
@@ -3729,7 +3733,8 @@ async def sample_set_legacy_abac():
37293733
Args:
37303734
request (Optional[Union[google.cloud.container_v1.types.SetLegacyAbacRequest, dict]]):
37313735
The request object. SetLegacyAbacRequest enables or
3732-
disables the ABAC authorization mechanism for a cluster.
3736+
disables the ABAC authorization
3737+
mechanism for a cluster.
37333738
project_id (:class:`str`):
37343739
Deprecated. The Google Developers Console `project ID or
37353740
project
@@ -3879,8 +3884,9 @@ async def sample_start_ip_rotation():
38793884
Args:
38803885
request (Optional[Union[google.cloud.container_v1.types.StartIPRotationRequest, dict]]):
38813886
The request object. StartIPRotationRequest creates a new
3882-
IP for the cluster and then performs a node upgrade on
3883-
each node pool to point to the new IP.
3887+
IP for the cluster and then performs a
3888+
node upgrade on each node pool to point
3889+
to the new IP.
38843890
project_id (:class:`str`):
38853891
Deprecated. The Google Developers Console `project ID or
38863892
project
@@ -4248,7 +4254,8 @@ async def sample_set_network_policy():
42484254
Args:
42494255
request (Optional[Union[google.cloud.container_v1.types.SetNetworkPolicyRequest, dict]]):
42504256
The request object. SetNetworkPolicyRequest
4251-
enables/disables network policy for a cluster.
4257+
enables/disables network policy for a
4258+
cluster.
42524259
project_id (:class:`str`):
42534260
Deprecated. The Google Developers Console `project ID or
42544261
project
@@ -4550,9 +4557,9 @@ async def sample_list_usable_subnetworks():
45504557
45514558
Args:
45524559
request (Optional[Union[google.cloud.container_v1.types.ListUsableSubnetworksRequest, dict]]):
4553-
The request object. ListUsableSubnetworksRequest
4554-
requests the list of usable subnetworks available to a
4555-
user for creating clusters.
4560+
The request object. ListUsableSubnetworksRequest requests
4561+
the list of usable subnetworks available
4562+
to a user for creating clusters.
45564563
retry (google.api_core.retry.Retry): Designation of what errors, if any,
45574564
should be retried.
45584565
timeout (float): The timeout for this request.

‎google/cloud/container_v1/services/cluster_manager/client.py‎

Lines changed: 28 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -2783,11 +2783,11 @@ def sample_get_json_web_keys():
27832783
27842784
Args:
27852785
request (Union[google.cloud.container_v1.types.GetJSONWebKeysRequest, dict]):
2786-
The request object. GetJSONWebKeysRequest gets the
2787-
public component of the keys used by the cluster to sign
2788-
token requests. This will be the jwks_uri for the
2789-
discover document returned by getOpenIDConfig. See the
2790-
OpenID Connect Discovery 1.0 specification for details.
2786+
The request object. GetJSONWebKeysRequest gets the public component of the
2787+
keys used by the cluster to sign token requests. This
2788+
will be the jwks_uri for the discover document returned
2789+
by getOpenIDConfig. See the OpenID Connect Discovery 1.0
2790+
specification for details.
27912791
retry (google.api_core.retry.Retry): Designation of what errors, if any,
27922792
should be retried.
27932793
timeout (float): The timeout for this request.
@@ -3463,7 +3463,8 @@ def sample_complete_node_pool_upgrade():
34633463
Args:
34643464
request (Union[google.cloud.container_v1.types.CompleteNodePoolUpgradeRequest, dict]):
34653465
The request object. CompleteNodePoolUpgradeRequest sets
3466-
the name of target node pool to complete upgrade.
3466+
the name of target node pool to complete
3467+
upgrade.
34673468
retry (google.api_core.retry.Retry): Designation of what errors, if any,
34683469
should be retried.
34693470
timeout (float): The timeout for this request.
@@ -3545,9 +3546,10 @@ def sample_rollback_node_pool_upgrade():
35453546
Args:
35463547
request (Union[google.cloud.container_v1.types.RollbackNodePoolUpgradeRequest, dict]):
35473548
The request object. RollbackNodePoolUpgradeRequest
3548-
rollbacks the previously Aborted or Failed NodePool
3549-
upgrade. This will be an no-op if the last upgrade
3550-
successfully completed.
3549+
rollbacks the previously Aborted or
3550+
Failed NodePool upgrade. This will be an
3551+
no-op if the last upgrade successfully
3552+
completed.
35513553
project_id (str):
35523554
Deprecated. The Google Developers Console `project ID or
35533555
project
@@ -3699,8 +3701,9 @@ def sample_set_node_pool_management():
36993701
37003702
Args:
37013703
request (Union[google.cloud.container_v1.types.SetNodePoolManagementRequest, dict]):
3702-
The request object. SetNodePoolManagementRequest sets
3703-
the node management properties of a node pool.
3704+
The request object. SetNodePoolManagementRequest sets the
3705+
node management properties of a node
3706+
pool.
37043707
retry (google.api_core.retry.Retry): Designation of what errors, if any,
37053708
should be retried.
37063709
timeout (float): The timeout for this request.
@@ -3783,9 +3786,10 @@ def sample_set_labels():
37833786
Args:
37843787
request (Union[google.cloud.container_v1.types.SetLabelsRequest, dict]):
37853788
The request object. SetLabelsRequest sets the Google
3786-
Cloud Platform labels on a Google Container Engine
3787-
cluster, which will in turn set them for Google Compute
3788-
Engine resources used by that cluster
3789+
Cloud Platform labels on a Google
3790+
Container Engine cluster, which will in
3791+
turn set them for Google Compute Engine
3792+
resources used by that cluster
37893793
retry (google.api_core.retry.Retry): Designation of what errors, if any,
37903794
should be retried.
37913795
timeout (float): The timeout for this request.
@@ -3874,7 +3878,8 @@ def sample_set_legacy_abac():
38743878
Args:
38753879
request (Union[google.cloud.container_v1.types.SetLegacyAbacRequest, dict]):
38763880
The request object. SetLegacyAbacRequest enables or
3877-
disables the ABAC authorization mechanism for a cluster.
3881+
disables the ABAC authorization
3882+
mechanism for a cluster.
38783883
project_id (str):
38793884
Deprecated. The Google Developers Console `project ID or
38803885
project
@@ -4024,8 +4029,9 @@ def sample_start_ip_rotation():
40244029
Args:
40254030
request (Union[google.cloud.container_v1.types.StartIPRotationRequest, dict]):
40264031
The request object. StartIPRotationRequest creates a new
4027-
IP for the cluster and then performs a node upgrade on
4028-
each node pool to point to the new IP.
4032+
IP for the cluster and then performs a
4033+
node upgrade on each node pool to point
4034+
to the new IP.
40294035
project_id (str):
40304036
Deprecated. The Google Developers Console `project ID or
40314037
project
@@ -4394,7 +4400,8 @@ def sample_set_network_policy():
43944400
Args:
43954401
request (Union[google.cloud.container_v1.types.SetNetworkPolicyRequest, dict]):
43964402
The request object. SetNetworkPolicyRequest
4397-
enables/disables network policy for a cluster.
4403+
enables/disables network policy for a
4404+
cluster.
43984405
project_id (str):
43994406
Deprecated. The Google Developers Console `project ID or
44004407
project
@@ -4696,9 +4703,9 @@ def sample_list_usable_subnetworks():
46964703
46974704
Args:
46984705
request (Union[google.cloud.container_v1.types.ListUsableSubnetworksRequest, dict]):
4699-
The request object. ListUsableSubnetworksRequest
4700-
requests the list of usable subnetworks available to a
4701-
user for creating clusters.
4706+
The request object. ListUsableSubnetworksRequest requests
4707+
the list of usable subnetworks available
4708+
to a user for creating clusters.
47024709
retry (google.api_core.retry.Retry): Designation of what errors, if any,
47034710
should be retried.
47044711
timeout (float): The timeout for this request.

‎google/cloud/container_v1beta1/services/cluster_manager/async_client.py‎

Lines changed: 31 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -818,8 +818,8 @@ async def sample_update_node_pool():
818818
819819
Args:
820820
request (Optional[Union[google.cloud.container_v1beta1.types.UpdateNodePoolRequest, dict]]):
821-
The request object. SetNodePoolVersionRequest updates
822-
the version of a node pool.
821+
The request object. SetNodePoolVersionRequest updates the
822+
version of a node pool.
823823
retry (google.api_core.retry.Retry): Designation of what errors, if any,
824824
should be retried.
825825
timeout (float): The timeout for this request.
@@ -2532,11 +2532,11 @@ async def sample_get_json_web_keys():
25322532
25332533
Args:
25342534
request (Optional[Union[google.cloud.container_v1beta1.types.GetJSONWebKeysRequest, dict]]):
2535-
The request object. GetJSONWebKeysRequest gets the
2536-
public component of the keys used by the cluster to sign
2537-
token requests. This will be the jwks_uri for the
2538-
discover document returned by getOpenIDConfig. See the
2539-
OpenID Connect Discovery 1.0 specification for details.
2535+
The request object. GetJSONWebKeysRequest gets the public component of the
2536+
keys used by the cluster to sign token requests. This
2537+
will be the jwks_uri for the discover document returned
2538+
by getOpenIDConfig. See the OpenID Connect Discovery 1.0
2539+
specification for details.
25402540
retry (google.api_core.retry.Retry): Designation of what errors, if any,
25412541
should be retried.
25422542
timeout (float): The timeout for this request.
@@ -3249,7 +3249,8 @@ async def sample_complete_node_pool_upgrade():
32493249
Args:
32503250
request (Optional[Union[google.cloud.container_v1beta1.types.CompleteNodePoolUpgradeRequest, dict]]):
32513251
The request object. CompleteNodePoolUpgradeRequest sets
3252-
the name of target node pool to complete upgrade.
3252+
the name of target node pool to complete
3253+
upgrade.
32533254
retry (google.api_core.retry.Retry): Designation of what errors, if any,
32543255
should be retried.
32553256
timeout (float): The timeout for this request.
@@ -3331,9 +3332,10 @@ async def sample_rollback_node_pool_upgrade():
33313332
Args:
33323333
request (Optional[Union[google.cloud.container_v1beta1.types.RollbackNodePoolUpgradeRequest, dict]]):
33333334
The request object. RollbackNodePoolUpgradeRequest
3334-
rollbacks the previously Aborted or Failed NodePool
3335-
upgrade. This will be an no-op if the last upgrade
3336-
successfully completed.
3335+
rollbacks the previously Aborted or
3336+
Failed NodePool upgrade. This will be an
3337+
no-op if the last upgrade successfully
3338+
completed.
33373339
project_id (:class:`str`):
33383340
Required. Deprecated. The Google Developers Console
33393341
`project ID or project
@@ -3482,8 +3484,9 @@ async def sample_set_node_pool_management():
34823484
34833485
Args:
34843486
request (Optional[Union[google.cloud.container_v1beta1.types.SetNodePoolManagementRequest, dict]]):
3485-
The request object. SetNodePoolManagementRequest sets
3486-
the node management properties of a node pool.
3487+
The request object. SetNodePoolManagementRequest sets the
3488+
node management properties of a node
3489+
pool.
34873490
project_id (:class:`str`):
34883491
Required. Deprecated. The Google Developers Console
34893492
`project ID or project
@@ -3642,9 +3645,10 @@ async def sample_set_labels():
36423645
Args:
36433646
request (Optional[Union[google.cloud.container_v1beta1.types.SetLabelsRequest, dict]]):
36443647
The request object. SetLabelsRequest sets the Google
3645-
Cloud Platform labels on a Google Container Engine
3646-
cluster, which will in turn set them for Google Compute
3647-
Engine resources used by that cluster
3648+
Cloud Platform labels on a Google
3649+
Container Engine cluster, which will in
3650+
turn set them for Google Compute Engine
3651+
resources used by that cluster
36483652
project_id (:class:`str`):
36493653
Required. Deprecated. The Google Developers Console
36503654
`project ID or project
@@ -3807,7 +3811,8 @@ async def sample_set_legacy_abac():
38073811
Args:
38083812
request (Optional[Union[google.cloud.container_v1beta1.types.SetLegacyAbacRequest, dict]]):
38093813
The request object. SetLegacyAbacRequest enables or
3810-
disables the ABAC authorization mechanism for a cluster.
3814+
disables the ABAC authorization
3815+
mechanism for a cluster.
38113816
project_id (:class:`str`):
38123817
Required. Deprecated. The Google Developers Console
38133818
`project ID or project
@@ -3950,8 +3955,9 @@ async def sample_start_ip_rotation():
39503955
Args:
39513956
request (Optional[Union[google.cloud.container_v1beta1.types.StartIPRotationRequest, dict]]):
39523957
The request object. StartIPRotationRequest creates a new
3953-
IP for the cluster and then performs a node upgrade on
3954-
each node pool to point to the new IP.
3958+
IP for the cluster and then performs a
3959+
node upgrade on each node pool to point
3960+
to the new IP.
39553961
project_id (:class:`str`):
39563962
Required. Deprecated. The Google Developers Console
39573963
`project ID or project
@@ -4309,7 +4315,8 @@ async def sample_set_network_policy():
43094315
Args:
43104316
request (Optional[Union[google.cloud.container_v1beta1.types.SetNetworkPolicyRequest, dict]]):
43114317
The request object. SetNetworkPolicyRequest
4312-
enables/disables network policy for a cluster.
4318+
enables/disables network policy for a
4319+
cluster.
43134320
project_id (:class:`str`):
43144321
Required. Deprecated. The Google Developers Console
43154322
`project ID or project
@@ -4591,9 +4598,10 @@ async def sample_list_usable_subnetworks():
45914598
45924599
Args:
45934600
request (Optional[Union[google.cloud.container_v1beta1.types.ListUsableSubnetworksRequest, dict]]):
4594-
The request object. ListUsableSubnetworksRequest
4595-
requests the list of usable subnetworks. available to a
4596-
user for creating clusters.
4601+
The request object. ListUsableSubnetworksRequest requests
4602+
the list of usable subnetworks.
4603+
available to a user for creating
4604+
clusters.
45974605
parent (:class:`str`):
45984606
Required. The parent project where subnetworks are
45994607
usable. Specified in the format ``projects/*``.

0 commit comments

Comments
 (0)