google-cloud-channel-v1 0.1.1 → 0.6.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,58 @@
1
+ # Generated by the protocol buffer compiler. DO NOT EDIT!
2
+ # source: google/cloud/channel/v1/subscriber_event.proto
3
+
4
+ require 'google/protobuf'
5
+
6
+ require 'google/api/resource_pb'
7
+ require 'google/api/annotations_pb'
8
+ Google::Protobuf::DescriptorPool.generated_pool.build do
9
+ add_file("google/cloud/channel/v1/subscriber_event.proto", :syntax => :proto3) do
10
+ add_message "google.cloud.channel.v1.CustomerEvent" do
11
+ optional :customer, :string, 1
12
+ optional :event_type, :enum, 2, "google.cloud.channel.v1.CustomerEvent.Type"
13
+ end
14
+ add_enum "google.cloud.channel.v1.CustomerEvent.Type" do
15
+ value :TYPE_UNSPECIFIED, 0
16
+ value :PRIMARY_DOMAIN_CHANGED, 1
17
+ value :PRIMARY_DOMAIN_VERIFIED, 2
18
+ end
19
+ add_message "google.cloud.channel.v1.EntitlementEvent" do
20
+ optional :entitlement, :string, 1
21
+ optional :event_type, :enum, 2, "google.cloud.channel.v1.EntitlementEvent.Type"
22
+ end
23
+ add_enum "google.cloud.channel.v1.EntitlementEvent.Type" do
24
+ value :TYPE_UNSPECIFIED, 0
25
+ value :CREATED, 1
26
+ value :PRICE_PLAN_SWITCHED, 3
27
+ value :COMMITMENT_CHANGED, 4
28
+ value :RENEWED, 5
29
+ value :SUSPENDED, 6
30
+ value :ACTIVATED, 7
31
+ value :CANCELLED, 8
32
+ value :SKU_CHANGED, 9
33
+ value :RENEWAL_SETTING_CHANGED, 10
34
+ value :PAID_SERVICE_STARTED, 11
35
+ value :LICENSE_ASSIGNMENT_CHANGED, 12
36
+ end
37
+ add_message "google.cloud.channel.v1.SubscriberEvent" do
38
+ oneof :event do
39
+ optional :customer_event, :message, 1, "google.cloud.channel.v1.CustomerEvent"
40
+ optional :entitlement_event, :message, 2, "google.cloud.channel.v1.EntitlementEvent"
41
+ end
42
+ end
43
+ end
44
+ end
45
+
46
+ module Google
47
+ module Cloud
48
+ module Channel
49
+ module V1
50
+ CustomerEvent = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.channel.v1.CustomerEvent").msgclass
51
+ CustomerEvent::Type = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.channel.v1.CustomerEvent.Type").enummodule
52
+ EntitlementEvent = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.channel.v1.EntitlementEvent").msgclass
53
+ EntitlementEvent::Type = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.channel.v1.EntitlementEvent.Type").enummodule
54
+ SubscriberEvent = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.channel.v1.SubscriberEvent").msgclass
55
+ end
56
+ end
57
+ end
58
+ end
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module Channel
23
23
  module V1
24
- VERSION = "0.1.1"
24
+ VERSION = "0.6.0"
25
25
  end
26
26
  end
27
27
  end
@@ -54,6 +54,12 @@ module Google
54
54
  # This indicates that the field may be set once in a request to create a
55
55
  # resource, but may not be changed thereafter.
56
56
  IMMUTABLE = 5
57
+
58
+ # Denotes that a (repeated) field is an unordered list.
59
+ # This indicates that the service may provide the elements of the list
60
+ # in any arbitrary order, rather than the order the user originally
61
+ # provided. Additionally, the list's order may or may not be stable.
62
+ UNORDERED_LIST = 6
57
63
  end
58
64
  end
59
65
  end
@@ -82,9 +82,13 @@ module Google
82
82
  # @!attribute [r] primary_domain
83
83
  # @return [::String]
84
84
  # Output only. The primary domain name.
85
- # @!attribute [rw] is_domain_verified
85
+ # @!attribute [r] is_domain_verified
86
86
  # @return [::Boolean]
87
- # Whether the domain is verified.
87
+ # Output only. Whether the domain is verified.
88
+ # This field is not returned for a Customer's cloud_identity_info resource.
89
+ # Partners can use the domains.get() method of the Workspace SDK's
90
+ # Directory API, or listen to the PRIMARY_DOMAIN_VERIFIED Pub/Sub event in
91
+ # to track domain verification of their resolve Workspace customers.
88
92
  # @!attribute [rw] alternate_email
89
93
  # @return [::String]
90
94
  # The alternate email.
@@ -130,6 +134,9 @@ module Google
130
134
  # @!attribute [rw] proto_value
131
135
  # @return [::Google::Protobuf::Any]
132
136
  # Represents an 'Any' proto value.
137
+ # @!attribute [rw] bool_value
138
+ # @return [::Boolean]
139
+ # Represents a boolean value.
133
140
  class Value
134
141
  include ::Google::Protobuf::MessageExts
135
142
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -33,6 +33,7 @@ module Google
33
33
  # @return [::Google::Type::PostalAddress]
34
34
  # Required. Address of the organization of the customer entity.
35
35
  # Region and zip codes are required to enforce US laws and embargoes.
36
+ # Valid address lines are required for all customers.
36
37
  # Language code is discarded. Use the Customer-level language code to set the
37
38
  # customer's language.
38
39
  # @!attribute [rw] primary_contact_info
@@ -203,18 +203,15 @@ module Google
203
203
  # TransferableSku represents information a reseller needs to view existing
204
204
  # provisioned services for a customer that they do not own.
205
205
  # Read-only.
206
- # @!attribute [rw] is_commitment
207
- # @return [::Google::Protobuf::BoolValue]
208
- # Whether a transferable SKU is commitment-based or not.
209
- # @!attribute [rw] commitment_end_timestamp
210
- # @return [::Google::Protobuf::Timestamp]
211
- # Commitment end timestamp.
212
206
  # @!attribute [rw] transfer_eligibility
213
207
  # @return [::Google::Cloud::Channel::V1::TransferEligibility]
214
208
  # Describes the transfer eligibility of a SKU.
215
209
  # @!attribute [rw] sku
216
210
  # @return [::Google::Cloud::Channel::V1::Sku]
217
211
  # The SKU pertaining to the provisioning resource as specified in the Offer.
212
+ # @!attribute [rw] legacy_sku
213
+ # @return [::Google::Cloud::Channel::V1::Sku]
214
+ # Optional. The customer to transfer has an entitlement with the populated legacy SKU.
218
215
  class TransferableSku
219
216
  include ::Google::Protobuf::MessageExts
220
217
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -147,6 +147,10 @@ module Google
147
147
  # For Regular Offers with a trial period, the regular pricing goes into
148
148
  # effect when trial period ends, or if paid service is started before the end
149
149
  # of the trial period.
150
+ # @!attribute [rw] billing_account
151
+ # @return [::String]
152
+ # Reseller Billing account to charge after an offer transaction.
153
+ # Only present for Google Cloud Platform offers.
150
154
  class Plan
