Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion packages/google-cloud-storageinsights/.flake8
Original file line number Diff line number Diff line change
@@ -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-storageinsights/CONTRIBUTING.rst
Original file line number Diff line number Diff line change
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-storageinsights/noxfile.py


**********
Expand Down
2 changes: 1 addition & 1 deletion packages/google-cloud-storageinsights/MANIFEST.in
Original file line number Diff line number Diff line change
@@ -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-storageinsights/README.rst
Original file line number Diff line number Diff line change
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-storageinsights/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-storageinsights
pip install google-cloud-storageinsights


Windows
^^^^^^^

.. code-block:: console

pip install virtualenv
virtualenv <your-env>
<your-env>\Scripts\activate
<your-env>\Scripts\pip.exe install google-cloud-storageinsights
py -m venv <your-env>
.\<your-env>\Scripts\activate
pip install google-cloud-storageinsights

Next Steps
~~~~~~~~~~
Expand Down
2 changes: 1 addition & 1 deletion packages/google-cloud-storageinsights/docs/conf.py
Original file line number Diff line number Diff line change
@@ -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
Original file line number Diff line number Diff line change
Expand Up @@ -406,8 +406,10 @@ async def sample_get_report_config():
google.cloud.storageinsights_v1.types.ReportConfig:
Message describing ReportConfig
object. ReportConfig is the
configuration to generate reports. Next
ID: 12
configuration to generate reports. See
https://cloud.google.com/storage/docs/insights/using-inventory-reports#create-config-rest
for more details on how to set various
fields. Next ID: 12

"""
# Create or coerce a protobuf request object.
Expand Down Expand Up @@ -525,8 +527,10 @@ async def sample_create_report_config():
google.cloud.storageinsights_v1.types.ReportConfig:
Message describing ReportConfig
object. ReportConfig is the
configuration to generate reports. Next
ID: 12
configuration to generate reports. See
https://cloud.google.com/storage/docs/insights/using-inventory-reports#create-config-rest
for more details on how to set various
fields. Next ID: 12

"""
# Create or coerce a protobuf request object.
Expand Down Expand Up @@ -641,8 +645,10 @@ async def sample_update_report_config():
google.cloud.storageinsights_v1.types.ReportConfig:
Message describing ReportConfig
object. ReportConfig is the
configuration to generate reports. Next
ID: 12
configuration to generate reports. See
https://cloud.google.com/storage/docs/insights/using-inventory-reports#create-config-rest
for more details on how to set various
fields. Next ID: 12

"""
# Create or coerce a protobuf request object.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -644,8 +644,10 @@ def sample_get_report_config():
google.cloud.storageinsights_v1.types.ReportConfig:
Message describing ReportConfig
object. ReportConfig is the
configuration to generate reports. Next
ID: 12
configuration to generate reports. See
https://cloud.google.com/storage/docs/insights/using-inventory-reports#create-config-rest
for more details on how to set various
fields. Next ID: 12

"""
# Create or coerce a protobuf request object.
Expand Down Expand Up @@ -754,8 +756,10 @@ def sample_create_report_config():
google.cloud.storageinsights_v1.types.ReportConfig:
Message describing ReportConfig
object. ReportConfig is the
configuration to generate reports. Next
ID: 12
configuration to generate reports. See
https://cloud.google.com/storage/docs/insights/using-inventory-reports#create-config-rest
for more details on how to set various
fields. Next ID: 12

"""
# Create or coerce a protobuf request object.
Expand Down Expand Up @@ -870,8 +874,10 @@ def sample_update_report_config():
google.cloud.storageinsights_v1.types.ReportConfig:
Message describing ReportConfig
object. ReportConfig is the
configuration to generate reports. Next
ID: 12
configuration to generate reports. See
https://cloud.google.com/storage/docs/insights/using-inventory-reports#create-config-rest
for more details on how to set various
fields. Next ID: 12

"""
# Create or coerce a protobuf request object.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -543,8 +543,10 @@ def __call__(
~.storageinsights.ReportConfig:
Message describing ReportConfig
object. ReportConfig is the
configuration to generate reports. Next
ID: 12
configuration to generate reports. See
https://cloud.google.com/storage/docs/insights/using-inventory-reports#create-config-rest
for more details on how to set various
fields. Next ID: 12

"""

Expand Down Expand Up @@ -720,8 +722,10 @@ def __call__(
~.storageinsights.ReportConfig:
Message describing ReportConfig
object. ReportConfig is the
configuration to generate reports. Next
ID: 12
configuration to generate reports. See
https://cloud.google.com/storage/docs/insights/using-inventory-reports#create-config-rest
for more details on how to set various
fields. Next ID: 12

"""

Expand Down Expand Up @@ -1088,8 +1092,10 @@ def __call__(
~.storageinsights.ReportConfig:
Message describing ReportConfig
object. ReportConfig is the
configuration to generate reports. Next
ID: 12
configuration to generate reports. See
https://cloud.google.com/storage/docs/insights/using-inventory-reports#create-config-rest
for more details on how to set various
fields. Next ID: 12

"""

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -670,6 +670,9 @@ class ObjectMetadataReportOptions(proto.Message):
class ReportConfig(proto.Message):
r"""Message describing ReportConfig object. ReportConfig is the
configuration to generate reports.
See
https://cloud.google.com/storage/docs/insights/using-inventory-reports#create-config-rest
for more details on how to set various fields.
Next ID: 12

This message has `oneof`_ fields (mutually exclusive fields).
Expand Down
2 changes: 1 addition & 1 deletion packages/google-cloud-storageinsights/noxfile.py
Original file line number Diff line number Diff line change
@@ -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
Original file line number Diff line number Diff line change
@@ -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