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

docs: Fix formatting of request arg in docstring #359

Merged
merged 2 commits into from
Mar 23, 2023
Merged

docs: Fix formatting of request arg in docstring #359

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5c187cd
docs: Fix formatting of request arg in docstring
gcf-owl-bot[bot] Mar 22, 2023
e539de5
🦉 Updates from OwlBot post-processor
gcf-owl-bot[bot] Mar 22, 2023
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
49 changes: 28 additions & 21 deletions google/cloud/container_v1/services/cluster_manager/async_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2616,11 +2616,11 @@ async def sample_get_json_web_keys():

Args:
request (Optional[Union[google.cloud.container_v1.types.GetJSONWebKeysRequest, dict]]):
The request object. GetJSONWebKeysRequest gets the
public component of the keys used by the cluster to sign
token requests. This will be the jwks_uri for the
discover document returned by getOpenIDConfig. See the
OpenID Connect Discovery 1.0 specification for details.
The request object. GetJSONWebKeysRequest gets the public component of the
keys used by the cluster to sign token requests. This
will be the jwks_uri for the discover document returned
by getOpenIDConfig. See the OpenID Connect Discovery 1.0
specification for details.
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 @@ -3325,7 +3325,8 @@ async def sample_complete_node_pool_upgrade():
Args:
request (Optional[Union[google.cloud.container_v1.types.CompleteNodePoolUpgradeRequest, dict]]):
The request object. CompleteNodePoolUpgradeRequest sets
the name of target node pool to complete upgrade.
the name of target node pool to complete
upgrade.
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 @@ -3404,9 +3405,10 @@ async def sample_rollback_node_pool_upgrade():
Args:
request (Optional[Union[google.cloud.container_v1.types.RollbackNodePoolUpgradeRequest, dict]]):
The request object. RollbackNodePoolUpgradeRequest
rollbacks the previously Aborted or Failed NodePool
upgrade. This will be an no-op if the last upgrade
successfully completed.
rollbacks the previously Aborted or
Failed NodePool upgrade. This will be an
no-op if the last upgrade successfully
completed.
project_id (:class:`str`):
Deprecated. The Google Developers Console `project ID or
project
Expand Down Expand Up @@ -3556,8 +3558,9 @@ async def sample_set_node_pool_management():

Args:
request (Optional[Union[google.cloud.container_v1.types.SetNodePoolManagementRequest, dict]]):
The request object. SetNodePoolManagementRequest sets
the node management properties of a node pool.
The request object. SetNodePoolManagementRequest sets the
node management properties of a node
pool.
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 @@ -3639,9 +3642,10 @@ async def sample_set_labels():
Args:
request (Optional[Union[google.cloud.container_v1.types.SetLabelsRequest, dict]]):
The request object. SetLabelsRequest sets the Google
Cloud Platform labels on a Google Container Engine
cluster, which will in turn set them for Google Compute
Engine resources used by that cluster
Cloud Platform labels on a Google
Container Engine cluster, which will in
turn set them for Google Compute Engine
resources used by that 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 @@ -3729,7 +3733,8 @@ async def sample_set_legacy_abac():
Args:
request (Optional[Union[google.cloud.container_v1.types.SetLegacyAbacRequest, dict]]):
The request object. SetLegacyAbacRequest enables or
disables the ABAC authorization mechanism for a cluster.
disables the ABAC authorization
mechanism for a cluster.
project_id (:class:`str`):
Deprecated. The Google Developers Console `project ID or
project
Expand Down Expand Up @@ -3879,8 +3884,9 @@ async def sample_start_ip_rotation():
Args:
request (Optional[Union[google.cloud.container_v1.types.StartIPRotationRequest, dict]]):
The request object. StartIPRotationRequest creates a new
IP for the cluster and then performs a node upgrade on
each node pool to point to the new IP.
IP for the cluster and then performs a
node upgrade on each node pool to point
to the new IP.
project_id (:class:`str`):
Deprecated. The Google Developers Console `project ID or
project
Expand Down Expand Up @@ -4248,7 +4254,8 @@ async def sample_set_network_policy():
Args:
request (Optional[Union[google.cloud.container_v1.types.SetNetworkPolicyRequest, dict]]):
The request object. SetNetworkPolicyRequest
enables/disables network policy for a cluster.
enables/disables network policy for a
cluster.
project_id (:class:`str`):
Deprecated. The Google Developers Console `project ID or
project
Expand Down Expand Up @@ -4550,9 +4557,9 @@ async def sample_list_usable_subnetworks():

Args:
request (Optional[Union[google.cloud.container_v1.types.ListUsableSubnetworksRequest, dict]]):
The request object. ListUsableSubnetworksRequest
requests the list of usable subnetworks available to a
user for creating clusters.
The request object. ListUsableSubnetworksRequest requests
the list of usable subnetworks available
to a user for creating 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
49 changes: 28 additions & 21 deletions google/cloud/container_v1/services/cluster_manager/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2783,11 +2783,11 @@ def sample_get_json_web_keys():