151
155
  include ::Google::Protobuf::MessageExts
152
156
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -24,35 +24,34 @@ module Google
24
24
  # Request message for {::Google::Cloud::Channel::V1::CloudChannelService::Client#check_cloud_identity_accounts_exist CloudChannelService.CheckCloudIdentityAccountsExist}.
25
25
  # @!attribute [rw] parent
26
26
  # @return [::String]
27
- # Required. The resource name of the reseller account.
28
- # The parent takes the format: accounts/\\{account_id}
27
+ # Required. The reseller account's resource name.
28
+ # Parent uses the format: accounts/\\{account_id}
29
29
  # @!attribute [rw] domain
30
30
  # @return [::String]
31
- # Required. Domain for which the Cloud Identity account customer is fetched.
31
+ # Required. Domain to fetch for Cloud Identity account customer.
32
32
  class CheckCloudIdentityAccountsExistRequest
33
33
  include ::Google::Protobuf::MessageExts
34
34
  extend ::Google::Protobuf::MessageExts::ClassMethods
35
35
  end
36
36
 
37
- # Entity representing a Cloud Identity account which may or may not be
37
+ # Entity representing a Cloud Identity account that may be
38
38
  # associated with a Channel Services API partner.
39
39
  # @!attribute [rw] existing
40
40
  # @return [::Boolean]
41
- # True if a Cloud Identity account exists for a specific domain.
41
+ # Returns true if a Cloud Identity account exists for a specific domain.
42
42
  # @!attribute [rw] owned
43
43
  # @return [::Boolean]
44
- # True if the Cloud Identity account is associated with a customer
45
- # belonging to the Channel Services partner making the API call.
44
+ # Returns true if the Cloud Identity account is associated with a customer
45
+ # of the Channel Services partner.
46
46
  # @!attribute [rw] customer_name
47
47
  # @return [::String]
48
- # Name of the customer that owns the Cloud Identity account. This field is
49
- # populated ONLY if owned = true.
50
- # The customer_name takes the format:
48
+ # If owned = true, the name of the customer that owns the Cloud Identity
49
+ # account.
50
+ # Customer_name uses the format:
51
51
  # accounts/\\{account_id}/customers/\\{customer_id}
52
52
  # @!attribute [rw] customer_cloud_identity_id
53
53
  # @return [::String]
54
- # Cloud Identity ID of the customer. This field is populated ONLY if
55
- # existing = true.
54
+ # If existing = true, the Cloud Identity ID of the customer.
56
55
  class CloudIdentityCustomerAccount
57
56
  include ::Google::Protobuf::MessageExts
58
57
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -71,17 +70,17 @@ module Google
71
70
  # Request message for {::Google::Cloud::Channel::V1::CloudChannelService::Client#list_customers CloudChannelService.ListCustomers}
72
71
  # @!attribute [rw] parent
73
72
  # @return [::String]
74
- # Required. The resource name of the reseller account from which to list customers.
75
- # The parent takes the format: accounts/\\{account_id}.
73
+ # Required. The resource name of the reseller account to list customers from.
74
+ # Parent uses the format: accounts/\\{account_id}.
76
75
  # @!attribute [rw] page_size
77
76
  # @return [::Integer]
78
77
  # Optional. The maximum number of customers to return. The service may return fewer
79
- # than this value. If unspecified, at most 10 customers will be returned. The
80
- # maximum value is 50; values about 50 will be coerced to 50.
78
+ # than this value. If unspecified, returns at most 10 customers. The
79
+ # maximum value is 50.
81
80
  # @!attribute [rw] page_token
82
81
  # @return [::String]
83
- # Optional. A token identifying a page of results, if other than the first one.
84
- # Typically obtained via
82
+ # Optional. A token identifying a page of results other than the first page.
83
+ # Obtained through
85
84
  # {::Google::Cloud::Channel::V1::ListCustomersResponse#next_page_token ListCustomersResponse.next_page_token} of the previous
86
85
  # {::Google::Cloud::Channel::V1::CloudChannelService::Client#list_customers CloudChannelService.ListCustomers} call.
87
86
  class ListCustomersRequest
@@ -92,7 +91,7 @@ module Google
92
91
  # Response message for {::Google::Cloud::Channel::V1::CloudChannelService::Client#list_customers CloudChannelService.ListCustomers}.
93
92
  # @!attribute [rw] customers
94
93
  # @return [::Array<::Google::Cloud::Channel::V1::Customer>]
95
- # The customers belonging to the reseller or distributor.
94
+ # The customers belonging to a reseller or distributor.
96
95
  # @!attribute [rw] next_page_token
97
96
  # @return [::String]
98
97
  # A token to retrieve the next page of results.
@@ -106,7 +105,7 @@ module Google
106
105
  # @!attribute [rw] name
107
106
  # @return [::String]
108
107
  # Required. The resource name of the customer to retrieve.
109
- # The name takes the format: accounts/\\{account_id}/customers/\\{customer_id}
108
+ # Name uses the format: accounts/\\{account_id}/customers/\\{customer_id}
110
109
  class GetCustomerRequest
111
110
  include ::Google::Protobuf::MessageExts
112
111
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -116,7 +115,7 @@ module Google
116
115
  # @!attribute [rw] parent
117
116
  # @return [::String]
118
117
  # Required. The resource name of reseller account in which to create the customer.
119
- # The parent takes the format: accounts/\\{account_id}
118
+ # Parent uses the format: accounts/\\{account_id}
120
119
  # @!attribute [rw] customer
121
120
  # @return [::Google::Cloud::Channel::V1::Customer]
122
121
  # Required. The customer to create.
@@ -160,8 +159,7 @@ module Google
160
159
  # Admin user information.
161
160
  # @!attribute [rw] validate_only
162
161
  # @return [::Boolean]
163
- # If set, validate the request and preview the review, but do not actually
164
- # post it.
162
+ # Validate the request and preview the review, but do not post it.
165
163
  class ProvisionCloudIdentityRequest
166
164
  include ::Google::Protobuf::MessageExts
167
165
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -170,18 +168,18 @@ module Google
170
168
  # Request message for {::Google::Cloud::Channel::V1::CloudChannelService::Client#list_entitlements CloudChannelService.ListEntitlements}
171
169
  # @!attribute [rw] parent
172
170
  # @return [::String]
173
- # Required. The resource name of the reseller's customer account for which to list
174
- # entitlements.
175
- # The parent takes the format: accounts/\\{account_id}/customers/\\{customer_id}
171
+ # Required. The resource name of the reseller's customer account to list
172
+ # entitlements for.
173
+ # Parent uses the format: accounts/\\{account_id}/customers/\\{customer_id}
176
174
  # @!attribute [rw] page_size
177
175
  # @return [::Integer]
178
176
  # Optional. Requested page size. Server might return fewer results than requested.
179
- # If unspecified, at most 50 entitlements will be returned.
180
- # The maximum value is 100; values above 100 will be coerced to 100.
177
+ # If unspecified, return at most 50 entitlements.
178
+ # The maximum value is 100; the server will coerce values above 100.
181
179
  # @!attribute [rw] page_token
