google-cloud-channel-v1 0.9.0 → 0.9.4

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.
@@ -143,6 +143,27 @@ module Google
143
143
  #
144
144
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
145
145
  #
146
+ # @example Basic example
147
+ # require "google/longrunning"
148
+ #
149
+ # # Create a client object. The client can be reused for multiple calls.
150
+ # client = Google::Longrunning::Operations::Client.new
151
+ #
152
+ # # Create a request. To set request fields, pass in keyword arguments.
153
+ # request = Google::Longrunning::ListOperationsRequest.new
154
+ #
155
+ # # Call the list_operations method.
156
+ # result = client.list_operations request
157
+ #
158
+ # # The returned object is of type Gapic::PagedEnumerable. You can
159
+ # # iterate over all elements by calling #each, and the enumerable
160
+ # # will lazily make API calls to fetch subsequent pages. Other
161
+ # # methods are also available for managing paging directly.
162
+ # result.each do |response|
163
+ # # Each element is of type ::Google::Longrunning::Operation.
164
+ # p response
165
+ # end
166
+ #
146
167
  def list_operations request, options = nil
147
168
  raise ::ArgumentError, "request must be provided" if request.nil?
148
169
 
@@ -217,6 +238,28 @@ module Google
217
238
  #
218
239
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
219
240
  #
241
+ # @example Basic example
242
+ # require "google/longrunning"
243
+ #
244
+ # # Create a client object. The client can be reused for multiple calls.
245
+ # client = Google::Longrunning::Operations::Client.new
246
+ #
247
+ # # Create a request. To set request fields, pass in keyword arguments.
248
+ # request = Google::Longrunning::GetOperationRequest.new
249
+ #
250
+ # # Call the get_operation method.
251
+ # result = client.get_operation request
252
+ #
253
+ # # The returned object is of type Gapic::Operation. You can use this
254
+ # # object to check the status of an operation, cancel it, or wait
255
+ # # for results. Here is how to block until completion:
256
+ # result.wait_until_done! timeout: 60
257
+ # if result.response?
258
+ # p result.response
259
+ # else
260
+ # puts "Error!"
261
+ # end
262
+ #
220
263
  def get_operation request, options = nil
221
264
  raise ::ArgumentError, "request must be provided" if request.nil?
222
265
 
@@ -291,6 +334,21 @@ module Google
291
334
  #
292
335
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
293
336
  #
337
+ # @example Basic example
338
+ # require "google/longrunning"
339
+ #
340
+ # # Create a client object. The client can be reused for multiple calls.
341
+ # client = Google::Longrunning::Operations::Client.new
342
+ #
343
+ # # Create a request. To set request fields, pass in keyword arguments.
344
+ # request = Google::Longrunning::DeleteOperationRequest.new
345
+ #
346
+ # # Call the delete_operation method.
347
+ # result = client.delete_operation request
348
+ #
349
+ # # The returned object is of type Google::Protobuf::Empty.
350
+ # p result
351
+ #
294
352
  def delete_operation request, options = nil
295
353
  raise ::ArgumentError, "request must be provided" if request.nil?
296
354
 
@@ -370,6 +428,21 @@ module Google
370
428
  #
371
429
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
372
430
  #
431
+ # @example Basic example
432
+ # require "google/longrunning"
433
+ #
434
+ # # Create a client object. The client can be reused for multiple calls.
435
+ # client = Google::Longrunning::Operations::Client.new
436
+ #
437
+ # # Create a request. To set request fields, pass in keyword arguments.
438
+ # request = Google::Longrunning::CancelOperationRequest.new
439
+ #
440
+ # # Call the cancel_operation method.
441
+ # result = client.cancel_operation request
442
+ #
443
+ # # The returned object is of type Google::Protobuf::Empty.
444
+ # p result
445
+ #
373
446
  def cancel_operation request, options = nil
374
447
  raise ::ArgumentError, "request must be provided" if request.nil?
375
448
 
@@ -452,6 +525,28 @@ module Google
452
525
  #
453
526
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
454
527
  #
