Skip to content

Commit

Permalink
docs: Minor formatting (#11634)
Browse files Browse the repository at this point in the history
- [ ] 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: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLXJlY2FwdGNoYS1lbnRlcnByaXNlLy5Pd2xCb3QueWFtbCIsImgiOiIyODAyNjRjYTAyZmI5MzE2YjQyMzdhOTZkMGFmMWEyMzQzYTgxYTU2In0=
Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLXJlY29tbWVuZGF0aW9ucy1haS8uT3dsQm90LnlhbWwiLCJoIjoiMjgwMjY0Y2EwMmZiOTMxNmI0MjM3YTk2ZDBhZjFhMjM0M2E4MWE1NiJ9
Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLXJlY29tbWVuZGVyLy5Pd2xCb3QueWFtbCIsImgiOiIyODAyNjRjYTAyZmI5MzE2YjQyMzdhOTZkMGFmMWEyMzQzYTgxYTU2In0=
Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLXJlZGlzLy5Pd2xCb3QueWFtbCIsImgiOiIyODAyNjRjYTAyZmI5MzE2YjQyMzdhOTZkMGFmMWEyMzQzYTgxYTU2In0=
Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLXJlc291cmNlLW1hbmFnZXIvLk93bEJvdC55YW1sIiwiaCI6IjI4MDI2NGNhMDJmYjkzMTZiNDIzN2E5NmQwYWYxYTIzNDNhODFhNTYifQ==
Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLXJlc291cmNlLXNldHRpbmdzLy5Pd2xCb3QueWFtbCIsImgiOiIyODAyNjRjYTAyZmI5MzE2YjQyMzdhOTZkMGFmMWEyMzQzYTgxYTU2In0=
Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLXNlY3JldC1tYW5hZ2VyLy5Pd2xCb3QueWFtbCIsImgiOiIyODAyNjRjYTAyZmI5MzE2YjQyMzdhOTZkMGFmMWEyMzQzYTgxYTU2In0=
Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLXNlY3VyaXR5Y2VudGVyLy5Pd2xCb3QueWFtbCIsImgiOiIyODAyNjRjYTAyZmI5MzE2YjQyMzdhOTZkMGFmMWEyMzQzYTgxYTU2In0=
Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLXNlcnZpY2UtY29udHJvbC8uT3dsQm90LnlhbWwiLCJoIjoiMjgwMjY0Y2EwMmZiOTMxNmI0MjM3YTk2ZDBhZjFhMjM0M2E4MWE1NiJ9
Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLXNlcnZpY2UtZGlyZWN0b3J5Ly5Pd2xCb3QueWFtbCIsImgiOiIyODAyNjRjYTAyZmI5MzE2YjQyMzdhOTZkMGFmMWEyMzQzYTgxYTU2In0=
Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLXNlcnZpY2UtdXNhZ2UvLk93bEJvdC55YW1sIiwiaCI6IjI4MDI2NGNhMDJmYjkzMTZiNDIzN2E5NmQwYWYxYTIzNDNhODFhNTYifQ==
Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLXNoZWxsLy5Pd2xCb3QueWFtbCIsImgiOiIyODAyNjRjYTAyZmI5MzE2YjQyMzdhOTZkMGFmMWEyMzQzYTgxYTU2In0=
Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLXNvdXJjZS1jb250ZXh0Ly5Pd2xCb3QueWFtbCIsImgiOiIyODAyNjRjYTAyZmI5MzE2YjQyMzdhOTZkMGFmMWEyMzQzYTgxYTU2In0=
Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLXN0b3JhZ2VpbnNpZ2h0cy8uT3dsQm90LnlhbWwiLCJoIjoiMjgwMjY0Y2EwMmZiOTMxNmI0MjM3YTk2ZDBhZjFhMjM0M2E4MWE1NiJ9
Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLXN1cHBvcnQvLk93bEJvdC55YW1sIiwiaCI6IjI4MDI2NGNhMDJmYjkzMTZiNDIzN2E5NmQwYWYxYTIzNDNhODFhNTYifQ==
Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLXRhbGVudC8uT3dsQm90LnlhbWwiLCJoIjoiMjgwMjY0Y2EwMmZiOTMxNmI0MjM3YTk2ZDBhZjFhMjM0M2E4MWE1NiJ9
Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLXRwdS8uT3dsQm90LnlhbWwiLCJoIjoiMjgwMjY0Y2EwMmZiOTMxNmI0MjM3YTk2ZDBhZjFhMjM0M2E4MWE1NiJ9
Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLXZtLW1pZ3JhdGlvbi8uT3dsQm90LnlhbWwiLCJoIjoiMjgwMjY0Y2EwMmZiOTMxNmI0MjM3YTk2ZDBhZjFhMjM0M2E4MWE1NiJ9
Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLXZtd2FyZWVuZ2luZS8uT3dsQm90LnlhbWwiLCJoIjoiMjgwMjY0Y2EwMmZiOTMxNmI0MjM3YTk2ZDBhZjFhMjM0M2E4MWE1NiJ9
Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLXZwYy1hY2Nlc3MvLk93bEJvdC55YW1sIiwiaCI6IjI4MDI2NGNhMDJmYjkzMTZiNDIzN2E5NmQwYWYxYTIzNDNhODFhNTYifQ==
  • Loading branch information
gcf-owl-bot[bot] committed Sep 13, 2023
1 parent 77bf61a commit 025219f
Show file tree
Hide file tree
Showing 329 changed files with 785 additions and 546 deletions.
2 changes: 1 addition & 1 deletion packages/google-cloud-recaptcha-enterprise/.flake8
@@ -1,6 +1,6 @@
# -*- coding: utf-8 -*-
#
# Copyright 2020 Google LLC
# Copyright 2023 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
Expand Down
Expand Up @@ -236,7 +236,7 @@ We support:

Supported versions can be found in our ``noxfile.py`` `config`_.

.. _config: https://github.com/googleapis/google-cloud-python/blob/main/noxfile.py
.. _config: https://github.com/googleapis/google-cloud-python/blob/main/packages/google-cloud-recaptcha-enterprise/noxfile.py


**********
Expand Down
2 changes: 1 addition & 1 deletion packages/google-cloud-recaptcha-enterprise/MANIFEST.in
@@ -1,6 +1,6 @@
# -*- coding: utf-8 -*-
#
# Copyright 2020 Google LLC
# Copyright 2023 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
Expand Down
27 changes: 14 additions & 13 deletions packages/google-cloud-recaptcha-enterprise/README.rst
Expand Up @@ -36,21 +36,24 @@ In order to use this library, you first need to go through the following steps:
Installation
~~~~~~~~~~~~

Install this library in a `virtualenv`_ using pip. `virtualenv`_ is a tool to
create isolated Python environments. The basic problem it addresses is one of
dependencies and versions, and indirectly permissions.
Install this library in a virtual environment using `venv`_. `venv`_ is a tool that
creates isolated Python environments. These isolated environments can have separate
versions of Python packages, which allows you to isolate one project's dependencies
from the dependencies of other projects.

With `virtualenv`_, it's possible to install this library without needing system
With `venv`_, it's possible to install this library without needing system
install permissions, and without clashing with the installed system
dependencies.

.. _`virtualenv`: https://virtualenv.pypa.io/en/latest/
.. _`venv`: https://docs.python.org/3/library/venv.html


Code samples and snippets
~~~~~~~~~~~~~~~~~~~~~~~~~

Code samples and snippets live in the `samples/` folder.
Code samples and snippets live in the `samples/`_ folder.

.. _samples/: https://github.com/googleapis/google-cloud-python/tree/main/packages/google-cloud-recaptcha-enterprise/samples


Supported Python Versions
Expand All @@ -77,21 +80,19 @@ Mac/Linux

.. code-block:: console
pip install virtualenv
virtualenv <your-env>
python3 -m venv <your-env>
source <your-env>/bin/activate
<your-env>/bin/pip install google-cloud-recaptcha-enterprise
pip install google-cloud-recaptcha-enterprise
Windows
^^^^^^^

.. code-block:: console
pip install virtualenv
virtualenv <your-env>
<your-env>\Scripts\activate
<your-env>\Scripts\pip.exe install google-cloud-recaptcha-enterprise
py -m venv <your-env>
.\<your-env>\Scripts\activate
pip install google-cloud-recaptcha-enterprise
Next Steps
~~~~~~~~~~
Expand Down
2 changes: 1 addition & 1 deletion packages/google-cloud-recaptcha-enterprise/docs/conf.py
@@ -1,5 +1,5 @@
# -*- coding: utf-8 -*-
# Copyright 2021 Google LLC
# Copyright 2023 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
Expand Down
2 changes: 1 addition & 1 deletion packages/google-cloud-recaptcha-enterprise/noxfile.py
@@ -1,6 +1,6 @@
# -*- coding: utf-8 -*-
#
# Copyright 2018 Google LLC
# Copyright 2023 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
Expand Down
@@ -1,6 +1,6 @@
#!/bin/bash

# Copyright 2015 Google Inc. All rights reserved.
# Copyright 2023 Google LLC All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
Expand Down
2 changes: 1 addition & 1 deletion packages/google-cloud-recommendations-ai/.flake8
@@ -1,6 +1,6 @@
# -*- coding: utf-8 -*-
#
# Copyright 2020 Google LLC
# Copyright 2023 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
Expand Down
2 changes: 1 addition & 1 deletion packages/google-cloud-recommendations-ai/CONTRIBUTING.rst
Expand Up @@ -236,7 +236,7 @@ We support:

Supported versions can be found in our ``noxfile.py`` `config`_.

.. _config: https://github.com/googleapis/google-cloud-python/blob/main/noxfile.py
.. _config: https://github.com/googleapis/google-cloud-python/blob/main/packages/google-cloud-recommendations-ai/noxfile.py


**********
Expand Down
2 changes: 1 addition & 1 deletion packages/google-cloud-recommendations-ai/MANIFEST.in
@@ -1,6 +1,6 @@
# -*- coding: utf-8 -*-
#
# Copyright 2020 Google LLC
# Copyright 2023 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
Expand Down
27 changes: 14 additions & 13 deletions packages/google-cloud-recommendations-ai/README.rst
Expand Up @@ -36,21 +36,24 @@ In order to use this library, you first need to go through the following steps:
Installation
~~~~~~~~~~~~

Install this library in a `virtualenv`_ using pip. `virtualenv`_ is a tool to
create isolated Python environments. The basic problem it addresses is one of
dependencies and versions, and indirectly permissions.
Install this library in a virtual environment using `venv`_. `venv`_ is a tool that
creates isolated Python environments. These isolated environments can have separate
versions of Python packages, which allows you to isolate one project's dependencies
from the dependencies of other projects.

With `virtualenv`_, it's possible to install this library without needing system
With `venv`_, it's possible to install this library without needing system
install permissions, and without clashing with the installed system
dependencies.

.. _`virtualenv`: https://virtualenv.pypa.io/en/latest/
.. _`venv`: https://docs.python.org/3/library/venv.html


Code samples and snippets
~~~~~~~~~~~~~~~~~~~~~~~~~

Code samples and snippets live in the `samples/` folder.
Code samples and snippets live in the `samples/`_ folder.

.. _samples/: https://github.com/googleapis/google-cloud-python/tree/main/packages/google-cloud-recommendations-ai/samples


Supported Python Versions
Expand All @@ -77,21 +80,19 @@ Mac/Linux

.. code-block:: console
pip install virtualenv
virtualenv <your-env>
python3 -m venv <your-env>
source <your-env>/bin/activate
<your-env>/bin/pip install google-cloud-recommendations-ai
pip install google-cloud-recommendations-ai
Windows
^^^^^^^

.. code-block:: console
pip install virtualenv
virtualenv <your-env>
<your-env>\Scripts\activate
<your-env>\Scripts\pip.exe install google-cloud-recommendations-ai
py -m venv <your-env>
.\<your-env>\Scripts\activate
pip install google-cloud-recommendations-ai
Next Steps
~~~~~~~~~~
Expand Down
2 changes: 1 addition & 1 deletion packages/google-cloud-recommendations-ai/docs/conf.py
@@ -1,5 +1,5 @@
# -*- coding: utf-8 -*-
# Copyright 2021 Google LLC
# Copyright 2023 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
Expand Down
Expand Up @@ -329,6 +329,7 @@ async def sample_predict():
Returns:
google.cloud.recommendationengine_v1beta1.services.prediction_service.pagers.PredictAsyncPager:
Response message for predict method.
Iterating over this object will yield
results and resolve additional pages
automatically.
Expand Down
Expand Up @@ -562,6 +562,7 @@ def sample_predict():
Returns:
google.cloud.recommendationengine_v1beta1.services.prediction_service.pagers.PredictPager:
Response message for predict method.
Iterating over this object will yield
results and resolve additional pages
automatically.
Expand Down
Expand Up @@ -369,6 +369,7 @@ async def collect_user_event(
r"""Writes a single user event from the browser. This
uses a GET request to due to browser restriction of
POST-ing to a 3rd party domain.
This method is used only by the Recommendations AI
JavaScript pixel. Users should not call this method
directly.
Expand Down Expand Up @@ -915,6 +916,7 @@ async def import_user_events(
r"""Bulk import of User events. Request processing might
be synchronous. Events that already exist are skipped.
Use this method for backfilling historical user events.
Operation.response is of type ImportResponse. Note that
it is possible for a subset of the items to be
successfully inserted. Operation.metadata is of type
Expand Down
Expand Up @@ -590,6 +590,7 @@ def collect_user_event(
r"""Writes a single user event from the browser. This
uses a GET request to due to browser restriction of
POST-ing to a 3rd party domain.
This method is used only by the Recommendations AI
JavaScript pixel. Users should not call this method
directly.
Expand Down Expand Up @@ -1106,6 +1107,7 @@ def import_user_events(
r"""Bulk import of User events. Request processing might
be synchronous. Events that already exist are skipped.
Use this method for backfilling historical user events.
Operation.response is of type ImportResponse. Note that
it is possible for a subset of the items to be
successfully inserted. Operation.metadata is of type
Expand Down
Expand Up @@ -283,6 +283,7 @@ def collect_user_event(
Writes a single user event from the browser. This
uses a GET request to due to browser restriction of
POST-ing to a 3rd party domain.
This method is used only by the Recommendations AI
JavaScript pixel. Users should not call this method
directly.
Expand Down Expand Up @@ -376,6 +377,7 @@ def import_user_events(
Bulk import of User events. Request processing might
be synchronous. Events that already exist are skipped.
Use this method for backfilling historical user events.
Operation.response is of type ImportResponse. Note that
it is possible for a subset of the items to be
successfully inserted. Operation.metadata is of type
Expand Down
Expand Up @@ -292,6 +292,7 @@ def collect_user_event(
Writes a single user event from the browser. This
uses a GET request to due to browser restriction of
POST-ing to a 3rd party domain.
This method is used only by the Recommendations AI
JavaScript pixel. Users should not call this method
directly.
Expand Down Expand Up @@ -387,6 +388,7 @@ def import_user_events(
Bulk import of User events. Request processing might
be synchronous. Events that already exist are skipped.
Use this method for backfilling historical user events.
Operation.response is of type ImportResponse. Note that
it is possible for a subset of the items to be
successfully inserted. Operation.metadata is of type
Expand Down
Expand Up @@ -42,6 +42,7 @@ class CatalogItem(proto.Message):
id (str):
Required. Catalog item identifier. UTF-8
encoded string with a length limit of 128 bytes.
This id must be unique among all catalog items
within the same catalog. It should also be used
when logging user events in order for the user
Expand Down Expand Up @@ -86,6 +87,7 @@ class CatalogItem(proto.Message):
Optional. Filtering tags associated with the
catalog item. Each tag should be a UTF-8 encoded
string with a length limit of 1 KiB.
This tag can be used for filtering
recommendation results by passing the tag as
part of the predict request filter.
Expand All @@ -110,6 +112,7 @@ class CategoryHierarchy(proto.Message):
Required. Catalog item categories. Each
category should be a UTF-8 encoded string with a
length limit of 2 KiB.
Note that the order in the list denotes the
specificity (from least to most specific).
"""
Expand Down
2 changes: 1 addition & 1 deletion packages/google-cloud-recommendations-ai/noxfile.py
@@ -1,6 +1,6 @@
# -*- coding: utf-8 -*-
#
# Copyright 2018 Google LLC
# Copyright 2023 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
Expand Down
@@ -1,6 +1,6 @@
#!/bin/bash

# Copyright 2015 Google Inc. All rights reserved.
# Copyright 2023 Google LLC All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
Expand Down
Expand Up @@ -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 field_mask_pb2 # type: ignore
from google.protobuf import json_format
Expand Down
Expand Up @@ -42,7 +42,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 any_pb2 # type: ignore
from google.protobuf import json_format
Expand Down
Expand Up @@ -13,4 +13,4 @@
# See the License for the specific language governing permissions and
# limitations under the License.
#
__version__ = "2.12.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__ = "2.12.0" # {x-release-please-version}
__version__ = "0.0.0" # {x-release-please-version}
Expand Up @@ -433,6 +433,7 @@ class CostProjection(proto.Message):
cost savings and positive cost units indicate
increase. See google.type.Money documentation
for positive/negative units.
A user's permissions may affect whether the cost
is computed using list prices or custom contract
prices.
Expand Down Expand Up @@ -655,29 +656,34 @@ class State(proto.Enum):
Recommendation is active and can be applied.
Recommendations content can be updated by
Google.
ACTIVE recommendations can be marked as CLAIMED,
SUCCEEDED, or FAILED.
CLAIMED (6):
Recommendation is in claimed state.
Recommendations content is immutable and cannot
be updated by Google.
CLAIMED recommendations can be marked as
CLAIMED, SUCCEEDED, or FAILED.
SUCCEEDED (3):
Recommendation is in succeeded state.
Recommendations content is immutable and cannot
be updated by Google.
SUCCEEDED recommendations can be marked as
SUCCEEDED, or FAILED.
FAILED (4):
Recommendation is in failed state.
Recommendations content is immutable and cannot
be updated by Google.
FAILED recommendations can be marked as
SUCCEEDED, or FAILED.
DISMISSED (5):
Recommendation is in dismissed state.
Recommendation content can be updated by Google.
DISMISSED recommendations can be marked as
ACTIVE.
"""
Expand Down
Expand Up @@ -13,4 +13,4 @@
# See the License for the specific language governing permissions and
# limitations under the License.
#
__version__ = "2.12.0" # {x-release-please-version}
__version__ = "0.0.0" # {x-release-please-version}

0 comments on commit 025219f

Please sign in to comment.