182
180
  # @return [::String]
183
- # Optional. A token identifying a page of results, if other than the first one.
184
- # Typically obtained via
181
+ # Optional. A token for a page of results other than the first page.
182
+ # Obtained using
185
183
  # {::Google::Cloud::Channel::V1::ListEntitlementsResponse#next_page_token ListEntitlementsResponse.next_page_token} of the previous
186
184
  # {::Google::Cloud::Channel::V1::CloudChannelService::Client#list_entitlements CloudChannelService.ListEntitlements} call.
187
185
  class ListEntitlementsRequest
@@ -192,10 +190,10 @@ module Google
192
190
  # Response message for {::Google::Cloud::Channel::V1::CloudChannelService::Client#list_entitlements CloudChannelService.ListEntitlements}.
193
191
  # @!attribute [rw] entitlements
194
192
  # @return [::Array<::Google::Cloud::Channel::V1::Entitlement>]
195
- # The entitlements belonging to the reseller's customer.
193
+ # The reseller customer's entitlements.
196
194
  # @!attribute [rw] next_page_token
197
195
  # @return [::String]
198
- # A token to List next page of results.
196
+ # A token to list the next page of results.
199
197
  # Pass to {::Google::Cloud::Channel::V1::ListEntitlementsRequest#page_token ListEntitlementsRequest.page_token} to obtain that page.
200
198
  class ListEntitlementsResponse
201
199
  include ::Google::Protobuf::MessageExts
@@ -210,37 +208,36 @@ module Google
210
208
  # @return [::String]
211
209
  # A reseller is required to create a customer and use the resource name of
212
210
  # the created customer here.
213
- # The customer_name takes the format:
211
+ # Customer_name uses the format:
214
212
  # accounts/\\{account_id}/customers/\\{customer_id}
215
213
  # @!attribute [rw] parent
216
214
  # @return [::String]
217
- # Required. The resource name of the reseller's account.
218
- # The parent takes the format: accounts/\\{account_id}
215
+ # Required. The reseller account's resource name.
216
+ # Parent uses the format: accounts/\\{account_id}
219
217
  # @!attribute [rw] page_size
220
218
  # @return [::Integer]
221
- # Requested page size. Server might return fewer results than requested.
222
- # If unspecified, at most 100 SKUs will be returned.
223
- # The maximum value is 1000; values above 1000 will be coerced to 1000.
219
+ # The requested page size. Server might return fewer results than requested.
220
+ # If unspecified, returns at most 100 SKUs.
221
+ # The maximum value is 1000; the server will coerce values above 1000.
224
222
  # Optional.
225
223
  # @!attribute [rw] page_token
226
224
  # @return [::String]
227
- # A token identifying a page of results, if other than the first one.
228
- # Typically obtained via
225
+ # A token for a page of results other than the first page.
226
+ # Obtained using
229
227
  # {::Google::Cloud::Channel::V1::ListTransferableSkusResponse#next_page_token ListTransferableSkusResponse.next_page_token} of the previous
230
228
  # {::Google::Cloud::Channel::V1::CloudChannelService::Client#list_transferable_skus CloudChannelService.ListTransferableSkus} call.
231
229
  # Optional.
232
230
  # @!attribute [rw] auth_token
233
231
  # @return [::String]
234
- # This token is generated by the Super Admin of the resold customer to
232
+ # The super admin of the resold customer generates this token to
235
233
  # authorize a reseller to access their Cloud Identity and purchase
236
- # entitlements on their behalf. This token can be omitted once the
237
- # authorization is generated. See https://support.google.com/a/answer/7643790
238
- # for more details.
234
+ # entitlements on their behalf. You can omit this token after authorization.
235
+ # See https://support.google.com/a/answer/7643790 for more details.
239
236
  # @!attribute [rw] language_code
240
237
  # @return [::String]
241
- # The BCP-47 language code, such as "en-US". If specified, the
242
- # response will be localized to the corresponding language code. Default is
243
- # "en-US".
238
+ # The BCP-47 language code. For example, "en-US". The
239
+ # response will localize in the corresponding language code, if specified.
240
+ # The default value is "en-US".
244
241
  # Optional.
245
242
  class ListTransferableSkusRequest
246
243
  include ::Google::Protobuf::MessageExts
@@ -250,8 +247,7 @@ module Google
250
247
  # Response message for {::Google::Cloud::Channel::V1::CloudChannelService::Client#list_transferable_skus CloudChannelService.ListTransferableSkus}.
251
248
  # @!attribute [rw] transferable_skus
252
249
  # @return [::Array<::Google::Cloud::Channel::V1::TransferableSku>]
253
- # Information about existing SKUs for a customer that would need to be
254
- # transferred.
250
+ # Information about existing SKUs for a customer that needs a transfer.
255
251
  # @!attribute [rw] next_page_token
256
252
  # @return [::String]
257
253
  # A token to retrieve the next page of results.
@@ -269,29 +265,29 @@ module Google
269
265
  # @!attribute [rw] customer_name
270
266
  # @return [::String]
271
267
  # A reseller should create a customer and use the resource name of
272
- # the created customer here.
268
+ # that customer here.
273
269
  # @!attribute [rw] parent
274
270
  # @return [::String]
275
271
  # Required. The resource name of the reseller's account.
276
272
  # @!attribute [rw] page_size
277
273
  # @return [::Integer]
278
274
  # Requested page size. Server might return fewer results than requested.
279
- # If unspecified, at most 100 Offers will be returned.
280
- # The maximum value is 1000; values above 1000 will be coerced to 1000.
275
+ # If unspecified, returns at most 100 offers.
276
+ # The maximum value is 1000; the server will coerce values above 1000.
281
277
  # @!attribute [rw] page_token
282
278
  # @return [::String]
283
- # A token identifying a page of results, if other than the first one.
284
- # Typically obtained via
279
+ # A token for a page of results other than the first page.
280
+ # Obtained using
285
281
  # {::Google::Cloud::Channel::V1::ListTransferableOffersResponse#next_page_token ListTransferableOffersResponse.next_page_token} of the previous
286
282
  # {::Google::Cloud::Channel::V1::CloudChannelService::Client#list_transferable_offers CloudChannelService.ListTransferableOffers} call.
287
283
  # @!attribute [rw] sku
288
284
  # @return [::String]
289
- # Required. SKU for which the Offers are being looked up.
285
+ # Required. The SKU to look up Offers for.
290
286
  # @!attribute [rw] language_code
291
287
  # @return [::String]
292
- # The BCP-47 language code, such as "en-US". If specified, the
293
- # response will be localized to the corresponding language code. Default is
294
- # "en-US".
288
+ # The BCP-47 language code. For example, "en-US". The
289
+ # response will localize in the corresponding language code, if specified.
290
+ # The default value is "en-US".
295
291
  class ListTransferableOffersRequest
296
292
  include ::Google::Protobuf::MessageExts
297
293
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -326,8 +322,8 @@ module Google
326
322
  # @!attribute [rw] name
327
323
  # @return [::String]
328
324
  # Required. The resource name of the entitlement to retrieve.
