google-cloud-channel-v1 0.9.0 → 0.9.4

data/lib/google/cloud/channel/v1/cloud_channel_service/operations.rb

@@ -143,6 +143,27 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/longrunning"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Longrunning::Operations::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Longrunning::ListOperationsRequest.new
+            #
+            #   # Call the list_operations method.
+            #   result = client.list_operations request
+            #
+            #   # The returned object is of type Gapic::PagedEnumerable. You can
+            #   # iterate over all elements by calling #each, and the enumerable
+            #   # will lazily make API calls to fetch subsequent pages. Other
+            #   # methods are also available for managing paging directly.
+            #   result.each do |response|
+            #     # Each element is of type ::Google::Longrunning::Operation.
+            #     p response
+            #   end
+            #
             def list_operations request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -217,6 +238,28 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/longrunning"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Longrunning::Operations::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Longrunning::GetOperationRequest.new
+            #
+            #   # Call the get_operation method.
+            #   result = client.get_operation request
+            #
+            #   # The returned object is of type Gapic::Operation. You can use this
+            #   # object to check the status of an operation, cancel it, or wait
+            #   # for results. Here is how to block until completion:
+            #   result.wait_until_done! timeout: 60
+            #   if result.response?
+            #     p result.response
+            #   else
+            #     puts "Error!"
+            #   end
+            #
             def get_operation request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -291,6 +334,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/longrunning"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Longrunning::Operations::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Longrunning::DeleteOperationRequest.new
+            #
+            #   # Call the delete_operation method.
+            #   result = client.delete_operation request
+            #
+            #   # The returned object is of type Google::Protobuf::Empty.
+            #   p result
+            #
             def delete_operation request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -370,6 +428,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/longrunning"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Longrunning::Operations::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Longrunning::CancelOperationRequest.new
+            #
+            #   # Call the cancel_operation method.
+            #   result = client.cancel_operation request
+            #
+            #   # The returned object is of type Google::Protobuf::Empty.
+            #   p result
+            #
             def cancel_operation request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -452,6 +525,28 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/longrunning"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Longrunning::Operations::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Longrunning::WaitOperationRequest.new
+            #
+            #   # Call the wait_operation method.
+            #   result = client.wait_operation request
+            #
+            #   # The returned object is of type Gapic::Operation. You can use this
+            #   # object to check the status of an operation, cancel it, or wait
+            #   # for results. Here is how to block until completion:
+            #   result.wait_until_done! timeout: 60
+            #   if result.response?
+            #     p result.response
+            #   else
+            #     puts "Error!"
+            #   end
+            #
             def wait_operation request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 

data/lib/google/cloud/channel/v1/common_pb.rb

@@ -1,9 +1,9 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/channel/v1/common.proto
 
+require 'google/api/annotations_pb'
 require 'google/api/field_behavior_pb'
 require 'google/protobuf/any_pb'
-require 'google/api/annotations_pb'
 require 'google/protobuf'
 
 Google::Protobuf::DescriptorPool.generated_pool.build do

data/lib/google/cloud/channel/v1/customers_pb.rb

@@ -1,12 +1,12 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/channel/v1/customers.proto
 
+require 'google/api/annotations_pb'
 require 'google/api/field_behavior_pb'
 require 'google/api/resource_pb'
 require 'google/cloud/channel/v1/common_pb'
 require 'google/protobuf/timestamp_pb'
 require 'google/type/postal_address_pb'
-require 'google/api/annotations_pb'
 require 'google/protobuf'
 
 Google::Protobuf::DescriptorPool.generated_pool.build do

data/lib/google/cloud/channel/v1/entitlements_pb.rb

@@ -1,6 +1,7 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/channel/v1/entitlements.proto
 
+require 'google/api/annotations_pb'
 require 'google/api/field_behavior_pb'
 require 'google/api/resource_pb'
 require 'google/cloud/channel/v1/common_pb'
@@ -8,7 +9,6 @@ require 'google/cloud/channel/v1/offers_pb'
 require 'google/cloud/channel/v1/products_pb'
 require 'google/protobuf/timestamp_pb'
 require 'google/protobuf/wrappers_pb'
