google-cloud-channel-v1 0.14.0 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e2a27761452f019abbce6e4d101c681898e68ac29282ad0b2ca7033f14498614
-  data.tar.gz: d2ebee645190d8e393c1d0fe5ebf94b8052c7056746d978cf019e98a1bfe9520
+  metadata.gz: cdf3c3ad2fbdba2747db533d2b1799aa193890699bee88076ad04fd752169561
+  data.tar.gz: 6c491505cced7628a330142bdafaa10486aafe6400c0cba132c4ba42090f4704
 SHA512:
-  metadata.gz: abd65416c88e4bd1502814bc8dc825a9459a0046628da1998e900b6de953583baada1e7a2a1c29d17631f6892403a5d5f34d2c2124a73f6264d11f01a3dd058c
-  data.tar.gz: 2b4b5a08959b1ddaffc29411e997813c16ccac6cc92ffe267343a4f9dabe40b94606065e4da06044691415560d2731f5bc5db772e73df3229f9c34b95d595dfc
+  metadata.gz: 6225e99f7fed79535a4d1c24ce37d447cb539602a29c704c70624ec0ca6cc85239d15003cd3c1e7e9d57cd3f0482fa916823d420e1131de8a0d581f5e3932195
+  data.tar.gz: 431ea70d5f3b5eaeaa79be21bea9623f804372d5c923f66d0eb7828561d9fb5fff83dc757b72ba3f175926fa0b6323c63539357a4718699a46ae6cf17bf13f67

data/README.md

@@ -1,6 +1,6 @@
 # Ruby Client for the Cloud Channel V1 API
 
-API Client library for the Cloud Channel V1 API
+The Cloud Channel API enables Google Cloud partners to have a single unified resale platform and APIs across all of Google Cloud including GCP, Workspace, Maps and Chrome.
 
 You can use Channel Services to manage your relationships with your partners and your customers. Channel Services include a console and APIs to view and provision links between distributors and resellers, customers and entitlements.
 
@@ -46,7 +46,7 @@ for general usage information.
 ## Enabling Logging
 
 To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