329
- # The name takes the format:
330
- # accounts/\\{account_id}/customers/\\{customer_id}/entitlements/\\{id}
325
+ # Name uses the format:
326
+ # accounts/\\{account_id}/customers/\\{customer_id}/entitlements/\\{entitlement_id}
331
327
  class GetEntitlementRequest
332
328
  include ::Google::Protobuf::MessageExts
333
329
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -338,16 +334,16 @@ module Google
338
334
  # @return [::String]
339
335
  # Required. The resource name of the reseller account for listing channel partner
340
336
  # links.
341
- # The parent takes the format: accounts/\\{account_id}
337
+ # Parent uses the format: accounts/\\{account_id}
342
338
  # @!attribute [rw] page_size
343
339
  # @return [::Integer]
344
340
  # Optional. Requested page size. Server might return fewer results than requested.
345
341
  # If unspecified, server will pick a default size (25).
346
- # The maximum value is 200, values above 200 will be coerced to 200.
342
+ # The maximum value is 200; the server will coerce values above 200.
347
343
  # @!attribute [rw] page_token
348
344
  # @return [::String]
349
- # Optional. A token identifying a page of results, if other than the first one.
350
- # Typically obtained via
345
+ # Optional. A token for a page of results other than the first page.
346
+ # Obtained using
351
347
  # {::Google::Cloud::Channel::V1::ListChannelPartnerLinksResponse#next_page_token ListChannelPartnerLinksResponse.next_page_token} of the previous
352
348
  # {::Google::Cloud::Channel::V1::CloudChannelService::Client#list_channel_partner_links CloudChannelService.ListChannelPartnerLinks} call.
353
349
  # @!attribute [rw] view
@@ -375,7 +371,7 @@ module Google
375
371
  # @!attribute [rw] name
376
372
  # @return [::String]
377
373
  # Required. The resource name of the channel partner link to retrieve.
378
- # The name takes the format: accounts/\\{account_id}/channelPartnerLinks/\\{id}
374
+ # Name uses the format: accounts/\\{account_id}/channelPartnerLinks/\\{id}
379
375
  # where \\{id} is the Cloud Identity ID of the partner.
380
376
  # @!attribute [rw] view
381
377
  # @return [::Google::Cloud::Channel::V1::ChannelPartnerLinkView]
@@ -388,19 +384,14 @@ module Google
388
384
  # Request message for {::Google::Cloud::Channel::V1::CloudChannelService::Client#create_channel_partner_link CloudChannelService.CreateChannelPartnerLink}
389
385
  # @!attribute [rw] parent
390
386
  # @return [::String]
391
- # Required. The resource name of reseller's account for which to create a channel
392
- # partner link.
393
- # The parent takes the format: accounts/\\{account_id}
387
+ # Required. Create a channel partner link for the provided reseller account's
388
+ # resource name.
389
+ # Parent uses the format: accounts/\\{account_id}
394
390
  # @!attribute [rw] channel_partner_link
395
391
  # @return [::Google::Cloud::Channel::V1::ChannelPartnerLink]
396
392
  # Required. The channel partner link to create.
397
393
  # Either channel_partner_link.reseller_cloud_identity_id or domain can be
398
394
  # used to create a link.
399
- # @!attribute [rw] domain
400
- # @return [::String]
401
- # Optional. The invited partner's domain. Either domain or
402
- # channel_partner_link.reseller_cloud_identity_id can be used to create a
403
- # link.
404
395
  class CreateChannelPartnerLinkRequest
405
396
  include ::Google::Protobuf::MessageExts
406
397
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -410,16 +401,16 @@ module Google
410
401
  # @!attribute [rw] name
411
402
  # @return [::String]
412
403
  # Required. The resource name of the channel partner link to cancel.
413
- # The name takes the format: accounts/\\{account_id}/channelPartnerLinks/\\{id}
404
+ # Name uses the format: accounts/\\{account_id}/channelPartnerLinks/\\{id}
414
405
  # where \\{id} is the Cloud Identity ID of the partner.
415
406
  # @!attribute [rw] channel_partner_link
416
407
  # @return [::Google::Cloud::Channel::V1::ChannelPartnerLink]
417
- # Required. The channel partner link to update. Only field
418
- # channel_partner_link.link_state is allowed to be updated.
408
+ # Required. The channel partner link to update. Only channel_partner_link.link_state
409
+ # is allowed for updates.
419
410
  # @!attribute [rw] update_mask
420
411
  # @return [::Google::Protobuf::FieldMask]
421
412
  # Required. The update mask that applies to the resource.
422
- # The only allowable value for update mask is
413
+ # The only allowable value for an update mask is
423
414
  # channel_partner_link.link_state.
424
415
  class UpdateChannelPartnerLinkRequest
425
416
  include ::Google::Protobuf::MessageExts
@@ -429,22 +420,21 @@ module Google
429
420
  # Request message for {::Google::Cloud::Channel::V1::CloudChannelService::Client#create_entitlement CloudChannelService.CreateEntitlement}
430
421
  # @!attribute [rw] parent
431
422
  # @return [::String]
432
- # Required. The resource name of reseller's customer account in which to create the
423
+ # Required. The resource name of the reseller's customer account in which to create the
433
424
  # entitlement.
434
- # The parent takes the format: accounts/\\{account_id}/customers/\\{customer_id}
425
+ # Parent uses the format: accounts/\\{account_id}/customers/\\{customer_id}
435
426
  # @!attribute [rw] entitlement
436
427
  # @return [::Google::Cloud::Channel::V1::Entitlement]
437
428
  # Required. The entitlement to create.
438
429
  # @!attribute [rw] request_id
439
430
  # @return [::String]
440
- # Optional. An optional request ID to identify requests. Specify a unique request ID so
441
- # that if you must retry your request, the server will know to ignore the
442
- # request if it has already been completed.
431
+ # Optional. You can specify an optional unique request ID, and if you need to retry
432
+ # your request, the server will know to ignore the request if it's complete.
443
433
  #
444
- # For example, consider a situation where you make an initial request and
445
- # the request times out. If you make the request again with the same
446
- # request ID, the server can check if the original operation with the same
447
- # request ID was received, and if so, will ignore the second request.
434
+ # For example, you make an initial request and the request times out. If you
435
+ # make the request again with the same request ID, the server can check if
436
+ # it received the original operation with the same request ID. If it did, it
437
+ # will ignore the second request.
448
438
  #
449
439
  # The request ID must be a valid [UUID](https://tools.ietf.org/html/rfc4122)
450
440
  # with the exception that zero UUID is not supported
@@ -457,29 +447,27 @@ module Google
457
447
  # Request message for {::Google::Cloud::Channel::V1::CloudChannelService::Client#transfer_entitlements CloudChannelService.TransferEntitlements}.
458
448
  # @!attribute [rw] parent
459
449
  # @return [::String]
460
- # Required. The resource name of reseller's customer account where the entitlements
461
- # transfer to.
462
- # The parent takes the format: accounts/\\{account_id}/customers/\\{customer_id}
450
+ # Required. The resource name of the reseller's customer account that will receive
451
+ # transferred entitlements.
452
+ # Parent uses the format: accounts/\\{account_id}/customers/\\{customer_id}
463
453
  # @!attribute [rw] entitlements
