Skip to content

Commit bc9fdfe

Browse files
docs: [google-cloud-functions] updated docker_registry proto to reflect its deprecated status (#13736)
- [ ] Regenerate this pull request now. BEGIN_COMMIT_OVERRIDE docs: updated docker_registry proto to reflect its deprecated status #13736 docs: updated `docker_registry` proto to reflect its deprecated status docs: small fixes END_COMMIT_OVERRIDE PiperOrigin-RevId: 744033945 Source-Link: googleapis/googleapis@c98457c Source-Link: googleapis/googleapis-gen@3db2446 Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWZ1bmN0aW9ucy8uT3dsQm90LnlhbWwiLCJoIjoiM2RiMjQ0NmM3YjUwMzU0ZTUyYWI1YTYxN2U4NzU1NWRkYjk3OTgxYiJ9 BEGIN_NESTED_COMMIT docs: [google-cloud-functions] updated `docker_registry` proto to reflect its deprecated status docs: small fixes PiperOrigin-RevId: 743742601 Source-Link: googleapis/googleapis@a31d216 Source-Link: googleapis/googleapis-gen@c4ef236 Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWZ1bmN0aW9ucy8uT3dsQm90LnlhbWwiLCJoIjoiYzRlZjIzNmYxY2M0YzI1NjIwMjQ2MWMwMDFhMjBmNDZjMmI3MWFhOCJ9 END_NESTED_COMMIT --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
1 parent c970f9f commit bc9fdfe

File tree

2 files changed

+35
-27
lines changed

2 files changed

+35
-27
lines changed

packages/google-cloud-functions/google/cloud/functions_v1/types/functions.py

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -283,7 +283,12 @@ class CloudFunction(proto.Message):
283283
repositories are not supported. Repository format must be
284284
'DOCKER'.
285285
docker_registry (google.cloud.functions_v1.types.CloudFunction.DockerRegistry):
286-
Docker Registry to use for this deployment.
286+
Docker Registry to use for this deployment. As of March
287+
2025, ``CONTAINER_REGISTRY`` option is no longer available
288+
in response to Container Registry's deprecation:
289+
https://cloud.google.com/artifact-registry/docs/transition/transition-from-gcr
290+
Please use Artifact Registry instead, which is the default
291+
choice.
287292
288293
If unspecified, it defaults to ``ARTIFACT_REGISTRY``. If
289294
``docker_repository`` field is specified, this field should
@@ -757,12 +762,12 @@ class SecretEnvVar(proto.Message):
757762
key (str):
758763
Name of the environment variable.
759764
project_id (str):
760-
Project identifier (preferrably project
761-
number but can also be the project ID) of the
762-
project that contains the secret. If not set, it
763-
will be populated with the function's project
764-
assuming that the secret exists in the same
765-
project as of the function.
765+
Project identifier (preferably project number
766+
but can also be the project ID) of the project
767+
that contains the secret. If not set, it will be
768+
populated with the function's project assuming
769+
that the secret exists in the same project as of
770+
the function.
766771
secret (str):
767772
Name of the secret in secret manager (not the
768773
full resource name).

packages/google-cloud-functions/google/cloud/functions_v2/types/functions.py

Lines changed: 23 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -136,8 +136,8 @@ class Function(proto.Message):
136136
Output only. The deployed url for the
137137
function.
138138
kms_key_name (str):
139-
[Preview] Resource name of a KMS crypto key (managed by the
140-
user) used to encrypt/decrypt function resources.
139+
Resource name of a KMS crypto key (managed by the user) used
140+
to encrypt/decrypt function resources.
141141
142142
It must match the pattern
143143
``projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}``.
@@ -557,7 +557,12 @@ class BuildConfig(proto.Message):
557557
docker_registry (google.cloud.functions_v2.types.BuildConfig.DockerRegistry):
558558
Docker Registry to use for this deployment. This
559559
configuration is only applicable to 1st Gen functions, 2nd
560-
Gen functions can only use Artifact Registry.
560+
Gen functions can only use Artifact Registry. Deprecated: As
561+
of March 2025, ``CONTAINER_REGISTRY`` option is no longer
562+
available in response to Container Registry's deprecation:
563+
https://cloud.google.com/artifact-registry/docs/transition/transition-from-gcr
564+
Please use Artifact Registry instead, which is the default
565+
choice.
561566
562567
If unspecified, it defaults to ``ARTIFACT_REGISTRY``. If
563568
``docker_repository`` field is specified, this field should
@@ -572,10 +577,7 @@ class BuildConfig(proto.Message):
572577
573578
It must match the pattern
574579
``projects/{project}/locations/{location}/repositories/{repository}``.
575-
576-
Cross-project repositories are not supported. Cross-location
577-
repositories are not supported. Repository format must be
578-
'DOCKER'.
580+
Repository format must be 'DOCKER'.
579581
service_account (str):
580582
Service account to be used for building the container. The
581583
format of this field is
@@ -1191,14 +1193,15 @@ class GetFunctionRequest(proto.Message):
11911193
Required. The name of the function which
11921194
details should be obtained.
11931195
revision (str):
1194-
Optional. The version of the 1st gen function
1195-
whose details should be obtained. The version of
1196-
a 1st gen function is an integer that starts
1197-
from 1 and gets incremented on redeployments.
1198-
GCF may keep historical configs for old versions
1199-
of 1st gen function. This field can be specified
1200-
to fetch the historical configs. This field is
1201-
valid only for GCF 1st gen function.
1196+
Optional. The optional version of the 1st gen
1197+
function whose details should be obtained. The
1198+
version of a 1st gen function is an integer that
1199+
starts from 1 and gets incremented on
1200+
redeployments. GCF may keep historical configs
1201+
for old versions of 1st gen function. This field
1202+
can be specified to fetch the historical
1203+
configs. This field is valid only for GCF 1st
1204+
gen function.
12021205
"""
12031206

12041207
name: str = proto.Field(
@@ -1242,7 +1245,7 @@ class ListFunctionsRequest(proto.Message):
12421245
order_by (str):
12431246
The sorting order of the resources returned.
12441247
Value should be a comma separated list of
1245-
fields. The default sorting oder is ascending.
1248+
fields. The default sorting order is ascending.
12461249
See https://google.aip.dev/132#ordering.
12471250
"""
12481251

@@ -1384,9 +1387,9 @@ class GenerateUploadUrlRequest(proto.Message):
13841387
Storage signed URL should be generated, specified in the
13851388
format ``projects/*/locations/*``.
13861389
kms_key_name (str):
1387-
[Preview] Resource name of a KMS crypto key (managed by the
1388-
user) used to encrypt/decrypt function source code objects
1389-
in intermediate Cloud Storage buckets. When you generate an
1390+
Resource name of a KMS crypto key (managed by the user) used
1391+
to encrypt/decrypt function source code objects in
1392+
intermediate Cloud Storage buckets. When you generate an
13901393
upload url and upload your source code, it gets copied to an
13911394
intermediate Cloud Storage bucket. The source code is then
13921395
copied to a versioned directory in the sources bucket in the
@@ -1776,7 +1779,7 @@ class Name(proto.Enum):
17761779
NAME_UNSPECIFIED (0):
17771780
Not specified. Invalid name.
17781781
ARTIFACT_REGISTRY (1):
1779-
Artifact Regsitry Stage
1782+
Artifact Registry Stage
17801783
BUILD (2):
17811784
Build Stage
17821785
SERVICE (3):

0 commit comments

Comments
 (0)