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

Commit

Permalink
docs: Minor formatting (#558)
Browse files Browse the repository at this point in the history
* docs: Minor formatting
chore: Update gapic-generator-python to v1.11.5
build: Update rules_python to 0.24.0

PiperOrigin-RevId: 563436317

Source-Link: googleapis/googleapis@42fd37b

Source-Link: googleapis/googleapis-gen@280264c
Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiMjgwMjY0Y2EwMmZiOTMxNmI0MjM3YTk2ZDBhZjFhMjM0M2E4MWE1NiJ9

* 🦉 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] committed Sep 13, 2023
1 parent bb8e4eb commit c3c65bc
Show file tree
Hide file tree
Showing 34 changed files with 43 additions and 32 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@

from google.iam.v1 import iam_policy_pb2 # type: ignore
from google.iam.v1 import policy_pb2 # type: ignore
from google.longrunning import operations_pb2
from google.longrunning import operations_pb2 # type: ignore

from google.cloud.dataproc_v1.services.autoscaling_policy_service import pagers
from google.cloud.dataproc_v1.types import autoscaling_policies
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@

from google.iam.v1 import iam_policy_pb2 # type: ignore
from google.iam.v1 import policy_pb2 # type: ignore
from google.longrunning import operations_pb2
from google.longrunning import operations_pb2 # type: ignore

from google.cloud.dataproc_v1.services.autoscaling_policy_service import pagers
from google.cloud.dataproc_v1.types import autoscaling_policies
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
from google.auth import credentials as ga_credentials # type: ignore
from google.iam.v1 import iam_policy_pb2 # type: ignore
from google.iam.v1 import policy_pb2 # type: ignore
from google.longrunning import operations_pb2
from google.longrunning import operations_pb2 # type: ignore
from google.oauth2 import service_account # type: ignore
from google.protobuf import empty_pb2 # type: ignore

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
from google.auth.transport.grpc import SslCredentials # type: ignore
from google.iam.v1 import iam_policy_pb2 # type: ignore
from google.iam.v1 import policy_pb2 # type: ignore
from google.longrunning import operations_pb2
from google.longrunning import operations_pb2 # type: ignore
from google.protobuf import empty_pb2 # type: ignore
import grpc # type: ignore

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
from google.auth.transport.grpc import SslCredentials # type: ignore
from google.iam.v1 import iam_policy_pb2 # type: ignore
from google.iam.v1 import policy_pb2 # type: ignore
from google.longrunning import operations_pb2
from google.longrunning import operations_pb2 # type: ignore
from google.protobuf import empty_pb2 # type: ignore
import grpc # type: ignore
from grpc.experimental import aio # type: ignore
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,6 @@
from google.auth.transport.requests import AuthorizedSession # type: ignore
from google.iam.v1 import iam_policy_pb2 # type: ignore
from google.iam.v1 import policy_pb2 # type: ignore
from google.longrunning import operations_pb2
from google.protobuf import json_format
import grpc # type: ignore
from requests import __version__ as requests_version
Expand All @@ -39,6 +38,7 @@
OptionalRetry = Union[retries.Retry, object] # type: ignore


from google.longrunning import operations_pb2 # type: ignore
from google.protobuf import empty_pb2 # type: ignore

from google.cloud.dataproc_v1.types import autoscaling_policies
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@
from google.api_core import operation_async # type: ignore
from google.iam.v1 import iam_policy_pb2 # type: ignore
from google.iam.v1 import policy_pb2 # type: ignore
from google.longrunning import operations_pb2
from google.longrunning import operations_pb2 # type: ignore
from google.protobuf import timestamp_pb2 # type: ignore

from google.cloud.dataproc_v1.services.batch_controller import pagers
Expand Down Expand Up @@ -528,6 +528,7 @@ async def sample_list_batches():
Returns:
google.cloud.dataproc_v1.services.batch_controller.pagers.ListBatchesAsyncPager:
A list of batch workloads.
Iterating over this object will yield
results and resolve additional pages
automatically.
Expand Down
3 changes: 2 additions & 1 deletion google/cloud/dataproc_v1/services/batch_controller/client.py
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@
from google.api_core import operation_async # type: ignore
from google.iam.v1 import iam_policy_pb2 # type: ignore
from google.iam.v1 import policy_pb2 # type: ignore
from google.longrunning import operations_pb2
from google.longrunning import operations_pb2 # type: ignore
from google.protobuf import timestamp_pb2 # type: ignore