464
454
  # @return [::Array<::Google::Cloud::Channel::V1::Entitlement>]
465
- # Required. The new entitlements to be created or transferred.
455
+ # Required. The new entitlements to create or transfer.
466
456
  # @!attribute [rw] auth_token
467
457
  # @return [::String]
468
- # This token is generated by the Super Admin of the resold customer to
458
+ # The super admin of the resold customer generates this token to
469
459
  # authorize a reseller to access their Cloud Identity and purchase
470
- # entitlements on their behalf. This token can be omitted once the
471
- # authorization is generated. See https://support.google.com/a/answer/7643790
472
- # for more details.
460
+ # entitlements on their behalf. You can omit this token after authorization.
461
+ # See https://support.google.com/a/answer/7643790 for more details.
473
462
  # @!attribute [rw] request_id
474
463
  # @return [::String]
475
- # Optional. An optional request ID to identify requests. Specify a unique request ID so
476
- # that if you must retry your request, the server will know to ignore the
477
- # request if it has already been completed.
464
+ # Optional. You can specify an optional unique request ID, and if you need to retry
465
+ # your request, the server will know to ignore the request if it's complete.
478
466
  #
479
- # For example, consider a situation where you make an initial request and
480
- # the request times out. If you make the request again with the same
481
- # request ID, the server can check if the original operation with the same
482
- # request ID was received, and if so, will ignore the second request.
467
+ # For example, you make an initial request and the request times out. If you
468
+ # make the request again with the same request ID, the server can check if
469
+ # it received the original operation with the same request ID. If it did, it
470
+ # will ignore the second request.
483
471
  #
484
472
  # The request ID must be a valid [UUID](https://tools.ietf.org/html/rfc4122)
485
473
  # with the exception that zero UUID is not supported
@@ -490,10 +478,10 @@ module Google
490
478
  end
491
479
 
492
480
  # Response message for {::Google::Cloud::Channel::V1::CloudChannelService::Client#transfer_entitlements CloudChannelService.TransferEntitlements}.
493
- # This will be put into the response field of google.longrunning.Operation.
481
+ # This is put in the response field of google.longrunning.Operation.
494
482
  # @!attribute [rw] entitlements
495
483
  # @return [::Array<::Google::Cloud::Channel::V1::Entitlement>]
496
- # The entitlements that have been transferred.
484
+ # The transferred entitlements.
497
485
  class TransferEntitlementsResponse
498
486
  include ::Google::Protobuf::MessageExts
499
487
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -502,22 +490,21 @@ module Google
502
490
  # Request message for {::Google::Cloud::Channel::V1::CloudChannelService::Client#transfer_entitlements_to_google CloudChannelService.TransferEntitlementsToGoogle}.
503
491
  # @!attribute [rw] parent
504
492
  # @return [::String]
505
- # Required. The resource name of reseller's customer account where the entitlements
493
+ # Required. The resource name of the reseller's customer account where the entitlements
506
494
  # transfer from.
507
- # The parent takes the format: accounts/\\{account_id}/customers/\\{customer_id}
495
+ # Parent uses the format: accounts/\\{account_id}/customers/\\{customer_id}
508
496
  # @!attribute [rw] entitlements
509
497
  # @return [::Array<::Google::Cloud::Channel::V1::Entitlement>]
510
- # Required. The entitlements to be transferred to Google.
498
+ # Required. The entitlements to transfer to Google.
511
499
  # @!attribute [rw] request_id
512
500
  # @return [::String]
513
- # Optional. An optional request ID to identify requests. Specify a unique request ID so
514
- # that if you must retry your request, the server will know to ignore the
515
- # request if it has already been completed.
501
+ # Optional. You can specify an optional unique request ID, and if you need to retry
502
+ # your request, the server will know to ignore the request if it's complete.
516
503
  #
517
- # For example, consider a situation where you make an initial request and
518
- # the request times out. If you make the request again with the same
519
- # request ID, the server can check if the original operation with the same
520
- # request ID was received, and if so, will ignore the second request.
504
+ # For example, you make an initial request and the request times out. If you
505
+ # make the request again with the same request ID, the server can check if
506
+ # it received the original operation with the same request ID. If it did, it
507
+ # will ignore the second request.
521
508
  #
522
509
  # The request ID must be a valid [UUID](https://tools.ietf.org/html/rfc4122)
523
510
  # with the exception that zero UUID is not supported
@@ -531,26 +518,23 @@ module Google
531
518
  # @!attribute [rw] name
532
519
  # @return [::String]
533
520
  # Required. The name of the entitlement to update.
534
- # The name takes the format:
521
+ # Name uses the format:
535
522
  # accounts/\\{account_id}/customers/\\{customer_id}/entitlements/\\{entitlement_id}
536
523
  # @!attribute [rw] parameters
537
524
  # @return [::Array<::Google::Cloud::Channel::V1::Parameter>]
538
- # Required. Entitlement parameters to update. Only editable parameters are allowed to
539
- # be changed.
525
+ # Required. Entitlement parameters to update. You can only change editable parameters.
540
526
  # @!attribute [rw] request_id
541
527
  # @return [::String]
542
- # Optional. An optional request ID to identify requests. Specify a unique request ID so
543
- # that if you must retry your request, the server will know to ignore the
544
- # request if it has already been completed.
528
+ # Optional. You can specify an optional unique request ID, and if you need to retry
529
+ # your request, the server will know to ignore the request if it's complete.
545
530
  #
546
- # For example, consider a situation where you make an initial request and
547
- # the request times out. If you make the request again with the same
548
- # request ID, the server can check if the original operation with the same
549
- # request ID was received, and if so, will ignore the second request.
531
+ # For example, you make an initial request and the request times out. If you
532
+ # make the request again with the same request ID, the server can check if
533
+ # it received the original operation with the same request ID. If it did, it
534
+ # will ignore the second request.
550
535
  #
551
- # The request ID must be
552
- # a valid [UUID](https://tools.ietf.org/html/rfc4122) with the exception that
553
- # zero UUID is not supported
536
+ # The request ID must be a valid [UUID](https://tools.ietf.org/html/rfc4122)
537
+ # with the exception that zero UUID is not supported
554
538
  # (`00000000-0000-0000-0000-000000000000`).
555
539
  # @!attribute [rw] purchase_order_id
556
540
  # @return [::String]
@@ -564,21 +548,20 @@ module Google
564
548
  # @!attribute [rw] name
565
549
  # @return [::String]
566
550
  # Required. The name of the entitlement to update.
567
- # The name takes the format:
551
+ # Name uses the format:
568
552
  # accounts/\\{account_id}/customers/\\{customer_id}/entitlements/\\{entitlement_id}
569
553
  # @!attribute [rw] renewal_settings
570
554
  # @return [::Google::Cloud::Channel::V1::RenewalSettings]
571
555
  # Required. New renewal settings.
572
556
  # @!attribute [rw] request_id
573
557
  # @return [::String]