-The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/stdlib/libdoc/logger/rdoc/Logger.html) as shown below,
+The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/current/stdlibs/logger/Logger.html) as shown below,
 or a [`Google::Cloud::Logging::Logger`](https://googleapis.dev/ruby/google-cloud-logging/latest)
 that will write logs to [Cloud Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
 and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.

data/lib/google/cloud/channel/v1/cloud_channel_reports_service/client.rb

@@ -183,7 +183,8 @@ module Google
             # instance of {::Google::Cloud::Channel::V1::OperationMetadata OperationMetadata}.
             #
             # To get the results of report generation, call
-            # {::Google::Cloud::Channel::V1::CloudChannelReportsService::Client#fetch_report_results CloudChannelReportsService.FetchReportResults} with the
+            # {::Google::Cloud::Channel::V1::CloudChannelReportsService::Client#fetch_report_results CloudChannelReportsService.FetchReportResults}
+            # with the
             # {::Google::Cloud::Channel::V1::RunReportJobResponse#report_job RunReportJobResponse.report_job}.
             #
             # @overload run_report_job(request, options = nil)
@@ -202,16 +203,16 @@ module Google
             #   the default parameter values, pass an empty Hash as a request object (see above).
             #
             #   @param name [::String]
-            #     Required. The report's resource name. Specifies the account and report used to
-            #     generate report data. The report_id identifier is a UID (for example,
+            #     Required. The report's resource name. Specifies the account and report used
+            #     to generate report data. The report_id identifier is a UID (for example,
             #     `613bf59q`).
             #     Name uses the format:
             #     accounts/\\{account_id}/reports/\\{report_id}
             #   @param date_range [::Google::Cloud::Channel::V1::DateRange, ::Hash]
             #     Optional. The range of usage or invoice dates to include in the result.
             #   @param filter [::String]
-            #     Optional. A structured string that defines conditions on dimension columns to
-            #     restrict the report output.
+            #     Optional. A structured string that defines conditions on dimension columns
+            #     to restrict the report output.
             #
             #     Filters support logical operators (AND, OR, NOT) and conditional operators
             #     (=, !=, <, >, <=, and >=) using `column_id` as keys.
@@ -246,14 +247,14 @@ module Google
             #   # Call the run_report_job method.
             #   result = client.run_report_job request
             #
-            #   # The returned object is of type Gapic::Operation. You can use this
-            #   # object to check the status of an operation, cancel it, or wait
-            #   # for results. Here is how to block until completion:
+            #   # The returned object is of type Gapic::Operation. You can use it to
+            #   # check the status of an operation, cancel it, or wait for results.
+            #   # Here is how to wait for a response.
             #   result.wait_until_done! timeout: 60
             #   if result.response?
             #     p result.response
             #   else
-            #     puts "Error!"
+            #     puts "No response received."
             #   end
             #
             def run_report_job request, options = nil
@@ -299,7 +300,8 @@ module Google
             end
 
             ##
-            # Retrieves data generated by {::Google::Cloud::Channel::V1::CloudChannelReportsService::Client#run_report_job CloudChannelReportsService.RunReportJob}.
+            # Retrieves data generated by
+            # {::Google::Cloud::Channel::V1::CloudChannelReportsService::Client#run_report_job CloudChannelReportsService.RunReportJob}.
             #
             # @overload fetch_report_results(request, options = nil)
             #   Pass arguments to `fetch_report_results` via a request object, either of type
@@ -317,21 +319,24 @@ module Google
             #   the default parameter values, pass an empty Hash as a request object (see above).
             #
             #   @param report_job [::String]
-            #     Required. The report job created by {::Google::Cloud::Channel::V1::CloudChannelReportsService::Client#run_report_job CloudChannelReportsService.RunReportJob}.
+            #     Required. The report job created by
+            #     {::Google::Cloud::Channel::V1::CloudChannelReportsService::Client#run_report_job CloudChannelReportsService.RunReportJob}.
             #     Report_job uses the format:
             #     accounts/\\{account_id}/reportJobs/\\{report_job_id}
             #   @param page_size [::Integer]
-            #     Optional. Requested page size of the report. The server may return fewer results than
-            #     requested. If you don't specify a page size, the server uses a sensible
-            #     default (may change over time).
+            #     Optional. Requested page size of the report. The server may return fewer
+            #     results than requested. If you don't specify a page size, the server uses a
+            #     sensible default (may change over time).
             #
             #     The maximum value is 30,000; the server will change larger values to
             #     30,000.
             #   @param page_token [::String]
             #     Optional. A token that specifies a page of results beyond the first page.
             #     Obtained through
-            #     {::Google::Cloud::Channel::V1::FetchReportResultsResponse#next_page_token FetchReportResultsResponse.next_page_token} of the previous
-            #     {::Google::Cloud::Channel::V1::CloudChannelReportsService::Client#fetch_report_results CloudChannelReportsService.FetchReportResults} call.
+            #     {::Google::Cloud::Channel::V1::FetchReportResultsResponse#next_page_token FetchReportResultsResponse.next_page_token}
+            #     of the previous
+            #     {::Google::Cloud::Channel::V1::CloudChannelReportsService::Client#fetch_report_results CloudChannelReportsService.FetchReportResults}
+            #     call.
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Channel::V1::Row>]
@@ -353,13 +358,11 @@ module Google
             #   # Call the fetch_report_results method.
             #   result = client.fetch_report_results request
             #
-            #   # The returned object is of type Gapic::PagedEnumerable. You can
-            #   # iterate over all elements by calling #each, and the enumerable
-            #   # will lazily make API calls to fetch subsequent pages. Other
-            #   # methods are also available for managing paging directly.
-            #   result.each do |response|
+            #   # The returned object is of type Gapic::PagedEnumerable. You can iterate
+            #   # over elements, and API calls will be issued to fetch pages as needed.
+            #   result.each do |item|
             #     # Each element is of type ::Google::Cloud::Channel::V1::Row.
-            #     p response
+            #     p item
             #   end
             #
             def fetch_report_results request, options = nil
@@ -424,18 +427,19 @@ module Google
             #   the default parameter values, pass an empty Hash as a request object (see above).
             #
             #   @param parent [::String]
-            #     Required. The resource name of the partner account to list available reports for.
-            #     Parent uses the format:
-            #     accounts/\\{account_id}
+            #     Required. The resource name of the partner account to list available
+            #     reports for. Parent uses the format: accounts/\\{account_id}
             #   @param page_size [::Integer]
-            #     Optional. Requested page size of the report. The server might return fewer results
-            #     than requested. If unspecified, returns 20 reports.
-            #     The maximum value is 100.
+            #     Optional. Requested page size of the report. The server might return fewer
+            #     results than requested. If unspecified, returns 20 reports. The maximum
+            #     value is 100.
             #   @param page_token [::String]
             #     Optional. A token that specifies a page of results beyond the first page.
             #     Obtained through
-            #     {::Google::Cloud::Channel::V1::ListReportsResponse#next_page_token ListReportsResponse.next_page_token} of the previous
-            #     {::Google::Cloud::Channel::V1::CloudChannelReportsService::Client#list_reports CloudChannelReportsService.ListReports} call.
+            #     {::Google::Cloud::Channel::V1::ListReportsResponse#next_page_token ListReportsResponse.next_page_token}
+            #     of the previous
+            #     {::Google::Cloud::Channel::V1::CloudChannelReportsService::Client#list_reports CloudChannelReportsService.ListReports}
+            #     call.
             #   @param language_code [::String]
             #     Optional. The BCP-47 language code, such as "en-US".  If specified, the
             #     response is localized to the corresponding language code if the
@@ -462,13 +466,11 @@ module Google
             #   # Call the list_reports method.
             #   result = client.list_reports request
             #
-            #   # The returned object is of type Gapic::PagedEnumerable. You can
-            #   # iterate over all elements by calling #each, and the enumerable
-            #   # will lazily make API calls to fetch subsequent pages. Other
-            #   # methods are also available for managing paging directly.
-            #   result.each do |response|
+            #   # The returned object is of type Gapic::PagedEnumerable. You can iterate
+            #   # over elements, and API calls will be issued to fetch pages as needed.
+            #   result.each do |item|
             #     # Each element is of type ::Google::Cloud::Channel::V1::Report.
-            #     p response
+            #     p item
             #   end
             #
             def list_reports request, options = nil

data/lib/google/cloud/channel/v1/cloud_channel_reports_service/operations.rb

@@ -158,13 +158,11 @@ module Google
             #   # Call the list_operations method.
             #   result = client.list_operations request
             #
-            #   # The returned object is of type Gapic::PagedEnumerable. You can
-            #   # iterate over all elements by calling #each, and the enumerable
-            #   # will lazily make API calls to fetch subsequent pages. Other
-            #   # methods are also available for managing paging directly.
-            #   result.each do |response|
+            #   # The returned object is of type Gapic::PagedEnumerable. You can iterate
+            #   # over elements, and API calls will be issued to fetch pages as needed.
+            #   result.each do |item|
             #     # Each element is of type ::Google::Longrunning::Operation.
-            #     p response
+            #     p item
             #   end
             #
             def list_operations request, options = nil
@@ -253,14 +251,14 @@ module Google
             #   # Call the get_operation method.
             #   result = client.get_operation request
             #
-            #   # The returned object is of type Gapic::Operation. You can use this
-            #   # object to check the status of an operation, cancel it, or wait
-            #   # for results. Here is how to block until completion:
+            #   # The returned object is of type Gapic::Operation. You can use it to
+            #   # check the status of an operation, cancel it, or wait for results.
+            #   # Here is how to wait for a response.
             #   result.wait_until_done! timeout: 60
             #   if result.response?
             #     p result.response
             #   else
-            #     puts "Error!"
+            #     puts "No response received."
             #   end
             #
             def get_operation request, options = nil
@@ -540,14 +538,14 @@ module Google
             #   # Call the wait_operation method.
             #   result = client.wait_operation request
             #
-            #   # The returned object is of type Gapic::Operation. You can use this
-            #   # object to check the status of an operation, cancel it, or wait
-            #   # for results. Here is how to block until completion:
+            #   # The returned object is of type Gapic::Operation. You can use it to
+            #   # check the status of an operation, cancel it, or wait for results.
+            #   # Here is how to wait for a response.
             #   result.wait_until_done! timeout: 60
             #   if result.response?
             #     p result.response
             #   else
-            #     puts "Error!"
+            #     puts "No response received."
             #   end
             #
             def wait_operation request, options = nil