google-cloud-channel-v1 0.5.0 → 0.7.2
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 +8 -8
- data/README.md +1 -1
- data/lib/google/cloud/channel/v1/cloud_channel_service.rb +14 -16
- data/lib/google/cloud/channel/v1/cloud_channel_service/client.rb +765 -688
- data/lib/google/cloud/channel/v1/cloud_channel_service/operations.rb +34 -25
- data/lib/google/cloud/channel/v1/common_pb.rb +1 -0
- data/lib/google/cloud/channel/v1/entitlements_pb.rb +1 -0
- data/lib/google/cloud/channel/v1/service_pb.rb +4 -0
- data/lib/google/cloud/channel/v1/service_services_pb.rb +380 -417
- data/lib/google/cloud/channel/v1/subscriber_event_pb.rb +3 -0
- data/lib/google/cloud/channel/v1/version.rb +1 -1
- data/proto_docs/google/api/field_behavior.rb +7 -1
- data/proto_docs/google/cloud/channel/v1/common.rb +9 -2
- data/proto_docs/google/cloud/channel/v1/customers.rb +23 -27
- data/proto_docs/google/cloud/channel/v1/entitlements.rb +3 -0
- data/proto_docs/google/cloud/channel/v1/service.rb +211 -220
- data/proto_docs/google/cloud/channel/v1/subscriber_event.rb +9 -0
- data/proto_docs/google/type/money.rb +1 -1
- metadata +13 -7
@@ -13,6 +13,8 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
13
13
|
end
|
14
14
|
add_enum "google.cloud.channel.v1.CustomerEvent.Type" do
|
15
15
|
value :TYPE_UNSPECIFIED, 0
|
16
|
+
value :PRIMARY_DOMAIN_CHANGED, 1
|
17
|
+
value :PRIMARY_DOMAIN_VERIFIED, 2
|
16
18
|
end
|
17
19
|
add_message "google.cloud.channel.v1.EntitlementEvent" do
|
18
20
|
optional :entitlement, :string, 1
|
@@ -31,6 +33,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
31
33
|
value :RENEWAL_SETTING_CHANGED, 10
|
32
34
|
value :PAID_SERVICE_STARTED, 11
|
33
35
|
value :LICENSE_ASSIGNMENT_CHANGED, 12
|
36
|
+
value :LICENSE_CAP_CHANGED, 13
|
34
37
|
end
|
35
38
|
add_message "google.cloud.channel.v1.SubscriberEvent" do
|
36
39
|
oneof :event do
|
@@ -57,9 +57,15 @@ module Google
|
|
57
57
|
|
58
58
|
# Denotes that a (repeated) field is an unordered list.
|
59
59
|
# This indicates that the service may provide the elements of the list
|
60
|
-
# in any arbitrary
|
60
|
+
# in any arbitrary order, rather than the order the user originally
|
61
61
|
# provided. Additionally, the list's order may or may not be stable.
|
62
62
|
UNORDERED_LIST = 6
|
63
|
+
|
64
|
+
# Denotes that this field returns a non-empty default value if not set.
|
65
|
+
# This indicates that if the user provides the empty value in a request,
|
66
|
+
# a non-empty value will be returned. The user will not be aware of what
|
67
|
+
# non-empty value to expect.
|
68
|
+
NON_EMPTY_DEFAULT = 7
|
63
69
|
end
|
64
70
|
end
|
65
71
|
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 [
|
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
|
@@ -31,36 +31,33 @@ module Google
|
|
31
31
|
# Required. Name of the organization that the customer entity represents.
|
32
32
|
# @!attribute [rw] org_postal_address
|
33
33
|
# @return [::Google::Type::PostalAddress]
|
34
|
-
# Required.
|
35
|
-
#
|
36
|
-
#
|
37
|
-
#
|
38
|
-
# customer's language.
|
34
|
+
# Required. The organization address for the customer. To enforce US laws and
|
35
|
+
# embargoes, we require a region and zip code. You must provide valid
|
36
|
+
# addresses for every customer. To set the customer's language, use the
|
37
|
+
# Customer-level language code.
|
39
38
|
# @!attribute [rw] primary_contact_info
|
40
39
|
# @return [::Google::Cloud::Channel::V1::ContactInfo]
|
41
40
|
# Primary contact info.
|
42
41
|
# @!attribute [rw] alternate_email
|
43
42
|
# @return [::String]
|
44
|
-
# Secondary contact email.
|
45
|
-
#
|
46
|
-
#
|
47
|
-
#
|
48
|
-
# this email. This email address is also used as a recovery email.
|
43
|
+
# Secondary contact email. You need to provide an alternate email to create
|
44
|
+
# different domains if a primary contact email already exists. Users will
|
45
|
+
# receive a notification with credentials when you create an admin.google.com
|
46
|
+
# account. Secondary emails are also recovery email addresses.
|
49
47
|
# @!attribute [rw] domain
|
50
48
|
# @return [::String]
|
51
|
-
# Required.
|
52
|
-
#
|
53
|
-
# domain.
|
49
|
+
# Required. The customer's primary domain. Must match the primary contact
|
50
|
+
# email's domain.
|
54
51
|
# @!attribute [r] create_time
|
55
52
|
# @return [::Google::Protobuf::Timestamp]
|
56
|
-
# Output only.
|
53
|
+
# Output only. Time when the customer was created.
|
57
54
|
# @!attribute [r] update_time
|
58
55
|
# @return [::Google::Protobuf::Timestamp]
|
59
|
-
# Output only.
|
56
|
+
# Output only. Time when the customer was updated.
|
60
57
|
# @!attribute [r] cloud_identity_id
|
61
58
|
# @return [::String]
|
62
|
-
# Output only.
|
63
|
-
#
|
59
|
+
# Output only. The customer's Cloud Identity ID if the customer has a Cloud
|
60
|
+
# Identity resource.
|
64
61
|
# @!attribute [rw] language_code
|
65
62
|
# @return [::String]
|
66
63
|
# Optional. The BCP-47 language code, such as "en-US" or "sr-Latn". For more
|
@@ -82,26 +79,25 @@ module Google
|
|
82
79
|
# Contact information for a customer account.
|
83
80
|
# @!attribute [rw] first_name
|
84
81
|
# @return [::String]
|
85
|
-
#
|
82
|
+
# The customer account contact's first name.
|
86
83
|
# @!attribute [rw] last_name
|
87
84
|
# @return [::String]
|
88
|
-
#
|
85
|
+
# The customer account contact's last name.
|
89
86
|
# @!attribute [r] display_name
|
90
87
|
# @return [::String]
|
91
|
-
# Output only.
|
92
|
-
#
|
88
|
+
# Output only. The customer account contact's display name, formatted as a
|
89
|
+
# combination of the customer's first and last name.
|
93
90
|
# @!attribute [rw] email
|
94
91
|
# @return [::String]
|
95
|
-
#
|
96
|
-
#
|
97
|
-
# accounts.
|
98
|
-
# admin.google.com account.
|
92
|
+
# The customer account's contact email. Required for entitlements that create
|
93
|
+
# admin.google.com accounts, and serves as the customer's username for those
|
94
|
+
# accounts.
|
99
95
|
# @!attribute [rw] title
|
100
96
|
# @return [::String]
|
101
|
-
# Optional.
|
97
|
+
# Optional. The customer account contact's job title.
|
102
98
|
# @!attribute [rw] phone
|
103
99
|
# @return [::String]
|
104
|
-
#
|
100
|
+
# The customer account's contact phone number.
|
105
101
|
class ContactInfo
|
106
102
|
include ::Google::Protobuf::MessageExts
|
107
103
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -209,6 +209,9 @@ module Google
|
|
209
209
|
# @!attribute [rw] sku
|
210
210
|
# @return [::Google::Cloud::Channel::V1::Sku]
|
211
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.
|
212
215
|
class TransferableSku
|
213
216
|
include ::Google::Protobuf::MessageExts
|
214
217
|
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
|
28
|
-
#
|
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
|
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
|
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
|
-
#
|
41
|
+
# Returns true if a Cloud Identity account exists for a specific domain.
|
42
42
|
# @!attribute [rw] owned
|
43
43
|
# @return [::Boolean]
|
44
|
-
#
|
45
|
-
#
|
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
|
-
#
|
49
|
-
#
|
50
|
-
#
|
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.
|
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
|
75
|
-
#
|
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
|
80
|
-
# maximum value is 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
|
84
|
-
#
|
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
|
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
|
-
#
|
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
|
-
#
|
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
|
-
#
|
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
|
174
|
-
# entitlements.
|
175
|
-
#
|
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
|
180
|
-
# The maximum value is 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
|
184
|
-
#
|
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
|
193
|
+
# The reseller customer's entitlements.
|
196
194
|
# @!attribute [rw] next_page_token
|
197
195
|
# @return [::String]
|
198
|
-
# A token to
|
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
|
-
#
|
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
|
218
|
-
#
|
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
|
-
#
|
222
|
-
# If unspecified, at most 100 SKUs
|
223
|
-
# The maximum value is 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
|
228
|
-
#
|
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
|
-
#
|
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.
|
237
|
-
#
|
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
|
242
|
-
# response will
|
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
|
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
|
-
#
|
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
|
280
|
-
# The maximum value is 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
|
284
|
-
#
|
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
|
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
|
293
|
-
# response will
|
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
|
-
#
|
330
|
-
# accounts/\\{account_id}/customers/\\{customer_id}/entitlements/\\{
|
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
|
-
#
|
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
|
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
|
350
|
-
#
|
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
|
-
#
|
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,9 +384,9 @@ 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.
|
392
|
-
#
|
393
|
-
#
|
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.
|
@@ -405,16 +401,16 @@ module Google
|
|
405
401
|
# @!attribute [rw] name
|
406
402
|
# @return [::String]
|
407
403
|
# Required. The resource name of the channel partner link to cancel.
|
408
|
-
#
|
404
|
+
# Name uses the format: accounts/\\{account_id}/channelPartnerLinks/\\{id}
|
409
405
|
# where \\{id} is the Cloud Identity ID of the partner.
|
410
406
|
# @!attribute [rw] channel_partner_link
|
411
407
|
# @return [::Google::Cloud::Channel::V1::ChannelPartnerLink]
|
412
|
-
# Required. The channel partner link to update. Only
|
413
|
-
#
|
408
|
+
# Required. The channel partner link to update. Only channel_partner_link.link_state
|
409
|
+
# is allowed for updates.
|
414
410
|
# @!attribute [rw] update_mask
|
415
411
|
# @return [::Google::Protobuf::FieldMask]
|
416
412
|
# Required. The update mask that applies to the resource.
|
417
|
-
# The only allowable value for update mask is
|
413
|
+
# The only allowable value for an update mask is
|
418
414
|
# channel_partner_link.link_state.
|
419
415
|
class UpdateChannelPartnerLinkRequest
|
420
416
|
include ::Google::Protobuf::MessageExts
|
@@ -424,22 +420,21 @@ module Google
|
|
424
420
|
# Request message for {::Google::Cloud::Channel::V1::CloudChannelService::Client#create_entitlement CloudChannelService.CreateEntitlement}
|
425
421
|
# @!attribute [rw] parent
|
426
422
|
# @return [::String]
|
427
|
-
# 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
|
428
424
|
# entitlement.
|
429
|
-
#
|
425
|
+
# Parent uses the format: accounts/\\{account_id}/customers/\\{customer_id}
|
430
426
|
# @!attribute [rw] entitlement
|
431
427
|
# @return [::Google::Cloud::Channel::V1::Entitlement]
|
432
428
|
# Required. The entitlement to create.
|
433
429
|
# @!attribute [rw] request_id
|
434
430
|
# @return [::String]
|
435
|
-
# Optional.
|
436
|
-
#
|
437
|
-
# 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.
|
438
433
|
#
|
439
|
-
# For example,
|
440
|
-
# the request
|
441
|
-
#
|
442
|
-
#
|
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.
|
443
438
|
#
|
444
439
|
# The request ID must be a valid [UUID](https://tools.ietf.org/html/rfc4122)
|
445
440
|
# with the exception that zero UUID is not supported
|
@@ -452,29 +447,27 @@ module Google
|
|
452
447
|
# Request message for {::Google::Cloud::Channel::V1::CloudChannelService::Client#transfer_entitlements CloudChannelService.TransferEntitlements}.
|
453
448
|
# @!attribute [rw] parent
|
454
449
|
# @return [::String]
|
455
|
-
# Required. The resource name of reseller's customer account
|
456
|
-
#
|
457
|
-
#
|
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}
|
458
453
|
# @!attribute [rw] entitlements
|
459
454
|
# @return [::Array<::Google::Cloud::Channel::V1::Entitlement>]
|
460
|
-
# Required. The new entitlements to
|
455
|
+
# Required. The new entitlements to create or transfer.
|
461
456
|
# @!attribute [rw] auth_token
|
462
457
|
# @return [::String]
|
463
|
-
#
|
458
|
+
# The super admin of the resold customer generates this token to
|
464
459
|
# authorize a reseller to access their Cloud Identity and purchase
|
465
|
-
# entitlements on their behalf.
|
466
|
-
#
|
467
|
-
# 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.
|
468
462
|
# @!attribute [rw] request_id
|
469
463
|
# @return [::String]
|
470
|
-
# Optional.
|
471
|
-
#
|
472
|
-
# 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.
|
473
466
|
#
|
474
|
-
# For example,
|
475
|
-
# the request
|
476
|
-
#
|
477
|
-
#
|
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.
|
478
471
|
#
|
479
472
|
# The request ID must be a valid [UUID](https://tools.ietf.org/html/rfc4122)
|
480
473
|
# with the exception that zero UUID is not supported
|
@@ -485,10 +478,10 @@ module Google
|
|
485
478
|
end
|
486
479
|
|
487
480
|
# Response message for {::Google::Cloud::Channel::V1::CloudChannelService::Client#transfer_entitlements CloudChannelService.TransferEntitlements}.
|
488
|
-
# This
|
481
|
+
# This is put in the response field of google.longrunning.Operation.
|
489
482
|
# @!attribute [rw] entitlements
|
490
483
|
# @return [::Array<::Google::Cloud::Channel::V1::Entitlement>]
|
491
|
-
# The entitlements
|
484
|
+
# The transferred entitlements.
|
492
485
|
class TransferEntitlementsResponse
|
493
486
|
include ::Google::Protobuf::MessageExts
|
494
487
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -497,22 +490,21 @@ module Google
|
|
497
490
|
# Request message for {::Google::Cloud::Channel::V1::CloudChannelService::Client#transfer_entitlements_to_google CloudChannelService.TransferEntitlementsToGoogle}.
|
498
491
|
# @!attribute [rw] parent
|
499
492
|
# @return [::String]
|
500
|
-
# 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
|
501
494
|
# transfer from.
|
502
|
-
#
|
495
|
+
# Parent uses the format: accounts/\\{account_id}/customers/\\{customer_id}
|
503
496
|
# @!attribute [rw] entitlements
|
504
497
|
# @return [::Array<::Google::Cloud::Channel::V1::Entitlement>]
|
505
|
-
# Required. The entitlements to
|
498
|
+
# Required. The entitlements to transfer to Google.
|
506
499
|
# @!attribute [rw] request_id
|
507
500
|
# @return [::String]
|
508
|
-
# Optional.
|
509
|
-
#
|
510
|
-
# 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.
|
511
503
|
#
|
512
|
-
# For example,
|
513
|
-
# the request
|
514
|
-
#
|
515
|
-
#
|
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.
|
516
508
|
#
|
517
509
|
# The request ID must be a valid [UUID](https://tools.ietf.org/html/rfc4122)
|
518
510
|
# with the exception that zero UUID is not supported
|
@@ -526,26 +518,23 @@ module Google
|
|
526
518
|
# @!attribute [rw] name
|
527
519
|
# @return [::String]
|
528
520
|
# Required. The name of the entitlement to update.
|
529
|
-
#
|
521
|
+
# Name uses the format:
|
530
522
|
# accounts/\\{account_id}/customers/\\{customer_id}/entitlements/\\{entitlement_id}
|
531
523
|
# @!attribute [rw] parameters
|
532
524
|
# @return [::Array<::Google::Cloud::Channel::V1::Parameter>]
|
533
|
-
# Required. Entitlement parameters to update.
|
534
|
-
# be changed.
|
525
|
+
# Required. Entitlement parameters to update. You can only change editable parameters.
|
535
526
|
# @!attribute [rw] request_id
|
536
527
|
# @return [::String]
|
537
|
-
# Optional.
|
538
|
-
#
|
539
|
-
# 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.
|
540
530
|
#
|
541
|
-
# For example,
|
542
|
-
# the request
|
543
|
-
#
|
544
|
-
#
|
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.
|
545
535
|
#
|
546
|
-
# The request ID must be
|
547
|
-
#
|
548
|
-
# 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
|
549
538
|
# (`00000000-0000-0000-0000-000000000000`).
|
550
539
|
# @!attribute [rw] purchase_order_id
|
551
540
|
# @return [::String]
|
@@ -559,21 +548,20 @@ module Google
|
|
559
548
|
# @!attribute [rw] name
|
560
549
|
# @return [::String]
|
561
550
|
# Required. The name of the entitlement to update.
|
562
|
-
#
|
551
|
+
# Name uses the format:
|
563
552
|
# accounts/\\{account_id}/customers/\\{customer_id}/entitlements/\\{entitlement_id}
|
564
553
|
# @!attribute [rw] renewal_settings
|
565
554
|
# @return [::Google::Cloud::Channel::V1::RenewalSettings]
|
566
555
|
# Required. New renewal settings.
|
567
556
|
# @!attribute [rw] request_id
|
568
557
|
# @return [::String]
|
569
|
-
# Optional.
|
570
|
-
#
|
571
|
-
# 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.
|
572
560
|
#
|
573
|
-
# For example,
|
574
|
-
# the request
|
575
|
-
#
|
576
|
-
#
|
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.
|
577
565
|
#
|
578
566
|
# The request ID must be a valid [UUID](https://tools.ietf.org/html/rfc4122)
|
579
567
|
# with the exception that zero UUID is not supported
|
@@ -586,8 +574,8 @@ module Google
|
|
586
574
|
# Request message for {::Google::Cloud::Channel::V1::CloudChannelService::Client#change_offer CloudChannelService.ChangeOffer}.
|
587
575
|
# @!attribute [rw] name
|
588
576
|
# @return [::String]
|
589
|
-
# Required. The name of the entitlement to update.
|
590
|
-
#
|
577
|
+
# Required. The resource name of the entitlement to update.
|
578
|
+
# Name uses the format:
|
591
579
|
# accounts/\\{account_id}/customers/\\{customer_id}/entitlements/\\{entitlement_id}
|
592
580
|
# @!attribute [rw] offer
|
593
581
|
# @return [::String]
|
@@ -601,14 +589,13 @@ module Google
|
|
601
589
|
# Optional. Purchase order id provided by the reseller.
|
602
590
|
# @!attribute [rw] request_id
|
603
591
|
# @return [::String]
|
604
|
-
# Optional.
|
605
|
-
#
|
606
|
-
# 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.
|
607
594
|
#
|
608
|
-
# For example,
|
609
|
-
# the request
|
610
|
-
#
|
611
|
-
#
|
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.
|
612
599
|
#
|
613
600
|
# The request ID must be a valid [UUID](https://tools.ietf.org/html/rfc4122)
|
614
601
|
# with the exception that zero UUID is not supported
|
@@ -621,19 +608,18 @@ module Google
|
|
621
608
|
# Request message for {::Google::Cloud::Channel::V1::CloudChannelService::Client#start_paid_service CloudChannelService.StartPaidService}.
|
622
609
|
# @!attribute [rw] name
|
623
610
|
# @return [::String]
|
624
|
-
# Required. The name of the entitlement
|
625
|
-
#
|
611
|
+
# Required. The name of the entitlement to start a paid service for.
|
612
|
+
# Name uses the format:
|
626
613
|
# accounts/\\{account_id}/customers/\\{customer_id}/entitlements/\\{entitlement_id}
|
627
614
|
# @!attribute [rw] request_id
|
628
615
|
# @return [::String]
|
629
|
-
# Optional.
|
630
|
-
#
|
631
|
-
# 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.
|
632
618
|
#
|
633
|
-
# For example,
|
634
|
-
# the request
|
635
|
-
#
|
636
|
-
#
|
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.
|
637
623
|
#
|
638
624
|
# The request ID must be a valid [UUID](https://tools.ietf.org/html/rfc4122)
|
639
625
|
# with the exception that zero UUID is not supported
|
@@ -647,18 +633,17 @@ module Google
|
|
647
633
|
# @!attribute [rw] name
|
648
634
|
# @return [::String]
|
649
635
|
# Required. The resource name of the entitlement to cancel.
|
650
|
-
#
|
636
|
+
# Name uses the format:
|
651
637
|
# accounts/\\{account_id}/customers/\\{customer_id}/entitlements/\\{entitlement_id}
|
652
638
|
# @!attribute [rw] request_id
|
653
639
|
# @return [::String]
|
654
|
-
# Optional.
|
655
|
-
#
|
656
|
-
# 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.
|
657
642
|
#
|
658
|
-
# For example,
|
659
|
-
# the request
|
660
|
-
#
|
661
|
-
#
|
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.
|
662
647
|
#
|
663
648
|
# The request ID must be a valid [UUID](https://tools.ietf.org/html/rfc4122)
|
664
649
|
# with the exception that zero UUID is not supported
|
@@ -672,18 +657,17 @@ module Google
|
|
672
657
|
# @!attribute [rw] name
|
673
658
|
# @return [::String]
|
674
659
|
# Required. The resource name of the entitlement to suspend.
|
675
|
-
#
|
660
|
+
# Name uses the format:
|
676
661
|
# accounts/\\{account_id}/customers/\\{customer_id}/entitlements/\\{entitlement_id}
|
677
662
|
# @!attribute [rw] request_id
|
678
663
|
# @return [::String]
|
679
|
-
# Optional.
|
680
|
-
#
|
681
|
-
# 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.
|
682
666
|
#
|
683
|
-
# For example,
|
684
|
-
# the request
|
685
|
-
#
|
686
|
-
#
|
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.
|
687
671
|
#
|
688
672
|
# The request ID must be a valid [UUID](https://tools.ietf.org/html/rfc4122)
|
689
673
|
# with the exception that zero UUID is not supported
|
@@ -697,18 +681,17 @@ module Google
|
|
697
681
|
# @!attribute [rw] name
|
698
682
|
# @return [::String]
|
699
683
|
# Required. The resource name of the entitlement to activate.
|
700
|
-
#
|
684
|
+
# Name uses the format:
|
701
685
|
# accounts/\\{account_id}/customers/\\{customer_id}/entitlements/\\{entitlement_id}
|
702
686
|
# @!attribute [rw] request_id
|
703
687
|
# @return [::String]
|
704
|
-
# Optional.
|
705
|
-
#
|
706
|
-
# 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.
|
707
690
|
#
|
708
|
-
# For example,
|
709
|
-
# the request
|
710
|
-
#
|
711
|
-
#
|
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.
|
712
695
|
#
|
713
696
|
# The request ID must be a valid [UUID](https://tools.ietf.org/html/rfc4122)
|
714
697
|
# with the exception that zero UUID is not supported
|
@@ -718,6 +701,17 @@ module Google
|
|
718
701
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
719
702
|
end
|
720
703
|
|
704
|
+
# Request message for LookupOffer.
|
705
|
+
# @!attribute [rw] entitlement
|
706
|
+
# @return [::String]
|
707
|
+
# Required. The resource name of the entitlement to retrieve the Offer.
|
708
|
+
# Entitlement uses the format:
|
709
|
+
# accounts/\\{account_id}/customers/\\{customer_id}/entitlements/\\{entitlement_id}
|
710
|
+
class LookupOfferRequest
|
711
|
+
include ::Google::Protobuf::MessageExts
|
712
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
713
|
+
end
|
714
|
+
|
721
715
|
# Request message for ListProducts.
|
722
716
|
# @!attribute [rw] account
|
723
717
|
# @return [::String]
|
@@ -726,16 +720,16 @@ module Google
|
|
726
720
|
# @!attribute [rw] page_size
|
727
721
|
# @return [::Integer]
|
728
722
|
# Optional. Requested page size. Server might return fewer results than requested.
|
729
|
-
# If unspecified, at most 100 Products
|
730
|
-
# The maximum value is 1000;
|
723
|
+
# If unspecified, returns at most 100 Products.
|
724
|
+
# The maximum value is 1000; the server will coerce values above 1000.
|
731
725
|
# @!attribute [rw] page_token
|
732
726
|
# @return [::String]
|
733
|
-
# Optional. A token
|
727
|
+
# Optional. A token for a page of results other than the first page.
|
734
728
|
# @!attribute [rw] language_code
|
735
729
|
# @return [::String]
|
736
|
-
# Optional. The BCP-47 language code
|
737
|
-
# response will
|
738
|
-
# "en-US".
|
730
|
+
# Optional. The BCP-47 language code. For example, "en-US". The
|
731
|
+
# response will localize in the corresponding language code, if specified.
|
732
|
+
# The default value is "en-US".
|
739
733
|
class ListProductsRequest
|
740
734
|
include ::Google::Protobuf::MessageExts
|
741
735
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -756,8 +750,8 @@ module Google
|
|
756
750
|
# Request message for ListSkus.
|
757
751
|
# @!attribute [rw] parent
|
758
752
|
# @return [::String]
|
759
|
-
# Required. The resource name of the Product
|
760
|
-
#
|
753
|
+
# Required. The resource name of the Product to list SKUs for.
|
754
|
+
# Parent uses the format: products/\\{product_id}.
|
761
755
|
# Supports products/- to retrieve SKUs for all products.
|
762
756
|
# @!attribute [rw] account
|
763
757
|
# @return [::String]
|
@@ -766,17 +760,17 @@ module Google
|
|
766
760
|
# @!attribute [rw] page_size
|
767
761
|
# @return [::Integer]
|
768
762
|
# Optional. Requested page size. Server might return fewer results than requested.
|
769
|
-
# If unspecified, at most 100 SKUs
|
770
|
-
# The maximum value is 1000;
|
763
|
+
# If unspecified, returns at most 100 SKUs.
|
764
|
+
# The maximum value is 1000; the server will coerce values above 1000.
|
771
765
|
# @!attribute [rw] page_token
|
772
766
|
# @return [::String]
|
773
|
-
# Optional. A token
|
767
|
+
# Optional. A token for a page of results other than the first page.
|
774
768
|
# Optional.
|
775
769
|
# @!attribute [rw] language_code
|
776
770
|
# @return [::String]
|
777
|
-
# Optional. The BCP-47 language code
|
778
|
-
# response will
|
779
|
-
# "en-US".
|
771
|
+
# Optional. The BCP-47 language code. For example, "en-US". The
|
772
|
+
# response will localize in the corresponding language code, if specified.
|
773
|
+
# The default value is "en-US".
|
780
774
|
class ListSkusRequest
|
781
775
|
include ::Google::Protobuf::MessageExts
|
782
776
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -798,27 +792,27 @@ module Google
|
|
798
792
|
# @!attribute [rw] parent
|
799
793
|
# @return [::String]
|
800
794
|
# Required. The resource name of the reseller account from which to list Offers.
|
801
|
-
#
|
795
|
+
# Parent uses the format: accounts/\\{account_id}.
|
802
796
|
# @!attribute [rw] page_size
|
803
797
|
# @return [::Integer]
|
804
798
|
# Optional. Requested page size. Server might return fewer results than requested.
|
805
|
-
# If unspecified, at most 500 Offers
|
806
|
-
# The maximum value is 1000;
|
799
|
+
# If unspecified, returns at most 500 Offers.
|
800
|
+
# The maximum value is 1000; the server will coerce values above 1000.
|
807
801
|
# @!attribute [rw] page_token
|
808
802
|
# @return [::String]
|
809
|
-
# Optional. A token
|
803
|
+
# Optional. A token for a page of results other than the first page.
|
810
804
|
# @!attribute [rw] filter
|
811
805
|
# @return [::String]
|
812
806
|
# Optional. The expression to filter results by name (name of
|
813
|
-
# the Offer), sku.name (name of the SKU) or sku.product.name (name of the
|
807
|
+
# the Offer), sku.name (name of the SKU), or sku.product.name (name of the
|
814
808
|
# Product).
|
815
809
|
# Example 1: sku.product.name=products/p1 AND sku.name!=products/p1/skus/s1
|
816
810
|
# Example 2: name=accounts/a1/offers/o1
|
817
811
|
# @!attribute [rw] language_code
|
818
812
|
# @return [::String]
|
819
|
-
# Optional. The BCP-47 language code
|
820
|
-
# response will
|
821
|
-
# "en-US".
|
813
|
+
# Optional. The BCP-47 language code. For example, "en-US". The
|
814
|
+
# response will localize in the corresponding language code, if specified.
|
815
|
+
# The default value is "en-US".
|
822
816
|
class ListOffersRequest
|
823
817
|
include ::Google::Protobuf::MessageExts
|
824
818
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -845,21 +839,21 @@ module Google
|
|
845
839
|
# List SKUs for ChangeOffer purchase with a new SKU.
|
846
840
|
# @!attribute [rw] customer
|
847
841
|
# @return [::String]
|
848
|
-
# Required. The resource name of the customer
|
842
|
+
# Required. The resource name of the customer to list SKUs for.
|
849
843
|
# Format: accounts/\\{account_id}/customers/\\{customer_id}.
|
850
844
|
# @!attribute [rw] page_size
|
851
845
|
# @return [::Integer]
|
852
846
|
# Optional. Requested page size. Server might return fewer results than requested.
|
853
|
-
# If unspecified, at most 100 SKUs
|
854
|
-
# The maximum value is 1000;
|
847
|
+
# If unspecified, returns at most 100 SKUs.
|
848
|
+
# The maximum value is 1000; the server will coerce values above 1000.
|
855
849
|
# @!attribute [rw] page_token
|
856
850
|
# @return [::String]
|
857
|
-
# Optional. A token
|
851
|
+
# Optional. A token for a page of results other than the first page.
|
858
852
|
# @!attribute [rw] language_code
|
859
853
|
# @return [::String]
|
860
|
-
# Optional. The BCP-47 language code
|
861
|
-
# response will
|
862
|
-
# "en-US".
|
854
|
+
# Optional. The BCP-47 language code. For example, "en-US". The
|
855
|
+
# response will localize in the corresponding language code, if specified.
|
856
|
+
# The default value is "en-US".
|
863
857
|
class ListPurchasableSkusRequest
|
864
858
|
include ::Google::Protobuf::MessageExts
|
865
859
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -916,7 +910,7 @@ module Google
|
|
916
910
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
917
911
|
end
|
918
912
|
|
919
|
-
# SKU that can
|
913
|
+
# SKU that you can purchase. This is used in ListPurchasableSku API
|
920
914
|
# response.
|
921
915
|
# @!attribute [rw] sku
|
922
916
|
# @return [::Google::Cloud::Channel::V1::Sku]
|
@@ -935,21 +929,21 @@ module Google
|
|
935
929
|
# List Offers for ChangeOffer purchase.
|
936
930
|
# @!attribute [rw] customer
|
937
931
|
# @return [::String]
|
938
|
-
# Required. The resource name of the customer
|
932
|
+
# Required. The resource name of the customer to list Offers for.
|
939
933
|
# Format: accounts/\\{account_id}/customers/\\{customer_id}.
|
940
934
|
# @!attribute [rw] page_size
|
941
935
|
# @return [::Integer]
|
942
936
|
# Optional. Requested page size. Server might return fewer results than requested.
|
943
|
-
# If unspecified, at most 100 Offers
|
944
|
-
# The maximum value is 1000;
|
937
|
+
# If unspecified, returns at most 100 Offers.
|
938
|
+
# The maximum value is 1000; the server will coerce values above 1000.
|
945
939
|
# @!attribute [rw] page_token
|
946
940
|
# @return [::String]
|
947
|
-
# Optional. A token
|
941
|
+
# Optional. A token for a page of results other than the first page.
|
948
942
|
# @!attribute [rw] language_code
|
949
943
|
# @return [::String]
|
950
|
-
# Optional. The BCP-47 language code
|
951
|
-
# response will
|
952
|
-
# "en-US".
|
944
|
+
# Optional. The BCP-47 language code. For example, "en-US". The
|
945
|
+
# response will localize in the corresponding language code, if specified.
|
946
|
+
# The default value is "en-US".
|
953
947
|
class ListPurchasableOffersRequest
|
954
948
|
include ::Google::Protobuf::MessageExts
|
955
949
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -972,7 +966,7 @@ module Google
|
|
972
966
|
# accounts/\\{account_id}/customers/\\{customer_id}/entitlements/\\{entitlement_id}
|
973
967
|
# @!attribute [rw] new_sku
|
974
968
|
# @return [::String]
|
975
|
-
# Optional. Resource name of the
|
969
|
+
# Optional. Resource name of the new target SKU. Provide this SKU when
|
976
970
|
# upgrading or downgrading an entitlement. Format:
|
977
971
|
# products/\\{product_id}/skus/\\{sku_id}
|
978
972
|
class ChangeOfferPurchase
|
@@ -993,7 +987,7 @@ module Google
|
|
993
987
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
994
988
|
end
|
995
989
|
|
996
|
-
# Offer that can
|
990
|
+
# Offer that you can purchase for a customer. This is used in the
|
997
991
|
# ListPurchasableOffer API response.
|
998
992
|
# @!attribute [rw] offer
|
999
993
|
# @return [::Google::Cloud::Channel::V1::Offer]
|
@@ -1009,8 +1003,7 @@ module Google
|
|
1009
1003
|
# Required. Resource name of the account.
|
1010
1004
|
# @!attribute [rw] service_account
|
1011
1005
|
# @return [::String]
|
1012
|
-
# Required. Service account
|
1013
|
-
# registered topic.
|
1006
|
+
# Required. Service account that provides subscriber access to the registered topic.
|
1014
1007
|
class RegisterSubscriberRequest
|
1015
1008
|
include ::Google::Protobuf::MessageExts
|
1016
1009
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -1019,7 +1012,7 @@ module Google
|
|
1019
1012
|
# Response Message for RegisterSubscriber.
|
1020
1013
|
# @!attribute [rw] topic
|
1021
1014
|
# @return [::String]
|
1022
|
-
# Name of the topic
|
1015
|
+
# Name of the topic the subscriber will listen to.
|
1023
1016
|
class RegisterSubscriberResponse
|
1024
1017
|
include ::Google::Protobuf::MessageExts
|
1025
1018
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -1031,8 +1024,7 @@ module Google
|
|
1031
1024
|
# Required. Resource name of the account.
|
1032
1025
|
# @!attribute [rw] service_account
|
1033
1026
|
# @return [::String]
|
1034
|
-
# Required. Service account
|
1035
|
-
# to the topic.
|
1027
|
+
# Required. Service account to unregister from subscriber access to the topic.
|
1036
1028
|
class UnregisterSubscriberRequest
|
1037
1029
|
include ::Google::Protobuf::MessageExts
|
1038
1030
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -1041,8 +1033,7 @@ module Google
|
|
1041
1033
|
# Response Message for UnregisterSubscriber.
|
1042
1034
|
# @!attribute [rw] topic
|
1043
1035
|
# @return [::String]
|
1044
|
-
# Name of the topic
|
1045
|
-
# removed.
|
1036
|
+
# Name of the topic the service account subscriber access was removed from.
|
1046
1037
|
class UnregisterSubscriberResponse
|
1047
1038
|
include ::Google::Protobuf::MessageExts
|
1048
1039
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -1056,15 +1047,15 @@ module Google
|
|
1056
1047
|
# @return [::Integer]
|
1057
1048
|
# Optional. The maximum number of service accounts to return. The service may return
|
1058
1049
|
# fewer than this value.
|
1059
|
-
# If unspecified, at most 100 service accounts
|
1060
|
-
# The maximum value is 1000;
|
1050
|
+
# If unspecified, returns at most 100 service accounts.
|
1051
|
+
# The maximum value is 1000; the server will coerce values above 1000.
|
1061
1052
|
# @!attribute [rw] page_token
|
1062
1053
|
# @return [::String]
|
1063
1054
|
# Optional. A page token, received from a previous `ListSubscribers` call.
|
1064
1055
|
# Provide this to retrieve the subsequent page.
|
1065
1056
|
#
|
1066
1057
|
# When paginating, all other parameters provided to `ListSubscribers` must
|
1067
|
-
#
|
1058
|
+
# match the call that provided the page token.
|
1068
1059
|
class ListSubscribersRequest
|
1069
1060
|
include ::Google::Protobuf::MessageExts
|
1070
1061
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|