574
- # Optional. A request ID to identify requests. Specify a unique request ID so
575
- # that if you must retry your request, the server will know to ignore the
576
- # request if it has already been completed.
558
+ # Optional. You can specify an optional unique request ID, and if you need to retry
559
+ # your request, the server will know to ignore the request if it's complete.
577
560
  #
578
- # For example, consider a situation where you make an initial request and
579
- # the request times out. If you make the request again with the same
580
- # request ID, the server can check if the original operation with the same
581
- # request ID was received, and if so, will ignore the second request.
561
+ # For example, you make an initial request and the request times out. If you
562
+ # make the request again with the same request ID, the server can check if
563
+ # it received the original operation with the same request ID. If it did, it
564
+ # will ignore the second request.
582
565
  #
583
566
  # The request ID must be a valid [UUID](https://tools.ietf.org/html/rfc4122)
584
567
  # with the exception that zero UUID is not supported
@@ -591,8 +574,8 @@ module Google
591
574
  # Request message for {::Google::Cloud::Channel::V1::CloudChannelService::Client#change_offer CloudChannelService.ChangeOffer}.
592
575
  # @!attribute [rw] name
593
576
  # @return [::String]
594
- # Required. The name of the entitlement to update.
595
- # Format:
577
+ # Required. The resource name of the entitlement to update.
578
+ # Name uses the format:
596
579
  # accounts/\\{account_id}/customers/\\{customer_id}/entitlements/\\{entitlement_id}
597
580
  # @!attribute [rw] offer
598
581
  # @return [::String]
@@ -606,14 +589,13 @@ module Google
606
589
  # Optional. Purchase order id provided by the reseller.
607
590
  # @!attribute [rw] request_id
608
591
  # @return [::String]
609
- # Optional. An optional request ID to identify requests. Specify a unique request ID so
610
- # that if you must retry your request, the server will know to ignore the
611
- # request if it has already been completed.
592
+ # Optional. You can specify an optional unique request ID, and if you need to retry
593
+ # your request, the server will know to ignore the request if it's complete.
612
594
  #
613
- # For example, consider a situation where you make an initial request and
614
- # the request times out. If you make the request again with the same
615
- # request ID, the server can check if the original operation with the same
616
- # request ID was received, and if so, will ignore the second request.
595
+ # For example, you make an initial request and the request times out. If you
596
+ # make the request again with the same request ID, the server can check if
597
+ # it received the original operation with the same request ID. If it did, it
598
+ # will ignore the second request.
617
599
  #
618
600
  # The request ID must be a valid [UUID](https://tools.ietf.org/html/rfc4122)
619
601
  # with the exception that zero UUID is not supported
@@ -626,19 +608,18 @@ module Google
626
608
  # Request message for {::Google::Cloud::Channel::V1::CloudChannelService::Client#start_paid_service CloudChannelService.StartPaidService}.
627
609
  # @!attribute [rw] name
628
610
  # @return [::String]
629
- # Required. The name of the entitlement for which paid service is being started.
630
- # The name takes the format:
611
+ # Required. The name of the entitlement to start a paid service for.
612
+ # Name uses the format:
631
613
  # accounts/\\{account_id}/customers/\\{customer_id}/entitlements/\\{entitlement_id}
632
614
  # @!attribute [rw] request_id
633
615
  # @return [::String]
634
- # Optional. An optional request ID to identify requests. Specify a unique request ID so
635
- # that if you must retry your request, the server will know to ignore the
636
- # request if it has already been completed.
616
+ # Optional. You can specify an optional unique request ID, and if you need to retry
617
+ # your request, the server will know to ignore the request if it's complete.
637
618
  #
638
- # For example, consider a situation where you make an initial request and
639
- # the request times out. If you make the request again with the same
640
- # request ID, the server can check if the original operation with the same
641
- # request ID was received, and if so, will ignore the second request.
619
+ # For example, you make an initial request and the request times out. If you
620
+ # make the request again with the same request ID, the server can check if
621
+ # it received the original operation with the same request ID. If it did, it
622
+ # will ignore the second request.
642
623
  #
643
624
  # The request ID must be a valid [UUID](https://tools.ietf.org/html/rfc4122)
644
625
  # with the exception that zero UUID is not supported
@@ -652,18 +633,17 @@ module Google
652
633
  # @!attribute [rw] name
653
634
  # @return [::String]
654
635
  # Required. The resource name of the entitlement to cancel.
655
- # The name takes the format:
636
+ # Name uses the format:
656
637
  # accounts/\\{account_id}/customers/\\{customer_id}/entitlements/\\{entitlement_id}
657
638
  # @!attribute [rw] request_id
658
639
  # @return [::String]
659
- # Optional. An optional request ID to identify requests. Specify a unique request ID so
660
- # that if you must retry your request, the server will know to ignore the
661
- # request if it has already been completed.
640
+ # Optional. You can specify an optional unique request ID, and if you need to retry
641
+ # your request, the server will know to ignore the request if it's complete.
662
642
  #
663
- # For example, consider a situation where you make an initial request and
664
- # the request times out. If you make the request again with the same
665
- # request ID, the server can check if the original operation with the same
666
- # request ID was received, and if so, will ignore the second request.
643
+ # For example, you make an initial request and the request times out. If you
644
+ # make the request again with the same request ID, the server can check if
645
+ # it received the original operation with the same request ID. If it did, it
646
+ # will ignore the second request.
667
647
  #
668
648
  # The request ID must be a valid [UUID](https://tools.ietf.org/html/rfc4122)
669
649
  # with the exception that zero UUID is not supported
@@ -677,18 +657,17 @@ module Google
677
657
  # @!attribute [rw] name
678
658
  # @return [::String]
679
659
  # Required. The resource name of the entitlement to suspend.
680
- # The name takes the format:
660
+ # Name uses the format:
681
661
  # accounts/\\{account_id}/customers/\\{customer_id}/entitlements/\\{entitlement_id}
682
662
  # @!attribute [rw] request_id
683
663
  # @return [::String]
684
- # Optional. An optional request ID to identify requests. Specify a unique request ID so
685
- # that if you must retry your request, the server will know to ignore the
686
- # request if it has already been completed.
664
+ # Optional. You can specify an optional unique request ID, and if you need to retry
665
+ # your request, the server will know to ignore the request if it's complete.
687
666
  #
688
- # For example, consider a situation where you make an initial request and
689
- # the request times out. If you make the request again with the same
690
- # request ID, the server can check if the original operation with the same
691
- # request ID was received, and if so, will ignore the second request.
667
+ # For example, you make an initial request and the request times out. If you
668
+ # make the request again with the same request ID, the server can check if
669
+ # it received the original operation with the same request ID. If it did, it
670
+ # will ignore the second request.
692
671
  #
693
672
  # The request ID must be a valid [UUID](https://tools.ietf.org/html/rfc4122)
694
673
  # with the exception that zero UUID is not supported
@@ -702,18 +681,17 @@ module Google
702
681
  # @!attribute [rw] name
703
682
  # @return [::String]
704
683
  # Required. The resource name of the entitlement to activate.