-require 'google/api/annotations_pb'
 require 'google/protobuf'
 
 Google::Protobuf::DescriptorPool.generated_pool.build do

data/lib/google/cloud/channel/v1/offers_pb.rb

@@ -1,13 +1,13 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/channel/v1/offers.proto
 
+require 'google/api/annotations_pb'
 require 'google/api/field_behavior_pb'
 require 'google/api/resource_pb'
 require 'google/cloud/channel/v1/common_pb'
 require 'google/cloud/channel/v1/products_pb'
 require 'google/protobuf/timestamp_pb'
 require 'google/type/money_pb'
-require 'google/api/annotations_pb'
 require 'google/protobuf'
 
 Google::Protobuf::DescriptorPool.generated_pool.build do

data/lib/google/cloud/channel/v1/products_pb.rb

@@ -1,8 +1,8 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/channel/v1/products.proto
 
-require 'google/api/resource_pb'
 require 'google/api/annotations_pb'
+require 'google/api/resource_pb'
 require 'google/protobuf'
 
 Google::Protobuf::DescriptorPool.generated_pool.build do

data/lib/google/cloud/channel/v1/subscriber_event_pb.rb

@@ -1,8 +1,8 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/channel/v1/subscriber_event.proto
 
-require 'google/api/resource_pb'
 require 'google/api/annotations_pb'
+require 'google/api/resource_pb'
 require 'google/protobuf'
 
 Google::Protobuf::DescriptorPool.generated_pool.build do

data/lib/google/cloud/channel/v1/version.rb

@@ -21,7 +21,7 @@ module Google
   module Cloud
     module Channel
       module V1
-        VERSION = "0.9.0"
+        VERSION = "0.9.4"
       end
     end
   end

data/proto_docs/google/api/resource.rb

@@ -33,11 +33,7 @@ module Google
     #       // For Kubernetes resources, the format is {api group}/{kind}.
     #       option (google.api.resource) = {
     #         type: "pubsub.googleapis.com/Topic"
-    #         name_descriptor: {
-    #           pattern: "projects/{project}/topics/{topic}"
-    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
-    #           parent_name_extractor: "projects/{project}"
-    #         }
+    #         pattern: "projects/{project}/topics/{topic}"
     #       };
     #     }
     #
@@ -45,10 +41,7 @@ module Google
     #
     #     resources:
     #     - type: "pubsub.googleapis.com/Topic"
-    #       name_descriptor:
-    #         - pattern: "projects/{project}/topics/{topic}"
-    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
-    #           parent_name_extractor: "projects/{project}"
+    #       pattern: "projects/{project}/topics/{topic}"
     #
     # Sometimes, resources have multiple patterns, typically because they can
     # live under multiple parents.
@@ -58,26 +51,10 @@ module Google
     #     message LogEntry {
     #       option (google.api.resource) = {
     #         type: "logging.googleapis.com/LogEntry"
-    #         name_descriptor: {
-    #           pattern: "projects/{project}/logs/{log}"
-    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
-    #           parent_name_extractor: "projects/{project}"
-    #         }
-    #         name_descriptor: {
-    #           pattern: "folders/{folder}/logs/{log}"
-    #           parent_type: "cloudresourcemanager.googleapis.com/Folder"
-    #           parent_name_extractor: "folders/{folder}"
-    #         }
-    #         name_descriptor: {
-    #           pattern: "organizations/{organization}/logs/{log}"
-    #           parent_type: "cloudresourcemanager.googleapis.com/Organization"
-    #           parent_name_extractor: "organizations/{organization}"
-    #         }
-    #         name_descriptor: {
-    #           pattern: "billingAccounts/{billing_account}/logs/{log}"
-    #           parent_type: "billing.googleapis.com/BillingAccount"
-    #           parent_name_extractor: "billingAccounts/{billing_account}"
-    #         }
+    #         pattern: "projects/{project}/logs/{log}"
+    #         pattern: "folders/{folder}/logs/{log}"
+    #         pattern: "organizations/{organization}/logs/{log}"
+    #         pattern: "billingAccounts/{billing_account}/logs/{log}"
     #       };
     #     }
     #
