docs: Add documentation for enums (#198)

gcf-owl-bot[bot] · web-flow · commit 27c4e7c30a0d · 2023-01-20T11:46:20.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 Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
diff --git a/google/cloud/binaryauthorization_v1/services/binauthz_management_service_v1/client.py b/google/cloud/binaryauthorization_v1/services/binauthz_management_service_v1/client.py
@@ -1277,7 +1277,7 @@ def sample_delete_attestor():
             metadata=metadata,
         )
 
-    def __enter__(self):
+    def __enter__(self) -> "BinauthzManagementServiceV1Client":
         return self
 
     def __exit__(self, type, value, traceback):
diff --git a/google/cloud/binaryauthorization_v1/services/system_policy_v1/client.py b/google/cloud/binaryauthorization_v1/services/system_policy_v1/client.py
@@ -539,7 +539,7 @@ def sample_get_system_policy():
         # Done; return the response.
         return response
 
-    def __enter__(self):
+    def __enter__(self) -> "SystemPolicyV1Client":
         return self
 
     def __exit__(self, type, value, traceback):
diff --git a/google/cloud/binaryauthorization_v1/services/validation_helper_v1/client.py b/google/cloud/binaryauthorization_v1/services/validation_helper_v1/client.py
@@ -506,7 +506,7 @@ def sample_validate_attestation_occurrence():
         # Done; return the response.
         return response
 
-    def __enter__(self):
+    def __enter__(self) -> "ValidationHelperV1Client":
         return self
 
     def __exit__(self, type, value, traceback):
diff --git a/google/cloud/binaryauthorization_v1/types/resources.py b/google/cloud/binaryauthorization_v1/types/resources.py
@@ -89,7 +89,16 @@ class Policy(proto.Message):
     """
 
     class GlobalPolicyEvaluationMode(proto.Enum):
-        r""""""
+        r"""
+
+        Values:
+            GLOBAL_POLICY_EVALUATION_MODE_UNSPECIFIED (0):
+                Not specified: DISABLE is assumed.
+            ENABLE (1):
+                Enables system policy evaluation.
+            DISABLE (2):
+                Disables system policy evaluation.
+        """
         GLOBAL_POLICY_EVALUATION_MODE_UNSPECIFIED = 0
         ENABLE = 1
         DISABLE = 2
@@ -212,7 +221,20 @@ class AdmissionRule(proto.Message):
     """
 
     class EvaluationMode(proto.Enum):
-        r""""""
+        r"""
+
+        Values:
+            EVALUATION_MODE_UNSPECIFIED (0):
+                Do not use.
+            ALWAYS_ALLOW (1):
+                This rule allows all all pod creations.
+            REQUIRE_ATTESTATION (2):
+                This rule allows a pod creation if all the attestors listed
+                in 'require_attestations_by' have valid attestations for all
+                of the images in the pod spec.
+            ALWAYS_DENY (3):
+                This rule denies all pod creations.
+        """
         EVALUATION_MODE_UNSPECIFIED = 0
         ALWAYS_ALLOW = 1
         REQUIRE_ATTESTATION = 2
@@ -221,6 +243,17 @@ class EvaluationMode(proto.Enum):
     class EnforcementMode(proto.Enum):
         r"""Defines the possible actions when a pod creation is denied by
         an admission rule.
+
+        Values:
+            ENFORCEMENT_MODE_UNSPECIFIED (0):
+                Do not use.
+            ENFORCED_BLOCK_AND_AUDIT_LOG (1):
+                Enforce the admission rule by blocking the
+                pod creation.
+            DRYRUN_AUDIT_LOG_ONLY (2):
+                Dryrun mode: Audit logging only.  This will
+                allow the pod creation as if the admission
+                request had specified break-glass.
         """
         ENFORCEMENT_MODE_UNSPECIFIED = 0
         ENFORCED_BLOCK_AND_AUDIT_LOG = 1
@@ -372,6 +405,44 @@ class SignatureAlgorithm(proto.Enum):
         algorithms. See https://cloud.google.com/kms/docs/algorithms. In
         the future, BinAuthz might support additional public key types
         independently of Tink and/or KMS.
