From 3074826e65e4e05ca8c5cc45a9716985f57b7e54 Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Wed, 13 Sep 2023 20:38:14 +0000 Subject: [PATCH] docs: Minor formatting (#249) - [ ] Regenerate this pull request now. chore: Update gapic-generator-python to v1.11.5 build: Update rules_python to 0.24.0 PiperOrigin-RevId: 563436317 Source-Link: https://togithub.com/googleapis/googleapis/commit/42fd37b18d706f6f51f52f209973b3b2c28f509a Source-Link: https://togithub.com/googleapis/googleapis-gen/commit/280264ca02fb9316b4237a96d0af1a2343a81a56 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiMjgwMjY0Y2EwMmZiOTMxNmI0MjM3YTk2ZDBhZjFhMjM0M2E4MWE1NiJ9 --- .../appengine_admin_v1/services/firewall/async_client.py | 1 + .../cloud/appengine_admin_v1/services/firewall/client.py | 1 + .../appengine_admin_v1/services/firewall/transports/grpc.py | 1 + .../services/firewall/transports/grpc_asyncio.py | 1 + .../appengine_admin_v1/services/firewall/transports/rest.py | 1 + .../google/cloud/appengine_admin_v1/types/appengine.py | 1 + .../google/cloud/appengine_admin_v1/types/application.py | 2 ++ .../google/cloud/appengine_admin_v1/types/certificate.py | 1 + .../google/cloud/appengine_admin_v1/types/deploy.py | 2 ++ .../google/cloud/appengine_admin_v1/types/domain_mapping.py | 1 + .../google/cloud/appengine_admin_v1/types/operation.py | 3 +++ .../google/cloud/appengine_admin_v1/types/service.py | 1 + .../google/cloud/appengine_admin_v1/types/version.py | 4 ++++ .../tests/unit/gapic/appengine_admin_v1/test_applications.py | 2 +- .../unit/gapic/appengine_admin_v1/test_domain_mappings.py | 2 +- .../tests/unit/gapic/appengine_admin_v1/test_instances.py | 2 +- .../tests/unit/gapic/appengine_admin_v1/test_services.py | 2 +- .../tests/unit/gapic/appengine_admin_v1/test_versions.py | 2 +- 18 files changed, 25 insertions(+), 5 deletions(-) diff --git a/packages/google-cloud-appengine-admin/google/cloud/appengine_admin_v1/services/firewall/async_client.py b/packages/google-cloud-appengine-admin/google/cloud/appengine_admin_v1/services/firewall/async_client.py index e492179f45a3..8eb483c584ad 100644 --- a/packages/google-cloud-appengine-admin/google/cloud/appengine_admin_v1/services/firewall/async_client.py +++ b/packages/google-cloud-appengine-admin/google/cloud/appengine_admin_v1/services/firewall/async_client.py @@ -56,6 +56,7 @@ class FirewallAsyncClient: position which specifies the rule's order in the sequence of rules, an IP range to be matched against requests, and an action to take upon matching requests. + Every request is evaluated against the Firewall rules in priority order. Processesing stops at the first rule which matches the request's IP address. A final rule always specifies diff --git a/packages/google-cloud-appengine-admin/google/cloud/appengine_admin_v1/services/firewall/client.py b/packages/google-cloud-appengine-admin/google/cloud/appengine_admin_v1/services/firewall/client.py index dbe1d1df3665..4acd108b219a 100644 --- a/packages/google-cloud-appengine-admin/google/cloud/appengine_admin_v1/services/firewall/client.py +++ b/packages/google-cloud-appengine-admin/google/cloud/appengine_admin_v1/services/firewall/client.py @@ -96,6 +96,7 @@ class FirewallClient(metaclass=FirewallClientMeta): position which specifies the rule's order in the sequence of rules, an IP range to be matched against requests, and an action to take upon matching requests. + Every request is evaluated against the Firewall rules in priority order. Processesing stops at the first rule which matches the request's IP address. A final rule always specifies diff --git a/packages/google-cloud-appengine-admin/google/cloud/appengine_admin_v1/services/firewall/transports/grpc.py b/packages/google-cloud-appengine-admin/google/cloud/appengine_admin_v1/services/firewall/transports/grpc.py index 10de39780349..eb28eed73bde 100644 --- a/packages/google-cloud-appengine-admin/google/cloud/appengine_admin_v1/services/firewall/transports/grpc.py +++ b/packages/google-cloud-appengine-admin/google/cloud/appengine_admin_v1/services/firewall/transports/grpc.py @@ -36,6 +36,7 @@ class FirewallGrpcTransport(FirewallTransport): position which specifies the rule's order in the sequence of rules, an IP range to be matched against requests, and an action to take upon matching requests. + Every request is evaluated against the Firewall rules in priority order. Processesing stops at the first rule which matches the request's IP address. A final rule always specifies diff --git a/packages/google-cloud-appengine-admin/google/cloud/appengine_admin_v1/services/firewall/transports/grpc_asyncio.py b/packages/google-cloud-appengine-admin/google/cloud/appengine_admin_v1/services/firewall/transports/grpc_asyncio.py index bb68615ce952..595906f8a29e 100644 --- a/packages/google-cloud-appengine-admin/google/cloud/appengine_admin_v1/services/firewall/transports/grpc_asyncio.py +++ b/packages/google-cloud-appengine-admin/google/cloud/appengine_admin_v1/services/firewall/transports/grpc_asyncio.py @@ -37,6 +37,7 @@ class FirewallGrpcAsyncIOTransport(FirewallTransport): position which specifies the rule's order in the sequence of rules, an IP range to be matched against requests, and an action to take upon matching requests. + Every request is evaluated against the Firewall rules in priority order. Processesing stops at the first rule which matches the request's IP address. A final rule always specifies diff --git a/packages/google-cloud-appengine-admin/google/cloud/appengine_admin_v1/services/firewall/transports/rest.py b/packages/google-cloud-appengine-admin/google/cloud/appengine_admin_v1/services/firewall/transports/rest.py index f4a39a18c2a3..f217721df470 100644 --- a/packages/google-cloud-appengine-admin/google/cloud/appengine_admin_v1/services/firewall/transports/rest.py +++ b/packages/google-cloud-appengine-admin/google/cloud/appengine_admin_v1/services/firewall/transports/rest.py @@ -258,6 +258,7 @@ class FirewallRestTransport(FirewallTransport): position which specifies the rule's order in the sequence of rules, an IP range to be matched against requests, and an action to take upon matching requests. + Every request is evaluated against the Firewall rules in priority order. Processesing stops at the first rule which matches the request's IP address. A final rule always specifies diff --git a/packages/google-cloud-appengine-admin/google/cloud/appengine_admin_v1/types/appengine.py b/packages/google-cloud-appengine-admin/google/cloud/appengine_admin_v1/types/appengine.py index bb3f4b9dfc33..2d7f0abf193e 100644 --- a/packages/google-cloud-appengine-admin/google/cloud/appengine_admin_v1/types/appengine.py +++ b/packages/google-cloud-appengine-admin/google/cloud/appengine_admin_v1/types/appengine.py @@ -729,6 +729,7 @@ class CreateIngressRuleRequest(proto.Message): new rule. Example: ``apps/myapp/firewall/ingressRules``. rule (google.cloud.appengine_admin_v1.types.FirewallRule): A FirewallRule containing the new resource. + The user may optionally provide a position at which the new rule will be placed. The positions define a sequential list starting at 1. If a diff --git a/packages/google-cloud-appengine-admin/google/cloud/appengine_admin_v1/types/application.py b/packages/google-cloud-appengine-admin/google/cloud/appengine_admin_v1/types/application.py index 680f782215b3..1863614d5684 100644 --- a/packages/google-cloud-appengine-admin/google/cloud/appengine_admin_v1/types/application.py +++ b/packages/google-cloud-appengine-admin/google/cloud/appengine_admin_v1/types/application.py @@ -53,6 +53,7 @@ class Application(proto.Message): Google Apps authentication domain that controls which users can access this application. + Defaults to open access for any Google Account. location_id (str): Location from which this application runs. Application @@ -70,6 +71,7 @@ class Application(proto.Message): application. This bucket is associated with the application and can be used by the gcloud deployment commands. + @OutputOnly default_cookie_expiration (google.protobuf.duration_pb2.Duration): Cookie expiration policy for this diff --git a/packages/google-cloud-appengine-admin/google/cloud/appengine_admin_v1/types/certificate.py b/packages/google-cloud-appengine-admin/google/cloud/appengine_admin_v1/types/certificate.py index 74f6e09a47db..bd4df73189b2 100644 --- a/packages/google-cloud-appengine-admin/google/cloud/appengine_admin_v1/types/certificate.py +++ b/packages/google-cloud-appengine-admin/google/cloud/appengine_admin_v1/types/certificate.py @@ -252,6 +252,7 @@ class ManagedCertificate(proto.Message): Status of certificate management. Refers to the most recent certificate acquisition or renewal attempt. + @OutputOnly """ diff --git a/packages/google-cloud-appengine-admin/google/cloud/appengine_admin_v1/types/deploy.py b/packages/google-cloud-appengine-admin/google/cloud/appengine_admin_v1/types/deploy.py index daa95b1a8a21..1e60343731ef 100644 --- a/packages/google-cloud-appengine-admin/google/cloud/appengine_admin_v1/types/deploy.py +++ b/packages/google-cloud-appengine-admin/google/cloud/appengine_admin_v1/types/deploy.py @@ -96,6 +96,7 @@ class FileInfo(proto.Message): The SHA1 hash of the file, in hex. mime_type (str): The MIME type of the file. + Defaults to the value from Google Cloud Storage. """ @@ -142,6 +143,7 @@ class CloudBuildOptions(proto.Message): app_yaml_path (str): Path to the yaml file used in deployment, used to determine runtime configuration details. + Required for flexible environment builds. See diff --git a/packages/google-cloud-appengine-admin/google/cloud/appengine_admin_v1/types/domain_mapping.py b/packages/google-cloud-appengine-admin/google/cloud/appengine_admin_v1/types/domain_mapping.py index 4041cc16eaad..a69702fb5e34 100644 --- a/packages/google-cloud-appengine-admin/google/cloud/appengine_admin_v1/types/domain_mapping.py +++ b/packages/google-cloud-appengine-admin/google/cloud/appengine_admin_v1/types/domain_mapping.py @@ -50,6 +50,7 @@ class DomainMapping(proto.Message): this domain mapping. These records must be added to the domain's DNS configuration in order to serve the application via this domain mapping. + @OutputOnly """ diff --git a/packages/google-cloud-appengine-admin/google/cloud/appengine_admin_v1/types/operation.py b/packages/google-cloud-appengine-admin/google/cloud/appengine_admin_v1/types/operation.py index 410386c9419e..58e0524961b3 100644 --- a/packages/google-cloud-appengine-admin/google/cloud/appengine_admin_v1/types/operation.py +++ b/packages/google-cloud-appengine-admin/google/cloud/appengine_admin_v1/types/operation.py @@ -44,12 +44,15 @@ class OperationMetadataV1(proto.Message): @OutputOnly insert_time (google.protobuf.timestamp_pb2.Timestamp): Time that this operation was created. + @OutputOnly end_time (google.protobuf.timestamp_pb2.Timestamp): Time that this operation completed. + @OutputOnly user (str): User who requested this operation. + @OutputOnly target (str): Name of the resource that this operation is acting on. diff --git a/packages/google-cloud-appengine-admin/google/cloud/appengine_admin_v1/types/service.py b/packages/google-cloud-appengine-admin/google/cloud/appengine_admin_v1/types/service.py index 8eb0defac40d..1b58295f82ea 100644 --- a/packages/google-cloud-appengine-admin/google/cloud/appengine_admin_v1/types/service.py +++ b/packages/google-cloud-appengine-admin/google/cloud/appengine_admin_v1/types/service.py @@ -68,6 +68,7 @@ class Service(proto.Message): using labels is to tag resources belonging to different environments (e.g., "env=prod", "env=qa"). +

Label keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores, diff --git a/packages/google-cloud-appengine-admin/google/cloud/appengine_admin_v1/types/version.py b/packages/google-cloud-appengine-admin/google/cloud/appengine_admin_v1/types/version.py index e8409db7f44b..ec9345526019 100644 --- a/packages/google-cloud-appengine-admin/google/cloud/appengine_admin_v1/types/version.py +++ b/packages/google-cloud-appengine-admin/google/cloud/appengine_admin_v1/types/version.py @@ -214,11 +214,13 @@ class Version(proto.Message): @OutputOnly create_time (google.protobuf.timestamp_pb2.Timestamp): Time that this version was created. + @OutputOnly disk_usage_bytes (int): Total size in bytes of all the files that are included in this version and currently hosted on the App Engine disk. + @OutputOnly runtime_api_version (str): The version of the API in the given runtime @@ -299,6 +301,7 @@ class Version(proto.Message): Serving URL for this version. Example: "https://myversion-dot-myservice-dot-myapp.appspot.com" + @OutputOnly endpoints_api_service (google.cloud.appengine_admin_v1.types.EndpointsApiService): Cloud Endpoints configuration. @@ -595,6 +598,7 @@ class AutomaticScaling(proto.Message): Number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance. + Defaults to a runtime-specific value. max_idle_instances (int): Maximum number of idle instances that should diff --git a/packages/google-cloud-appengine-admin/tests/unit/gapic/appengine_admin_v1/test_applications.py b/packages/google-cloud-appengine-admin/tests/unit/gapic/appengine_admin_v1/test_applications.py index c347e7f87760..4b357a05aec0 100644 --- a/packages/google-cloud-appengine-admin/tests/unit/gapic/appengine_admin_v1/test_applications.py +++ b/packages/google-cloud-appengine-admin/tests/unit/gapic/appengine_admin_v1/test_applications.py @@ -41,7 +41,7 @@ import google.auth from google.auth import credentials as ga_credentials from google.auth.exceptions import MutualTLSChannelError -from google.longrunning import operations_pb2 +from google.longrunning import operations_pb2 # type: ignore from google.oauth2 import service_account from google.protobuf import duration_pb2 # type: ignore from google.protobuf import field_mask_pb2 # type: ignore diff --git a/packages/google-cloud-appengine-admin/tests/unit/gapic/appengine_admin_v1/test_domain_mappings.py b/packages/google-cloud-appengine-admin/tests/unit/gapic/appengine_admin_v1/test_domain_mappings.py index e631be238416..523099b2e9e6 100644 --- a/packages/google-cloud-appengine-admin/tests/unit/gapic/appengine_admin_v1/test_domain_mappings.py +++ b/packages/google-cloud-appengine-admin/tests/unit/gapic/appengine_admin_v1/test_domain_mappings.py @@ -41,7 +41,7 @@ import google.auth from google.auth import credentials as ga_credentials from google.auth.exceptions import MutualTLSChannelError -from google.longrunning import operations_pb2 +from google.longrunning import operations_pb2 # type: ignore from google.oauth2 import service_account from google.protobuf import empty_pb2 # type: ignore from google.protobuf import field_mask_pb2 # type: ignore diff --git a/packages/google-cloud-appengine-admin/tests/unit/gapic/appengine_admin_v1/test_instances.py b/packages/google-cloud-appengine-admin/tests/unit/gapic/appengine_admin_v1/test_instances.py index f4983f97e80f..43e5114f406c 100644 --- a/packages/google-cloud-appengine-admin/tests/unit/gapic/appengine_admin_v1/test_instances.py +++ b/packages/google-cloud-appengine-admin/tests/unit/gapic/appengine_admin_v1/test_instances.py @@ -41,7 +41,7 @@ import google.auth from google.auth import credentials as ga_credentials from google.auth.exceptions import MutualTLSChannelError -from google.longrunning import operations_pb2 +from google.longrunning import operations_pb2 # type: ignore from google.oauth2 import service_account from google.protobuf import empty_pb2 # type: ignore from google.protobuf import json_format diff --git a/packages/google-cloud-appengine-admin/tests/unit/gapic/appengine_admin_v1/test_services.py b/packages/google-cloud-appengine-admin/tests/unit/gapic/appengine_admin_v1/test_services.py index e5ab4fbf94be..4119c69c4ce3 100644 --- a/packages/google-cloud-appengine-admin/tests/unit/gapic/appengine_admin_v1/test_services.py +++ b/packages/google-cloud-appengine-admin/tests/unit/gapic/appengine_admin_v1/test_services.py @@ -41,7 +41,7 @@ import google.auth from google.auth import credentials as ga_credentials from google.auth.exceptions import MutualTLSChannelError -from google.longrunning import operations_pb2 +from google.longrunning import operations_pb2 # type: ignore from google.oauth2 import service_account from google.protobuf import empty_pb2 # type: ignore from google.protobuf import field_mask_pb2 # type: ignore diff --git a/packages/google-cloud-appengine-admin/tests/unit/gapic/appengine_admin_v1/test_versions.py b/packages/google-cloud-appengine-admin/tests/unit/gapic/appengine_admin_v1/test_versions.py index 5045b3054c6c..09437e03e737 100644 --- a/packages/google-cloud-appengine-admin/tests/unit/gapic/appengine_admin_v1/test_versions.py +++ b/packages/google-cloud-appengine-admin/tests/unit/gapic/appengine_admin_v1/test_versions.py @@ -41,7 +41,7 @@ import google.auth from google.auth import credentials as ga_credentials from google.auth.exceptions import MutualTLSChannelError -from google.longrunning import operations_pb2 +from google.longrunning import operations_pb2 # type: ignore from google.oauth2 import service_account from google.protobuf import duration_pb2 # type: ignore from google.protobuf import empty_pb2 # type: ignore