528
+ # @example Basic example
529
+ # require "google/longrunning"
530
+ #
531
+ # # Create a client object. The client can be reused for multiple calls.
532
+ # client = Google::Longrunning::Operations::Client.new
533
+ #
534
+ # # Create a request. To set request fields, pass in keyword arguments.
535
+ # request = Google::Longrunning::WaitOperationRequest.new
536
+ #
537
+ # # Call the wait_operation method.
538
+ # result = client.wait_operation request
539
+ #
540
+ # # The returned object is of type Gapic::Operation. You can use this
541
+ # # object to check the status of an operation, cancel it, or wait
542
+ # # for results. Here is how to block until completion:
543
+ # result.wait_until_done! timeout: 60
544
+ # if result.response?
545
+ # p result.response
546
+ # else
547
+ # puts "Error!"
548
+ # end
549
+ #
455
550
  def wait_operation request, options = nil
456
551
  raise ::ArgumentError, "request must be provided" if request.nil?
457
552
 
@@ -1,9 +1,9 @@
1
1
  # Generated by the protocol buffer compiler. DO NOT EDIT!
2
2
  # source: google/cloud/channel/v1/common.proto
3
3
 
4
+ require 'google/api/annotations_pb'
4
5
  require 'google/api/field_behavior_pb'
5
6
  require 'google/protobuf/any_pb'
6
- require 'google/api/annotations_pb'
7
7
  require 'google/protobuf'
8
8
 
9
9
  Google::Protobuf::DescriptorPool.generated_pool.build do
@@ -1,12 +1,12 @@
1
1
  # Generated by the protocol buffer compiler. DO NOT EDIT!
2
2
  # source: google/cloud/channel/v1/customers.proto
3
3
 
4
+ require 'google/api/annotations_pb'
4
5
  require 'google/api/field_behavior_pb'
5
6
  require 'google/api/resource_pb'
6
7
  require 'google/cloud/channel/v1/common_pb'
7
8
  require 'google/protobuf/timestamp_pb'
8
9
  require 'google/type/postal_address_pb'
9
- require 'google/api/annotations_pb'
10
10
  require 'google/protobuf'
11
11
 
12
12
  Google::Protobuf::DescriptorPool.generated_pool.build do
@@ -1,6 +1,7 @@
1
1
  # Generated by the protocol buffer compiler. DO NOT EDIT!
2
2
  # source: google/cloud/channel/v1/entitlements.proto
3
3
 
4
+ require 'google/api/annotations_pb'
4
5
  require 'google/api/field_behavior_pb'
5
6
  require 'google/api/resource_pb'
6
7
  require 'google/cloud/channel/v1/common_pb'
@@ -8,7 +9,6 @@ require 'google/cloud/channel/v1/offers_pb'
8
9
  require 'google/cloud/channel/v1/products_pb'
9
10
  require 'google/protobuf/timestamp_pb'
10
11
  require 'google/protobuf/wrappers_pb'
11
- require 'google/api/annotations_pb'
12
12
  require 'google/protobuf'
13
13
 
14
14
  Google::Protobuf::DescriptorPool.generated_pool.build do
@@ -1,13 +1,13 @@
1
1
  # Generated by the protocol buffer compiler. DO NOT EDIT!
2
2
  # source: google/cloud/channel/v1/offers.proto
3
3
 
4
+ require 'google/api/annotations_pb'
4
5
  require 'google/api/field_behavior_pb'
5
6
  require 'google/api/resource_pb'
6
7
  require 'google/cloud/channel/v1/common_pb'
7
8
  require 'google/cloud/channel/v1/products_pb'
8
9
  require 'google/protobuf/timestamp_pb'
9
10
  require 'google/type/money_pb'
10
- require 'google/api/annotations_pb'
11
11
  require 'google/protobuf'
12
12
 
13
13
  Google::Protobuf::DescriptorPool.generated_pool.build do
@@ -1,8 +1,8 @@
1
1
  # Generated by the protocol buffer compiler. DO NOT EDIT!
2
2
  # source: google/cloud/channel/v1/products.proto
3
3
 
4
- require 'google/api/resource_pb'
5
4
  require 'google/api/annotations_pb'
5
+ require 'google/api/resource_pb'
6
6
  require 'google/protobuf'
7
7
 
8
8
  Google::Protobuf::DescriptorPool.generated_pool.build do
