docs: Add documentation for enums (#52)

gcf-owl-bot[bot] · parthea · web-flow · commit 970b8d3a969d · 2023-01-20T15:46:46.000-05:00
* docs: Add documentation for enums fix: Add context manager return types chore: Update gapic-generator-python to v1.8.1 PiperOrigin-RevId: 503210727 Source-Link: googleapis/googleapis@a391fd1 Source-Link: https://github.com/googleapis/googleapis-gen/commit/0080f830dec37c3384157082bce279e37079ea58 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiMDA4MGY4MzBkZWMzN2MzMzg0MTU3MDgyYmNlMjc5ZTM3MDc5ZWE1OCJ9 * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * restore rest support Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com> Co-authored-by: Anthonios Partheniou <partheniou@google.com>
diff --git a/google/cloud/gke_multicloud_v1/services/attached_clusters/client.py b/google/cloud/gke_multicloud_v1/services/attached_clusters/client.py
@@ -1594,7 +1594,7 @@ def sample_generate_attached_cluster_install_manifest():
         # Done; return the response.
         return response
 
-    def __enter__(self):
+    def __enter__(self) -> "AttachedClustersClient":
         return self
 
     def __exit__(self, type, value, traceback):
diff --git a/google/cloud/gke_multicloud_v1/services/aws_clusters/client.py b/google/cloud/gke_multicloud_v1/services/aws_clusters/client.py
@@ -2137,7 +2137,7 @@ def sample_get_aws_server_config():
         # Done; return the response.
         return response
 
-    def __enter__(self):
+    def __enter__(self) -> "AwsClustersClient":
         return self
 
     def __exit__(self, type, value, traceback):
diff --git a/google/cloud/gke_multicloud_v1/services/azure_clusters/client.py b/google/cloud/gke_multicloud_v1/services/azure_clusters/client.py
@@ -2712,7 +2712,7 @@ def sample_get_azure_server_config():
         # Done; return the response.
         return response
 
-    def __enter__(self):
+    def __enter__(self) -> "AzureClustersClient":
         return self
 
     def __exit__(self, type, value, traceback):
diff --git a/google/cloud/gke_multicloud_v1/types/attached_resources.py b/google/cloud/gke_multicloud_v1/types/attached_resources.py
@@ -125,7 +125,32 @@ class AttachedCluster(proto.Message):
     """
 
     class State(proto.Enum):
-        r"""The lifecycle state of the cluster."""
+        r"""The lifecycle state of the cluster.
+
+        Values:
+            STATE_UNSPECIFIED (0):
+                Not set.
+            PROVISIONING (1):
+                The PROVISIONING state indicates the cluster
+                is being registered.
+            RUNNING (2):
+                The RUNNING state indicates the cluster has
+                been register and is fully usable.
+            RECONCILING (3):
+                The RECONCILING state indicates that some
+                work is actively being done on the cluster, such
+                as upgrading software components.
+            STOPPING (4):
+                The STOPPING state indicates the cluster is
+                being de-registered.
+            ERROR (5):
+                The ERROR state indicates the cluster is in a
+                broken unrecoverable state.
+            DEGRADED (6):
+                The DEGRADED state indicates the cluster
+                requires user action to restore full
+                functionality.
+        """
         STATE_UNSPECIFIED = 0
         PROVISIONING = 1
         RUNNING = 2
diff --git a/google/cloud/gke_multicloud_v1/types/aws_resources.py b/google/cloud/gke_multicloud_v1/types/aws_resources.py
@@ -135,7 +135,32 @@ class AwsCluster(proto.Message):
     """
 
     class State(proto.Enum):
-        r"""The lifecycle state of the cluster."""
+        r"""The lifecycle state of the cluster.
+
+        Values:
+            STATE_UNSPECIFIED (0):
+                Not set.
+            PROVISIONING (1):
+                The PROVISIONING state indicates the cluster
+                is being created.
+            RUNNING (2):
+                The RUNNING state indicates the cluster has
+                been created and is fully usable.
+            RECONCILING (3):
+                The RECONCILING state indicates that some
+                work is actively being done on the cluster, such
+                as upgrading the control plane replicas.
+            STOPPING (4):
+                The STOPPING state indicates the cluster is
+                being deleted.
+            ERROR (5):
+                The ERROR state indicates the cluster is in a
+                broken unrecoverable state.
+            DEGRADED (6):
+                The DEGRADED state indicates the cluster
+                requires user action to restore full
+                functionality.
+        """
         STATE_UNSPECIFIED = 0
         PROVISIONING = 1
         RUNNING = 2
@@ -493,6 +518,14 @@ class VolumeType(proto.Enum):
         See
         https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html
         for more information.
+
+        Values:
+            VOLUME_TYPE_UNSPECIFIED (0):
+                Not set.
+            GP2 (1):
+                GP2 (General Purpose SSD volume type).
+            GP3 (2):
+                GP3 (General Purpose SSD volume type).
         """
         VOLUME_TYPE_UNSPECIFIED = 0
         GP2 = 1
@@ -625,7 +658,31 @@ class AwsNodePool(proto.Message):
     """
 
     class State(proto.Enum):
-        r"""The lifecycle state of the node pool."""
+        r"""The lifecycle state of the node pool.
+
+        Values:
+            STATE_UNSPECIFIED (0):
+                Not set.
+            PROVISIONING (1):
+                The PROVISIONING state indicates the node
+                pool is being created.
+            RUNNING (2):
+                The RUNNING state indicates the node pool has
+                been created and is fully usable.
+            RECONCILING (3):
+                The RECONCILING state indicates that the node
+                pool is being reconciled.
+            STOPPING (4):
+                The STOPPING state indicates the node pool is
+                being deleted.
+            ERROR (5):
+                The ERROR state indicates the node pool is in
+                a broken unrecoverable state.
+            DEGRADED (6):
+                The DEGRADED state indicates the node pool
+                requires user action to restore full
+                functionality.
+        """
         STATE_UNSPECIFIED = 0
         PROVISIONING = 1
         RUNNING = 2
@@ -967,6 +1024,16 @@ class AwsInstancePlacement(proto.Message):
     class Tenancy(proto.Enum):
         r"""Tenancy defines how EC2 instances are distributed across
         physical hardware.
+
+        Values:
+            TENANCY_UNSPECIFIED (0):
+                Not set.
+            DEFAULT (1):
+                Use default VPC tenancy.
+            DEDICATED (2):
+                Run a dedicated instance.
+            HOST (3):
+                Launch this instance to a dedicated host.
         """
         TENANCY_UNSPECIFIED = 0
         DEFAULT = 1
diff --git a/google/cloud/gke_multicloud_v1/types/azure_resources.py b/google/cloud/gke_multicloud_v1/types/azure_resources.py
@@ -157,7 +157,32 @@ class AzureCluster(proto.Message):
     """
 
     class State(proto.Enum):
-        r"""The lifecycle state of the cluster."""
+        r"""The lifecycle state of the cluster.
+
+        Values:
+            STATE_UNSPECIFIED (0):
+                Not set.
+            PROVISIONING (1):
+                The PROVISIONING state indicates the cluster
+                is being created.
+            RUNNING (2):
+                The RUNNING state indicates the cluster has
+                been created and is fully usable.
+            RECONCILING (3):
+                The RECONCILING state indicates that some
+                work is actively being done on the cluster, such
+                as upgrading the control plane replicas.
+            STOPPING (4):
+                The STOPPING state indicates the cluster is
+                being deleted.
+            ERROR (5):
+                The ERROR state indicates the cluster is in a
+                broken unrecoverable state.
+            DEGRADED (6):
+                The DEGRADED state indicates the cluster
+                requires user action to restore full
+                functionality.
+        """
         STATE_UNSPECIFIED = 0
         PROVISIONING = 1
         RUNNING = 2
@@ -790,7 +815,31 @@ class AzureNodePool(proto.Message):
     """
 
     class State(proto.Enum):
-        r"""The lifecycle state of the node pool."""
+        r"""The lifecycle state of the node pool.
+
+        Values:
+            STATE_UNSPECIFIED (0):
+                Not set.
+            PROVISIONING (1):
+                The PROVISIONING state indicates the node
+                pool is being created.
+            RUNNING (2):
+                The RUNNING state indicates the node pool has
+                been created and is fully usable.
+            RECONCILING (3):
+                The RECONCILING state indicates that the node
+                pool is being reconciled.
+            STOPPING (4):
+                The STOPPING state indicates the node pool is
+                being deleted.
+            ERROR (5):
+                The ERROR state indicates the node pool is in
+                a broken unrecoverable state.
+            DEGRADED (6):
+                The DEGRADED state indicates the node pool
+                requires user action to restore full
+                functionality.
+        """
         STATE_UNSPECIFIED = 0
         PROVISIONING = 1
         RUNNING = 2
diff --git a/google/cloud/gke_multicloud_v1/types/common_resources.py b/google/cloud/gke_multicloud_v1/types/common_resources.py
@@ -154,7 +154,29 @@ class NodeTaint(proto.Message):
     """
 
     class Effect(proto.Enum):
-        r"""The taint effect."""
+        r"""The taint effect.
+
+        Values:
+            EFFECT_UNSPECIFIED (0):
+                Not set.
+            NO_SCHEDULE (1):
+                Do not allow new pods to schedule onto the
+                node unless they tolerate the taint, but allow
+                all pods submitted to Kubelet without going
+                through the scheduler to start, and allow all
+                already-running pods to continue running.
+                Enforced by the scheduler.
+            PREFER_NO_SCHEDULE (2):
+                Like TaintEffectNoSchedule, but the scheduler
+                tries not to schedule new pods onto the node,
+                rather than prohibiting new pods from scheduling
+                onto the node entirely. Enforced by the
+                scheduler.
+            NO_EXECUTE (3):
+                Evict any already-running pods that do not
+                tolerate the taint. Currently enforced by
+                NodeController.
+        """
         EFFECT_UNSPECIFIED = 0
         NO_SCHEDULE = 1
         PREFER_NO_SCHEDULE = 2
@@ -237,7 +259,18 @@ class LoggingComponentConfig(proto.Message):
     """
 
     class Component(proto.Enum):
-        r"""The components of the logging configuration;"""
+        r"""The components of the logging configuration;
+
+        Values:
+            COMPONENT_UNSPECIFIED (0):
+                No component is specified
+            SYSTEM_COMPONENTS (1):
+                This indicates that system logging components
+                is enabled.
+            WORKLOADS (2):
+                This indicates that user workload logging
+                component is enabled.
+        """
         COMPONENT_UNSPECIFIED = 0
         SYSTEM_COMPONENTS = 1
         WORKLOADS = 2
diff --git a/samples/generated_samples/snippet_metadata_google.cloud.gkemulticloud.v1.json b/samples/generated_samples/snippet_metadata_google.cloud.gkemulticloud.v1.json
@@ -8,7 +8,7 @@
     ],
     "language": "PYTHON",
     "name": "google-cloud-gke-multicloud",
-    "version": "0.5.0"
+    "version": "0.1.0"
   },
   "snippets": [
     {

Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@`
`8`	`8`	`],`
`9`	`9`	`"language": "PYTHON",`
`10`	`10`	`"name": "google-cloud-gke-multicloud",`
`11`		`- "version": "0.5.0"`
	`11`	`+ "version": "0.1.0"`
`12`	`12`	`},`
`13`	`13`	`"snippets": [`
`14`	`14`	`{`