705
- # The name takes the format:
684
+ # Name uses the format:
706
685
  # accounts/\\{account_id}/customers/\\{customer_id}/entitlements/\\{entitlement_id}
707
686
  # @!attribute [rw] request_id
708
687
  # @return [::String]
709
- # Optional. An optional request ID to identify requests. Specify a unique request ID so
710
- # that if you must retry your request, the server will know to ignore the
711
- # request if it has already been completed.
688
+ # Optional. You can specify an optional unique request ID, and if you need to retry
689
+ # your request, the server will know to ignore the request if it's complete.
712
690
  #
713
- # For example, consider a situation where you make an initial request and
714
- # the request times out. If you make the request again with the same
715
- # request ID, the server can check if the original operation with the same
716
- # request ID was received, and if so, will ignore the second request.
691
+ # For example, you make an initial request and the request times out. If you
692
+ # make the request again with the same request ID, the server can check if
693
+ # it received the original operation with the same request ID. If it did, it
694
+ # will ignore the second request.
717
695
  #
718
696
  # The request ID must be a valid [UUID](https://tools.ietf.org/html/rfc4122)
719
697
  # with the exception that zero UUID is not supported
@@ -731,16 +709,16 @@ module Google
731
709
  # @!attribute [rw] page_size
732
710
  # @return [::Integer]
733
711
  # Optional. Requested page size. Server might return fewer results than requested.
734
- # If unspecified, at most 100 Products will be returned.
735
- # The maximum value is 1000; values above 1000 will be coerced to 1000.
712
+ # If unspecified, returns at most 100 Products.
713
+ # The maximum value is 1000; the server will coerce values above 1000.
736
714
  # @!attribute [rw] page_token
737
715
  # @return [::String]
738
- # Optional. A token identifying a page of results, if other than the first one.
716
+ # Optional. A token for a page of results other than the first page.
739
717
  # @!attribute [rw] language_code
740
718
  # @return [::String]
741
- # Optional. The BCP-47 language code, such as "en-US". If specified, the
742
- # response will be localized to the corresponding language code. Default is
743
- # "en-US".
719
+ # Optional. The BCP-47 language code. For example, "en-US". The
720
+ # response will localize in the corresponding language code, if specified.
721
+ # The default value is "en-US".
744
722
  class ListProductsRequest
745
723
  include ::Google::Protobuf::MessageExts
746
724
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -761,8 +739,8 @@ module Google
761
739
  # Request message for ListSkus.
762
740
  # @!attribute [rw] parent
763
741
  # @return [::String]
764
- # Required. The resource name of the Product for which to list SKUs.
765
- # The parent takes the format: products/\\{product_id}.
742
+ # Required. The resource name of the Product to list SKUs for.
743
+ # Parent uses the format: products/\\{product_id}.
766
744
  # Supports products/- to retrieve SKUs for all products.
767
745
  # @!attribute [rw] account
768
746
  # @return [::String]
@@ -771,17 +749,17 @@ module Google
771
749
  # @!attribute [rw] page_size
772
750
  # @return [::Integer]
773
751
  # Optional. Requested page size. Server might return fewer results than requested.
774
- # If unspecified, at most 100 SKUs will be returned.
775
- # The maximum value is 1000; values above 1000 will be coerced to 1000.
752
+ # If unspecified, returns at most 100 SKUs.
753
+ # The maximum value is 1000; the server will coerce values above 1000.
776
754
  # @!attribute [rw] page_token
777
755
  # @return [::String]
778
- # Optional. A token identifying a page of results, if other than the first one.
756
+ # Optional. A token for a page of results other than the first page.
779
757
  # Optional.
780
758
  # @!attribute [rw] language_code
781
759
  # @return [::String]
782
- # Optional. The BCP-47 language code, such as "en-US". If specified, the
783
- # response will be localized to the corresponding language code. Default is
784
- # "en-US".
760
+ # Optional. The BCP-47 language code. For example, "en-US". The
761
+ # response will localize in the corresponding language code, if specified.
762
+ # The default value is "en-US".
785
763
  class ListSkusRequest
786
764
  include ::Google::Protobuf::MessageExts
787
765
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -803,27 +781,27 @@ module Google
803
781
  # @!attribute [rw] parent
804
782
  # @return [::String]
805
783
  # Required. The resource name of the reseller account from which to list Offers.
806
- # The parent takes the format: accounts/\\{account_id}.
784
+ # Parent uses the format: accounts/\\{account_id}.
807
785
  # @!attribute [rw] page_size
808
786
  # @return [::Integer]
809
787
  # Optional. Requested page size. Server might return fewer results than requested.
810
- # If unspecified, at most 500 Offers will be returned.
811
- # The maximum value is 1000; values above 1000 will be coerced to 1000.
788
+ # If unspecified, returns at most 500 Offers.
789
+ # The maximum value is 1000; the server will coerce values above 1000.
812
790
  # @!attribute [rw] page_token
813
791
  # @return [::String]
814
- # Optional. A token identifying a page of results, if other than the first one.
792
+ # Optional. A token for a page of results other than the first page.
815
793
  # @!attribute [rw] filter
816
794
  # @return [::String]
817
795
  # Optional. The expression to filter results by name (name of
818
- # the Offer), sku.name (name of the SKU) or sku.product.name (name of the
796
+ # the Offer), sku.name (name of the SKU), or sku.product.name (name of the
819
797
  # Product).
820
798
  # Example 1: sku.product.name=products/p1 AND sku.name!=products/p1/skus/s1
821
799
  # Example 2: name=accounts/a1/offers/o1
822
800
  # @!attribute [rw] language_code
823
801
  # @return [::String]
824
- # Optional. The BCP-47 language code, such as "en-US". If specified, the
825
- # response will be localized to the corresponding language code. Default is
826
- # "en-US".
802
+ # Optional. The BCP-47 language code. For example, "en-US". The
803
+ # response will localize in the corresponding language code, if specified.
804
+ # The default value is "en-US".
827
805
  class ListOffersRequest
828
806
  include ::Google::Protobuf::MessageExts
829
807
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -850,21 +828,21 @@ module Google
850
828
  # List SKUs for ChangeOffer purchase with a new SKU.
851
829
  # @!attribute [rw] customer
852
830
  # @return [::String]
853
- # Required. The resource name of the customer for which to list SKUs.
831
+ # Required. The resource name of the customer to list SKUs for.
854
832
  # Format: accounts/\\{account_id}/customers/\\{customer_id}.
855
833
  # @!attribute [rw] page_size
856
834
  # @return [::Integer]
857
835
  # Optional. Requested page size. Server might return fewer results than requested.
858
- # If unspecified, at most 100 SKUs will be returned.
859
- # The maximum value is 1000; values above 1000 will be coerced to 1000.
836
+ # If unspecified, returns at most 100 SKUs.
837
+ # The maximum value is 1000; the server will coerce values above 1000.
860
838
  # @!attribute [rw] page_token
861
839
  # @return [::String]
862
- # Optional. A token identifying a page of results, if other than the first one.
840
+ # Optional. A token for a page of results other than the first page.
863
841
  # @!attribute [rw] language_code
