google-cloud-channel-v1 0.14.0 → 0.15.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -21,11 +21,12 @@ module Google
21
21
  module Cloud
22
22
  module Channel
23
23
  module V1
24
- # Request message for {::Google::Cloud::Channel::V1::CloudChannelReportsService::Client#run_report_job CloudChannelReportsService.RunReportJob}.
24
+ # Request message for
25
+ # {::Google::Cloud::Channel::V1::CloudChannelReportsService::Client#run_report_job CloudChannelReportsService.RunReportJob}.
25
26
  # @!attribute [rw] name
26
27
  # @return [::String]
27
- # Required. The report's resource name. Specifies the account and report used to
28
- # generate report data. The report_id identifier is a UID (for example,
28
+ # Required. The report's resource name. Specifies the account and report used
29
+ # to generate report data. The report_id identifier is a UID (for example,
29
30
  # `613bf59q`).
30
31
  # Name uses the format:
31
32
  # accounts/\\{account_id}/reports/\\{report_id}
@@ -34,8 +35,8 @@ module Google
34
35
  # Optional. The range of usage or invoice dates to include in the result.
35
36
  # @!attribute [rw] filter
36
37
  # @return [::String]
37
- # Optional. A structured string that defines conditions on dimension columns to
38
- # restrict the report output.
38
+ # Optional. A structured string that defines conditions on dimension columns
39
+ # to restrict the report output.
39
40
  #
40
41
  # Filters support logical operators (AND, OR, NOT) and conditional operators
41
42
  # (=, !=, <, >, <=, and >=) using `column_id` as keys.
@@ -55,10 +56,12 @@ module Google
55
56
  extend ::Google::Protobuf::MessageExts::ClassMethods
56
57
  end
57
58
 
58
- # Response message for {::Google::Cloud::Channel::V1::CloudChannelReportsService::Client#run_report_job CloudChannelReportsService.RunReportJob}.
59
+ # Response message for
60
+ # {::Google::Cloud::Channel::V1::CloudChannelReportsService::Client#run_report_job CloudChannelReportsService.RunReportJob}.
59
61
  # @!attribute [rw] report_job
60
62
  # @return [::Google::Cloud::Channel::V1::ReportJob]
61
- # Pass `report_job.name` to {::Google::Cloud::Channel::V1::FetchReportResultsRequest#report_job FetchReportResultsRequest.report_job}
63
+ # Pass `report_job.name` to
64
+ # {::Google::Cloud::Channel::V1::FetchReportResultsRequest#report_job FetchReportResultsRequest.report_job}
62
65
  # to retrieve the report's results.
63
66
  # @!attribute [rw] report_metadata
64
67
  # @return [::Google::Cloud::Channel::V1::ReportResultsMetadata]
@@ -70,17 +73,19 @@ module Google
70
73
  extend ::Google::Protobuf::MessageExts::ClassMethods
71
74
  end
72
75
 
73
- # Request message for {::Google::Cloud::Channel::V1::CloudChannelReportsService::Client#fetch_report_results CloudChannelReportsService.FetchReportResults}.
76
+ # Request message for
77
+ # {::Google::Cloud::Channel::V1::CloudChannelReportsService::Client#fetch_report_results CloudChannelReportsService.FetchReportResults}.
74
78
  # @!attribute [rw] report_job
75
79
  # @return [::String]
76
- # Required. The report job created by {::Google::Cloud::Channel::V1::CloudChannelReportsService::Client#run_report_job CloudChannelReportsService.RunReportJob}.
80
+ # Required. The report job created by
81
+ # {::Google::Cloud::Channel::V1::CloudChannelReportsService::Client#run_report_job CloudChannelReportsService.RunReportJob}.
77
82
  # Report_job uses the format:
78
83
  # accounts/\\{account_id}/reportJobs/\\{report_job_id}
79
84
  # @!attribute [rw] page_size
80
85
  # @return [::Integer]
81
- # Optional. Requested page size of the report. The server may return fewer results than
82
- # requested. If you don't specify a page size, the server uses a sensible
83
- # default (may change over time).
86
+ # Optional. Requested page size of the report. The server may return fewer
87
+ # results than requested. If you don't specify a page size, the server uses a
88
+ # sensible default (may change over time).
84
89
  #
85
90
  # The maximum value is 30,000; the server will change larger values to
86
91
  # 30,000.
@@ -88,14 +93,17 @@ module Google
88
93
  # @return [::String]
89
94
  # Optional. A token that specifies a page of results beyond the first page.
90
95
  # Obtained through