@@ -1,8 +1,8 @@
1
1
  # Generated by the protocol buffer compiler. DO NOT EDIT!
2
2
  # source: google/cloud/channel/v1/subscriber_event.proto
3
3
 
4
- require 'google/api/resource_pb'
5
4
  require 'google/api/annotations_pb'
5
+ require 'google/api/resource_pb'
6
6
  require 'google/protobuf'
7
7
 
8
8
  Google::Protobuf::DescriptorPool.generated_pool.build do
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module Channel
23
23
  module V1
24
- VERSION = "0.9.0"
24
+ VERSION = "0.9.4"
25
25
  end
26
26
  end
27
27
  end
@@ -33,11 +33,7 @@ module Google
33
33
  # // For Kubernetes resources, the format is {api group}/{kind}.
34
34
  # option (google.api.resource) = {
35
35
  # type: "pubsub.googleapis.com/Topic"
36
- # name_descriptor: {
37
- # pattern: "projects/{project}/topics/{topic}"
38
- # parent_type: "cloudresourcemanager.googleapis.com/Project"
39
- # parent_name_extractor: "projects/{project}"
40
- # }
36
+ # pattern: "projects/{project}/topics/{topic}"
41
37
  # };
42
38
  # }
43
39
  #
@@ -45,10 +41,7 @@ module Google
45
41
  #
46
42
  # resources:
47
43
  # - type: "pubsub.googleapis.com/Topic"
48
- # name_descriptor:
49
- # - pattern: "projects/{project}/topics/{topic}"
50
- # parent_type: "cloudresourcemanager.googleapis.com/Project"
51
- # parent_name_extractor: "projects/{project}"
44
+ # pattern: "projects/{project}/topics/{topic}"
52
45
  #
53
46
  # Sometimes, resources have multiple patterns, typically because they can
54
47
  # live under multiple parents.
@@ -58,26 +51,10 @@ module Google
58
51
  # message LogEntry {
59
52
  # option (google.api.resource) = {
60
53
  # type: "logging.googleapis.com/LogEntry"
61
- # name_descriptor: {
62
- # pattern: "projects/{project}/logs/{log}"
63
- # parent_type: "cloudresourcemanager.googleapis.com/Project"
64
- # parent_name_extractor: "projects/{project}"
65
- # }
66
- # name_descriptor: {
67
- # pattern: "folders/{folder}/logs/{log}"
68
- # parent_type: "cloudresourcemanager.googleapis.com/Folder"
69
- # parent_name_extractor: "folders/{folder}"
70
- # }
71
- # name_descriptor: {
72
- # pattern: "organizations/{organization}/logs/{log}"
73
- # parent_type: "cloudresourcemanager.googleapis.com/Organization"
74
- # parent_name_extractor: "organizations/{organization}"
75
- # }
76
- # name_descriptor: {
77
- # pattern: "billingAccounts/{billing_account}/logs/{log}"
78
- # parent_type: "billing.googleapis.com/BillingAccount"
79
- # parent_name_extractor: "billingAccounts/{billing_account}"
80
- # }
54
+ # pattern: "projects/{project}/logs/{log}"
55
+ # pattern: "folders/{folder}/logs/{log}"
56
+ # pattern: "organizations/{organization}/logs/{log}"
57
+ # pattern: "billingAccounts/{billing_account}/logs/{log}"
81
58
  # };
82
59
  # }
83
60
  #
@@ -85,48 +62,10 @@ module Google
85
62
  #
86
63
  # resources:
87
64
  # - type: 'logging.googleapis.com/LogEntry'