864
842
  # @return [::String]
865
- # Optional. The BCP-47 language code, such as "en-US". If specified, the
866
- # response will be localized to the corresponding language code. Default is
867
- # "en-US".
843
+ # Optional. The BCP-47 language code. For example, "en-US". The
844
+ # response will localize in the corresponding language code, if specified.
845
+ # The default value is "en-US".
868
846
  class ListPurchasableSkusRequest
869
847
  include ::Google::Protobuf::MessageExts
870
848
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -921,7 +899,7 @@ module Google
921
899
  extend ::Google::Protobuf::MessageExts::ClassMethods
922
900
  end
923
901
 
924
- # SKU that can be used for a puchase. This is used in ListPurchasableSku API
902
+ # SKU that you can purchase. This is used in ListPurchasableSku API
925
903
  # response.
926
904
  # @!attribute [rw] sku
927
905
  # @return [::Google::Cloud::Channel::V1::Sku]
@@ -940,21 +918,21 @@ module Google
940
918
  # List Offers for ChangeOffer purchase.
941
919
  # @!attribute [rw] customer
942
920
  # @return [::String]
943
- # Required. The resource name of the customer for which to list Offers.
921
+ # Required. The resource name of the customer to list Offers for.
944
922
  # Format: accounts/\\{account_id}/customers/\\{customer_id}.
945
923
  # @!attribute [rw] page_size
946
924
  # @return [::Integer]
947
925
  # Optional. Requested page size. Server might return fewer results than requested.
948
- # If unspecified, at most 100 Offers will be returned.
949
- # The maximum value is 1000; values above 1000 will be coerced to 1000.
926
+ # If unspecified, returns at most 100 Offers.
927
+ # The maximum value is 1000; the server will coerce values above 1000.
950
928
  # @!attribute [rw] page_token
951
929
  # @return [::String]
952
- # Optional. A token identifying a page of results, if other than the first one.
930
+ # Optional. A token for a page of results other than the first page.
953
931
  # @!attribute [rw] language_code
954
932
  # @return [::String]
955
- # Optional. The BCP-47 language code, such as "en-US". If specified, the
956
- # response will be localized to the corresponding language code. Default is
957
- # "en-US".
933
+ # Optional. The BCP-47 language code. For example, "en-US". The
934
+ # response will localize in the corresponding language code, if specified.
935
+ # The default value is "en-US".
958
936
  class ListPurchasableOffersRequest
959
937
  include ::Google::Protobuf::MessageExts
960
938
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -977,7 +955,7 @@ module Google
977
955
  # accounts/\\{account_id}/customers/\\{customer_id}/entitlements/\\{entitlement_id}
978
956
  # @!attribute [rw] new_sku
979
957
  # @return [::String]
980
- # Optional. Resource name of the SKU that is being changed to. Should be provided if
958
+ # Optional. Resource name of the new target SKU. Provide this SKU when
981
959
  # upgrading or downgrading an entitlement. Format:
982
960
  # products/\\{product_id}/skus/\\{sku_id}
983
961
  class ChangeOfferPurchase
@@ -998,7 +976,7 @@ module Google
998
976
  extend ::Google::Protobuf::MessageExts::ClassMethods
999
977
  end
1000
978
 
1001
- # Offer that can be puchased for a customer. This is used in
979
+ # Offer that you can purchase for a customer. This is used in the
1002
980
  # ListPurchasableOffer API response.
1003
981
  # @!attribute [rw] offer
1004
982
  # @return [::Google::Cloud::Channel::V1::Offer]
@@ -1007,6 +985,86 @@ module Google
1007
985
  include ::Google::Protobuf::MessageExts
1008
986
  extend ::Google::Protobuf::MessageExts::ClassMethods
1009
987
  end
988
+
989
+ # Request Message for RegisterSubscriber.
990
+ # @!attribute [rw] account
991
+ # @return [::String]
992
+ # Required. Resource name of the account.
993
+ # @!attribute [rw] service_account
994
+ # @return [::String]
995
+ # Required. Service account that provides subscriber access to the registered topic.
996
+ class RegisterSubscriberRequest
997
+ include ::Google::Protobuf::MessageExts
998
+ extend ::Google::Protobuf::MessageExts::ClassMethods
999
+ end
1000
+
1001
+ # Response Message for RegisterSubscriber.
1002
+ # @!attribute [rw] topic
1003
+ # @return [::String]
1004
+ # Name of the topic the subscriber will listen to.
1005
+ class RegisterSubscriberResponse
1006
+ include ::Google::Protobuf::MessageExts
1007
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1008
+ end
1009
+
1010
+ # Request Message for UnregisterSubscriber.
1011
+ # @!attribute [rw] account
1012
+ # @return [::String]
1013
+ # Required. Resource name of the account.
1014
+ # @!attribute [rw] service_account
1015
+ # @return [::String]
1016
+ # Required. Service account to unregister from subscriber access to the topic.
1017
+ class UnregisterSubscriberRequest
1018
+ include ::Google::Protobuf::MessageExts
1019
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1020
+ end
1021
+
1022
+ # Response Message for UnregisterSubscriber.
1023
+ # @!attribute [rw] topic
1024
+ # @return [::String]
1025
+ # Name of the topic the service account subscriber access was removed from.
1026
+ class UnregisterSubscriberResponse
1027
+ include ::Google::Protobuf::MessageExts
1028
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1029
+ end
1030
+
1031
+ # Request Message for ListSubscribers.
1032
+ # @!attribute [rw] account
1033
+ # @return [::String]
1034
+ # Required. Resource name of the account.
1035
+ # @!attribute [rw] page_size
1036
+ # @return [::Integer]
1037
+ # Optional. The maximum number of service accounts to return. The service may return
1038
+ # fewer than this value.
1039
+ # If unspecified, returns at most 100 service accounts.
1040
+ # The maximum value is 1000; the server will coerce values above 1000.
1041
+ # @!attribute [rw] page_token
1042
+ # @return [::String]
1043
+ # Optional. A page token, received from a previous `ListSubscribers` call.
1044
+ # Provide this to retrieve the subsequent page.
1045
+ #
1046
+ # When paginating, all other parameters provided to `ListSubscribers` must
1047
+ # match the call that provided the page token.
1048
+ class ListSubscribersRequest
1049
+ include ::Google::Protobuf::MessageExts
1050
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1051
+ end
1052
+
1053
+ # Response Message for ListSubscribers.
1054
+ # @!attribute [rw] topic
1055
+ # @return [::String]
1056
+ # Name of the topic registered with the reseller.
1057
+ # @!attribute [rw] service_accounts
1058
+ # @return [::Array<::String>]
1059
+ # List of service accounts which have subscriber access to the topic.
1060
+ # @!attribute [rw] next_page_token
1061
+ # @return [::String]
1062
+ # A token that can be sent as `page_token` to retrieve the next page.
1063
+ # If this field is omitted, there are no subsequent pages.
1064
+ class ListSubscribersResponse
1065
+ include ::Google::Protobuf::MessageExts
1066
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1067
+ end
1010
1068
  end
1011
1069
  end
1012
1070
  end