@@ -85,48 +62,10 @@ module Google
     #
     #     resources:
     #     - type: 'logging.googleapis.com/LogEntry'
-    #       name_descriptor:
-    #         - pattern: "projects/{project}/logs/{log}"
-    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
-    #           parent_name_extractor: "projects/{project}"
-    #         - pattern: "folders/{folder}/logs/{log}"
-    #           parent_type: "cloudresourcemanager.googleapis.com/Folder"
-    #           parent_name_extractor: "folders/{folder}"
-    #         - pattern: "organizations/{organization}/logs/{log}"
-    #           parent_type: "cloudresourcemanager.googleapis.com/Organization"
-    #           parent_name_extractor: "organizations/{organization}"
-    #         - pattern: "billingAccounts/{billing_account}/logs/{log}"
-    #           parent_type: "billing.googleapis.com/BillingAccount"
-    #           parent_name_extractor: "billingAccounts/{billing_account}"
-    #
-    # For flexible resources, the resource name doesn't contain parent names, but
-    # the resource itself has parents for policy evaluation.
-    #
-    # Example:
-    #
-    #     message Shelf {
-    #       option (google.api.resource) = {
-    #         type: "library.googleapis.com/Shelf"
-    #         name_descriptor: {
-    #           pattern: "shelves/{shelf}"
-    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
-    #         }
-    #         name_descriptor: {
-    #           pattern: "shelves/{shelf}"
-    #           parent_type: "cloudresourcemanager.googleapis.com/Folder"
-    #         }
-    #       };
-    #     }
-    #
-    # The ResourceDescriptor Yaml config will look like:
-    #
-    #     resources:
-    #     - type: 'library.googleapis.com/Shelf'
-    #       name_descriptor:
-    #         - pattern: "shelves/{shelf}"
-    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
-    #         - pattern: "shelves/{shelf}"
-    #           parent_type: "cloudresourcemanager.googleapis.com/Folder"
+    #       pattern: "projects/{project}/logs/{log}"
+    #       pattern: "folders/{folder}/logs/{log}"
+    #       pattern: "organizations/{organization}/logs/{log}"
+    #       pattern: "billingAccounts/{billing_account}/logs/{log}"
     # @!attribute [rw] type
     #   @return [::String]
     #     The resource type. It must be in the format of

data/proto_docs/google/cloud/channel/v1/channel_partner_links.rb

@@ -70,7 +70,7 @@ module Google
 
         # ChannelPartnerLinkState represents state of a channel partner link.
         module ChannelPartnerLinkState
-          # The state is not specified.
+          # Not used.
           CHANNEL_PARTNER_LINK_STATE_UNSPECIFIED = 0
 
           # An invitation has been sent to the reseller to create a channel partner

data/proto_docs/google/cloud/channel/v1/common.rb

@@ -37,7 +37,7 @@ module Google
 
           # Enum to specify the institute type.
           module InstituteType
-            # Default value.  This state doesn't show unless an error occurs.
+            # Not used.
             INSTITUTE_TYPE_UNSPECIFIED = 0
 
             # Elementary/Secondary Schools & Districts
@@ -49,7 +49,7 @@ module Google
 
           # Number of students and staff the institute has.
           module InstituteSize
-            # Default value. This state doesn't show unless an error occurs.
+            # Not used.
             INSTITUTE_SIZE_UNSPECIFIED = 0
 
             # 1 - 100
@@ -110,7 +110,7 @@ module Google
 
           # CustomerType of the customer
           module CustomerType
-            # Default value. This state doesn't show unless an error occurs.
+            # Not used.
             CUSTOMER_TYPE_UNSPECIFIED = 0
 
             # Domain-owning customer which needs domain verification to use services.

data/proto_docs/google/cloud/channel/v1/entitlements.rb

@@ -64,15 +64,23 @@ module Google
         # @!attribute [rw] parameters
         #   @return [::Array<::Google::Cloud::Channel::V1::Parameter>]
         #     Extended entitlement parameters. When creating an entitlement, valid