88
- # name_descriptor:
89
- # - pattern: "projects/{project}/logs/{log}"
90
- # parent_type: "cloudresourcemanager.googleapis.com/Project"
91
- # parent_name_extractor: "projects/{project}"
92
- # - pattern: "folders/{folder}/logs/{log}"
93
- # parent_type: "cloudresourcemanager.googleapis.com/Folder"
94
- # parent_name_extractor: "folders/{folder}"
95
- # - pattern: "organizations/{organization}/logs/{log}"
96
- # parent_type: "cloudresourcemanager.googleapis.com/Organization"
97
- # parent_name_extractor: "organizations/{organization}"
98
- # - pattern: "billingAccounts/{billing_account}/logs/{log}"
99
- # parent_type: "billing.googleapis.com/BillingAccount"
100
- # parent_name_extractor: "billingAccounts/{billing_account}"
101
- #
102
- # For flexible resources, the resource name doesn't contain parent names, but
103
- # the resource itself has parents for policy evaluation.
104
- #
105
- # Example:
106
- #
107
- # message Shelf {
108
- # option (google.api.resource) = {
109
- # type: "library.googleapis.com/Shelf"
110
- # name_descriptor: {
111
- # pattern: "shelves/{shelf}"
112
- # parent_type: "cloudresourcemanager.googleapis.com/Project"
113
- # }
114
- # name_descriptor: {
115
- # pattern: "shelves/{shelf}"
116
- # parent_type: "cloudresourcemanager.googleapis.com/Folder"
117
- # }
118
- # };
119
- # }
120
- #
121
- # The ResourceDescriptor Yaml config will look like:
122
- #
123
- # resources:
124
- # - type: 'library.googleapis.com/Shelf'
125
- # name_descriptor:
126
- # - pattern: "shelves/{shelf}"
127
- # parent_type: "cloudresourcemanager.googleapis.com/Project"
128
- # - pattern: "shelves/{shelf}"
129
- # parent_type: "cloudresourcemanager.googleapis.com/Folder"
65
+ # pattern: "projects/{project}/logs/{log}"
66
+ # pattern: "folders/{folder}/logs/{log}"
67
+ # pattern: "organizations/{organization}/logs/{log}"
68
+ # pattern: "billingAccounts/{billing_account}/logs/{log}"
130
69
  # @!attribute [rw] type
131
70
  # @return [::String]
132
71
  # The resource type. It must be in the format of
@@ -70,7 +70,7 @@ module Google
70
70
 
71
71
  # ChannelPartnerLinkState represents state of a channel partner link.
72
72
  module ChannelPartnerLinkState
73
- # The state is not specified.
73
+ # Not used.
74
74
  CHANNEL_PARTNER_LINK_STATE_UNSPECIFIED = 0
75
75
 
76
76
  # An invitation has been sent to the reseller to create a channel partner
@@ -37,7 +37,7 @@ module Google
37
37
 
38
38
  # Enum to specify the institute type.
39
39
  module InstituteType
40
- # Default value. This state doesn't show unless an error occurs.
40
+ # Not used.
41
41
  INSTITUTE_TYPE_UNSPECIFIED = 0
42
42
 
43
43
  # Elementary/Secondary Schools & Districts
@@ -49,7 +49,7 @@ module Google
49
49
 
50
50
  # Number of students and staff the institute has.
51
51
  module InstituteSize
52
- # Default value. This state doesn't show unless an error occurs.
52
+ # Not used.
53
53
  INSTITUTE_SIZE_UNSPECIFIED = 0
54
54
 
55
55
  # 1 - 100
@@ -110,7 +110,7 @@ module Google
110
110
 
111
111
  # CustomerType of the customer
112
112
  module CustomerType
113
- # Default value. This state doesn't show unless an error occurs.
113
+ # Not used.
114
114
  CUSTOMER_TYPE_UNSPECIFIED = 0
115
115
 
116
116
  # Domain-owning customer which needs domain verification to use services.
@@ -64,15 +64,23 @@ module Google
64
64
  # @!attribute [rw] parameters
65
65
  # @return [::Array<::Google::Cloud::Channel::V1::Parameter>]
66
66
  # Extended entitlement parameters. When creating an entitlement, valid
67
- # parameters' names and values are defined in the offer's parameter
68
- # definitions.
67
+ # parameter names and values are defined in the
68
+ # {::Google::Cloud::Channel::V1::Offer#parameter_definitions Offer.parameter_definitions}.
69
+ #
70
+ # The response may include the following output-only Parameters:
71
+ #
72
+ # - assigned_units: The number of licenses assigned to users.
73
+ #
74
+ # - max_units: The maximum assignable units for a flexible offer.
75
+ #
76
+ # - num_units: The total commitment for commitment-based offers.
69
77
  class Entitlement