+
+        Values:
+            SIGNATURE_ALGORITHM_UNSPECIFIED (0):
+                Not specified.
+            RSA_PSS_2048_SHA256 (1):
+                RSASSA-PSS 2048 bit key with a SHA256 digest.
+            RSA_PSS_3072_SHA256 (2):
+                RSASSA-PSS 3072 bit key with a SHA256 digest.
+            RSA_PSS_4096_SHA256 (3):
+                RSASSA-PSS 4096 bit key with a SHA256 digest.
+            RSA_PSS_4096_SHA512 (4):
+                RSASSA-PSS 4096 bit key with a SHA512 digest.
+            RSA_SIGN_PKCS1_2048_SHA256 (5):
+                RSASSA-PKCS1-v1_5 with a 2048 bit key and a SHA256 digest.
+            RSA_SIGN_PKCS1_3072_SHA256 (6):
+                RSASSA-PKCS1-v1_5 with a 3072 bit key and a SHA256 digest.
+            RSA_SIGN_PKCS1_4096_SHA256 (7):
+                RSASSA-PKCS1-v1_5 with a 4096 bit key and a SHA256 digest.
+            RSA_SIGN_PKCS1_4096_SHA512 (8):
+                RSASSA-PKCS1-v1_5 with a 4096 bit key and a SHA512 digest.
+            ECDSA_P256_SHA256 (9):
+                ECDSA on the NIST P-256 curve with a SHA256
+                digest.
+            EC_SIGN_P256_SHA256 (9):
+                ECDSA on the NIST P-256 curve with a SHA256
+                digest.
+            ECDSA_P384_SHA384 (10):
+                ECDSA on the NIST P-384 curve with a SHA384
+                digest.
+            EC_SIGN_P384_SHA384 (10):
+                ECDSA on the NIST P-384 curve with a SHA384
+                digest.
+            ECDSA_P521_SHA512 (11):
+                ECDSA on the NIST P-521 curve with a SHA512
+                digest.
+            EC_SIGN_P521_SHA512 (11):
+                ECDSA on the NIST P-521 curve with a SHA512
+                digest.
         """
         _pb_options = {"allow_alias": True}
         SIGNATURE_ALGORITHM_UNSPECIFIED = 0
diff --git a/google/cloud/binaryauthorization_v1/types/service.py b/google/cloud/binaryauthorization_v1/types/service.py
@@ -300,7 +300,18 @@ class ValidateAttestationOccurrenceResponse(proto.Message):
     """
 
     class Result(proto.Enum):
-        r"""The enum returned in the "result" field."""
+        r"""The enum returned in the "result" field.
+
+        Values:
+            RESULT_UNSPECIFIED (0):
+                Unspecified.
+            VERIFIED (1):
+                The Attestation was able to verified by the
+                Attestor.
+            ATTESTATION_NOT_VERIFIABLE (2):
+                The Attestation was not able to verified by
+                the Attestor.
+        """
         RESULT_UNSPECIFIED = 0
         VERIFIED = 1
         ATTESTATION_NOT_VERIFIABLE = 2
diff --git a/google/cloud/binaryauthorization_v1beta1/services/binauthz_management_service_v1_beta1/client.py b/google/cloud/binaryauthorization_v1beta1/services/binauthz_management_service_v1_beta1/client.py
@@ -1290,7 +1290,7 @@ def sample_delete_attestor():
             metadata=metadata,
         )
 
-    def __enter__(self):
+    def __enter__(self) -> "BinauthzManagementServiceV1Beta1Client":
         return self
 
     def __exit__(self, type, value, traceback):
diff --git a/google/cloud/binaryauthorization_v1beta1/services/system_policy_v1_beta1/client.py b/google/cloud/binaryauthorization_v1beta1/services/system_policy_v1_beta1/client.py
@@ -540,7 +540,7 @@ def sample_get_system_policy():
         # Done; return the response.
         return response
 
-    def __enter__(self):
+    def __enter__(self) -> "SystemPolicyV1Beta1Client":
         return self
 
     def __exit__(self, type, value, traceback):
