From 846b2e19462cbe1a0b2e201b95eee65deb3dbd5b Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Fri, 20 Jan 2023 10:47:59 -0500 Subject: [PATCH 1/2] docs: Add documentation for enums (#218) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * 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: https://github.com/googleapis/googleapis/commit/a391fd1dac18dfdfa00c18c8404f2c3a6ff8e98e 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 --- .../services/applications/client.py | 2 +- .../authorized_certificates/client.py | 2 +- .../services/authorized_domains/client.py | 2 +- .../services/domain_mappings/client.py | 2 +- .../services/firewall/client.py | 2 +- .../services/instances/client.py | 2 +- .../services/services/client.py | 2 +- .../services/versions/client.py | 2 +- .../appengine_admin_v1/types/app_yaml.py | 91 ++++++++++++++++++- .../appengine_admin_v1/types/appengine.py | 39 +++++++- .../appengine_admin_v1/types/application.py | 26 +++++- .../appengine_admin_v1/types/certificate.py | 37 ++++++++ .../types/domain_mapping.py | 32 ++++++- .../appengine_admin_v1/types/firewall.py | 11 ++- .../appengine_admin_v1/types/instance.py | 42 ++++++++- .../types/network_settings.py | 16 +++- .../cloud/appengine_admin_v1/types/service.py | 20 +++- .../cloud/appengine_admin_v1/types/version.py | 68 +++++++++++++- .../snippet_metadata_google.appengine.v1.json | 2 +- 19 files changed, 373 insertions(+), 27 deletions(-) diff --git a/google/cloud/appengine_admin_v1/services/applications/client.py b/google/cloud/appengine_admin_v1/services/applications/client.py index 9a82047..5742ba5 100644 --- a/google/cloud/appengine_admin_v1/services/applications/client.py +++ b/google/cloud/appengine_admin_v1/services/applications/client.py @@ -827,7 +827,7 @@ def sample_repair_application(): # Done; return the response. return response - def __enter__(self): + def __enter__(self) -> "ApplicationsClient": return self def __exit__(self, type, value, traceback): diff --git a/google/cloud/appengine_admin_v1/services/authorized_certificates/client.py b/google/cloud/appengine_admin_v1/services/authorized_certificates/client.py index 2573e72..be433ac 100644 --- a/google/cloud/appengine_admin_v1/services/authorized_certificates/client.py +++ b/google/cloud/appengine_admin_v1/services/authorized_certificates/client.py @@ -860,7 +860,7 @@ def sample_delete_authorized_certificate(): metadata=metadata, ) - def __enter__(self): + def __enter__(self) -> "AuthorizedCertificatesClient": return self def __exit__(self, type, value, traceback): diff --git a/google/cloud/appengine_admin_v1/services/authorized_domains/client.py b/google/cloud/appengine_admin_v1/services/authorized_domains/client.py index d336158..d4d8c57 100644 --- a/google/cloud/appengine_admin_v1/services/authorized_domains/client.py +++ b/google/cloud/appengine_admin_v1/services/authorized_domains/client.py @@ -516,7 +516,7 @@ def sample_list_authorized_domains(): # Done; return the response. return response - def __enter__(self): + def __enter__(self) -> "AuthorizedDomainsClient": return self def __exit__(self, type, value, traceback): diff --git a/google/cloud/appengine_admin_v1/services/domain_mappings/client.py b/google/cloud/appengine_admin_v1/services/domain_mappings/client.py index 163abcf..a96a7a6 100644 --- a/google/cloud/appengine_admin_v1/services/domain_mappings/client.py +++ b/google/cloud/appengine_admin_v1/services/domain_mappings/client.py @@ -897,7 +897,7 @@ def sample_delete_domain_mapping(): # Done; return the response. return response - def __enter__(self): + def __enter__(self) -> "DomainMappingsClient": return self def __exit__(self, type, value, traceback): diff --git a/google/cloud/appengine_admin_v1/services/firewall/client.py b/google/cloud/appengine_admin_v1/services/firewall/client.py index 4b9b9f2..2788d82 100644 --- a/google/cloud/appengine_admin_v1/services/firewall/client.py +++ b/google/cloud/appengine_admin_v1/services/firewall/client.py @@ -920,7 +920,7 @@ def sample_delete_ingress_rule(): metadata=metadata, ) - def __enter__(self): + def __enter__(self) -> "FirewallClient": return self def __exit__(self, type, value, traceback): diff --git a/google/cloud/appengine_admin_v1/services/instances/client.py b/google/cloud/appengine_admin_v1/services/instances/client.py index 612bd41..ff8afbb 100644 --- a/google/cloud/appengine_admin_v1/services/instances/client.py +++ b/google/cloud/appengine_admin_v1/services/instances/client.py @@ -843,7 +843,7 @@ def sample_debug_instance(): # Done; return the response. return response - def __enter__(self): + def __enter__(self) -> "InstancesClient": return self def __exit__(self, type, value, traceback): diff --git a/google/cloud/appengine_admin_v1/services/services/client.py b/google/cloud/appengine_admin_v1/services/services/client.py index 11ffc05..f1bb91a 100644 --- a/google/cloud/appengine_admin_v1/services/services/client.py +++ b/google/cloud/appengine_admin_v1/services/services/client.py @@ -810,7 +810,7 @@ def sample_delete_service(): # Done; return the response. return response - def __enter__(self): + def __enter__(self) -> "ServicesClient": return self def __exit__(self, type, value, traceback): diff --git a/google/cloud/appengine_admin_v1/services/versions/client.py b/google/cloud/appengine_admin_v1/services/versions/client.py index b8dc6a0..f4280cd 100644 --- a/google/cloud/appengine_admin_v1/services/versions/client.py +++ b/google/cloud/appengine_admin_v1/services/versions/client.py @@ -925,7 +925,7 @@ def sample_delete_version(): # Done; return the response. return response - def __enter__(self): + def __enter__(self) -> "VersionsClient": return self def __exit__(self, type, value, traceback): diff --git a/google/cloud/appengine_admin_v1/types/app_yaml.py b/google/cloud/appengine_admin_v1/types/app_yaml.py index 1f1f30f..9384f6e 100644 --- a/google/cloud/appengine_admin_v1/types/app_yaml.py +++ b/google/cloud/appengine_admin_v1/types/app_yaml.py @@ -39,14 +39,42 @@ class AuthFailAction(proto.Enum): - r"""Actions to take when the user is not logged in.""" + r"""Actions to take when the user is not logged in. + + Values: + AUTH_FAIL_ACTION_UNSPECIFIED (0): + Not specified. ``AUTH_FAIL_ACTION_REDIRECT`` is assumed. + AUTH_FAIL_ACTION_REDIRECT (1): + Redirects user to "accounts.google.com". The + user is redirected back to the application URL + after signing in or creating an account. + AUTH_FAIL_ACTION_UNAUTHORIZED (2): + Rejects request with a ``401`` HTTP status code and an error + message. + """ AUTH_FAIL_ACTION_UNSPECIFIED = 0 AUTH_FAIL_ACTION_REDIRECT = 1 AUTH_FAIL_ACTION_UNAUTHORIZED = 2 class LoginRequirement(proto.Enum): - r"""Methods to restrict access to a URL based on login status.""" + r"""Methods to restrict access to a URL based on login status. + + Values: + LOGIN_UNSPECIFIED (0): + Not specified. ``LOGIN_OPTIONAL`` is assumed. + LOGIN_OPTIONAL (1): + Does not require that the user is signed in. + LOGIN_ADMIN (2): + If the user is not signed in, the ``auth_fail_action`` is + taken. In addition, if the user is not an administrator for + the application, they are given an error message regardless + of ``auth_fail_action``. If the user is an administrator, + the handler proceeds. + LOGIN_REQUIRED (3): + If the user has signed in, the handler proceeds normally. + Otherwise, the auth_fail_action is taken. + """ LOGIN_UNSPECIFIED = 0 LOGIN_OPTIONAL = 1 LOGIN_ADMIN = 2 @@ -54,7 +82,32 @@ class LoginRequirement(proto.Enum): class SecurityLevel(proto.Enum): - r"""Methods to enforce security (HTTPS) on a URL.""" + r"""Methods to enforce security (HTTPS) on a URL. + + Values: + SECURE_UNSPECIFIED (0): + Not specified. + SECURE_DEFAULT (0): + Both HTTP and HTTPS requests with URLs that + match the handler succeed without redirects. The + application can examine the request to determine + which protocol was used, and respond + accordingly. + SECURE_NEVER (1): + Requests for a URL that match this handler + that use HTTPS are automatically redirected to + the HTTP equivalent URL. + SECURE_OPTIONAL (2): + Both HTTP and HTTPS requests with URLs that + match the handler succeed without redirects. The + application can examine the request to determine + which protocol was used and respond accordingly. + SECURE_ALWAYS (3): + Requests for a URL that match this handler + that do not use HTTPS are automatically + redirected to the HTTPS URL with the same path. + Query parameters are reserved for the redirect. + """ _pb_options = {"allow_alias": True} SECURE_UNSPECIFIED = 0 SECURE_DEFAULT = 0 @@ -123,7 +176,22 @@ class ErrorHandler(proto.Message): """ class ErrorCode(proto.Enum): - r"""Error codes.""" + r"""Error codes. + + Values: + ERROR_CODE_UNSPECIFIED (0): + Not specified. ERROR_CODE_DEFAULT is assumed. + ERROR_CODE_DEFAULT (0): + All other error types. + ERROR_CODE_OVER_QUOTA (1): + Application has exceeded a resource quota. + ERROR_CODE_DOS_API_DENIAL (2): + Client blocked by the application's Denial of + Service protection configuration. + ERROR_CODE_TIMEOUT (3): + Deadline reached before the application + responds. + """ _pb_options = {"allow_alias": True} ERROR_CODE_UNSPECIFIED = 0 ERROR_CODE_DEFAULT = 0 @@ -198,7 +266,20 @@ class UrlMap(proto.Message): """ class RedirectHttpResponseCode(proto.Enum): - r"""Redirect codes.""" + r"""Redirect codes. + + Values: + REDIRECT_HTTP_RESPONSE_CODE_UNSPECIFIED (0): + Not specified. ``302`` is assumed. + REDIRECT_HTTP_RESPONSE_CODE_301 (1): + ``301 Moved Permanently`` code. + REDIRECT_HTTP_RESPONSE_CODE_302 (2): + ``302 Moved Temporarily`` code. + REDIRECT_HTTP_RESPONSE_CODE_303 (3): + ``303 See Other`` code. + REDIRECT_HTTP_RESPONSE_CODE_307 (4): + ``307 Temporary Redirect`` code. + """ REDIRECT_HTTP_RESPONSE_CODE_UNSPECIFIED = 0 REDIRECT_HTTP_RESPONSE_CODE_301 = 1 REDIRECT_HTTP_RESPONSE_CODE_302 = 2 diff --git a/google/cloud/appengine_admin_v1/types/appengine.py b/google/cloud/appengine_admin_v1/types/appengine.py index 3b24d8e..28ceb53 100644 --- a/google/cloud/appengine_admin_v1/types/appengine.py +++ b/google/cloud/appengine_admin_v1/types/appengine.py @@ -81,6 +81,17 @@ class VersionView(proto.Enum): r"""Fields that should be returned when [Version][google.appengine.v1.Version] resources are retrieved. + + Values: + BASIC (0): + Basic version information including scaling + and inbound services, but not detailed + deployment information. + FULL (1): + The information from ``BASIC``, plus detailed information + about the deployment. This format is required when creating + resources, but is not returned in ``Get`` or ``List`` by + default. """ BASIC = 0 FULL = 1 @@ -89,13 +100,39 @@ class VersionView(proto.Enum): class AuthorizedCertificateView(proto.Enum): r"""Fields that should be returned when an AuthorizedCertificate resource is retrieved. + + Values: + BASIC_CERTIFICATE (0): + Basic certificate information, including + applicable domains and expiration date. + FULL_CERTIFICATE (1): + The information from ``BASIC_CERTIFICATE``, plus detailed + information on the domain mappings that have this + certificate mapped. """ BASIC_CERTIFICATE = 0 FULL_CERTIFICATE = 1 class DomainOverrideStrategy(proto.Enum): - r"""Override strategy for mutating an existing mapping.""" + r"""Override strategy for mutating an existing mapping. + + Values: + UNSPECIFIED_DOMAIN_OVERRIDE_STRATEGY (0): + Strategy unspecified. Defaults to ``STRICT``. + STRICT (1): + Overrides not allowed. If a mapping already exists for the + specified domain, the request will return an ALREADY_EXISTS + (409). + OVERRIDE (2): + Overrides allowed. If a mapping already + exists for the specified domain, the request + will overwrite it. Note that this might stop + another Google product from serving. For + example, if the domain is mapped to another App + Engine application, that app will no longer + serve from that domain. + """ UNSPECIFIED_DOMAIN_OVERRIDE_STRATEGY = 0 STRICT = 1 OVERRIDE = 2 diff --git a/google/cloud/appengine_admin_v1/types/application.py b/google/cloud/appengine_admin_v1/types/application.py index 4206407..d50a6c0 100644 --- a/google/cloud/appengine_admin_v1/types/application.py +++ b/google/cloud/appengine_admin_v1/types/application.py @@ -104,14 +104,36 @@ class Application(proto.Message): """ class ServingStatus(proto.Enum): - r"""""" + r""" + + Values: + UNSPECIFIED (0): + Serving status is unspecified. + SERVING (1): + Application is serving. + USER_DISABLED (2): + Application has been disabled by the user. + SYSTEM_DISABLED (3): + Application has been disabled by the system. + """ UNSPECIFIED = 0 SERVING = 1 USER_DISABLED = 2 SYSTEM_DISABLED = 3 class DatabaseType(proto.Enum): - r"""""" + r""" + + Values: + DATABASE_TYPE_UNSPECIFIED (0): + Database type is unspecified. + CLOUD_DATASTORE (1): + Cloud Datastore + CLOUD_FIRESTORE (2): + Cloud Firestore Native + CLOUD_DATASTORE_COMPATIBILITY (3): + Cloud Firestore in Datastore Mode + """ DATABASE_TYPE_UNSPECIFIED = 0 CLOUD_DATASTORE = 1 CLOUD_FIRESTORE = 2 diff --git a/google/cloud/appengine_admin_v1/types/certificate.py b/google/cloud/appengine_admin_v1/types/certificate.py index 0fe3c65..e314a8a 100644 --- a/google/cloud/appengine_admin_v1/types/certificate.py +++ b/google/cloud/appengine_admin_v1/types/certificate.py @@ -32,6 +32,43 @@ class ManagementStatus(proto.Enum): r"""State of certificate management. Refers to the most recent certificate acquisition or renewal attempt. + + Values: + MANAGEMENT_STATUS_UNSPECIFIED (0): + + OK (1): + Certificate was successfully obtained and + inserted into the serving system. + PENDING (2): + Certificate is under active attempts to + acquire or renew. + FAILED_RETRYING_NOT_VISIBLE (4): + Most recent renewal failed due to an invalid + DNS setup and will be retried. Renewal attempts + will continue to fail until the certificate + domain's DNS configuration is fixed. The last + successfully provisioned certificate may still + be serving. + FAILED_PERMANENT (6): + All renewal attempts have been exhausted, + likely due to an invalid DNS setup. + FAILED_RETRYING_CAA_FORBIDDEN (7): + Most recent renewal failed due to an explicit + CAA record that does not include one of the + in-use CAs (Google CA and Let's Encrypt). + Renewals will continue to fail until the CAA is + reconfigured. The last successfully provisioned + certificate may still be serving. + FAILED_RETRYING_CAA_CHECKING (8): + Most recent renewal failed due to a CAA + retrieval failure. This means that the domain's + DNS provider does not properly handle CAA + records, failing requests for CAA records when + no CAA records are defined. Renewals will + continue to fail until the DNS provider is + changed or a CAA record is added for the given + domain. The last successfully provisioned + certificate may still be serving. """ MANAGEMENT_STATUS_UNSPECIFIED = 0 OK = 1 diff --git a/google/cloud/appengine_admin_v1/types/domain_mapping.py b/google/cloud/appengine_admin_v1/types/domain_mapping.py index 7d75e5b..5007c5a 100644 --- a/google/cloud/appengine_admin_v1/types/domain_mapping.py +++ b/google/cloud/appengine_admin_v1/types/domain_mapping.py @@ -107,7 +107,21 @@ class SslSettings(proto.Message): """ class SslManagementType(proto.Enum): - r"""The SSL management type for this domain.""" + r"""The SSL management type for this domain. + + Values: + SSL_MANAGEMENT_TYPE_UNSPECIFIED (0): + Defaults to ``AUTOMATIC``. + AUTOMATIC (1): + SSL support for this domain is configured + automatically. The mapped SSL certificate will + be automatically renewed. + MANUAL (2): + SSL support for this domain is configured + manually by the user. Either the domain has no + SSL support or a user-obtained SSL certificate + has been explictly mapped to this domain. + """ SSL_MANAGEMENT_TYPE_UNSPECIFIED = 0 AUTOMATIC = 1 MANUAL = 2 @@ -143,7 +157,21 @@ class ResourceRecord(proto.Message): """ class RecordType(proto.Enum): - r"""A resource record type.""" + r"""A resource record type. + + Values: + RECORD_TYPE_UNSPECIFIED (0): + An unknown resource record. + A (1): + An A resource record. Data is an IPv4 + address. + AAAA (2): + An AAAA resource record. Data is an IPv6 + address. + CNAME (3): + A CNAME resource record. Data is a domain + name to be aliased. + """ RECORD_TYPE_UNSPECIFIED = 0 A = 1 AAAA = 2 diff --git a/google/cloud/appengine_admin_v1/types/firewall.py b/google/cloud/appengine_admin_v1/types/firewall.py index 9062b66..cd8209a 100644 --- a/google/cloud/appengine_admin_v1/types/firewall.py +++ b/google/cloud/appengine_admin_v1/types/firewall.py @@ -61,7 +61,16 @@ class FirewallRule(proto.Message): """ class Action(proto.Enum): - r"""Available actions to take on matching requests.""" + r"""Available actions to take on matching requests. + + Values: + UNSPECIFIED_ACTION (0): + + ALLOW (1): + Matching requests are allowed. + DENY (2): + Matching requests are denied. + """ UNSPECIFIED_ACTION = 0 ALLOW = 1 DENY = 2 diff --git a/google/cloud/appengine_admin_v1/types/instance.py b/google/cloud/appengine_admin_v1/types/instance.py index a767775..db103a8 100644 --- a/google/cloud/appengine_admin_v1/types/instance.py +++ b/google/cloud/appengine_admin_v1/types/instance.py @@ -92,7 +92,16 @@ class Instance(proto.Message): """ class Availability(proto.Enum): - r"""Availability of the instance.""" + r"""Availability of the instance. + + Values: + UNSPECIFIED (0): + + RESIDENT (1): + + DYNAMIC (2): + + """ UNSPECIFIED = 0 RESIDENT = 1 DYNAMIC = 2 @@ -101,7 +110,36 @@ class Liveness(proto.Message): r"""Wrapper for LivenessState enum.""" class LivenessState(proto.Enum): - r"""Liveness health check status for Flex instances.""" + r"""Liveness health check status for Flex instances. + + Values: + LIVENESS_STATE_UNSPECIFIED (0): + There is no liveness health check for the + instance. Only applicable for instances in App + Engine standard environment. + UNKNOWN (1): + The health checking system is aware of the + instance but its health is not known at the + moment. + HEALTHY (2): + The instance is reachable i.e. a connection + to the application health checking endpoint can + be established, and conforms to the requirements + defined by the health check. + UNHEALTHY (3): + The instance is reachable, but does not + conform to the requirements defined by the + health check. + DRAINING (4): + The instance is being drained. The existing + connections to the instance have time to + complete, but the new ones are being refused. + TIMEOUT (5): + The instance is unreachable i.e. a connection + to the application health checking endpoint + cannot be established, or the server does not + respond within the specified timeout. + """ LIVENESS_STATE_UNSPECIFIED = 0 UNKNOWN = 1 HEALTHY = 2 diff --git a/google/cloud/appengine_admin_v1/types/network_settings.py b/google/cloud/appengine_admin_v1/types/network_settings.py index 3594eb4..f47ece3 100644 --- a/google/cloud/appengine_admin_v1/types/network_settings.py +++ b/google/cloud/appengine_admin_v1/types/network_settings.py @@ -35,7 +35,21 @@ class NetworkSettings(proto.Message): """ class IngressTrafficAllowed(proto.Enum): - r"""If unspecified, INGRESS_TRAFFIC_ALLOWED_ALL will be used.""" + r"""If unspecified, INGRESS_TRAFFIC_ALLOWED_ALL will be used. + + Values: + INGRESS_TRAFFIC_ALLOWED_UNSPECIFIED (0): + Unspecified + INGRESS_TRAFFIC_ALLOWED_ALL (1): + Allow HTTP traffic from public and private + sources. + INGRESS_TRAFFIC_ALLOWED_INTERNAL_ONLY (2): + Allow HTTP traffic from only private VPC + sources. + INGRESS_TRAFFIC_ALLOWED_INTERNAL_AND_LB (3): + Allow HTTP traffic from private VPC sources + and through load balancers. + """ INGRESS_TRAFFIC_ALLOWED_UNSPECIFIED = 0 INGRESS_TRAFFIC_ALLOWED_ALL = 1 INGRESS_TRAFFIC_ALLOWED_INTERNAL_ONLY = 2 diff --git a/google/cloud/appengine_admin_v1/types/service.py b/google/cloud/appengine_admin_v1/types/service.py index e09e628..1da091b 100644 --- a/google/cloud/appengine_admin_v1/types/service.py +++ b/google/cloud/appengine_admin_v1/types/service.py @@ -127,7 +127,25 @@ class TrafficSplit(proto.Message): """ class ShardBy(proto.Enum): - r"""Available sharding mechanisms.""" + r"""Available sharding mechanisms. + + Values: + UNSPECIFIED (0): + Diversion method unspecified. + COOKIE (1): + Diversion based on a specially named cookie, + "GOOGAPPUID." The cookie must be set by the + application itself or no diversion will occur. + IP (2): + Diversion based on applying the modulus + operation to a fingerprint of the IP address. + RANDOM (3): + Diversion based on weighted random + assignment. An incoming request is randomly + routed to a version in the traffic split, with + probability proportional to the version's + traffic share. + """ UNSPECIFIED = 0 COOKIE = 1 IP = 2 diff --git a/google/cloud/appengine_admin_v1/types/version.py b/google/cloud/appengine_admin_v1/types/version.py index 62361bc..e1c5027 100644 --- a/google/cloud/appengine_admin_v1/types/version.py +++ b/google/cloud/appengine_admin_v1/types/version.py @@ -46,7 +46,35 @@ class InboundServiceType(proto.Enum): - r"""Available inbound services.""" + r"""Available inbound services. + + Values: + INBOUND_SERVICE_UNSPECIFIED (0): + Not specified. + INBOUND_SERVICE_MAIL (1): + Allows an application to receive mail. + INBOUND_SERVICE_MAIL_BOUNCE (2): + Allows an application to receive email-bound + notifications. + INBOUND_SERVICE_XMPP_ERROR (3): + Allows an application to receive error + stanzas. + INBOUND_SERVICE_XMPP_MESSAGE (4): + Allows an application to receive instant + messages. + INBOUND_SERVICE_XMPP_SUBSCRIBE (5): + Allows an application to receive user + subscription POSTs. + INBOUND_SERVICE_XMPP_PRESENCE (6): + Allows an application to receive a user's + chat presence. + INBOUND_SERVICE_CHANNEL_PRESENCE (7): + Registers an application for notifications + when a client connects or disconnects from a + channel. + INBOUND_SERVICE_WARMUP (9): + Enables warmup requests. + """ INBOUND_SERVICE_UNSPECIFIED = 0 INBOUND_SERVICE_MAIL = 1 INBOUND_SERVICE_MAIL_BOUNCE = 2 @@ -59,7 +87,20 @@ class InboundServiceType(proto.Enum): class ServingStatus(proto.Enum): - r"""Run states of a version.""" + r"""Run states of a version. + + Values: + SERVING_STATUS_UNSPECIFIED (0): + Not specified. + SERVING (1): + Currently serving. Instances are created + according to the scaling settings of the + version. + STOPPED (2): + Disabled. No instances will be created and the scaling + settings are ignored until the state of the version changes + to ``SERVING``. + """ SERVING_STATUS_UNSPECIFIED = 0 SERVING = 1 STOPPED = 2 @@ -497,7 +538,18 @@ class EndpointsApiService(proto.Message): """ class RolloutStrategy(proto.Enum): - r"""Available rollout strategies.""" + r"""Available rollout strategies. + + Values: + UNSPECIFIED_ROLLOUT_STRATEGY (0): + Not specified. Defaults to ``FIXED``. + FIXED (1): + Endpoints service configuration ID will be fixed to the + configuration ID specified by ``config_id``. + MANAGED (2): + Endpoints service configuration ID will be + updated with each rollout. + """ UNSPECIFIED_ROLLOUT_STRATEGY = 0 FIXED = 1 MANAGED = 2 @@ -981,6 +1033,16 @@ class EgressSetting(proto.Enum): This controls what traffic is diverted through the VPC Access Connector resource. By default PRIVATE_IP_RANGES will be used. + + Values: + EGRESS_SETTING_UNSPECIFIED (0): + + ALL_TRAFFIC (1): + Force the use of VPC Access for all egress + traffic from the function. + PRIVATE_IP_RANGES (2): + Use the VPC Access Connector for private IP + space from RFC1918. """ EGRESS_SETTING_UNSPECIFIED = 0 ALL_TRAFFIC = 1 diff --git a/samples/generated_samples/snippet_metadata_google.appengine.v1.json b/samples/generated_samples/snippet_metadata_google.appengine.v1.json index fb8aad8..fb8cbf5 100644 --- a/samples/generated_samples/snippet_metadata_google.appengine.v1.json +++ b/samples/generated_samples/snippet_metadata_google.appengine.v1.json @@ -8,7 +8,7 @@ ], "language": "PYTHON", "name": "google-cloud-appengine-admin", - "version": "1.8.0" + "version": "0.1.0" }, "snippets": [ { From e156b27a32b83bd6276915899ed334a7a99eebb3 Mon Sep 17 00:00:00 2001 From: "release-please[bot]" <55107282+release-please[bot]@users.noreply.github.com> Date: Mon, 23 Jan 2023 10:40:42 -0500 Subject: [PATCH 2/2] chore(main): release 1.8.1 (#219) Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com> --- .release-please-manifest.json | 2 +- CHANGELOG.md | 12 ++++++++++++ google/cloud/appengine_admin/gapic_version.py | 2 +- google/cloud/appengine_admin_v1/gapic_version.py | 2 +- .../snippet_metadata_google.appengine.v1.json | 2 +- 5 files changed, 16 insertions(+), 4 deletions(-) diff --git a/.release-please-manifest.json b/.release-please-manifest.json index 099626f..7840fde 100644 --- a/.release-please-manifest.json +++ b/.release-please-manifest.json @@ -1,3 +1,3 @@ { - ".": "1.8.0" + ".": "1.8.1" } diff --git a/CHANGELOG.md b/CHANGELOG.md index c96d63f..1c9c677 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,17 @@ # Changelog +## [1.8.1](https://github.com/googleapis/python-appengine-admin/compare/v1.8.0...v1.8.1) (2023-01-20) + + +### Bug Fixes + +* Add context manager return types ([846b2e1](https://github.com/googleapis/python-appengine-admin/commit/846b2e19462cbe1a0b2e201b95eee65deb3dbd5b)) + + +### Documentation + +* Add documentation for enums ([846b2e1](https://github.com/googleapis/python-appengine-admin/commit/846b2e19462cbe1a0b2e201b95eee65deb3dbd5b)) + ## [1.8.0](https://github.com/googleapis/python-appengine-admin/compare/v1.7.1...v1.8.0) (2023-01-10) diff --git a/google/cloud/appengine_admin/gapic_version.py b/google/cloud/appengine_admin/gapic_version.py index b334dcc..90e0293 100644 --- a/google/cloud/appengine_admin/gapic_version.py +++ b/google/cloud/appengine_admin/gapic_version.py @@ -13,4 +13,4 @@ # See the License for the specific language governing permissions and # limitations under the License. # -__version__ = "1.8.0" # {x-release-please-version} +__version__ = "1.8.1" # {x-release-please-version} diff --git a/google/cloud/appengine_admin_v1/gapic_version.py b/google/cloud/appengine_admin_v1/gapic_version.py index b334dcc..90e0293 100644 --- a/google/cloud/appengine_admin_v1/gapic_version.py +++ b/google/cloud/appengine_admin_v1/gapic_version.py @@ -13,4 +13,4 @@ # See the License for the specific language governing permissions and # limitations under the License. # -__version__ = "1.8.0" # {x-release-please-version} +__version__ = "1.8.1" # {x-release-please-version} diff --git a/samples/generated_samples/snippet_metadata_google.appengine.v1.json b/samples/generated_samples/snippet_metadata_google.appengine.v1.json index fb8cbf5..4447546 100644 --- a/samples/generated_samples/snippet_metadata_google.appengine.v1.json +++ b/samples/generated_samples/snippet_metadata_google.appengine.v1.json @@ -8,7 +8,7 @@ ], "language": "PYTHON", "name": "google-cloud-appengine-admin", - "version": "0.1.0" + "version": "1.8.1" }, "snippets": [ {