Skip to content

Commit

Permalink
feat: [google-cloud-functions] updated description for `docker_regist…
Browse files Browse the repository at this point in the history
…ry` 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>
  • Loading branch information
gcf-owl-bot[bot] and gcf-owl-bot[bot] committed Jan 24, 2024
1 parent 7d78274 commit 82e676d
Show file tree
Hide file tree
Showing 14 changed files with 202 additions and 136 deletions.
Expand Up @@ -13,4 +13,4 @@
# See the License for the specific language governing permissions and
# limitations under the License.
#
__version__ = "1.14.0" # {x-release-please-version}
__version__ = "0.0.0" # {x-release-please-version}
Expand Up @@ -13,4 +13,4 @@
# See the License for the specific language governing permissions and
# limitations under the License.
#
__version__ = "1.14.0" # {x-release-please-version}
__version__ = "0.0.0" # {x-release-please-version}
Expand Up @@ -398,7 +398,7 @@ async def sample_get_function():
google.cloud.functions_v1.types.CloudFunction:
Describes a Cloud Function that
contains user computation executed in
response to an event. It encapsulates
response to an event. It encapsulate
function and triggers configurations.
"""
Expand Down Expand Up @@ -466,7 +466,7 @@ async def create_function(
) -> operation_async.AsyncOperation:
r"""Creates a new function. If a function with the given name
already exists in the specified project, the long running
operation returns an ``ALREADY_EXISTS`` error.
operation will return ``ALREADY_EXISTS`` error.
.. code-block:: python
Expand Down Expand Up @@ -529,7 +529,7 @@ async def sample_create_function():
An object representing a long-running operation.
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
response to an event. It encapsulates function and
response to an event. It encapsulate function and
triggers configurations.
"""
Expand Down Expand Up @@ -650,7 +650,7 @@ async def sample_update_function():
An object representing a long-running operation.
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
response to an event. It encapsulates function and
response to an event. It encapsulate function and
triggers configurations.
"""
Expand Down Expand Up @@ -727,7 +727,8 @@ async def delete_function(
) -> operation_async.AsyncOperation:
r"""Deletes a function with the given name from the
specified project. If the given function is used by some
trigger, the trigger is updated to remove this function.
trigger, the trigger will be updated to remove this
function.
.. code-block:: python
Expand Down Expand Up @@ -991,13 +992,13 @@ async def generate_upload_url(
credentials would be used, but that identity does not have
permissions to upload files to the URL.
When making an HTTP PUT request, these two headers must be
When making a HTTP PUT request, these two headers need to be
specified:
- ``content-type: application/zip``
- ``x-goog-content-length-range: 0,104857600``
And this header must NOT be specified:
And this header SHOULD NOT be specified:
- ``Authorization: Bearer YOUR_TOKEN``
Expand Down Expand Up @@ -1077,9 +1078,9 @@ async def generate_download_url(
) -> functions.GenerateDownloadUrlResponse:
r"""Returns a signed URL for downloading deployed
function source code. The URL is only valid for a
limited period and must be used within minutes after
limited period and should be used within minutes after
generation.
For more information about the signed URL usage, see:
For more information about the signed URL usage see:
https://cloud.google.com/storage/docs/access-control/signed-urls
Expand Down Expand Up @@ -1383,8 +1384,8 @@ async def test_iam_permissions(
metadata: Sequence[Tuple[str, str]] = (),
) -> iam_policy_pb2.TestIamPermissionsResponse:
r"""Tests the specified permissions against the IAM access control
policy for a function. If the function does not exist, this
returns an empty set of permissions, not a NOT_FOUND error.
policy for a function. If the function does not exist, this will
return an empty set of permissions, not a NOT_FOUND error.
.. code-block:: python
Expand Down
Expand Up @@ -653,7 +653,7 @@ def sample_get_function():
google.cloud.functions_v1.types.CloudFunction:
Describes a Cloud Function that
contains user computation executed in
response to an event. It encapsulates
response to an event. It encapsulate
function and triggers configurations.
"""
Expand Down Expand Up @@ -711,7 +711,7 @@ def create_function(
) -> operation.Operation:
r"""Creates a new function. If a function with the given name
already exists in the specified project, the long running
operation returns an ``ALREADY_EXISTS`` error.
operation will return ``ALREADY_EXISTS`` error.
.. code-block:: python
Expand Down Expand Up @@ -774,7 +774,7 @@ def sample_create_function():
An object representing a long-running operation.
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
response to an event. It encapsulates function and
response to an event. It encapsulate function and
triggers configurations.
"""
Expand Down Expand Up @@ -895,7 +895,7 @@ def sample_update_function():
An object representing a long-running operation.
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
response to an event. It encapsulates function and
response to an event. It encapsulate function and
triggers configurations.
"""
Expand Down Expand Up @@ -962,7 +962,8 @@ def delete_function(
) -> operation.Operation:
r"""Deletes a function with the given name from the
specified project. If the given function is used by some
trigger, the trigger is updated to remove this function.
trigger, the trigger will be updated to remove this
function.
.. code-block:: python
Expand Down Expand Up @@ -1216,13 +1217,13 @@ def generate_upload_url(
credentials would be used, but that identity does not have
permissions to upload files to the URL.
When making an HTTP PUT request, these two headers must be
When making a HTTP PUT request, these two headers need to be
specified:
- ``content-type: application/zip``
- ``x-goog-content-length-range: 0,104857600``
And this header must NOT be specified:
And this header SHOULD NOT be specified:
- ``Authorization: Bearer YOUR_TOKEN``
Expand Down Expand Up @@ -1303,9 +1304,9 @@ def generate_download_url(
) -> functions.GenerateDownloadUrlResponse:
r"""Returns a signed URL for downloading deployed
function source code. The URL is only valid for a
limited period and must be used within minutes after
limited period and should be used within minutes after
generation.
For more information about the signed URL usage, see:
For more information about the signed URL usage see:
https://cloud.google.com/storage/docs/access-control/signed-urls
Expand Down Expand Up @@ -1608,8 +1609,8 @@ def test_iam_permissions(
metadata: Sequence[Tuple[str, str]] = (),
) -> iam_policy_pb2.TestIamPermissionsResponse:
r"""Tests the specified permissions against the IAM access control
policy for a function. If the function does not exist, this
returns an empty set of permissions, not a NOT_FOUND error.
policy for a function. If the function does not exist, this will
return an empty set of permissions, not a NOT_FOUND error.
.. code-block:: python
Expand Down
Expand Up @@ -310,7 +310,7 @@ def create_function(
Creates a new function. If a function with the given name
already exists in the specified project, the long running
operation returns an ``ALREADY_EXISTS`` error.
operation will return ``ALREADY_EXISTS`` error.
Returns:
Callable[[~.CreateFunctionRequest],
Expand Down Expand Up @@ -364,7 +364,8 @@ def delete_function(
Deletes a function with the given name from the
specified project. If the given function is used by some
trigger, the trigger is updated to remove this function.
trigger, the trigger will be updated to remove this
function.
Returns:
Callable[[~.DeleteFunctionRequest],
Expand Down Expand Up @@ -440,13 +441,13 @@ def generate_upload_url(
credentials would be used, but that identity does not have
permissions to upload files to the URL.
When making an HTTP PUT request, these two headers must be
When making a HTTP PUT request, these two headers need to be
specified:
- ``content-type: application/zip``
- ``x-goog-content-length-range: 0,104857600``
And this header must NOT be specified:
And this header SHOULD NOT be specified:
- ``Authorization: Bearer YOUR_TOKEN``
Expand Down Expand Up @@ -478,9 +479,9 @@ def generate_download_url(
Returns a signed URL for downloading deployed
function source code. The URL is only valid for a
limited period and must be used within minutes after
limited period and should be used within minutes after
generation.
For more information about the signed URL usage, see:
For more information about the signed URL usage see:
https://cloud.google.com/storage/docs/access-control/signed-urls
Expand Down Expand Up @@ -567,8 +568,8 @@ def test_iam_permissions(
r"""Return a callable for the test iam permissions method over gRPC.
Tests the specified permissions against the IAM access control
policy for a function. If the function does not exist, this
returns an empty set of permissions, not a NOT_FOUND error.
policy for a function. If the function does not exist, this will
return an empty set of permissions, not a NOT_FOUND error.
Returns:
Callable[[~.TestIamPermissionsRequest],
Expand Down
Expand Up @@ -319,7 +319,7 @@ def create_function(
Creates a new function. If a function with the given name
already exists in the specified project, the long running
operation returns an ``ALREADY_EXISTS`` error.
operation will return ``ALREADY_EXISTS`` error.
Returns:
Callable[[~.CreateFunctionRequest],
Expand Down Expand Up @@ -377,7 +377,8 @@ def delete_function(
Deletes a function with the given name from the
specified project. If the given function is used by some
trigger, the trigger is updated to remove this function.
trigger, the trigger will be updated to remove this
function.
Returns:
Callable[[~.DeleteFunctionRequest],
Expand Down Expand Up @@ -456,13 +457,13 @@ def generate_upload_url(
credentials would be used, but that identity does not have
permissions to upload files to the URL.
When making an HTTP PUT request, these two headers must be
When making a HTTP PUT request, these two headers need to be
specified:
- ``content-type: application/zip``
- ``x-goog-content-length-range: 0,104857600``
And this header must NOT be specified:
And this header SHOULD NOT be specified:
- ``Authorization: Bearer YOUR_TOKEN``
Expand Down Expand Up @@ -495,9 +496,9 @@ def generate_download_url(
Returns a signed URL for downloading deployed
function source code. The URL is only valid for a
limited period and must be used within minutes after
limited period and should be used within minutes after
generation.
For more information about the signed URL usage, see:
For more information about the signed URL usage see:
https://cloud.google.com/storage/docs/access-control/signed-urls
Expand Down Expand Up @@ -584,8 +585,8 @@ def test_iam_permissions(
r"""Return a callable for the test iam permissions method over gRPC.
Tests the specified permissions against the IAM access control
policy for a function. If the function does not exist, this
returns an empty set of permissions, not a NOT_FOUND error.
policy for a function. If the function does not exist, this will
return an empty set of permissions, not a NOT_FOUND error.
Returns:
Callable[[~.TestIamPermissionsRequest],
Expand Down
Expand Up @@ -1112,7 +1112,7 @@ def __call__(
~.functions.CloudFunction:
Describes a Cloud Function that
contains user computation executed in
response to an event. It encapsulates
response to an event. It encapsulate
function and triggers configurations.
"""
Expand Down

0 comments on commit 82e676d

Please sign in to comment.