google-cloud-channel-v1 0.12.0 → 0.13.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/AUTHENTICATION.md +7 -7
- data/README.md +3 -3
- data/lib/google/cloud/channel/v1/cloud_channel_reports_service/client.rb +685 -0
- data/lib/google/cloud/channel/v1/cloud_channel_reports_service/credentials.rb +51 -0
- data/lib/google/cloud/channel/v1/cloud_channel_reports_service/operations.rb +770 -0
- data/lib/google/cloud/channel/v1/cloud_channel_reports_service/paths.rb +67 -0
- data/lib/google/cloud/channel/v1/cloud_channel_reports_service.rb +53 -0
- data/lib/google/cloud/channel/v1/cloud_channel_service/client.rb +4 -3
- data/lib/google/cloud/channel/v1/reports_service_pb.rb +136 -0
- data/lib/google/cloud/channel/v1/reports_service_services_pb.rb +76 -0
- data/lib/google/cloud/channel/v1/service_services_pb.rb +2 -1
- data/lib/google/cloud/channel/v1/version.rb +1 -1
- data/lib/google/cloud/channel/v1.rb +2 -1
- data/proto_docs/google/cloud/channel/v1/reports_service.rb +375 -0
- data/proto_docs/google/cloud/channel/v1/service.rb +2 -2
- data/proto_docs/google/protobuf/empty.rb +0 -2
- data/proto_docs/google/type/datetime.rb +99 -0
- metadata +13 -4
@@ -0,0 +1,67 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2022 Google LLC
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
18
|
+
|
19
|
+
|
20
|
+
module Google
|
21
|
+
module Cloud
|
22
|
+
module Channel
|
23
|
+
module V1
|
24
|
+
module CloudChannelReportsService
|
25
|
+
# Path helper methods for the CloudChannelReportsService API.
|
26
|
+
module Paths
|
27
|
+
##
|
28
|
+
# Create a fully-qualified Report resource string.
|
29
|
+
#
|
30
|
+
# The resource will be in the following format:
|
31
|
+
#
|
32
|
+
# `accounts/{account}/reports/{report}`
|
33
|
+
#
|
34
|
+
# @param account [String]
|
35
|
+
# @param report [String]
|
36
|
+
#
|
37
|
+
# @return [::String]
|
38
|
+
def report_path account:, report:
|
39
|
+
raise ::ArgumentError, "account cannot contain /" if account.to_s.include? "/"
|
40
|
+
|
41
|
+
"accounts/#{account}/reports/#{report}"
|
42
|
+
end
|
43
|
+
|
44
|
+
##
|
45
|
+
# Create a fully-qualified ReportJob resource string.
|
46
|
+
#
|
47
|
+
# The resource will be in the following format:
|
48
|
+
#
|
49
|
+
# `accounts/{account}/reportJobs/{report_job}`
|
50
|
+
#
|
51
|
+
# @param account [String]
|
52
|
+
# @param report_job [String]
|
53
|
+
#
|
54
|
+
# @return [::String]
|
55
|
+
def report_job_path account:, report_job:
|
56
|
+
raise ::ArgumentError, "account cannot contain /" if account.to_s.include? "/"
|
57
|
+
|
58
|
+
"accounts/#{account}/reportJobs/#{report_job}"
|
59
|
+
end
|
60
|
+
|
61
|
+
extend self
|
62
|
+
end
|
63
|
+
end
|
64
|
+
end
|
65
|
+
end
|
66
|
+
end
|
67
|
+
end
|
@@ -0,0 +1,53 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2022 Google LLC
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
18
|
+
|
19
|
+
require "gapic/common"
|
20
|
+
require "gapic/config"
|
21
|
+
require "gapic/config/method"
|
22
|
+
|
23
|
+
require "google/cloud/channel/v1/version"
|
24
|
+
|
25
|
+
require "google/cloud/channel/v1/cloud_channel_reports_service/credentials"
|
26
|
+
require "google/cloud/channel/v1/cloud_channel_reports_service/paths"
|
27
|
+
require "google/cloud/channel/v1/cloud_channel_reports_service/operations"
|
28
|
+
require "google/cloud/channel/v1/cloud_channel_reports_service/client"
|
29
|
+
|
30
|
+
module Google
|
31
|
+
module Cloud
|
32
|
+
module Channel
|
33
|
+
module V1
|
34
|
+
##
|
35
|
+
# CloudChannelReportsService lets Google Cloud resellers and
|
36
|
+
# distributors retrieve and combine a variety of data in Cloud Channel for
|
37
|
+
# multiple products (Google Cloud Platform (GCP), Google Voice, and
|
38
|
+
# Google Workspace.)
|
39
|
+
#
|
40
|
+
# To load this service and instantiate a client:
|
41
|
+
#
|
42
|
+
# require "google/cloud/channel/v1/cloud_channel_reports_service"
|
43
|
+
# client = ::Google::Cloud::Channel::V1::CloudChannelReportsService::Client.new
|
44
|
+
#
|
45
|
+
module CloudChannelReportsService
|
46
|
+
end
|
47
|
+
end
|
48
|
+
end
|
49
|
+
end
|
50
|
+
end
|
51
|
+
|
52
|
+
helper_path = ::File.join __dir__, "cloud_channel_reports_service", "helpers.rb"
|
53
|
+
require "google/cloud/channel/v1/cloud_channel_reports_service/helpers" if ::File.file? helper_path
|
@@ -1221,7 +1221,7 @@ module Google
|
|
1221
1221
|
# {::Google::Cloud::Channel::V1::CloudChannelService::Client#list_transferable_skus CloudChannelService.ListTransferableSkus} call.
|
1222
1222
|
# Optional.
|
1223
1223
|
# @param auth_token [::String]
|
1224
|
-
# The super admin of the resold customer generates this token to
|
1224
|
+
# Optional. The super admin of the resold customer generates this token to
|
1225
1225
|
# authorize a reseller to access their Cloud Identity and purchase
|
1226
1226
|
# entitlements on their behalf. You can omit this token after authorization.
|
1227
1227
|
# See https://support.google.com/a/answer/7643790 for more details.
|
@@ -1314,7 +1314,8 @@ module Google
|
|
1314
1314
|
#
|
1315
1315
|
# * PERMISSION_DENIED:
|
1316
1316
|
# * The customer doesn't belong to the reseller and has no auth token.
|
1317
|
-
# * The
|
1317
|
+
# * The customer provided incorrect reseller information when generating
|
1318
|
+
# auth token.
|
1318
1319
|
# * The reseller account making the request is different
|
1319
1320
|
# from the reseller account in the query.
|
1320
1321
|
# * INVALID_ARGUMENT: Required request parameters are missing or invalid.
|
@@ -1356,7 +1357,7 @@ module Google
|
|
1356
1357
|
# @param sku [::String]
|
1357
1358
|
# Required. The SKU to look up Offers for.
|
1358
1359
|
# @param language_code [::String]
|
1359
|
-
# The BCP-47 language code. For example, "en-US". The
|
1360
|
+
# Optional. The BCP-47 language code. For example, "en-US". The
|
1360
1361
|
# response will localize in the corresponding language code, if specified.
|
1361
1362
|
# The default value is "en-US".
|
1362
1363
|
#
|
@@ -0,0 +1,136 @@
|
|
1
|
+
# Generated by the protocol buffer compiler. DO NOT EDIT!
|
2
|
+
# source: google/cloud/channel/v1/reports_service.proto
|
3
|
+
|
4
|
+
require 'google/protobuf'
|
5
|
+
|
6
|
+
require 'google/api/annotations_pb'
|
7
|
+
require 'google/api/client_pb'
|
8
|
+
require 'google/api/field_behavior_pb'
|
9
|
+
require 'google/api/resource_pb'
|
10
|
+
require 'google/longrunning/operations_pb'
|
11
|
+
require 'google/protobuf/timestamp_pb'
|
12
|
+
require 'google/type/date_pb'
|
13
|
+
require 'google/type/datetime_pb'
|
14
|
+
require 'google/type/decimal_pb'
|
15
|
+
require 'google/type/money_pb'
|
16
|
+
|
17
|
+
Google::Protobuf::DescriptorPool.generated_pool.build do
|
18
|
+
add_file("google/cloud/channel/v1/reports_service.proto", :syntax => :proto3) do
|
19
|
+
add_message "google.cloud.channel.v1.RunReportJobRequest" do
|
20
|
+
optional :name, :string, 1
|
21
|
+
optional :date_range, :message, 2, "google.cloud.channel.v1.DateRange"
|
22
|
+
optional :filter, :string, 3
|
23
|
+
optional :language_code, :string, 4
|
24
|
+
end
|
25
|
+
add_message "google.cloud.channel.v1.RunReportJobResponse" do
|
26
|
+
optional :report_job, :message, 1, "google.cloud.channel.v1.ReportJob"
|
27
|
+
optional :report_metadata, :message, 2, "google.cloud.channel.v1.ReportResultsMetadata"
|
28
|
+
end
|
29
|
+
add_message "google.cloud.channel.v1.FetchReportResultsRequest" do
|
30
|
+
optional :report_job, :string, 1
|
31
|
+
optional :page_size, :int32, 2
|
32
|
+
optional :page_token, :string, 3
|
33
|
+
end
|
34
|
+
add_message "google.cloud.channel.v1.FetchReportResultsResponse" do
|
35
|
+
optional :report_metadata, :message, 1, "google.cloud.channel.v1.ReportResultsMetadata"
|
36
|
+
repeated :rows, :message, 2, "google.cloud.channel.v1.Row"
|
37
|
+
optional :next_page_token, :string, 3
|
38
|
+
end
|
39
|
+
add_message "google.cloud.channel.v1.ListReportsRequest" do
|
40
|
+
optional :parent, :string, 1
|
41
|
+
optional :page_size, :int32, 2
|
42
|
+
optional :page_token, :string, 3
|
43
|
+
optional :language_code, :string, 4
|
44
|
+
end
|
45
|
+
add_message "google.cloud.channel.v1.ListReportsResponse" do
|
46
|
+
repeated :reports, :message, 1, "google.cloud.channel.v1.Report"
|
47
|
+
optional :next_page_token, :string, 2
|
48
|
+
end
|
49
|
+
add_message "google.cloud.channel.v1.ReportJob" do
|
50
|
+
optional :name, :string, 1
|
51
|
+
optional :report_status, :message, 2, "google.cloud.channel.v1.ReportStatus"
|
52
|
+
end
|
53
|
+
add_message "google.cloud.channel.v1.ReportResultsMetadata" do
|
54
|
+
optional :report, :message, 1, "google.cloud.channel.v1.Report"
|
55
|
+
optional :row_count, :int64, 2
|
56
|
+
optional :date_range, :message, 3, "google.cloud.channel.v1.DateRange"
|
57
|
+
optional :preceding_date_range, :message, 4, "google.cloud.channel.v1.DateRange"
|
58
|
+
end
|
59
|
+
add_message "google.cloud.channel.v1.Column" do
|
60
|
+
optional :column_id, :string, 1
|
61
|
+
optional :display_name, :string, 2
|
62
|
+
optional :data_type, :enum, 3, "google.cloud.channel.v1.Column.DataType"
|
63
|
+
end
|
64
|
+
add_enum "google.cloud.channel.v1.Column.DataType" do
|
65
|
+
value :DATA_TYPE_UNSPECIFIED, 0
|
66
|
+
value :STRING, 1
|
67
|
+
value :INT, 2
|
68
|
+
value :DECIMAL, 3
|
69
|
+
value :MONEY, 4
|
70
|
+
value :DATE, 5
|
71
|
+
value :DATE_TIME, 6
|
72
|
+
end
|
73
|
+
add_message "google.cloud.channel.v1.DateRange" do
|
74
|
+
optional :usage_start_date_time, :message, 1, "google.type.DateTime"
|
75
|
+
optional :usage_end_date_time, :message, 2, "google.type.DateTime"
|
76
|
+
optional :invoice_start_date, :message, 3, "google.type.Date"
|
77
|
+
optional :invoice_end_date, :message, 4, "google.type.Date"
|
78
|
+
end
|
79
|
+
add_message "google.cloud.channel.v1.Row" do
|
80
|
+
repeated :values, :message, 1, "google.cloud.channel.v1.ReportValue"
|
81
|
+
end
|
82
|
+
add_message "google.cloud.channel.v1.ReportValue" do
|
83
|
+
oneof :value do
|
84
|
+
optional :string_value, :string, 1
|
85
|
+
optional :int_value, :int64, 2
|
86
|
+
optional :decimal_value, :message, 3, "google.type.Decimal"
|
87
|
+
optional :money_value, :message, 4, "google.type.Money"
|
88
|
+
optional :date_value, :message, 5, "google.type.Date"
|
89
|
+
optional :date_time_value, :message, 6, "google.type.DateTime"
|
90
|
+
end
|
91
|
+
end
|
92
|
+
add_message "google.cloud.channel.v1.ReportStatus" do
|
93
|
+
optional :state, :enum, 1, "google.cloud.channel.v1.ReportStatus.State"
|
94
|
+
optional :start_time, :message, 2, "google.protobuf.Timestamp"
|
95
|
+
optional :end_time, :message, 3, "google.protobuf.Timestamp"
|
96
|
+
end
|
97
|
+
add_enum "google.cloud.channel.v1.ReportStatus.State" do
|
98
|
+
value :STATE_UNSPECIFIED, 0
|
99
|
+
value :STARTED, 1
|
100
|
+
value :WRITING, 2
|
101
|
+
value :AVAILABLE, 3
|
102
|
+
value :FAILED, 4
|
103
|
+
end
|
104
|
+
add_message "google.cloud.channel.v1.Report" do
|
105
|
+
optional :name, :string, 1
|
106
|
+
optional :display_name, :string, 2
|
107
|
+
repeated :columns, :message, 3, "google.cloud.channel.v1.Column"
|
108
|
+
optional :description, :string, 4
|
109
|
+
end
|
110
|
+
end
|
111
|
+
end
|
112
|
+
|
113
|
+
module Google
|
114
|
+
module Cloud
|
115
|
+
module Channel
|
116
|
+
module V1
|
117
|
+
RunReportJobRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.channel.v1.RunReportJobRequest").msgclass
|
118
|
+
RunReportJobResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.channel.v1.RunReportJobResponse").msgclass
|
119
|
+
FetchReportResultsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.channel.v1.FetchReportResultsRequest").msgclass
|
120
|
+
FetchReportResultsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.channel.v1.FetchReportResultsResponse").msgclass
|
121
|
+
ListReportsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.channel.v1.ListReportsRequest").msgclass
|
122
|
+
ListReportsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.channel.v1.ListReportsResponse").msgclass
|
123
|
+
ReportJob = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.channel.v1.ReportJob").msgclass
|
124
|
+
ReportResultsMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.channel.v1.ReportResultsMetadata").msgclass
|
125
|
+
Column = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.channel.v1.Column").msgclass
|
126
|
+
Column::DataType = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.channel.v1.Column.DataType").enummodule
|
127
|
+
DateRange = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.channel.v1.DateRange").msgclass
|
128
|
+
Row = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.channel.v1.Row").msgclass
|
129
|
+
ReportValue = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.channel.v1.ReportValue").msgclass
|
130
|
+
ReportStatus = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.channel.v1.ReportStatus").msgclass
|
131
|
+
ReportStatus::State = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.channel.v1.ReportStatus.State").enummodule
|
132
|
+
Report = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.channel.v1.Report").msgclass
|
133
|
+
end
|
134
|
+
end
|
135
|
+
end
|
136
|
+
end
|
@@ -0,0 +1,76 @@
|
|
1
|
+
# Generated by the protocol buffer compiler. DO NOT EDIT!
|
2
|
+
# Source: google/cloud/channel/v1/reports_service.proto for package 'google.cloud.channel.v1'
|
3
|
+
# Original file comments:
|
4
|
+
# Copyright 2022 Google LLC
|
5
|
+
#
|
6
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
7
|
+
# you may not use this file except in compliance with the License.
|
8
|
+
# You may obtain a copy of the License at
|
9
|
+
#
|
10
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
11
|
+
#
|
12
|
+
# Unless required by applicable law or agreed to in writing, software
|
13
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
14
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
15
|
+
# See the License for the specific language governing permissions and
|
16
|
+
# limitations under the License.
|
17
|
+
#
|
18
|
+
|
19
|
+
require 'grpc'
|
20
|
+
require 'google/cloud/channel/v1/reports_service_pb'
|
21
|
+
|
22
|
+
module Google
|
23
|
+
module Cloud
|
24
|
+
module Channel
|
25
|
+
module V1
|
26
|
+
module CloudChannelReportsService
|
27
|
+
# CloudChannelReportsService lets Google Cloud resellers and
|
28
|
+
# distributors retrieve and combine a variety of data in Cloud Channel for
|
29
|
+
# multiple products (Google Cloud Platform (GCP), Google Voice, and
|
30
|
+
# Google Workspace.)
|
31
|
+
class Service
|
32
|
+
|
33
|
+
include ::GRPC::GenericService
|
34
|
+
|
35
|
+
self.marshal_class_method = :encode
|
36
|
+
self.unmarshal_class_method = :decode
|
37
|
+
self.service_name = 'google.cloud.channel.v1.CloudChannelReportsService'
|
38
|
+
|
39
|
+
# Begins generation of data for a given report. The report
|
40
|
+
# identifier is a UID (for example, `613bf59q`).
|
41
|
+
#
|
42
|
+
# Possible error codes:
|
43
|
+
#
|
44
|
+
# * PERMISSION_DENIED: The user doesn't have access to this report.
|
45
|
+
# * INVALID_ARGUMENT: Required request parameters are missing
|
46
|
+
# or invalid.
|
47
|
+
# * NOT_FOUND: The report identifier was not found.
|
48
|
+
# * INTERNAL: Any non-user error related to a technical issue
|
49
|
+
# in the backend. Contact Cloud Channel support.
|
50
|
+
# * UNKNOWN: Any non-user error related to a technical issue
|
51
|
+
# in the backend. Contact Cloud Channel support.
|
52
|
+
#
|
53
|
+
# Return value:
|
54
|
+
# The ID of a long-running operation.
|
55
|
+
#
|
56
|
+
# To get the results of the operation, call the GetOperation method of
|
57
|
+
# CloudChannelOperationsService. The Operation metadata contains an
|
58
|
+
# instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata].
|
59
|
+
#
|
60
|
+
# To get the results of report generation, call
|
61
|
+
# [CloudChannelReportsService.FetchReportResults][google.cloud.channel.v1.CloudChannelReportsService.FetchReportResults] with the
|
62
|
+
# [RunReportJobResponse.report_job][google.cloud.channel.v1.RunReportJobResponse.report_job].
|
63
|
+
rpc :RunReportJob, ::Google::Cloud::Channel::V1::RunReportJobRequest, ::Google::Longrunning::Operation
|
64
|
+
# Retrieves data generated by [CloudChannelReportsService.RunReportJob][google.cloud.channel.v1.CloudChannelReportsService.RunReportJob].
|
65
|
+
rpc :FetchReportResults, ::Google::Cloud::Channel::V1::FetchReportResultsRequest, ::Google::Cloud::Channel::V1::FetchReportResultsResponse
|
66
|
+
# Lists the reports that RunReportJob can run. These reports include an ID,
|
67
|
+
# a description, and the list of columns that will be in the result.
|
68
|
+
rpc :ListReports, ::Google::Cloud::Channel::V1::ListReportsRequest, ::Google::Cloud::Channel::V1::ListReportsResponse
|
69
|
+
end
|
70
|
+
|
71
|
+
Stub = Service.rpc_stub_class
|
72
|
+
end
|
73
|
+
end
|
74
|
+
end
|
75
|
+
end
|
76
|
+
end
|
@@ -209,7 +209,8 @@ module Google
|
|
209
209
|
#
|
210
210
|
# * PERMISSION_DENIED:
|
211
211
|
# * The customer doesn't belong to the reseller and has no auth token.
|
212
|
-
# * The
|
212
|
+
# * The customer provided incorrect reseller information when generating
|
213
|
+
# auth token.
|
213
214
|
# * The reseller account making the request is different
|
214
215
|
# from the reseller account in the query.
|
215
216
|
# * INVALID_ARGUMENT: Required request parameters are missing or invalid.
|
@@ -16,6 +16,7 @@
|
|
16
16
|
|
17
17
|
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
18
18
|
|
19
|
+
require "google/cloud/channel/v1/cloud_channel_reports_service"
|
19
20
|
require "google/cloud/channel/v1/cloud_channel_service"
|
20
21
|
require "google/cloud/channel/v1/version"
|
21
22
|
|
@@ -28,7 +29,7 @@ module Google
|
|
28
29
|
# @example
|
29
30
|
#
|
30
31
|
# require "google/cloud/channel/v1"
|
31
|
-
# client = ::Google::Cloud::Channel::V1::
|
32
|
+
# client = ::Google::Cloud::Channel::V1::CloudChannelReportsService::Client.new
|
32
33
|
#
|
33
34
|
module V1
|
34
35
|
end
|