Skip to content

Commit 82e676d

Browse files
feat: [google-cloud-functions] updated description for docker_registry to reflect transition to Artifact Registry (#12220)
- [ ] Regenerate this pull request now. BEGIN_COMMIT_OVERRIDE feat: Add fields for automatic runtime updates feat: Add optional parameter `version_id` to `GetFunctionRequest` docs: Deprecate `network` field of `CloudFunction` docs: Minor updates in comments throughout docs: Update description for docker_registry to reflect transition to Artifact Registry END_COMMIT_OVERRIDE PiperOrigin-RevId: 600866189 Source-Link: googleapis/googleapis@78d3b67 Source-Link: googleapis/googleapis-gen@1947dd8 Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWZ1bmN0aW9ucy8uT3dsQm90LnlhbWwiLCJoIjoiMTk0N2RkODcwMGZkMDk5ZDVlMWU2ZDJmZWM1NDMwOWY5NjNjZmIzZiJ9 --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
1 parent 7d78274 commit 82e676d

File tree

14 files changed

+202
-136
lines changed

14 files changed

+202
-136
lines changed

packages/google-cloud-functions/google/cloud/functions/gapic_version.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,4 @@
1313
# See the License for the specific language governing permissions and
1414
# limitations under the License.
1515
#
16-
__version__ = "1.14.0" # {x-release-please-version}
16+
__version__ = "0.0.0" # {x-release-please-version}

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,4 @@
1313
# See the License for the specific language governing permissions and
1414
# limitations under the License.
1515
#
16-
__version__ = "1.14.0" # {x-release-please-version}
16+
__version__ = "0.0.0" # {x-release-please-version}

packages/google-cloud-functions/google/cloud/functions_v1/services/cloud_functions_service/async_client.py

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -398,7 +398,7 @@ async def sample_get_function():
398398
google.cloud.functions_v1.types.CloudFunction:
399399
Describes a Cloud Function that
400400
contains user computation executed in
401-
response to an event. It encapsulates
401+
response to an event. It encapsulate
402402
function and triggers configurations.
403403
404404
"""
@@ -466,7 +466,7 @@ async def create_function(
466466
) -> operation_async.AsyncOperation:
467467
r"""Creates a new function. If a function with the given name
468468
already exists in the specified project, the long running
469-
operation returns an ``ALREADY_EXISTS`` error.
469+
operation will return ``ALREADY_EXISTS`` error.
470470
471471
.. code-block:: python
472472
@@ -529,7 +529,7 @@ async def sample_create_function():
529529
An object representing a long-running operation.
530530
531531
The result type for the operation will be :class:`google.cloud.functions_v1.types.CloudFunction` Describes a Cloud Function that contains user computation executed in
532-
response to an event. It encapsulates function and
532+
response to an event. It encapsulate function and
533533
triggers configurations.
534534
535535
"""
@@ -650,7 +650,7 @@ async def sample_update_function():
650650
An object representing a long-running operation.
651651
652652
The result type for the operation will be :class:`google.cloud.functions_v1.types.CloudFunction` Describes a Cloud Function that contains user computation executed in
653-
response to an event. It encapsulates function and
653+
response to an event. It encapsulate function and
654654
triggers configurations.
655655
656656
"""
@@ -727,7 +727,8 @@ async def delete_function(
727727
) -> operation_async.AsyncOperation:
728728
r"""Deletes a function with the given name from the
729729
specified project. If the given function is used by some
730-
trigger, the trigger is updated to remove this function.
730+
trigger, the trigger will be updated to remove this
731+
function.
731732
732733
.. code-block:: python
733734
@@ -991,13 +992,13 @@ async def generate_upload_url(
991992
credentials would be used, but that identity does not have
992993
permissions to upload files to the URL.
993994
994-
When making an HTTP PUT request, these two headers must be
995+
When making a HTTP PUT request, these two headers need to be
995996
specified:
996997
997998
- ``content-type: application/zip``
998999
- ``x-goog-content-length-range: 0,104857600``
9991000
1000-
And this header must NOT be specified:
1001+
And this header SHOULD NOT be specified:
10011002
10021003
- ``Authorization: Bearer YOUR_TOKEN``
10031004
@@ -1077,9 +1078,9 @@ async def generate_download_url(
10771078
) -> functions.GenerateDownloadUrlResponse:
10781079
r"""Returns a signed URL for downloading deployed
10791080
function source code. The URL is only valid for a
1080-
limited period and must be used within minutes after
1081+
limited period and should be used within minutes after
10811082
generation.
1082-
For more information about the signed URL usage, see:
1083+
For more information about the signed URL usage see:
10831084
10841085
https://cloud.google.com/storage/docs/access-control/signed-urls
10851086
@@ -1383,8 +1384,8 @@ async def test_iam_permissions(
13831384
metadata: Sequence[Tuple[str, str]] = (),
13841385
) -> iam_policy_pb2.TestIamPermissionsResponse:
13851386
r"""Tests the specified permissions against the IAM access control
1386-
policy for a function. If the function does not exist, this
1387-
returns an empty set of permissions, not a NOT_FOUND error.
1387+
policy for a function. If the function does not exist, this will
1388+
return an empty set of permissions, not a NOT_FOUND error.
13881389
13891390
.. code-block:: python
13901391

packages/google-cloud-functions/google/cloud/functions_v1/services/cloud_functions_service/client.py

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -653,7 +653,7 @@ def sample_get_function():
653653
google.cloud.functions_v1.types.CloudFunction:
654654
Describes a Cloud Function that
655655
contains user computation executed in
656-
response to an event. It encapsulates
656+
response to an event. It encapsulate
657657
function and triggers configurations.
658658
659659
"""
@@ -711,7 +711,7 @@ def create_function(
711711
) -> operation.Operation:
712712
r"""Creates a new function. If a function with the given name
713713
already exists in the specified project, the long running
714-
operation returns an ``ALREADY_EXISTS`` error.
714+
operation will return ``ALREADY_EXISTS`` error.
715715
716716
.. code-block:: python
717717
@@ -774,7 +774,7 @@ def sample_create_function():
774774
An object representing a long-running operation.
775775
776776
The result type for the operation will be :class:`google.cloud.functions_v1.types.CloudFunction` Describes a Cloud Function that contains user computation executed in
777-
response to an event. It encapsulates function and
777+
response to an event. It encapsulate function and
778778
triggers configurations.
779779
780780
"""
@@ -895,7 +895,7 @@ def sample_update_function():
895895
An object representing a long-running operation.
896896
897897
The result type for the operation will be :class:`google.cloud.functions_v1.types.CloudFunction` Describes a Cloud Function that contains user computation executed in
898-
response to an event. It encapsulates function and
898+
response to an event. It encapsulate function and
899899
triggers configurations.
900900
901901
"""
@@ -962,7 +962,8 @@ def delete_function(
962962
) -> operation.Operation:
963963
r"""Deletes a function with the given name from the
964964
specified project. If the given function is used by some
965-
trigger, the trigger is updated to remove this function.
965+
trigger, the trigger will be updated to remove this
966+
function.
966967
967968
.. code-block:: python
968969
@@ -1216,13 +1217,13 @@ def generate_upload_url(
12161217
credentials would be used, but that identity does not have
12171218
permissions to upload files to the URL.
12181219
1219-
When making an HTTP PUT request, these two headers must be
1220+
When making a HTTP PUT request, these two headers need to be
12201221
specified:
12211222
12221223
- ``content-type: application/zip``
12231224
- ``x-goog-content-length-range: 0,104857600``
12241225
1225-
And this header must NOT be specified:
1226+
And this header SHOULD NOT be specified:
12261227
12271228
- ``Authorization: Bearer YOUR_TOKEN``
12281229
@@ -1303,9 +1304,9 @@ def generate_download_url(
13031304
) -> functions.GenerateDownloadUrlResponse:
13041305
r"""Returns a signed URL for downloading deployed
13051306
function source code. The URL is only valid for a
1306-
limited period and must be used within minutes after
1307+
limited period and should be used within minutes after
13071308
generation.
1308-
For more information about the signed URL usage, see:
1309+
For more information about the signed URL usage see:
13091310
13101311
https://cloud.google.com/storage/docs/access-control/signed-urls
13111312
@@ -1608,8 +1609,8 @@ def test_iam_permissions(
16081609
metadata: Sequence[Tuple[str, str]] = (),
16091610
) -> iam_policy_pb2.TestIamPermissionsResponse:
16101611
r"""Tests the specified permissions against the IAM access control
1611-
policy for a function. If the function does not exist, this
1612-
returns an empty set of permissions, not a NOT_FOUND error.
1612+
policy for a function. If the function does not exist, this will
1613+
return an empty set of permissions, not a NOT_FOUND error.
16131614
16141615
.. code-block:: python
16151616

packages/google-cloud-functions/google/cloud/functions_v1/services/cloud_functions_service/transports/grpc.py

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -310,7 +310,7 @@ def create_function(
310310
311311
Creates a new function. If a function with the given name
312312
already exists in the specified project, the long running
313-
operation returns an ``ALREADY_EXISTS`` error.
313+
operation will return ``ALREADY_EXISTS`` error.
314314
315315
Returns:
316316
Callable[[~.CreateFunctionRequest],
@@ -364,7 +364,8 @@ def delete_function(
364364
365365
Deletes a function with the given name from the
366366
specified project. If the given function is used by some
367-
trigger, the trigger is updated to remove this function.
367+
trigger, the trigger will be updated to remove this
368+
function.
368369
369370
Returns:
370371
Callable[[~.DeleteFunctionRequest],
@@ -440,13 +441,13 @@ def generate_upload_url(
440441
credentials would be used, but that identity does not have
441442
permissions to upload files to the URL.
442443
443-
When making an HTTP PUT request, these two headers must be
444+
When making a HTTP PUT request, these two headers need to be
444445
specified:
445446
446447
- ``content-type: application/zip``
447448
- ``x-goog-content-length-range: 0,104857600``
448449
449-
And this header must NOT be specified:
450+
And this header SHOULD NOT be specified:
450451
451452
- ``Authorization: Bearer YOUR_TOKEN``
452453
@@ -478,9 +479,9 @@ def generate_download_url(
478479
479480
Returns a signed URL for downloading deployed
480481
function source code. The URL is only valid for a
481-
limited period and must be used within minutes after
482+
limited period and should be used within minutes after
482483
generation.
483-
For more information about the signed URL usage, see:
484+
For more information about the signed URL usage see:
484485
485486
https://cloud.google.com/storage/docs/access-control/signed-urls
486487
@@ -567,8 +568,8 @@ def test_iam_permissions(
567568
r"""Return a callable for the test iam permissions method over gRPC.
568569
569570
Tests the specified permissions against the IAM access control
570-
policy for a function. If the function does not exist, this
571-
returns an empty set of permissions, not a NOT_FOUND error.
571+
policy for a function. If the function does not exist, this will
572+
return an empty set of permissions, not a NOT_FOUND error.
572573
573574
Returns:
574575
Callable[[~.TestIamPermissionsRequest],

packages/google-cloud-functions/google/cloud/functions_v1/services/cloud_functions_service/transports/grpc_asyncio.py

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -319,7 +319,7 @@ def create_function(
319319
320320
Creates a new function. If a function with the given name
321321
already exists in the specified project, the long running
322-
operation returns an ``ALREADY_EXISTS`` error.
322+
operation will return ``ALREADY_EXISTS`` error.
323323
324324
Returns:
325325
Callable[[~.CreateFunctionRequest],
@@ -377,7 +377,8 @@ def delete_function(
377377
378378
Deletes a function with the given name from the
379379
specified project. If the given function is used by some
380-
trigger, the trigger is updated to remove this function.
380+
trigger, the trigger will be updated to remove this
381+
function.
381382
382383
Returns:
383384
Callable[[~.DeleteFunctionRequest],
@@ -456,13 +457,13 @@ def generate_upload_url(
456457
credentials would be used, but that identity does not have
457458
permissions to upload files to the URL.
458459
459-
When making an HTTP PUT request, these two headers must be
460+
When making a HTTP PUT request, these two headers need to be
460461
specified:
461462
462463
- ``content-type: application/zip``
463464
- ``x-goog-content-length-range: 0,104857600``
464465
465-
And this header must NOT be specified:
466+
And this header SHOULD NOT be specified:
466467
467468
- ``Authorization: Bearer YOUR_TOKEN``
468469
@@ -495,9 +496,9 @@ def generate_download_url(
495496
496497
Returns a signed URL for downloading deployed
497498
function source code. The URL is only valid for a
498-
limited period and must be used within minutes after
499+
limited period and should be used within minutes after
499500
generation.
500-
For more information about the signed URL usage, see:
501+
For more information about the signed URL usage see:
501502
502503
https://cloud.google.com/storage/docs/access-control/signed-urls
503504
@@ -584,8 +585,8 @@ def test_iam_permissions(
584585
r"""Return a callable for the test iam permissions method over gRPC.
585586
586587
Tests the specified permissions against the IAM access control
587-
policy for a function. If the function does not exist, this
588-
returns an empty set of permissions, not a NOT_FOUND error.
588+
policy for a function. If the function does not exist, this will
589+
return an empty set of permissions, not a NOT_FOUND error.
589590
590591
Returns:
591592
Callable[[~.TestIamPermissionsRequest],

packages/google-cloud-functions/google/cloud/functions_v1/services/cloud_functions_service/transports/rest.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1112,7 +1112,7 @@ def __call__(
11121112
~.functions.CloudFunction:
11131113
Describes a Cloud Function that
11141114
contains user computation executed in
1115-
response to an event. It encapsulates
1115+
response to an event. It encapsulate
11161116
function and triggers configurations.
11171117
11181118
"""

0 commit comments

Comments
 (0)