Skip to content

Commit 13d8a87

Browse files
yoshi-automationyoshi-automation
authored
docs(dataproc): remove 'cloud' from references to dataproc; add py2 deprecation warning; add 3.8 tests (via synth) (#10066)
1 parent ee342a8 commit 13d8a87

21 files changed

+276
-273
lines changed

‎dataproc/docs/_static/custom.css

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
div#python2-eol {
22
border-color: red;
33
border-width: medium;
4-
}
4+
}

‎dataproc/docs/_templates/layout.html

+1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
12
{% extends "!layout.html" %}
23
{%- block content %}
34
{%- if theme_fixed_sidebar|lower == 'true' %}

‎dataproc/google/cloud/dataproc_v1/__init__.py

+11
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@
1616

1717

1818
from __future__ import absolute_import
19+
import sys
20+
import warnings
1921

2022
from google.cloud.dataproc_v1 import types
2123
from google.cloud.dataproc_v1.gapic import cluster_controller_client
@@ -24,6 +26,15 @@
2426
from google.cloud.dataproc_v1.gapic import workflow_template_service_client
2527

2628

29+
if sys.version_info[:2] == (2, 7):
30+
message = (
31+
"A future version of this library will drop support for Python 2.7."
32+
"More details about Python 2 support for Google Cloud Client Libraries"
33+
"can be found at https://cloud.google.com/python/docs/python2-sunset/"
34+
)
35+
warnings.warn(message, DeprecationWarning)
36+
37+
2738
class ClusterControllerClient(cluster_controller_client.ClusterControllerClient):
2839
__doc__ = cluster_controller_client.ClusterControllerClient.__doc__
2940
enums = enums

‎dataproc/google/cloud/dataproc_v1/gapic/cluster_controller_client.py