diff --git a/google/cloud/binaryauthorization_v1beta1/types/continuous_validation_logging.py b/google/cloud/binaryauthorization_v1beta1/types/continuous_validation_logging.py
@@ -67,7 +67,15 @@ class ContinuousValidationPodEvent(proto.Message):
         """
 
         class PolicyConformanceVerdict(proto.Enum):
-            r"""Audit time policy conformance verdict."""
+            r"""Audit time policy conformance verdict.
+
+            Values:
+                POLICY_CONFORMANCE_VERDICT_UNSPECIFIED (0):
+                    We should always have a verdict. This is an
+                    error.
+                VIOLATES_POLICY (1):
+                    The pod violates the policy.
+            """
             POLICY_CONFORMANCE_VERDICT_UNSPECIFIED = 0
             VIOLATES_POLICY = 1
 
@@ -84,7 +92,16 @@ class ImageDetails(proto.Message):
             """
 
             class AuditResult(proto.Enum):
-                r"""Result of the audit."""
+                r"""Result of the audit.
+
+                Values:
+                    AUDIT_RESULT_UNSPECIFIED (0):
+                        Unspecified result. This is an error.
+                    ALLOW (1):
+                        Image is allowed.
+                    DENY (2):
+                        Image is denied.
+                """
                 AUDIT_RESULT_UNSPECIFIED = 0
                 ALLOW = 1
                 DENY = 2
diff --git a/google/cloud/binaryauthorization_v1beta1/types/resources.py b/google/cloud/binaryauthorization_v1beta1/types/resources.py
@@ -88,7 +88,16 @@ class Policy(proto.Message):
     """
 
     class GlobalPolicyEvaluationMode(proto.Enum):
-        r""""""
+        r"""
+
+        Values:
+            GLOBAL_POLICY_EVALUATION_MODE_UNSPECIFIED (0):
+                Not specified: DISABLE is assumed.
+            ENABLE (1):
+                Enables system policy evaluation.
+            DISABLE (2):
+                Disables system policy evaluation.
+        """
         GLOBAL_POLICY_EVALUATION_MODE_UNSPECIFIED = 0
         ENABLE = 1
         DISABLE = 2
@@ -214,7 +223,20 @@ class AdmissionRule(proto.Message):
     """
 
     class EvaluationMode(proto.Enum):
-        r""""""
+        r"""
+
+        Values:
+            EVALUATION_MODE_UNSPECIFIED (0):
+                Do not use.
+            ALWAYS_ALLOW (1):
+                This rule allows all all pod creations.
+            REQUIRE_ATTESTATION (2):
+                This rule allows a pod creation if all the attestors listed
+                in ``require_attestations_by`` have valid attestations for
+                all of the images in the pod spec.
+            ALWAYS_DENY (3):
+                This rule denies all pod creations.
+        """
         EVALUATION_MODE_UNSPECIFIED = 0
         ALWAYS_ALLOW = 1
         REQUIRE_ATTESTATION = 2
@@ -223,6 +245,17 @@ class EvaluationMode(proto.Enum):
     class EnforcementMode(proto.Enum):
         r"""Defines the possible actions when a pod creation is denied by
         an admission rule.
+
+        Values:
+            ENFORCEMENT_MODE_UNSPECIFIED (0):
+                Do not use.
+            ENFORCED_BLOCK_AND_AUDIT_LOG (1):
+                Enforce the admission rule by blocking the
+                pod creation.
+            DRYRUN_AUDIT_LOG_ONLY (2):
+                Dryrun mode: Audit logging only.  This will
+                allow the pod creation as if the admission
+                request had specified break-glass.
         """
         ENFORCEMENT_MODE_UNSPECIFIED = 0
         ENFORCED_BLOCK_AND_AUDIT_LOG = 1
@@ -372,6 +405,44 @@ class SignatureAlgorithm(proto.Enum):
         algorithms. See https://cloud.google.com/kms/docs/algorithms. In
         the future, BinAuthz might support additional public key types
         independently of Tink and/or KMS.
