Skip to content

Commit

Permalink
docs: [google-cloud-channel] A comment for service `CloudChannelRepor…
Browse files Browse the repository at this point in the history
…tsService` is changed (#12140)

- [ ] Regenerate this pull request now.

BEGIN_COMMIT_OVERRIDE
docs: Add deprecation comment for method `RunReportJob` in service
`CloudChannelReportsService`
docs: Add deprecation comment for method `FetchReportResults` in service
`CloudChannelReportsService`
docs: Add deprecation comment for method `ListReports` in service
`CloudChannelReportsService`
docs: Add deprecation comment for service `CloudChannelReportsService
END_COMMIT_OVERRIDE



PiperOrigin-RevId: 592812793

Source-Link:
googleapis/googleapis@f3c9569

Source-Link:
googleapis/googleapis-gen@d705bd4
Copy-Tag:
eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWNoYW5uZWwvLk93bEJvdC55YW1sIiwiaCI6ImQ3MDViZDQ0OWRiMWM3NTk0NzhhNWU5ZTA1YjAzNzUyMjBjOWNjZjAifQ==

---------

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 Dec 21, 2023
1 parent b21ac63 commit 1e6bf49
Show file tree
Hide file tree
Showing 7 changed files with 127 additions and 27 deletions.
Expand Up @@ -13,4 +13,4 @@
# See the License for the specific language governing permissions and
# limitations under the License.
#
__version__ = "1.17.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.17.0" # {x-release-please-version}
__version__ = "0.0.0" # {x-release-please-version}
Expand Up @@ -27,6 +27,7 @@
Type,
Union,
)
import warnings

from google.api_core import exceptions as core_exceptions
from google.api_core import gapic_v1
Expand Down Expand Up @@ -56,9 +57,14 @@

class CloudChannelReportsServiceAsyncClient:
"""CloudChannelReportsService lets Google Cloud resellers and
distributors retrieve and combine a variety of data in Cloud
Channel for multiple products (Google Cloud, Google Voice, and
Google Workspace.)
distributors retrieve and combine a variety of data in Cloud Channel
for multiple products (Google Cloud, Google Voice, and Google
Workspace.)
Deprecated: This service is being deprecated. Please use `Export
Channel Services data to
BigQuery <https://cloud.google.com/channel/docs/rebilling/export-data-to-bigquery>`__
instead.
"""

_client: CloudChannelReportsServiceClient
Expand Down Expand Up @@ -268,6 +274,10 @@ async def run_report_job(
with the
[RunReportJobResponse.report_job][google.cloud.channel.v1.RunReportJobResponse.report_job].
Deprecated: Please use `Export Channel Services data to
BigQuery <https://cloud.google.com/channel/docs/rebilling/export-data-to-bigquery>`__
instead.
.. code-block:: python
# This snippet has been automatically generated and should be regarded as a
Expand Down Expand Up @@ -316,6 +326,11 @@ async def sample_run_report_job():
[CloudChannelReportsService.RunReportJob][google.cloud.channel.v1.CloudChannelReportsService.RunReportJob].
"""
warnings.warn(
"CloudChannelReportsServiceAsyncClient.run_report_job is deprecated",
DeprecationWarning,
)

# Create or coerce a protobuf request object.
request = reports_service.RunReportJobRequest(request)

Expand Down Expand Up @@ -366,6 +381,10 @@ async def fetch_report_results(
r"""Retrieves data generated by
[CloudChannelReportsService.RunReportJob][google.cloud.channel.v1.CloudChannelReportsService.RunReportJob].
Deprecated: Please use `Export Channel Services data to
BigQuery <https://cloud.google.com/channel/docs/rebilling/export-data-to-bigquery>`__
instead.
.. code-block:: python
# This snippet has been automatically generated and should be regarded as a
Expand Down Expand Up @@ -423,6 +442,11 @@ async def sample_fetch_report_results():
resolve additional pages automatically.
"""
warnings.warn(
"CloudChannelReportsServiceAsyncClient.fetch_report_results is deprecated",
DeprecationWarning,
)

# Create or coerce a protobuf request object.
# Quick check: If we got a request object, we should *not* have
# gotten any keyword arguments that map to the request.
Expand Down Expand Up @@ -485,9 +509,13 @@ async def list_reports(
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
metadata: Sequence[Tuple[str, str]] = (),
) -> pagers.ListReportsAsyncPager:
r"""Lists the reports that RunReportJob can run. These
reports include an ID, a description, and the list of
columns that will be in the result.
r"""Lists the reports that RunReportJob can run. These reports
include an ID, a description, and the list of columns that will
be in the result.
Deprecated: Please use `Export Channel Services data to
BigQuery <https://cloud.google.com/channel/docs/rebilling/export-data-to-bigquery>`__
instead.
.. code-block:: python
Expand Down Expand Up @@ -543,6 +571,11 @@ async def sample_list_reports():
resolve additional pages automatically.
"""
warnings.warn(
"CloudChannelReportsServiceAsyncClient.list_reports is deprecated",
DeprecationWarning,
)

# Create or coerce a protobuf request object.
# Quick check: If we got a request object, we should *not* have
# gotten any keyword arguments that map to the request.
Expand Down
Expand Up @@ -28,6 +28,7 @@
Union,
cast,
)
import warnings

from google.api_core import client_options as client_options_lib
from google.api_core import exceptions as core_exceptions
Expand Down Expand Up @@ -96,9 +97,14 @@ def get_transport_class(

class CloudChannelReportsServiceClient(metaclass=CloudChannelReportsServiceClientMeta):
"""CloudChannelReportsService lets Google Cloud resellers and
distributors retrieve and combine a variety of data in Cloud
Channel for multiple products (Google Cloud, Google Voice, and
Google Workspace.)
distributors retrieve and combine a variety of data in Cloud Channel
for multiple products (Google Cloud, Google Voice, and Google
Workspace.)
Deprecated: This service is being deprecated. Please use `Export
Channel Services data to
BigQuery <https://cloud.google.com/channel/docs/rebilling/export-data-to-bigquery>`__
instead.
"""

@staticmethod
Expand Down Expand Up @@ -498,6 +504,10 @@ def run_report_job(
with the
[RunReportJobResponse.report_job][google.cloud.channel.v1.RunReportJobResponse.report_job].
Deprecated: Please use `Export Channel Services data to
BigQuery <https://cloud.google.com/channel/docs/rebilling/export-data-to-bigquery>`__
instead.
.. code-block:: python
# This snippet has been automatically generated and should be regarded as a
Expand Down Expand Up @@ -546,6 +556,11 @@ def sample_run_report_job():
[CloudChannelReportsService.RunReportJob][google.cloud.channel.v1.CloudChannelReportsService.RunReportJob].
"""
warnings.warn(
"CloudChannelReportsServiceClient.run_report_job is deprecated",
DeprecationWarning,
)

# Create or coerce a protobuf request object.
# Minor optimization to avoid making a copy if the user passes
# in a reports_service.RunReportJobRequest.
Expand Down Expand Up @@ -597,6 +612,10 @@ def fetch_report_results(
r"""Retrieves data generated by
[CloudChannelReportsService.RunReportJob][google.cloud.channel.v1.CloudChannelReportsService.RunReportJob].
Deprecated: Please use `Export Channel Services data to
BigQuery <https://cloud.google.com/channel/docs/rebilling/export-data-to-bigquery>`__
instead.
.. code-block:: python
# This snippet has been automatically generated and should be regarded as a
Expand Down Expand Up @@ -654,6 +673,11 @@ def sample_fetch_report_results():
resolve additional pages automatically.
"""
warnings.warn(
"CloudChannelReportsServiceClient.fetch_report_results is deprecated",
DeprecationWarning,
)

# Create or coerce a protobuf request object.
# Quick check: If we got a request object, we should *not* have
# gotten any keyword arguments that map to the request.
Expand Down Expand Up @@ -716,9 +740,13 @@ def list_reports(
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
metadata: Sequence[Tuple[str, str]] = (),
) -> pagers.ListReportsPager:
r"""Lists the reports that RunReportJob can run. These
reports include an ID, a description, and the list of
columns that will be in the result.
r"""Lists the reports that RunReportJob can run. These reports
include an ID, a description, and the list of columns that will
be in the result.
Deprecated: Please use `Export Channel Services data to
BigQuery <https://cloud.google.com/channel/docs/rebilling/export-data-to-bigquery>`__
instead.
.. code-block:: python
Expand Down Expand Up @@ -774,6 +802,11 @@ def sample_list_reports():
resolve additional pages automatically.
"""
warnings.warn(
"CloudChannelReportsServiceClient.list_reports is deprecated",
DeprecationWarning,
)

# Create or coerce a protobuf request object.
# Quick check: If we got a request object, we should *not* have
# gotten any keyword arguments that map to the request.
Expand Down
Expand Up @@ -32,9 +32,14 @@ class CloudChannelReportsServiceGrpcTransport(CloudChannelReportsServiceTranspor
"""gRPC backend transport for CloudChannelReportsService.
CloudChannelReportsService lets Google Cloud resellers and
distributors retrieve and combine a variety of data in Cloud
Channel for multiple products (Google Cloud, Google Voice, and
Google Workspace.)
distributors retrieve and combine a variety of data in Cloud Channel
for multiple products (Google Cloud, Google Voice, and Google
Workspace.)
Deprecated: This service is being deprecated. Please use `Export
Channel Services data to
BigQuery <https://cloud.google.com/channel/docs/rebilling/export-data-to-bigquery>`__
instead.
This class defines the same methods as the primary client, so the
primary client can load the underlying transport implementation
Expand Down Expand Up @@ -280,6 +285,10 @@ def run_report_job(
with the
[RunReportJobResponse.report_job][google.cloud.channel.v1.RunReportJobResponse.report_job].
Deprecated: Please use `Export Channel Services data to
BigQuery <https://cloud.google.com/channel/docs/rebilling/export-data-to-bigquery>`__
instead.
Returns:
Callable[[~.RunReportJobRequest],
~.Operation]:
Expand Down Expand Up @@ -310,6 +319,10 @@ def fetch_report_results(
Retrieves data generated by
[CloudChannelReportsService.RunReportJob][google.cloud.channel.v1.CloudChannelReportsService.RunReportJob].
Deprecated: Please use `Export Channel Services data to
BigQuery <https://cloud.google.com/channel/docs/rebilling/export-data-to-bigquery>`__
instead.
Returns:
Callable[[~.FetchReportResultsRequest],
~.FetchReportResultsResponse]:
Expand All @@ -336,9 +349,13 @@ def list_reports(
]:
r"""Return a callable for the list reports method over gRPC.
Lists the reports that RunReportJob can run. These
reports include an ID, a description, and the list of
columns that will be in the result.
Lists the reports that RunReportJob can run. These reports
include an ID, a description, and the list of columns that will
be in the result.
Deprecated: Please use `Export Channel Services data to
BigQuery <https://cloud.google.com/channel/docs/rebilling/export-data-to-bigquery>`__
instead.
Returns:
Callable[[~.ListReportsRequest],
Expand Down
Expand Up @@ -35,9 +35,14 @@ class CloudChannelReportsServiceGrpcAsyncIOTransport(
"""gRPC AsyncIO backend transport for CloudChannelReportsService.
CloudChannelReportsService lets Google Cloud resellers and
distributors retrieve and combine a variety of data in Cloud
Channel for multiple products (Google Cloud, Google Voice, and
Google Workspace.)
distributors retrieve and combine a variety of data in Cloud Channel
for multiple products (Google Cloud, Google Voice, and Google
Workspace.)
Deprecated: This service is being deprecated. Please use `Export
Channel Services data to
BigQuery <https://cloud.google.com/channel/docs/rebilling/export-data-to-bigquery>`__
instead.
This class defines the same methods as the primary client, so the
primary client can load the underlying transport implementation
Expand Down Expand Up @@ -289,6 +294,10 @@ def run_report_job(
with the
[RunReportJobResponse.report_job][google.cloud.channel.v1.RunReportJobResponse.report_job].
Deprecated: Please use `Export Channel Services data to
BigQuery <https://cloud.google.com/channel/docs/rebilling/export-data-to-bigquery>`__
instead.
Returns:
Callable[[~.RunReportJobRequest],
Awaitable[~.Operation]]:
Expand Down Expand Up @@ -319,6 +328,10 @@ def fetch_report_results(
Retrieves data generated by
[CloudChannelReportsService.RunReportJob][google.cloud.channel.v1.CloudChannelReportsService.RunReportJob].
Deprecated: Please use `Export Channel Services data to
BigQuery <https://cloud.google.com/channel/docs/rebilling/export-data-to-bigquery>`__
instead.
Returns:
Callable[[~.FetchReportResultsRequest],
Awaitable[~.FetchReportResultsResponse]]:
Expand Down Expand Up @@ -346,9 +359,13 @@ def list_reports(
]:
r"""Return a callable for the list reports method over gRPC.
Lists the reports that RunReportJob can run. These
reports include an ID, a description, and the list of
columns that will be in the result.
Lists the reports that RunReportJob can run. These reports
include an ID, a description, and the list of columns that will
be in the result.
Deprecated: Please use `Export Channel Services data to
BigQuery <https://cloud.google.com/channel/docs/rebilling/export-data-to-bigquery>`__
instead.
Returns:
Callable[[~.ListReportsRequest],
Expand Down
Expand Up @@ -8,7 +8,7 @@
],
"language": "PYTHON",
"name": "google-cloud-channel",
"version": "1.17.0"
"version": "0.1.0"
},
"snippets": [
{
Expand Down

0 comments on commit 1e6bf49

Please sign in to comment.