-        #     parameters' names and values are defined in the offer's parameter
-        #     definitions.
+        #     parameter names and values are defined in the
+        #     {::Google::Cloud::Channel::V1::Offer#parameter_definitions Offer.parameter_definitions}.
+        #
+        #     The response may include the following output-only Parameters:
+        #
+        #     - assigned_units: The number of licenses assigned to users.
+        #
+        #     - max_units: The maximum assignable units for a flexible offer.
+        #
+        #     - num_units: The total commitment for commitment-based offers.
         class Entitlement
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
 
           # Indicates the current provisioning state of the entitlement.
           module ProvisioningState
-            # Default value. This state doesn't show unless an error occurs.
+            # Not used.
             PROVISIONING_STATE_UNSPECIFIED = 0
 
             # The entitlement is currently active.
@@ -84,7 +92,7 @@ module Google
 
           # Suspension reason for an entitlement if {::Google::Cloud::Channel::V1::Entitlement#provisioning_state provisioning_state} = SUSPENDED.
           module SuspensionReason
-            # Default value. This state doesn't show unless an error occurs.
+            # Not used.
             SUSPENSION_REASON_UNSPECIFIED = 0
 
             # Entitlement was manually suspended by the Reseller.
@@ -233,7 +241,7 @@ module Google
 
           # Reason of ineligibility.
           module Reason
-            # Reason is not available.
+            # Not used.
             REASON_UNSPECIFIED = 0
 
             # Reseller needs to accept TOS before transferring the SKU.

data/proto_docs/google/cloud/channel/v1/operations.rb

@@ -31,7 +31,7 @@ module Google
 
           # RPCs that return a Long Running Operation.
           module OperationType
-            # Default value. This state doesn't show unless an error occurs.
+            # Not used.
             OPERATION_TYPE_UNSPECIFIED = 0
 
             # Long Running Operation was triggered by CreateEntitlement.

data/proto_docs/google/cloud/channel/v1/service.rb

@@ -561,6 +561,9 @@ module Google
         # @!attribute [rw] parameters
         #   @return [::Array<::Google::Cloud::Channel::V1::Parameter>]
         #     Required. Entitlement parameters to update. You can only change editable parameters.
+        #
+        #     To view the available Parameters for a request, refer to the
+        #     {::Google::Cloud::Channel::V1::Offer#parameter_definitions Offer.parameter_definitions} from the desired offer.
         # @!attribute [rw] request_id
         #   @return [::String]
         #     Optional. You can specify an optional unique request ID, and if you need to retry
@@ -621,7 +624,8 @@ module Google
         #     Format: accounts/\\{account_id}/offers/\\{offer_id}.
         # @!attribute [rw] parameters
         #   @return [::Array<::Google::Cloud::Channel::V1::Parameter>]
-        #     Optional. Parameters needed to purchase the Offer.
+        #     Optional. Parameters needed to purchase the Offer. To view the available Parameters
+        #     refer to the {::Google::Cloud::Channel::V1::Offer#parameter_definitions Offer.parameter_definitions} from the desired offer.
         # @!attribute [rw] purchase_order_id
         #   @return [::String]
         #     Optional. Purchase order id provided by the reseller.

data/proto_docs/google/cloud/channel/v1/subscriber_event.rb

@@ -35,7 +35,7 @@ module Google
 
           # Type of customer event.
           module Type
-            # Default value. This state doesn't show unless an error occurs.
+            # Not used.
             TYPE_UNSPECIFIED = 0
 
             # Primary domain for customer was changed.
@@ -60,7 +60,7 @@ module Google
 
           # Type of entitlement event.
           module Type
-            # Default value. This state doesn't show unless an error occurs.
+            # Not used.
             TYPE_UNSPECIFIED = 0
 
             # A new entitlement was created.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-channel-v1
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.9.4
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-11-02 00:00:00.000000000 Z
+date: 2022-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -230,7 +230,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.17
+rubygems_version: 3.3.5
 signing_key: 
 specification_version: 4
 summary: API Client library for the Cloud Channel V1 API