91
- # {::Google::Cloud::Channel::V1::FetchReportResultsResponse#next_page_token FetchReportResultsResponse.next_page_token} of the previous
92
- # {::Google::Cloud::Channel::V1::CloudChannelReportsService::Client#fetch_report_results CloudChannelReportsService.FetchReportResults} call.
96
+ # {::Google::Cloud::Channel::V1::FetchReportResultsResponse#next_page_token FetchReportResultsResponse.next_page_token}
97
+ # of the previous
98
+ # {::Google::Cloud::Channel::V1::CloudChannelReportsService::Client#fetch_report_results CloudChannelReportsService.FetchReportResults}
99
+ # call.
93
100
  class FetchReportResultsRequest
94
101
  include ::Google::Protobuf::MessageExts
95
102
  extend ::Google::Protobuf::MessageExts::ClassMethods
96
103
  end
97
104
 
98
- # Response message for {::Google::Cloud::Channel::V1::CloudChannelReportsService::Client#fetch_report_results CloudChannelReportsService.FetchReportResults}.
105
+ # Response message for
106
+ # {::Google::Cloud::Channel::V1::CloudChannelReportsService::Client#fetch_report_results CloudChannelReportsService.FetchReportResults}.
99
107
  # Contains a tabular representation of the report results.
100
108
  # @!attribute [rw] report_metadata
101
109
  # @return [::Google::Cloud::Channel::V1::ReportResultsMetadata]
@@ -107,30 +115,33 @@ module Google
107
115
  # of the columns from `report_metadata`.
108
116
  # @!attribute [rw] next_page_token
109
117
  # @return [::String]
110
- # Pass this token to {::Google::Cloud::Channel::V1::FetchReportResultsRequest#page_token FetchReportResultsRequest.page_token} to retrieve
111
- # the next page of results.
118
+ # Pass this token to
119
+ # {::Google::Cloud::Channel::V1::FetchReportResultsRequest#page_token FetchReportResultsRequest.page_token}
120
+ # to retrieve the next page of results.
112
121
  class FetchReportResultsResponse
113
122
  include ::Google::Protobuf::MessageExts
114
123
  extend ::Google::Protobuf::MessageExts::ClassMethods
115
124
  end
116
125
 
117
- # Request message for {::Google::Cloud::Channel::V1::CloudChannelReportsService::Client#list_reports CloudChannelReportsService.ListReports}.
126
+ # Request message for
127
+ # {::Google::Cloud::Channel::V1::CloudChannelReportsService::Client#list_reports CloudChannelReportsService.ListReports}.
118
128
  # @!attribute [rw] parent
119
129
  # @return [::String]
120
- # Required. The resource name of the partner account to list available reports for.
121
- # Parent uses the format:
122
- # accounts/\\{account_id}
130
+ # Required. The resource name of the partner account to list available
131
+ # reports for. Parent uses the format: accounts/\\{account_id}
123
132
  # @!attribute [rw] page_size
124
133
  # @return [::Integer]
125
- # Optional. Requested page size of the report. The server might return fewer results
126
- # than requested. If unspecified, returns 20 reports.
127
- # The maximum value is 100.
134
+ # Optional. Requested page size of the report. The server might return fewer
135
+ # results than requested. If unspecified, returns 20 reports. The maximum
136
+ # value is 100.
128
137
  # @!attribute [rw] page_token
129
138
  # @return [::String]
130
139
  # Optional. A token that specifies a page of results beyond the first page.
131
140
  # Obtained through
132
- # {::Google::Cloud::Channel::V1::ListReportsResponse#next_page_token ListReportsResponse.next_page_token} of the previous
133
- # {::Google::Cloud::Channel::V1::CloudChannelReportsService::Client#list_reports CloudChannelReportsService.ListReports} call.
141
+ # {::Google::Cloud::Channel::V1::ListReportsResponse#next_page_token ListReportsResponse.next_page_token}
142
+ # of the previous
143
+ # {::Google::Cloud::Channel::V1::CloudChannelReportsService::Client#list_reports CloudChannelReportsService.ListReports}
144
+ # call.
134
145
  # @!attribute [rw] language_code
135
146
  # @return [::String]
136
147
  # Optional. The BCP-47 language code, such as "en-US". If specified, the
@@ -142,21 +153,24 @@ module Google
142
153
  extend ::Google::Protobuf::MessageExts::ClassMethods
143
154
  end
144
155
 
145
- # Response message for {::Google::Cloud::Channel::V1::CloudChannelReportsService::Client#list_reports CloudChannelReportsService.ListReports}.
156
+ # Response message for
157
+ # {::Google::Cloud::Channel::V1::CloudChannelReportsService::Client#list_reports CloudChannelReportsService.ListReports}.
146
158
  # @!attribute [rw] reports
147
159
  # @return [::Array<::Google::Cloud::Channel::V1::Report>]