Args:
request (Union[google.cloud.container_v1.types.GetJSONWebKeysRequest, dict]):
The request object. GetJSONWebKeysRequest gets the
public component of the keys used by the cluster to sign
token requests. This will be the jwks_uri for the
discover document returned by getOpenIDConfig. See the
OpenID Connect Discovery 1.0 specification for details.
The request object. GetJSONWebKeysRequest gets the public component of the
keys used by the cluster to sign token requests. This
will be the jwks_uri for the discover document returned
by getOpenIDConfig. See the OpenID Connect Discovery 1.0
specification for details.
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 @@ -3463,7 +3463,8 @@ def sample_complete_node_pool_upgrade():
Args:
request (Union[google.cloud.container_v1.types.CompleteNodePoolUpgradeRequest, dict]):
The request object. CompleteNodePoolUpgradeRequest sets
the name of target node pool to complete upgrade.
the name of target node pool to complete
upgrade.
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 @@ -3545,9 +3546,10 @@ def sample_rollback_node_pool_upgrade():
Args:
request (Union[google.cloud.container_v1.types.RollbackNodePoolUpgradeRequest, dict]):
The request object. RollbackNodePoolUpgradeRequest
rollbacks the previously Aborted or Failed NodePool
upgrade. This will be an no-op if the last upgrade
successfully completed.
rollbacks the previously Aborted or
Failed NodePool upgrade. This will be an
no-op if the last upgrade successfully
completed.
project_id (str):
Deprecated. The Google Developers Console `project ID or
project
Expand Down Expand Up @@ -3699,8 +3701,9 @@ def sample_set_node_pool_management():

Args:
request (Union[google.cloud.container_v1.types.SetNodePoolManagementRequest, dict]):
The request object. SetNodePoolManagementRequest sets
the node management properties of a node pool.
The request object. SetNodePoolManagementRequest sets the
node management properties of a node
pool.
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 @@ -3783,9 +3786,10 @@ def sample_set_labels():
Args:
request (Union[google.cloud.container_v1.types.SetLabelsRequest, dict]):
The request object. SetLabelsRequest sets the Google
Cloud Platform labels on a Google Container Engine
cluster, which will in turn set them for Google Compute
Engine resources used by that cluster
Cloud Platform labels on a Google
Container Engine cluster, which will in
turn set them for Google Compute Engine
resources used by that 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 @@ -3874,7 +3878,8 @@ def sample_set_legacy_abac():
Args:
request (Union[google.cloud.container_v1.types.SetLegacyAbacRequest, dict]):
The request object. SetLegacyAbacRequest enables or
disables the ABAC authorization mechanism for a cluster.
disables the ABAC authorization
mechanism for a cluster.
project_id (str):
Deprecated. The Google Developers Console `project ID or
project
Expand Down Expand Up @@ -4024,8 +4029,9 @@ def sample_start_ip_rotation():
Args:
request (Union[google.cloud.container_v1.types.StartIPRotationRequest, dict]):
The request object. StartIPRotationRequest creates a new
IP for the cluster and then performs a node upgrade on
each node pool to point to the new IP.
IP for the cluster and then performs a
node upgrade on each node pool to point
to the new IP.
project_id (str):
Deprecated. The Google Developers Console `project ID or
project
Expand Down Expand Up @@ -4394,7 +4400,8 @@ def sample_set_network_policy():
Args:
request (Union[google.cloud.container_v1.types.SetNetworkPolicyRequest, dict]):
The request object. SetNetworkPolicyRequest
enables/disables network policy for a cluster.
enables/disables network policy for a
cluster.
project_id (str):
Deprecated. The Google Developers Console `project ID or
project
Expand Down Expand Up @@ -4696,9 +4703,9 @@ def sample_list_usable_subnetworks():

Args:
request (Union[google.cloud.container_v1.types.ListUsableSubnetworksRequest, dict]):
The request object. ListUsableSubnetworksRequest
requests the list of usable subnetworks available to a
user for creating clusters.
The request object. ListUsableSubnetworksRequest requests
the list of usable subnetworks available
to a user for creating 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
54 changes: 31 additions & 23 deletions google/cloud/container_v1beta1/services/cluster_manager/async_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -818,8 +818,8 @@ async def sample_update_node_pool():

Args:
request (Optional[Union[google.cloud.container_v1beta1.types.UpdateNodePoolRequest, dict]]):
The request object. SetNodePoolVersionRequest updates
the version of a node pool.
The request object. SetNodePoolVersionRequest updates the
version of a node pool.
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 @@ -2532,11 +2532,11 @@ async def sample_get_json_web_keys():