from google.cloud.dataproc_v1.services.batch_controller import pagers
Expand Down Expand Up @@ -777,6 +777,7 @@ def sample_list_batches():
Returns:
google.cloud.dataproc_v1.services.batch_controller.pagers.ListBatchesPager:
A list of batch workloads.
Iterating over this object will yield
results and resolve additional pages
automatically.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,6 @@
from google.auth.transport.requests import AuthorizedSession # type: ignore
from google.iam.v1 import iam_policy_pb2 # type: ignore
from google.iam.v1 import policy_pb2 # type: ignore
from google.longrunning import operations_pb2
from google.protobuf import json_format
import grpc # type: ignore
from requests import __version__ as requests_version
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@
from google.api_core import operation_async # type: ignore
from google.iam.v1 import iam_policy_pb2 # type: ignore
from google.iam.v1 import policy_pb2 # type: ignore
from google.longrunning import operations_pb2
from google.longrunning import operations_pb2 # type: ignore
from google.protobuf import empty_pb2 # type: ignore
from google.protobuf import field_mask_pb2 # type: ignore

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@
from google.api_core import operation_async # type: ignore
from google.iam.v1 import iam_policy_pb2 # type: ignore
from google.iam.v1 import policy_pb2 # type: ignore
from google.longrunning import operations_pb2
from google.longrunning import operations_pb2 # type: ignore
from google.protobuf import empty_pb2 # type: ignore
from google.protobuf import field_mask_pb2 # type: ignore

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,6 @@
from google.auth.transport.requests import AuthorizedSession # type: ignore
from google.iam.v1 import iam_policy_pb2 # type: ignore
from google.iam.v1 import policy_pb2 # type: ignore
from google.longrunning import operations_pb2
from google.protobuf import json_format
import grpc # type: ignore
from requests import __version__ as requests_version
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@
from google.api_core import operation_async # type: ignore
from google.iam.v1 import iam_policy_pb2 # type: ignore
from google.iam.v1 import policy_pb2 # type: ignore
from google.longrunning import operations_pb2
from google.longrunning import operations_pb2 # type: ignore

from google.cloud.dataproc_v1.services.job_controller import pagers
from google.cloud.dataproc_v1.types import jobs
Expand Down Expand Up @@ -740,6 +740,7 @@ async def sample_list_jobs():
Returns:
google.cloud.dataproc_v1.services.job_controller.pagers.ListJobsAsyncPager:
A list of jobs in a project.
Iterating over this object will yield
results and resolve additional pages
automatically.
Expand Down
3 changes: 2 additions & 1 deletion google/cloud/dataproc_v1/services/job_controller/client.py
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@
from google.api_core import operation_async # type: ignore
from google.iam.v1 import iam_policy_pb2 # type: ignore
from google.iam.v1 import policy_pb2 # type: ignore
from google.longrunning import operations_pb2
from google.longrunning import operations_pb2 # type: ignore

from google.cloud.dataproc_v1.services.job_controller import pagers
from google.cloud.dataproc_v1.types import jobs
Expand Down Expand Up @@ -918,6 +918,7 @@ def sample_list_jobs():
Returns:
google.cloud.dataproc_v1.services.job_controller.pagers.ListJobsPager:
A list of jobs in a project.
Iterating over this object will yield
results and resolve additional pages
automatically.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,6 @@
from google.auth.transport.requests import AuthorizedSession # type: ignore
from google.iam.v1 import iam_policy_pb2 # type: ignore
from google.iam.v1 import policy_pb2 # type: ignore
from google.longrunning import operations_pb2
from google.protobuf import json_format
import grpc # type: ignore
from requests import __version__ as requests_version
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@
from google.api_core import operation_async # type: ignore
from google.iam.v1 import iam_policy_pb2 # type: ignore
from google.iam.v1 import policy_pb2 # type: ignore
from google.longrunning import operations_pb2
from google.longrunning import operations_pb2 # type: ignore

from google.cloud.dataproc_v1.types import clusters, node_groups, operations

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@
from google.api_core import operation_async # type: ignore
from google.iam.v1 import iam_policy_pb2 # type: ignore
from google.iam.v1 import policy_pb2 # type: ignore
from google.longrunning import operations_pb2
from google.longrunning import operations_pb2 # type: ignore