148
160
  # The reports available to the partner.
149
161
  # @!attribute [rw] next_page_token
150
162
  # @return [::String]
151
- # Pass this token to {::Google::Cloud::Channel::V1::FetchReportResultsRequest#page_token FetchReportResultsRequest.page_token} to retrieve
152
- # the next page of results.
163
+ # Pass this token to
164
+ # {::Google::Cloud::Channel::V1::FetchReportResultsRequest#page_token FetchReportResultsRequest.page_token}
165
+ # to retrieve the next page of results.
153
166
  class ListReportsResponse
154
167
  include ::Google::Protobuf::MessageExts
155
168
  extend ::Google::Protobuf::MessageExts::ClassMethods
156
169
  end
157
170
 
158
171
  # The result of a [RunReportJob][] operation. Contains the name to use in
159
- # {::Google::Cloud::Channel::V1::FetchReportResultsRequest#report_job FetchReportResultsRequest.report_job} and the status of the operation.
172
+ # {::Google::Cloud::Channel::V1::FetchReportResultsRequest#report_job FetchReportResultsRequest.report_job}
173
+ # and the status of the operation.
160
174
  # @!attribute [rw] name
161
175
  # @return [::String]
162
176
  # Required. The resource name of a report job.
@@ -171,7 +185,8 @@ module Google
171
185
  end
172
186
 
173
187
  # The features describing the data. Returned by
174
- # {::Google::Cloud::Channel::V1::CloudChannelReportsService::Client#run_report_job CloudChannelReportsService.RunReportJob} and
188
+ # {::Google::Cloud::Channel::V1::CloudChannelReportsService::Client#run_report_job CloudChannelReportsService.RunReportJob}
189
+ # and
175
190
  # {::Google::Cloud::Channel::V1::CloudChannelReportsService::Client#fetch_report_results CloudChannelReportsService.FetchReportResults}.
176
191
  # @!attribute [rw] report
177
192
  # @return [::Google::Cloud::Channel::V1::Report]
@@ -348,9 +363,9 @@ module Google
348
363
  # For example, "GCP Daily Spend", "Google Workspace License Activity", etc.
349
364
  # @!attribute [rw] name
350
365
  # @return [::String]
351
- # Required. The report's resource name. Specifies the account and report used to
352
- # generate report data. The report_id identifier is a UID
353
- # (for example, `613bf59q`).
366
+ # Required. The report's resource name. Specifies the account and report used
367
+ # to generate report data. The report_id identifier is a UID (for example,
368
+ # `613bf59q`).
354
369
  #
355
370
  # Name uses the format:
356
371
  # accounts/\\{account_id}/reports/\\{report_id}
@@ -29,13 +29,14 @@ module Google
29
29
  # accounts/\\{account_id}/customers/\\{customer_id}/customerRepricingConfigs/\\{id}.
30
30
  # @!attribute [rw] repricing_config
31
31
  # @return [::Google::Cloud::Channel::V1::RepricingConfig]
32
- # Required. The configuration for bill modifications made by a reseller before
33
- # sending it to customers.
32
+ # Required. The configuration for bill modifications made by a reseller
33
+ # before sending it to customers.
34
34
  # @!attribute [r] update_time
35
35
  # @return [::Google::Protobuf::Timestamp]
36
- # Output only. Timestamp of an update to the repricing rule. If `update_time` is after
37
- # {::Google::Cloud::Channel::V1::RepricingConfig#effective_invoice_month RepricingConfig.effective_invoice_month} then it indicates this was set
38
- # mid-month.
36
+ # Output only. Timestamp of an update to the repricing rule. If `update_time`
37
+ # is after
38
+ # {::Google::Cloud::Channel::V1::RepricingConfig#effective_invoice_month RepricingConfig.effective_invoice_month}
39
+ # then it indicates this was set mid-month.
39
40
  class CustomerRepricingConfig
40
41
  include ::Google::Protobuf::MessageExts
41
42
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -50,13 +51,14 @@ module Google
50
51
  # accounts/\\{account_id}/channelPartnerLinks/\\{channel_partner_id}/channelPartnerRepricingConfigs/\\{id}.
51
52
  # @!attribute [rw] repricing_config
52
53
  # @return [::Google::Cloud::Channel::V1::RepricingConfig]
53
- # Required. The configuration for bill modifications made by a reseller before
54
- # sending it to ChannelPartner.
54
+ # Required. The configuration for bill modifications made by a reseller
55
+ # before sending it to ChannelPartner.
55
56
  # @!attribute [r] update_time
56
57
  # @return [::Google::Protobuf::Timestamp]