Args:
request (Optional[Union[google.cloud.container_v1beta1.types.GetJSONWebKeysRequest, dict]]):
The request object. GetJSONWebKeysRequest gets the
public component of the keys used by the cluster to sign
token requests. This will be the jwks_uri for the
discover document returned by getOpenIDConfig. See the
OpenID Connect Discovery 1.0 specification for details.
The request object. GetJSONWebKeysRequest gets the public component of the
keys used by the cluster to sign token requests. This
will be the jwks_uri for the discover document returned
by getOpenIDConfig. See the OpenID Connect Discovery 1.0
specification for details.
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 @@ -3249,7 +3249,8 @@ async def sample_complete_node_pool_upgrade():
Args:
request (Optional[Union[google.cloud.container_v1beta1.types.CompleteNodePoolUpgradeRequest, dict]]):
The request object. CompleteNodePoolUpgradeRequest sets
the name of target node pool to complete upgrade.
the name of target node pool to complete
upgrade.
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 @@ -3331,9 +3332,10 @@ async def sample_rollback_node_pool_upgrade():
Args:
request (Optional[Union[google.cloud.container_v1beta1.types.RollbackNodePoolUpgradeRequest, dict]]):
The request object. RollbackNodePoolUpgradeRequest
rollbacks the previously Aborted or Failed NodePool
upgrade. This will be an no-op if the last upgrade
successfully completed.
rollbacks the previously Aborted or
Failed NodePool upgrade. This will be an
no-op if the last upgrade successfully
completed.
project_id (:class:`str`):
Required. Deprecated. The Google Developers Console
`project ID or project
Expand Down Expand Up @@ -3482,8 +3484,9 @@ async def sample_set_node_pool_management():

Args:
request (Optional[Union[google.cloud.container_v1beta1.types.SetNodePoolManagementRequest, dict]]):
The request object. SetNodePoolManagementRequest sets
the node management properties of a node pool.
The request object. SetNodePoolManagementRequest sets the
node management properties of a node
pool.
project_id (:class:`str`):
Required. Deprecated. The Google Developers Console
`project ID or project
Expand Down Expand Up @@ -3642,9 +3645,10 @@ async def sample_set_labels():
Args:
request (Optional[Union[google.cloud.container_v1beta1.types.SetLabelsRequest, dict]]):
The request object. SetLabelsRequest sets the Google
Cloud Platform labels on a Google Container Engine
cluster, which will in turn set them for Google Compute
Engine resources used by that cluster
Cloud Platform labels on a Google
Container Engine cluster, which will in
turn set them for Google Compute Engine
resources used by that cluster
project_id (:class:`str`):
Required. Deprecated. The Google Developers Console
`project ID or project
Expand Down Expand Up @@ -3807,7 +3811,8 @@ async def sample_set_legacy_abac():
Args:
request (Optional[Union[google.cloud.container_v1beta1.types.SetLegacyAbacRequest, dict]]):
The request object. SetLegacyAbacRequest enables or
disables the ABAC authorization mechanism for a cluster.
disables the ABAC authorization
mechanism for a cluster.
project_id (:class:`str`):
Required. Deprecated. The Google Developers Console
`project ID or project
Expand Down Expand Up @@ -3950,8 +3955,9 @@ async def sample_start_ip_rotation():
Args:
request (Optional[Union[google.cloud.container_v1beta1.types.StartIPRotationRequest, dict]]):
The request object. StartIPRotationRequest creates a new
IP for the cluster and then performs a node upgrade on
each node pool to point to the new IP.
IP for the cluster and then performs a
node upgrade on each node pool to point
to the new IP.
project_id (:class:`str`):
Required. Deprecated. The Google Developers Console
`project ID or project
Expand Down Expand Up @@ -4309,7 +4315,8 @@ async def sample_set_network_policy():
Args:
request (Optional[Union[google.cloud.container_v1beta1.types.SetNetworkPolicyRequest, dict]]):
The request object. SetNetworkPolicyRequest
enables/disables network policy for a cluster.
enables/disables network policy for a
cluster.
project_id (:class:`str`):
Required. Deprecated. The Google Developers Console
`project ID or project
Expand Down Expand Up @@ -4591,9 +4598,10 @@ async def sample_list_usable_subnetworks():

Args:
request (Optional[Union[google.cloud.container_v1beta1.types.ListUsableSubnetworksRequest, dict]]):
The request object. ListUsableSubnetworksRequest
requests the list of usable subnetworks. available to a
user for creating clusters.
The request object. ListUsableSubnetworksRequest requests
the list of usable subnetworks.
available to a user for creating
clusters.
parent (:class:`str`):
Required. The parent project where subnetworks are
usable. Specified in the format ``projects/*``.
Expand Down
Loading