70
78
  include ::Google::Protobuf::MessageExts
71
79
  extend ::Google::Protobuf::MessageExts::ClassMethods
72
80
 
73
81
  # Indicates the current provisioning state of the entitlement.
74
82
  module ProvisioningState
75
- # Default value. This state doesn't show unless an error occurs.
83
+ # Not used.
76
84
  PROVISIONING_STATE_UNSPECIFIED = 0
77
85
 
78
86
  # The entitlement is currently active.
@@ -84,7 +92,7 @@ module Google
84
92
 
85
93
  # Suspension reason for an entitlement if {::Google::Cloud::Channel::V1::Entitlement#provisioning_state provisioning_state} = SUSPENDED.
86
94
  module SuspensionReason
87
- # Default value. This state doesn't show unless an error occurs.
95
+ # Not used.
88
96
  SUSPENSION_REASON_UNSPECIFIED = 0
89
97
 
90
98
  # Entitlement was manually suspended by the Reseller.
@@ -233,7 +241,7 @@ module Google
233
241
 
234
242
  # Reason of ineligibility.
235
243
  module Reason
236
- # Reason is not available.
244
+ # Not used.
237
245
  REASON_UNSPECIFIED = 0
238
246
 
239
247
  # Reseller needs to accept TOS before transferring the SKU.
@@ -31,7 +31,7 @@ module Google
31
31
 
32
32
  # RPCs that return a Long Running Operation.
33
33
  module OperationType
34
- # Default value. This state doesn't show unless an error occurs.
34
+ # Not used.
35
35
  OPERATION_TYPE_UNSPECIFIED = 0
36
36
 
37
37
  # Long Running Operation was triggered by CreateEntitlement.
@@ -561,6 +561,9 @@ module Google
561
561
  # @!attribute [rw] parameters
562
562
  # @return [::Array<::Google::Cloud::Channel::V1::Parameter>]
563
563
  # Required. Entitlement parameters to update. You can only change editable parameters.
564
+ #
565
+ # To view the available Parameters for a request, refer to the
566
+ # {::Google::Cloud::Channel::V1::Offer#parameter_definitions Offer.parameter_definitions} from the desired offer.
564
567
  # @!attribute [rw] request_id
565
568
  # @return [::String]
566
569
  # Optional. You can specify an optional unique request ID, and if you need to retry
@@ -621,7 +624,8 @@ module Google
621
624
  # Format: accounts/\\{account_id}/offers/\\{offer_id}.
622
625
  # @!attribute [rw] parameters
623
626
  # @return [::Array<::Google::Cloud::Channel::V1::Parameter>]
624
- # Optional. Parameters needed to purchase the Offer.
627
+ # Optional. Parameters needed to purchase the Offer. To view the available Parameters
628
+ # refer to the {::Google::Cloud::Channel::V1::Offer#parameter_definitions Offer.parameter_definitions} from the desired offer.
625
629
  # @!attribute [rw] purchase_order_id
626
630
  # @return [::String]
627
631
  # Optional. Purchase order id provided by the reseller.
@@ -35,7 +35,7 @@ module Google
35
35
 
36
36
  # Type of customer event.
37
37
  module Type
38
- # Default value. This state doesn't show unless an error occurs.
38
+ # Not used.
39
39
  TYPE_UNSPECIFIED = 0
40
40
 
41
41
  # Primary domain for customer was changed.
@@ -60,7 +60,7 @@ module Google
60
60
 
61
61
  # Type of entitlement event.
62
62
  module Type
63
- # Default value. This state doesn't show unless an error occurs.
63
+ # Not used.
64
64
  TYPE_UNSPECIFIED = 0
65
65
 
66
66
  # A new entitlement was created.
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-channel-v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.9.0
4
+ version: 0.9.4
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2021-11-02 00:00:00.000000000 Z
11
+ date: 2022-01-20 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: gapic-common
@@ -230,7 +230,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
230
230
  - !ruby/object:Gem::Version
231
231
  version: '0'
232
232
  requirements: []
233
- rubygems_version: 3.2.17
233
+ rubygems_version: 3.3.5
234
234
  signing_key:
235
235
  specification_version: 4
236
236
  summary: API Client library for the Cloud Channel V1 API