Skip to content

Commit 6b785f3

Browse files
yoshi-automationtseaver
authored andcommitted
Pick up stub docstring fix in GAPIC generator. (#6966)
1 parent 7504e3f commit 6b785f3

File tree

3 files changed

+80
-80
lines changed

3 files changed

+80
-80
lines changed

container/google/cloud/container_v1/gapic/enums.py

Lines changed: 45 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -18,20 +18,6 @@
1818
import enum
1919

2020

21-
class NetworkPolicy(object):
22-
class Provider(enum.IntEnum):
23-
"""
24-
Allowed Network Policy providers.
25-
26-
Attributes:
27-
PROVIDER_UNSPECIFIED (int): Not set
28-
CALICO (int): Tigera (Calico Felix).
29-
"""
30-
31-
PROVIDER_UNSPECIFIED = 0
32-
CALICO = 1
33-
34-
3521
class Cluster(object):
3622
class Status(enum.IntEnum):
3723
"""
@@ -61,6 +47,51 @@ class Status(enum.IntEnum):
6147
DEGRADED = 6
6248

6349

50+
class NetworkPolicy(object):
51+
class Provider(enum.IntEnum):
52+
"""
53+
Allowed Network Policy providers.
54+
55+
Attributes:
56+
PROVIDER_UNSPECIFIED (int): Not set
57+
CALICO (int): Tigera (Calico Felix).
58+
"""
59+
60+
PROVIDER_UNSPECIFIED = 0
61+
CALICO = 1
62+
63+
64+
class NodePool(object):
65+
class Status(enum.IntEnum):
66+
"""
67+
The current status of the node pool instance.
68+
69+
Attributes:
70+
STATUS_UNSPECIFIED (int): Not set.
71+
PROVISIONING (int): The PROVISIONING state indicates the node pool is being created.
72+
RUNNING (int): The RUNNING state indicates the node pool has been created
73+
and is fully usable.
74+
RUNNING_WITH_ERROR (int): The RUNNING\_WITH\_ERROR state indicates the node pool has been created
75+
and is partially usable. Some error state has occurred and some
76+
functionality may be impaired. Customer may need to reissue a request or
77+
trigger a new update.
78+
RECONCILING (int): The RECONCILING state indicates that some work is actively being done on
79+
the node pool, such as upgrading node software. Details can be found in
80+
the ``statusMessage`` field.
81+
STOPPING (int): The STOPPING state indicates the node pool is being deleted.
82+
ERROR (int): The ERROR state indicates the node pool may be unusable. Details can be
83+
found in the ``statusMessage`` field.
84+
"""
85+
86+
STATUS_UNSPECIFIED = 0
87+
PROVISIONING = 1
88+
RUNNING = 2
89+
RUNNING_WITH_ERROR = 3
90+
RECONCILING = 4
91+
STOPPING = 5
92+
ERROR = 6
93+
94+
6495
class Operation(object):
6596
class Status(enum.IntEnum):
6697
"""
@@ -142,34 +173,3 @@ class Action(enum.IntEnum):
142173
SET_PASSWORD = 1
143174
GENERATE_PASSWORD = 2
144175
SET_USERNAME = 3
145-
146-
147-
class NodePool(object):
148-
class Status(enum.IntEnum):
149-
"""
150-
The current status of the node pool instance.
151-
152-
Attributes:
153-
STATUS_UNSPECIFIED (int): Not set.
154-
PROVISIONING (int): The PROVISIONING state indicates the node pool is being created.
155-
RUNNING (int): The RUNNING state indicates the node pool has been created
156-
and is fully usable.
157-
RUNNING_WITH_ERROR (int): The RUNNING\_WITH\_ERROR state indicates the node pool has been created
158-
and is partially usable. Some error state has occurred and some
159-
functionality may be impaired. Customer may need to reissue a request or
160-
trigger a new update.
161-
RECONCILING (int): The RECONCILING state indicates that some work is actively being done on
162-
the node pool, such as upgrading node software. Details can be found in
163-
the ``statusMessage`` field.
164-
STOPPING (int): The STOPPING state indicates the node pool is being deleted.
165-
ERROR (int): The ERROR state indicates the node pool may be unusable. Details can be
166-
found in the ``statusMessage`` field.
167-
"""
168-
169-
STATUS_UNSPECIFIED = 0
170-
PROVISIONING = 1
171-
RUNNING = 2
172-
RUNNING_WITH_ERROR = 3
173-
RECONCILING = 4
174-
STOPPING = 5
175-
ERROR = 6

container/google/cloud/container_v1/gapic/transports/cluster_manager_grpc_transport.py

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ def channel(self):
9797

9898
@property
9999
def list_clusters(self):
100-
"""Return the gRPC stub for {$apiMethod.name}.
100+
"""Return the gRPC stub for :meth:`ClusterManagerClient.list_clusters`.
101101
102102
Lists all clusters owned by a project in either the specified zone or all
103103
zones.
@@ -111,7 +111,7 @@ def list_clusters(self):
111111

112112
@property
113113
def get_cluster(self):
114-
"""Return the gRPC stub for {$apiMethod.name}.
114+
"""Return the gRPC stub for :meth:`ClusterManagerClient.get_cluster`.
115115
116116
Gets the details of a specific cluster.
117117
@@ -124,7 +124,7 @@ def get_cluster(self):
124124

125125
@property
126126
def create_cluster(self):
127-
"""Return the gRPC stub for {$apiMethod.name}.
127+
"""Return the gRPC stub for :meth:`ClusterManagerClient.create_cluster`.
128128
129129
Creates a cluster, consisting of the specified number and type of Google
130130
Compute Engine instances.
@@ -148,7 +148,7 @@ def create_cluster(self):
148148

149149
@property
150150
def update_cluster(self):
151-
"""Return the gRPC stub for {$apiMethod.name}.
151+
"""Return the gRPC stub for :meth:`ClusterManagerClient.update_cluster`.
152152
153153
Updates the settings of a specific cluster.
154154
@@ -161,7 +161,7 @@ def update_cluster(self):
161161

162162
@property
163163
def update_node_pool(self):
164-
"""Return the gRPC stub for {$apiMethod.name}.
164+
"""Return the gRPC stub for :meth:`ClusterManagerClient.update_node_pool`.
165165
166166
Updates the version and/or image type for a specific node pool.
167167
@@ -174,7 +174,7 @@ def update_node_pool(self):
174174

175175
@property
176176
def set_node_pool_autoscaling(self):
177-
"""Return the gRPC stub for {$apiMethod.name}.
177+
"""Return the gRPC stub for :meth:`ClusterManagerClient.set_node_pool_autoscaling`.
178178
179179
Sets the autoscaling settings for a specific node pool.
180180
@@ -187,7 +187,7 @@ def set_node_pool_autoscaling(self):
187187

188188
@property
189189
def set_logging_service(self):
190-
"""Return the gRPC stub for {$apiMethod.name}.
190+
"""Return the gRPC stub for :meth:`ClusterManagerClient.set_logging_service`.
191191
192192
Sets the logging service for a specific cluster.
193193
@@ -200,7 +200,7 @@ def set_logging_service(self):
200200

201201
@property
202202
def set_monitoring_service(self):
203-
"""Return the gRPC stub for {$apiMethod.name}.
203+
"""Return the gRPC stub for :meth:`ClusterManagerClient.set_monitoring_service`.
204204
205205
Sets the monitoring service for a specific cluster.
206206
@@ -213,7 +213,7 @@ def set_monitoring_service(self):
213213

214214
@property
215215
def set_addons_config(self):
216-
"""Return the gRPC stub for {$apiMethod.name}.
216+
"""Return the gRPC stub for :meth:`ClusterManagerClient.set_addons_config`.
217217
218218
Sets the addons for a specific cluster.
219219
@@ -226,7 +226,7 @@ def set_addons_config(self):
226226

227227
@property
228228
def set_locations(self):
229-
"""Return the gRPC stub for {$apiMethod.name}.
229+
"""Return the gRPC stub for :meth:`ClusterManagerClient.set_locations`.
230230
231231
Sets the locations for a specific cluster.
232232
@@ -239,7 +239,7 @@ def set_locations(self):
239239

240240
@property
241241
def update_master(self):
242-
"""Return the gRPC stub for {$apiMethod.name}.
242+
"""Return the gRPC stub for :meth:`ClusterManagerClient.update_master`.
243243
244244
Updates the master for a specific cluster.
245245
@@ -252,7 +252,7 @@ def update_master(self):
252252

253253
@property
254254
def set_master_auth(self):
255-
"""Return the gRPC stub for {$apiMethod.name}.
255+
"""Return the gRPC stub for :meth:`ClusterManagerClient.set_master_auth`.
256256
257257
Used to set master auth materials. Currently supports :-
258258
Changing the admin password for a specific cluster.
@@ -267,7 +267,7 @@ def set_master_auth(self):
267267

268268
@property
269269
def delete_cluster(self):
270-
"""Return the gRPC stub for {$apiMethod.name}.
270+
"""Return the gRPC stub for :meth:`ClusterManagerClient.delete_cluster`.
271271
272272
Deletes the cluster, including the Kubernetes endpoint and all worker
273273
nodes.
@@ -288,7 +288,7 @@ def delete_cluster(self):
288288

289289
@property
290290
def list_operations(self):
291-
"""Return the gRPC stub for {$apiMethod.name}.
291+
"""Return the gRPC stub for :meth:`ClusterManagerClient.list_operations`.
292292
293293
Lists all operations in a project in a specific zone or all zones.
294294
@@ -301,7 +301,7 @@ def list_operations(self):
301301

302302
@property
303303
def get_operation(self):
304-
"""Return the gRPC stub for {$apiMethod.name}.
304+
"""Return the gRPC stub for :meth:`ClusterManagerClient.get_operation`.
305305
306306
Gets the specified operation.
307307
@@ -314,7 +314,7 @@ def get_operation(self):
314314

315315
@property
316316
def cancel_operation(self):
317-
"""Return the gRPC stub for {$apiMethod.name}.
317+
"""Return the gRPC stub for :meth:`ClusterManagerClient.cancel_operation`.
318318
319319
Cancels the specified operation.
320320
@@ -327,7 +327,7 @@ def cancel_operation(self):
327327

328328
@property
329329
def get_server_config(self):
330-
"""Return the gRPC stub for {$apiMethod.name}.
330+
"""Return the gRPC stub for :meth:`ClusterManagerClient.get_server_config`.
331331
332332
Returns configuration info about the Kubernetes Engine service.
333333
@@ -340,7 +340,7 @@ def get_server_config(self):
340340

341341
@property
342342
def list_node_pools(self):
343-
"""Return the gRPC stub for {$apiMethod.name}.
343+
"""Return the gRPC stub for :meth:`ClusterManagerClient.list_node_pools`.
344344
345345
Lists the node pools for a cluster.
346346
@@ -353,7 +353,7 @@ def list_node_pools(self):
353353

354354
@property
355355
def get_node_pool(self):
356-
"""Return the gRPC stub for {$apiMethod.name}.
356+
"""Return the gRPC stub for :meth:`ClusterManagerClient.get_node_pool`.
357357
358358
Retrieves the node pool requested.
359359
@@ -366,7 +366,7 @@ def get_node_pool(self):
366366

367367
@property
368368
def create_node_pool(self):
369-
"""Return the gRPC stub for {$apiMethod.name}.
369+
"""Return the gRPC stub for :meth:`ClusterManagerClient.create_node_pool`.
370370
371371
Creates a node pool for a cluster.
372372
@@ -379,7 +379,7 @@ def create_node_pool(self):
379379

380380
@property
381381
def delete_node_pool(self):
382-
"""Return the gRPC stub for {$apiMethod.name}.
382+
"""Return the gRPC stub for :meth:`ClusterManagerClient.delete_node_pool`.
383383
384384
Deletes a node pool from a cluster.
385385
@@ -392,7 +392,7 @@ def delete_node_pool(self):
392392

393393
@property
394394
def rollback_node_pool_upgrade(self):
395-
"""Return the gRPC stub for {$apiMethod.name}.
395+
"""Return the gRPC stub for :meth:`ClusterManagerClient.rollback_node_pool_upgrade`.
396396
397397
Roll back the previously Aborted or Failed NodePool upgrade.
398398
This will be an no-op if the last upgrade successfully completed.
@@ -406,7 +406,7 @@ def rollback_node_pool_upgrade(self):
406406

407407
@property
408408
def set_node_pool_management(self):
409-
"""Return the gRPC stub for {$apiMethod.name}.
409+
"""Return the gRPC stub for :meth:`ClusterManagerClient.set_node_pool_management`.
410410
411411
Sets the NodeManagement options for a node pool.
412412
@@ -419,7 +419,7 @@ def set_node_pool_management(self):
419419

420420
@property
421421
def set_labels(self):
422-
"""Return the gRPC stub for {$apiMethod.name}.
422+
"""Return the gRPC stub for :meth:`ClusterManagerClient.set_labels`.
423423
424424
Sets labels on a cluster.
425425
@@ -432,7 +432,7 @@ def set_labels(self):
432432

433433
@property
434434
def set_legacy_abac(self):
435-
"""Return the gRPC stub for {$apiMethod.name}.
435+
"""Return the gRPC stub for :meth:`ClusterManagerClient.set_legacy_abac`.
436436
437437
Enables or disables the ABAC authorization mechanism on a cluster.
438438
@@ -445,7 +445,7 @@ def set_legacy_abac(self):
445445

446446
@property
447447
def start_i_p_rotation(self):
448-
"""Return the gRPC stub for {$apiMethod.name}.
448+
"""Return the gRPC stub for :meth:`ClusterManagerClient.start_i_p_rotation`.
449449
450450
Start master IP rotation.
451451
@@ -458,7 +458,7 @@ def start_i_p_rotation(self):
458458

459459
@property
460460
def complete_i_p_rotation(self):
461-
"""Return the gRPC stub for {$apiMethod.name}.
461+
"""Return the gRPC stub for :meth:`ClusterManagerClient.complete_i_p_rotation`.
462462
463463
Completes master IP rotation.
464464
@@ -471,7 +471,7 @@ def complete_i_p_rotation(self):
471471

472472
@property
473473
def set_node_pool_size(self):
474-
"""Return the gRPC stub for {$apiMethod.name}.
474+
"""Return the gRPC stub for :meth:`ClusterManagerClient.set_node_pool_size`.
475475
476476
Sets the size for a specific node pool.
477477
@@ -484,7 +484,7 @@ def set_node_pool_size(self):
484484

485485
@property
486486
def set_network_policy(self):
487-
"""Return the gRPC stub for {$apiMethod.name}.
487+
"""Return the gRPC stub for :meth:`ClusterManagerClient.set_network_policy`.
488488
489489
Enables/Disables Network Policy for a cluster.
490490
@@ -497,7 +497,7 @@ def set_network_policy(self):
497497

498498
@property
499499
def set_maintenance_policy(self):
500-
"""Return the gRPC stub for {$apiMethod.name}.
500+
"""Return the gRPC stub for :meth:`ClusterManagerClient.set_maintenance_policy`.
501501
502502
Sets the maintenance policy for a cluster.
503503

0 commit comments

Comments
 (0)