+6-6
Original file line numberDiff line numberDiff line change
@@ -235,7 +235,7 @@ def create_cluster(
235235
Args:
236236
project_id (str): Required. The ID of the Google Cloud Platform project that the cluster
237237
belongs to.
238-
region (str): Required. The Cloud Dataproc region in which to handle the request.
238+
region (str): Required. The Dataproc region in which to handle the request.
239239
cluster (Union[dict, ~google.cloud.dataproc_v1.types.Cluster]): Required. The cluster to create.
240240
241241
If a dict is provided, it must be of the same form as the protobuf
@@ -346,7 +346,7 @@ def update_cluster(
346346
Args:
347347
project_id (str): Required. The ID of the Google Cloud Platform project the
348348
cluster belongs to.
349-
region (str): Required. The Cloud Dataproc region in which to handle the request.
349+
region (str): Required. The Dataproc region in which to handle the request.
350350
cluster_name (str): Required. The cluster name.
351351
cluster (Union[dict, ~google.cloud.dataproc_v1.types.Cluster]): Required. The changes to the cluster.
352352
@@ -529,7 +529,7 @@ def delete_cluster(
529529
Args:
530530
project_id (str): Required. The ID of the Google Cloud Platform project that the cluster
531531
belongs to.
532-
region (str): Required. The Cloud Dataproc region in which to handle the request.
532+
region (str): Required. The Dataproc region in which to handle the request.
533533
cluster_name (str): Required. The cluster name.
534534
cluster_uuid (str): Optional. Specifying the ``cluster_uuid`` means the RPC should fail
535535
(with error NOT\_FOUND) if cluster with specified UUID does not exist.
@@ -622,7 +622,7 @@ def get_cluster(
622622
Args:
623623
project_id (str): Required. The ID of the Google Cloud Platform project that the cluster
624624
belongs to.
625-
region (str): Required. The Cloud Dataproc region in which to handle the request.
625+
region (str): Required. The Dataproc region in which to handle the request.
626626
cluster_name (str): Required. The cluster name.
627627
retry (Optional[google.api_core.retry.Retry]): A retry object used
628628
to retry requests. If ``None`` is specified, requests will
@@ -702,7 +702,7 @@ def list_clusters(
702702
Args:
703703
project_id (str): Required. The ID of the Google Cloud Platform project that the cluster
704704
belongs to.
705-
region (str): Required. The Cloud Dataproc region in which to handle the request.
705+
region (str): Required. The Dataproc region in which to handle the request.
706706
filter_ (str): Optional. A filter constraining the clusters to list. Filters are
707707
case-sensitive and have the following syntax:
708708
@@ -823,7 +823,7 @@ def diagnose_cluster(
823823
Args:
824824
project_id (str): Required. The ID of the Google Cloud Platform project that the cluster
825825
belongs to.
826-
region (str): Required. The Cloud Dataproc region in which to handle the request.
826+
region (str): Required. The Dataproc region in which to handle the request.
827827
cluster_name (str): Required. The cluster name.
828828
retry (Optional[google.api_core.retry.Retry]): A retry object used
829829
to retry requests. If ``None`` is specified, requests will

‎dataproc/google/cloud/dataproc_v1/gapic/enums.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ class Substate(enum.IntEnum):
8989
9090
Applies to RUNNING state.
9191
STALE_STATUS (int): The agent-reported status is out of date (may occur if
92-
Cloud Dataproc loses communication with Agent).
92+
Dataproc loses communication with Agent).
9393
9494
Applies to RUNNING state.
9595
"""
@@ -148,7 +148,7 @@ class Substate(enum.IntEnum):
148148
149149
Applies to RUNNING state.
150150
STALE_STATUS (int): The agent-reported status is out of date, which may be caused by a
151-
loss of communication between the agent and Cloud Dataproc. If the
151+
loss of communication between the agent and Dataproc. If the
152152
agent does not send a timely update, the job will fail.
153153
154154
Applies to RUNNING state.

‎dataproc/google/cloud/dataproc_v1/gapic/job_controller_client.py

+6-6
Original file line numberDiff line numberDiff line change
@@ -221,7 +221,7 @@ def submit_job(
221221
Args:
222222
project_id (str): Required. The ID of the Google Cloud Platform project that the job
223223
belongs to.
224-
region (str): Required. The Cloud Dataproc region in which to handle the request.
224+
region (str): Required. The Dataproc region in which to handle the request.
225225
job (Union[dict, ~google.cloud.dataproc_v1.types.Job]): Required. The job resource.
226226
227227
If a dict is provided, it must be of the same form as the protobuf
@@ -304,7 +304,7 @@ def get_job(
304304
Args:
305305
project_id (str): Required. The ID of the Google Cloud Platform project that the job
306306
belongs to.
307-
region (str): Required. The Cloud Dataproc region in which to handle the request.
307+
region (str): Required. The Dataproc region in which to handle the request.
308308
job_id (str): Required. The job ID.
309309
retry (Optional[google.api_core.retry.Retry]): A retry object used
310310
to retry requests. If ``None`` is specified, requests will
@@ -386,7 +386,7 @@ def list_jobs(
386386
Args:
387387
project_id (str): Required. The ID of the Google Cloud Platform project that the job
388388
belongs to.
389-
region (str): Required. The Cloud Dataproc region in which to handle the request.
389+
region (str): Required. The Dataproc region in which to handle the request.
390390
page_size (int): The maximum number of resources contained in the
391391
underlying API response. If page streaming is performed per-
392392
resource, this parameter does not affect the return value. If page
@@ -507,7 +507,7 @@ def update_job(
507507
Args:
508508
project_id (str): Required. The ID of the Google Cloud Platform project that the job
509509
belongs to.
510-
region (str): Required. The Cloud Dataproc region in which to handle the request.
510+
region (str): Required. The Dataproc region in which to handle the request.
511511
job_id (str): Required. The job ID.
512512
job (Union[dict, ~google.cloud.dataproc_v1.types.Job]): Required. The changes to the job.
513513
@@ -597,7 +597,7 @@ def cancel_job(
597597
Args:
598598
project_id (str): Required. The ID of the Google Cloud Platform project that the job
599599
belongs to.
600-
region (str): Required. The Cloud Dataproc region in which to handle the request.
600+
region (str): Required. The Dataproc region in which to handle the request.
601601
job_id (str): Required. The job ID.
602602
retry (Optional[google.api_core.retry.Retry]): A retry object used
603603
to retry requests. If ``None`` is specified, requests will
@@ -668,7 +668,7 @@ def delete_job(
668668
Args:
669669
project_id (str): Required. The ID of the Google Cloud Platform project that the job
670670
belongs to.
671-
region (str): Required. The Cloud Dataproc region in which to handle the request.
671+
region (str): Required. The Dataproc region in which to handle the request.
672672
job_id (str): Required. The job ID.
673673
retry (Optional[google.api_core.retry.Retry]): A retry object used
674674
to retry requests. If ``None`` is specified, requests will

‎dataproc/google/cloud/dataproc_v1/gapic/workflow_template_service_client.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@
5757
class WorkflowTemplateServiceClient(object):
5858
"""
5959
The API interface for managing Workflow Templates in the
60-
Cloud Dataproc API.
60+
Dataproc API.
6161
"""
6262

6363
SERVICE_ADDRESS = "dataproc.googleapis.com:443"

‎dataproc/google/cloud/dataproc_v1/proto/autoscaling_policies.proto

+1-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ option java_outer_classname = "AutoscalingPoliciesProto";
3030
option java_package = "com.google.cloud.dataproc.v1";
3131

3232
// The API interface for managing autoscaling policies in the
33-
// Google Cloud Dataproc API.
33+
// Dataproc API.
3434
service AutoscalingPolicyService {
3535
option (google.api.default_host) = "dataproc.googleapis.com";
3636
option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform";

‎dataproc/google/cloud/dataproc_v1/proto/autoscaling_policies_pb2_grpc.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99

1010
class AutoscalingPolicyServiceStub(object):
1111
"""The API interface for managing autoscaling policies in the
12-
Google Cloud Dataproc API.
12+
Dataproc API.
1313
"""
1414

1515
def __init__(self, channel):
@@ -47,7 +47,7 @@ def __init__(self, channel):
4747

4848
class AutoscalingPolicyServiceServicer(object):
4949
"""The API interface for managing autoscaling policies in the
50-
Google Cloud Dataproc API.
50+
Dataproc API.
5151
"""
5252

5353
def CreateAutoscalingPolicy(self, request, context):

0 commit comments

Comments
 (0)