57
- # Output only. Timestamp of an update to the repricing rule. If `update_time` is after
58
- # {::Google::Cloud::Channel::V1::RepricingConfig#effective_invoice_month RepricingConfig.effective_invoice_month} then it indicates this was set
59
- # mid-month.
58
+ # Output only. Timestamp of an update to the repricing rule. If `update_time`
59
+ # is after
60
+ # {::Google::Cloud::Channel::V1::RepricingConfig#effective_invoice_month RepricingConfig.effective_invoice_month}
61
+ # then it indicates this was set mid-month.
60
62
  class ChannelPartnerRepricingConfig
61
63
  include ::Google::Protobuf::MessageExts
62
64
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -73,15 +75,21 @@ module Google
73
75
  # This is the only supported value for ChannelPartnerRepricingConfig.
74
76
  # @!attribute [rw] effective_invoice_month
75
77
  # @return [::Google::Type::Date]
76
- # Required. The YearMonth when these adjustments activate. The Day field needs to be
77
- # "0" since we only accept YearMonth repricing boundaries.
78
+ # Required. The YearMonth when these adjustments activate. The Day field
79
+ # needs to be "0" since we only accept YearMonth repricing boundaries.
78
80
  # @!attribute [rw] adjustment
79
81
  # @return [::Google::Cloud::Channel::V1::RepricingAdjustment]
80
82
  # Required. Information about the adjustment.
81
83
  # @!attribute [rw] rebilling_basis
82
84
  # @return [::Google::Cloud::Channel::V1::RebillingBasis]
83
- # Required. The {::Google::Cloud::Channel::V1::RebillingBasis RebillingBasis} to use for this bill. Specifies the relative cost
84
- # based on repricing costs you will apply.
85
+ # Required. The {::Google::Cloud::Channel::V1::RebillingBasis RebillingBasis} to
86
+ # use for this bill. Specifies the relative cost based on repricing costs you
87
+ # will apply.
88
+ # @!attribute [rw] conditional_overrides
89
+ # @return [::Array<::Google::Cloud::Channel::V1::ConditionalOverride>]
90
+ # The conditional overrides to apply for this configuration. If you list
91
+ # multiple overrides, only the first valid override is used. If you don't
92
+ # list any overrides, the API uses the normal adjustment and rebilling basis.
85
93
  class RepricingConfig
86
94
  include ::Google::Protobuf::MessageExts
87
95
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -128,6 +136,47 @@ module Google
128
136
  extend ::Google::Protobuf::MessageExts::ClassMethods
129
137
  end
130
138
 
139
+ # Specifies the override to conditionally apply.
140
+ # @!attribute [rw] adjustment
141
+ # @return [::Google::Cloud::Channel::V1::RepricingAdjustment]
142
+ # Required. Information about the applied override's adjustment.
143
+ # @!attribute [rw] rebilling_basis
144
+ # @return [::Google::Cloud::Channel::V1::RebillingBasis]
145
+ # Required. The {::Google::Cloud::Channel::V1::RebillingBasis RebillingBasis} to
146
+ # use for the applied override. Shows the relative cost based on your
147
+ # repricing costs.
148
+ # @!attribute [rw] repricing_condition
149
+ # @return [::Google::Cloud::Channel::V1::RepricingCondition]
150
+ # Required. Specifies the condition which, if met, will apply the override.
151
+ class ConditionalOverride
152
+ include ::Google::Protobuf::MessageExts
153
+ extend ::Google::Protobuf::MessageExts::ClassMethods
154
+ end
155
+
156
+ # Represents the various repricing conditions you can use for a conditional
157
+ # override.
158
+ # @!attribute [rw] sku_group_condition
159
+ # @return [::Google::Cloud::Channel::V1::SkuGroupCondition]
160
+ # SKU Group condition for override.
161
+ class RepricingCondition
162
+ include ::Google::Protobuf::MessageExts
163
+ extend ::Google::Protobuf::MessageExts::ClassMethods
164
+ end
165
+
166
+ # A condition that applies the override if a line item SKU is found in the SKU
167
+ # group.
168
+ # @!attribute [rw] sku_group
169
+ # @return [::String]
170
+ # Specifies a SKU group (https://cloud.google.com/skus/sku-groups).
171
+ # Resource name of SKU group. Format:
172
+ # accounts/\\{account}/skuGroups/\\{sku_group}.
173
+ # Example:
174
+ # "accounts/C01234/skuGroups/3d50fd57-3157-4577-a5a9-a219b8490041".
175
+ class SkuGroupCondition
176
+ include ::Google::Protobuf::MessageExts
177
+ extend ::Google::Protobuf::MessageExts::ClassMethods
178
+ end
179
+
131
180
  # Specifies the different costs that the modified bill can be based on.
132
181
  module RebillingBasis
133
182
  # Not used.