Skip to content

docs: [google-cloud-functions] updated docker_registry proto to reflect its deprecated status #13736

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
parthea merged 4 commits into from
Apr 12, 2025
Merged

docs: [google-cloud-functions] updated docker_registry proto to reflect its deprecated status #13736

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3be5566
docs: updated `docker_registry` proto to reflect its deprecated status
gcf-owl-bot[bot] Apr 4, 2025
0d8e212
🦉 Updates from OwlBot post-processor
gcf-owl-bot[bot] Apr 4, 2025
8f29438
docs: updated `docker_registry` proto to reflect its deprecated status
gcf-owl-bot[bot] Apr 4, 2025
9793e7b
🦉 Updates from OwlBot post-processor
gcf-owl-bot[bot] Apr 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 12 additions & 7 deletions packages/google-cloud-functions/google/cloud/functions_v1/types/functions.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -283,7 +283,12 @@ class CloudFunction(proto.Message):
repositories are not supported. Repository format must be
'DOCKER'.
docker_registry (google.cloud.functions_v1.types.CloudFunction.DockerRegistry):
Docker Registry to use for this deployment.
Docker Registry to use for this deployment. As of March
2025, ``CONTAINER_REGISTRY`` option is no longer available
in response to Container Registry's deprecation:
https://cloud.google.com/artifact-registry/docs/transition/transition-from-gcr
Please use Artifact Registry instead, which is the default
choice.

If unspecified, it defaults to ``ARTIFACT_REGISTRY``. If
``docker_repository`` field is specified, this field should
Expand Down Expand Up @@ -757,12 +762,12 @@ class SecretEnvVar(proto.Message):
key (str):
Name of the environment variable.
project_id (str):
Project identifier (preferrably project
number but can also be the project ID) of the
project that contains the secret. If not set, it
will be populated with the function's project
assuming that the secret exists in the same
project as of the function.
Project identifier (preferably project number
but can also be the project ID) of the project
that contains the secret. If not set, it will be
populated with the function's project assuming
that the secret exists in the same project as of
the function.
secret (str):
Name of the secret in secret manager (not the
full resource name).
Expand Down
43 changes: 23 additions & 20 deletions packages/google-cloud-functions/google/cloud/functions_v2/types/functions.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,8 +136,8 @@ class Function(proto.Message):
Output only. The deployed url for the
function.
kms_key_name (str):
[Preview] Resource name of a KMS crypto key (managed by the
user) used to encrypt/decrypt function resources.
Resource name of a KMS crypto key (managed by the user) used
to encrypt/decrypt function resources.

It must match the pattern
``projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}``.
Expand Down Expand Up @@ -557,7 +557,12 @@ class BuildConfig(proto.Message):
docker_registry (google.cloud.functions_v2.types.BuildConfig.DockerRegistry):
Docker Registry to use for this deployment. This
configuration is only applicable to 1st Gen functions, 2nd
Gen functions can only use Artifact Registry.
Gen functions can only use Artifact Registry. Deprecated: As
of March 2025, ``CONTAINER_REGISTRY`` option is no longer
available in response to Container Registry's deprecation:
https://cloud.google.com/artifact-registry/docs/transition/transition-from-gcr
Please use Artifact Registry instead, which is the default
choice.

If unspecified, it defaults to ``ARTIFACT_REGISTRY``. If
``docker_repository`` field is specified, this field should
Expand All @@ -572,10 +577,7 @@ class BuildConfig(proto.Message):

It must match the pattern
``projects/{project}/locations/{location}/repositories/{repository}``.

Cross-project repositories are not supported. Cross-location
repositories are not supported. Repository format must be
'DOCKER'.
Repository format must be 'DOCKER'.
service_account (str):
Service account to be used for building the container. The
format of this field is
Expand Down Expand Up @@ -1191,14 +1193,15 @@ class GetFunctionRequest(proto.Message):
Required. The name of the function which
details should be obtained.
revision (str):
Optional. The version of the 1st gen function
whose details should be obtained. The version of
a 1st gen function is an integer that starts
from 1 and gets incremented on redeployments.
GCF may keep historical configs for old versions
of 1st gen function. This field can be specified
to fetch the historical configs. This field is
valid only for GCF 1st gen function.
Optional. The optional version of the 1st gen
function whose details should be obtained. The
version of a 1st gen function is an integer that
starts from 1 and gets incremented on
redeployments. GCF may keep historical configs
for old versions of 1st gen function. This field
can be specified to fetch the historical
configs. This field is valid only for GCF 1st
gen function.
"""

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

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