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

docs: Fix formatting of request arg in docstring #528

Merged
merged 4 commits into from
Mar 23, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -785,8 +785,8 @@ async def sample_delete_autoscaling_policy():
request (Optional[Union[google.cloud.dataproc_v1.types.DeleteAutoscalingPolicyRequest, dict]]):
The request object. A request to delete an autoscaling
policy.
Autoscaling policies in use by one or more clusters will
not be deleted.
Autoscaling policies in use by one or
more clusters will not be deleted.
name (:class:`str`):
Required. The "resource name" of the autoscaling policy,
as described in
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -981,8 +981,8 @@ def sample_delete_autoscaling_policy():
request (Union[google.cloud.dataproc_v1.types.DeleteAutoscalingPolicyRequest, dict]):
The request object. A request to delete an autoscaling
policy.
Autoscaling policies in use by one or more clusters will
not be deleted.
Autoscaling policies in use by one or
more clusters will not be deleted.
name (str):
Required. The "resource name" of the autoscaling policy,
as described in
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -508,7 +508,6 @@ def __call__(
request (~.autoscaling_policies.CreateAutoscalingPolicyRequest):
The request object. A request to create an autoscaling
policy.

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 @@ -616,7 +615,6 @@ def __call__(
policy.
Autoscaling policies in use by one or
more clusters will not be deleted.

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 @@ -698,7 +696,6 @@ def __call__(
request (~.autoscaling_policies.GetAutoscalingPolicyRequest):
The request object. A request to fetch an autoscaling
policy.

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 @@ -794,7 +791,6 @@ def __call__(
request (~.autoscaling_policies.ListAutoscalingPoliciesRequest):
The request object. A request to list autoscaling
policies in a project.

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 @@ -890,7 +886,6 @@ def __call__(
request (~.autoscaling_policies.UpdateAutoscalingPolicyRequest):
The request object. A request to update an autoscaling
policy.

retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -275,8 +275,7 @@ async def sample_create_batch():

Args:
request (Optional[Union[google.cloud.dataproc_v1.types.CreateBatchRequest, dict]]):
The request object. A request to create a batch
workload.
The request object. A request to create a batch workload.
parent (:class:`str`):
Required. The parent resource where
this batch will be created.
Expand Down Expand Up @@ -623,8 +622,7 @@ async def sample_delete_batch():

Args:
request (Optional[Union[google.cloud.dataproc_v1.types.DeleteBatchRequest, dict]]):
The request object. A request to delete a batch
workload.
The request object. A request to delete a batch workload.
name (:class:`str`):
Required. The fully qualified name of the batch to
retrieve in the format
Expand Down
6 changes: 2 additions & 4 deletions google/cloud/dataproc_v1/services/batch_controller/client.py
Original file line number Diff line number Diff line change
Expand Up @@ -524,8 +524,7 @@ def sample_create_batch():
Args:
request (Union[google.cloud.dataproc_v1.types.CreateBatchRequest, dict]):
The request object. A request to create a batch
workload.
The request object. A request to create a batch workload.
parent (str):
Required. The parent resource where
this batch will be created.
Expand Down Expand Up @@ -872,8 +871,7 @@ def sample_delete_batch():
Args:
request (Union[google.cloud.dataproc_v1.types.DeleteBatchRequest, dict]):
The request object. A request to delete a batch
workload.
The request object. A request to delete a batch workload.
name (str):
Required. The fully qualified name of the batch to
retrieve in the format
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -698,7 +698,6 @@ def __call__(
request (~.batches.GetBatchRequest):
The request object. A request to get the resource
representation for a batch workload.

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 @@ -788,7 +787,6 @@ def __call__(
request (~.batches.ListBatchesRequest):
The request object. A request to list batch workloads in
a project.

retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1034,7 +1034,8 @@ async def sample_get_cluster():
Args:
request (Optional[Union[google.cloud.dataproc_v1.types.GetClusterRequest, dict]]):
The request object. Request to get the resource
representation for a cluster in a project.
representation for a cluster in a
project.
project_id (:class:`str`):
Required. The ID of the Google Cloud
Platform project that the cluster
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1280,7 +1280,8 @@ def sample_get_cluster():
Args:
request (Union[google.cloud.dataproc_v1.types.GetClusterRequest, dict]):
The request object. Request to get the resource
representation for a cluster in a project.
representation for a cluster in a
project.
project_id (str):
Required. The ID of the Google Cloud
Platform project that the cluster
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -849,7 +849,6 @@ def __call__(
request (~.clusters.DiagnoseClusterRequest):
The request object. A request to collect cluster
diagnostic information.
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 @@ -950,7 +949,6 @@ def __call__(
The request object. Request to get the resource
representation for a cluster in a
project.
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 @@ -1041,7 +1039,6 @@ def __call__(
request (~.clusters.ListClustersRequest):
The request object. A request to list the clusters in a
project.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -775,7 +775,6 @@ def __call__(
request (~.jobs.GetJobRequest):
The request object. A request to get the resource
representation for a job in a project.

retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1181,7 +1181,8 @@ async def sample_delete_workflow_template():
request (Optional[Union[google.cloud.dataproc_v1.types.DeleteWorkflowTemplateRequest, dict]]):
The request object. A request to delete a workflow
template.
Currently started workflows will remain running.
Currently started workflows will remain
running.
name (:class:`str`):
Required. The resource name of the workflow template, as
described in
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1392,7 +1392,8 @@ def sample_delete_workflow_template():
request (Union[google.cloud.dataproc_v1.types.DeleteWorkflowTemplateRequest, dict]):
The request object. A request to delete a workflow
template.
Currently started workflows will remain running.
Currently started workflows will remain
running.
name (str):
Required. The resource name of the workflow template, as
described in
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -646,7 +646,6 @@ def __call__(
request (~.workflow_templates.CreateWorkflowTemplateRequest):
The request object. A request to create a workflow
template.

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 @@ -754,7 +753,6 @@ def __call__(
template.
Currently started workflows will remain
running.

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 @@ -836,7 +834,6 @@ def __call__(
request (~.workflow_templates.GetWorkflowTemplateRequest):
The request object. A request to fetch a workflow
template.

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 @@ -933,7 +930,6 @@ def __call__(
request (~.workflow_templates.InstantiateInlineWorkflowTemplateRequest):
The request object. A request to instantiate an inline
workflow template.

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 @@ -1044,7 +1040,6 @@ def __call__(
request (~.workflow_templates.InstantiateWorkflowTemplateRequest):
The request object. A request to instantiate a workflow
template.

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 @@ -1151,7 +1146,6 @@ def __call__(
request (~.workflow_templates.ListWorkflowTemplatesRequest):
The request object. A request to list workflow templates
in a project.

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 @@ -1247,7 +1241,6 @@ def __call__(
request (~.workflow_templates.UpdateWorkflowTemplateRequest):
The request object. A request to update a workflow
template.

retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
"proto-plus >= 1.22.0, <2.0.0dev",
"proto-plus >= 1.22.2, <2.0.0dev; python_version>='3.11'",
"protobuf>=3.19.5,<5.0.0dev,!=3.20.0,!=3.20.1,!=4.21.0,!=4.21.1,!=4.21.2,!=4.21.3,!=4.21.4,!=4.21.5",
"grpc-google-iam-v1 >= 0.12.4, < 1.0.0dev",
"grpc-google-iam-v1 >= 0.12.4, <1.0.0dev",
]
url = "https://github.com/googleapis/python-dataproc"

Expand Down