from google.cloud.dataproc_v1.types import clusters, node_groups, operations

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,6 @@
from google.auth.transport.requests import AuthorizedSession # type: ignore
from google.iam.v1 import iam_policy_pb2 # type: ignore
from google.iam.v1 import policy_pb2 # type: ignore
from google.longrunning import operations_pb2
from google.protobuf import json_format
import grpc # type: ignore
from requests import __version__ as requests_version
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@
from google.api_core import operation_async # type: ignore
from google.iam.v1 import iam_policy_pb2 # type: ignore
from google.iam.v1 import policy_pb2 # type: ignore
from google.longrunning import operations_pb2
from google.longrunning import operations_pb2 # type: ignore
from google.protobuf import duration_pb2 # type: ignore
from google.protobuf import empty_pb2 # type: ignore
from google.protobuf import timestamp_pb2 # type: ignore
Expand Down Expand Up @@ -392,6 +392,7 @@ async def get_workflow_template(
metadata: Sequence[Tuple[str, str]] = (),
) -> workflow_templates.WorkflowTemplate:
r"""Retrieves the latest workflow template.
Can retrieve previously instantiated template by
specifying optional version parameter.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@
from google.api_core import operation_async # type: ignore
from google.iam.v1 import iam_policy_pb2 # type: ignore
from google.iam.v1 import policy_pb2 # type: ignore
from google.longrunning import operations_pb2
from google.longrunning import operations_pb2 # type: ignore
from google.protobuf import duration_pb2 # type: ignore
from google.protobuf import empty_pb2 # type: ignore
from google.protobuf import timestamp_pb2 # type: ignore
Expand Down Expand Up @@ -643,6 +643,7 @@ def get_workflow_template(
metadata: Sequence[Tuple[str, str]] = (),
) -> workflow_templates.WorkflowTemplate:
r"""Retrieves the latest workflow template.
Can retrieve previously instantiated template by
specifying optional version parameter.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -287,6 +287,7 @@ def get_workflow_template(
r"""Return a callable for the get workflow template method over gRPC.
Retrieves the latest workflow template.
Can retrieve previously instantiated template by
specifying optional version parameter.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -292,6 +292,7 @@ def get_workflow_template(
r"""Return a callable for the get workflow template method over gRPC.
Retrieves the latest workflow template.
Can retrieve previously instantiated template by
specifying optional version parameter.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,6 @@
from google.auth.transport.requests import AuthorizedSession # type: ignore
from google.iam.v1 import iam_policy_pb2 # type: ignore
from google.iam.v1 import policy_pb2 # type: ignore
from google.longrunning import operations_pb2
from google.protobuf import json_format
import grpc # type: ignore
from requests import __version__ as requests_version
Expand Down
1 change: 1 addition & 0 deletions google/cloud/dataproc_v1/types/autoscaling_policies.py
Original file line number Diff line number Diff line change
Expand Up @@ -353,6 +353,7 @@ class UpdateAutoscalingPolicyRequest(proto.Message):

class DeleteAutoscalingPolicyRequest(proto.Message):
r"""A request to delete an autoscaling policy.
Autoscaling policies in use by one or more clusters will not be
deleted.
Expand Down
8 changes: 4 additions & 4 deletions google/cloud/dataproc_v1/types/clusters.py
Original file line number Diff line number Diff line change
Expand Up @@ -873,6 +873,7 @@ class Preemptibility(proto.Enum):
instance group.
NON_PREEMPTIBLE (1):
Instances are non-preemptible.
This option is allowed for all instance groups
and is the only valid value for Master and
Worker instance groups.
Expand Down Expand Up @@ -1401,6 +1402,7 @@ class Substate(proto.Enum):
The agent-reported status is out of date (may
occur if Dataproc loses communication with
Agent).
Applies to RUNNING state.
"""
UNSPECIFIED = 0
Expand Down Expand Up @@ -1459,10 +1461,8 @@ class KerberosConfig(proto.Message):
Attributes:
enable_kerberos (bool):
Optional. Flag to indicate whether to
Kerberize the cluster (default:
false). Set this field to true to enable
Kerberos on a cluster.
Kerberize the cluster (default: false). Set this
field to true to enable Kerberos on a cluster.
root_principal_password_uri (str):
Optional. The Cloud Storage URI of a KMS
encrypted file containing the root principal
Expand Down
2 changes: 2 additions & 0 deletions google/cloud/dataproc_v1/types/jobs.py
Original file line number Diff line number Diff line change
Expand Up @@ -959,6 +959,7 @@ class Substate(proto.Enum):
The job substate is unknown.
SUBMITTED (1):
The Job is submitted to the agent.
Applies to RUNNING state.
QUEUED (2):
The Job has been received and is awaiting
Expand All @@ -973,6 +974,7 @@ class Substate(proto.Enum):
between the agent and Dataproc. If the agent
does not send a timely update, the job will
fail.
Applies to RUNNING state.
"""
UNSPECIFIED = 0
Expand Down
5 changes: 5 additions & 0 deletions google/cloud/dataproc_v1/types/workflow_templates.py
Original file line number Diff line number Diff line change
Expand Up @@ -224,6 +224,7 @@ class ManagedCluster(proto.Message):
Required. The cluster name prefix. A unique
cluster name will be formed by appending a
random suffix.
The name must contain only lower-case letters
(a-z), numbers (0-9), and hyphens (-). Must
begin with a letter. Cannot begin or end with
Expand Down Expand Up @@ -271,6 +272,7 @@ class ClusterSelector(proto.Message):
Optional. The zone where workflow process
executes. This parameter does not affect the
selection of the cluster.
If unspecified, the zone of the first cluster
matching the selector is used.
cluster_labels (MutableMapping[str, str]):
Expand Down Expand Up @@ -899,6 +901,7 @@ class GetWorkflowTemplateRequest(proto.Message):
Optional. The version of workflow template to
retrieve. Only previously instantiated versions
can be retrieved.
If unspecified, retrieves the current version.
"""

Expand Down Expand Up @@ -935,6 +938,7 @@ class InstantiateWorkflowTemplateRequest(proto.Message):
instantiate. If specified, the workflow will be
instantiated only if the current version of the
workflow template has the supplied version.
This option cannot be used to instantiate a
previous version of workflow template.
request_id (str):
Expand Down Expand Up @@ -1110,6 +1114,7 @@ def raw_page(self):

class DeleteWorkflowTemplateRequest(proto.Message):
r"""A request to delete a workflow template.
Currently started workflows will remain running.
Attributes:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
],
"language": "PYTHON",
"name": "google-cloud-dataproc",
"version": "5.5.0"
"version": "0.1.0"
},
"snippets": [
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
from google.iam.v1 import iam_policy_pb2 # type: ignore
from google.iam.v1 import options_pb2 # type: ignore
from google.iam.v1 import policy_pb2 # type: ignore
from google.longrunning import operations_pb2
from google.longrunning import operations_pb2 # type: ignore
from google.oauth2 import service_account
from google.protobuf import duration_pb2 # type: ignore
from google.protobuf import json_format
Expand Down
2 changes: 1 addition & 1 deletion tests/unit/gapic/dataproc_v1/test_batch_controller.py
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@
from google.iam.v1 import iam_policy_pb2 # type: ignore
from google.iam.v1 import options_pb2 # type: ignore
from google.iam.v1 import policy_pb2 # type: ignore
from google.longrunning import operations_pb2
from google.longrunning import operations_pb2 # type: ignore
from google.oauth2 import service_account
from google.protobuf import duration_pb2 # type: ignore
from google.protobuf import json_format
Expand Down
2 changes: 1 addition & 1 deletion tests/unit/gapic/dataproc_v1/test_cluster_controller.py
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@
from google.iam.v1 import iam_policy_pb2 # type: ignore
from google.iam.v1 import options_pb2 # type: ignore
from google.iam.v1 import policy_pb2 # type: ignore
from google.longrunning import operations_pb2
from google.longrunning import operations_pb2 # type: ignore
from google.oauth2 import service_account
from google.protobuf import duration_pb2 # type: ignore
from google.protobuf import empty_pb2 # type: ignore
Expand Down
2 changes: 1 addition & 1 deletion tests/unit/gapic/dataproc_v1/test_job_controller.py
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@
from google.iam.v1 import iam_policy_pb2 # type: ignore
from google.iam.v1 import options_pb2 # type: ignore
from google.iam.v1 import policy_pb2 # type: ignore
from google.longrunning import operations_pb2
from google.longrunning import operations_pb2 # type: ignore
from google.oauth2 import service_account
from google.protobuf import field_mask_pb2 # type: ignore
from google.protobuf import json_format
Expand Down
Loading

0 comments on commit c3c65bc

Please sign in to comment.