+
+        Values:
+            SIGNATURE_ALGORITHM_UNSPECIFIED (0):
+                Not specified.
+            RSA_PSS_2048_SHA256 (1):
+                RSASSA-PSS 2048 bit key with a SHA256 digest.
+            RSA_PSS_3072_SHA256 (2):
+                RSASSA-PSS 3072 bit key with a SHA256 digest.
+            RSA_PSS_4096_SHA256 (3):
+                RSASSA-PSS 4096 bit key with a SHA256 digest.
+            RSA_PSS_4096_SHA512 (4):
+                RSASSA-PSS 4096 bit key with a SHA512 digest.
+            RSA_SIGN_PKCS1_2048_SHA256 (5):
+                RSASSA-PKCS1-v1_5 with a 2048 bit key and a SHA256 digest.
+            RSA_SIGN_PKCS1_3072_SHA256 (6):
+                RSASSA-PKCS1-v1_5 with a 3072 bit key and a SHA256 digest.
+            RSA_SIGN_PKCS1_4096_SHA256 (7):
+                RSASSA-PKCS1-v1_5 with a 4096 bit key and a SHA256 digest.
+            RSA_SIGN_PKCS1_4096_SHA512 (8):
+                RSASSA-PKCS1-v1_5 with a 4096 bit key and a SHA512 digest.
+            ECDSA_P256_SHA256 (9):
+                ECDSA on the NIST P-256 curve with a SHA256
+                digest.
+            EC_SIGN_P256_SHA256 (9):
+                ECDSA on the NIST P-256 curve with a SHA256
+                digest.
+            ECDSA_P384_SHA384 (10):
+                ECDSA on the NIST P-384 curve with a SHA384
+                digest.
+            EC_SIGN_P384_SHA384 (10):
+                ECDSA on the NIST P-384 curve with a SHA384
+                digest.
+            ECDSA_P521_SHA512 (11):
+                ECDSA on the NIST P-521 curve with a SHA512
+                digest.
+            EC_SIGN_P521_SHA512 (11):
+                ECDSA on the NIST P-521 curve with a SHA512
+                digest.
         """
         _pb_options = {"allow_alias": True}
         SIGNATURE_ALGORITHM_UNSPECIFIED = 0
diff --git a/samples/generated_samples/snippet_metadata_google.cloud.binaryauthorization.v1.json b/samples/generated_samples/snippet_metadata_google.cloud.binaryauthorization.v1.json
@@ -8,7 +8,7 @@
     ],
     "language": "PYTHON",
     "name": "google-cloud-binary-authorization",
-    "version": "1.5.0"
+    "version": "0.1.0"
   },
   "snippets": [
     {
diff --git a/samples/generated_samples/snippet_metadata_google.cloud.binaryauthorization.v1beta1.json b/samples/generated_samples/snippet_metadata_google.cloud.binaryauthorization.v1beta1.json
@@ -8,7 +8,7 @@
     ],
     "language": "PYTHON",
     "name": "google-cloud-binary-authorization",
-    "version": "1.5.0"
+    "version": "0.1.0"
   },
   "snippets": [
     {

Original file line number	Diff line number	Diff line change
`@@ -1277,7 +1277,7 @@ def sample_delete_attestor():`
`1277`	`1277`	`metadata=metadata,`
`1278`	`1278`	`)`
`1279`	`1279`
`1280`		`- def __enter__(self):`
	`1280`	`+ def __enter__(self) -> "BinauthzManagementServiceV1Client":`
`1281`	`1281`	`return self`
`1282`	`1282`
`1283`	`1283`	`def __exit__(self, type, value, traceback):`
Original file line number	Diff line number	Diff line change
`@@ -1290,7 +1290,7 @@ def sample_delete_attestor():`
`1290`	`1290`	`metadata=metadata,`
`1291`	`1291`	`)`
`1292`	`1292`
`1293`		`- def __enter__(self):`
	`1293`	`+ def __enter__(self) -> "BinauthzManagementServiceV1Beta1Client":`
`1294`	`1294`	`return self`
`1295`	`1295`
`1296`	`1296`	`def __exit__(self, type, value, traceback):`
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-binary-authorization",`
`11`		`- "version": "1.5.0"`
	`11`	`+ "version": "0.1.0"`
`12`	`12`	`},`
`13`	`13`	`"snippets": [`
`14`	`14`	`{`