google-cloud-dialogflow-v2 0.11.0 → 0.11.4

data/lib/google/cloud/dialogflow/v2/documents/client.rb

@@ -41,13 +41,12 @@ module Google
             # See {::Google::Cloud::Dialogflow::V2::Documents::Client::Configuration}
             # for a description of the configuration fields.
             #
-            # ## Example
+            # @example
             #
-            # To modify the configuration for all Documents clients:
-            #
-            #     ::Google::Cloud::Dialogflow::V2::Documents::Client.configure do |config|
-            #       config.timeout = 10.0
-            #     end
+            #   # Modify the configuration for all Documents clients
+            #   ::Google::Cloud::Dialogflow::V2::Documents::Client.configure do |config|
+            #     config.timeout = 10.0
+            #   end
             #
             # @yield [config] Configure the Client client.
             # @yieldparam config [Client::Configuration]
@@ -99,19 +98,15 @@ module Google
             ##
             # Create a new Documents client object.
             #
-            # ## Examples
-            #
-            # To create a new Documents client with the default
-            # configuration:
-            #
-            #     client = ::Google::Cloud::Dialogflow::V2::Documents::Client.new
+            # @example
             #
-            # To create a new Documents client with a custom
-            # configuration:
+            #   # Create a client using the default configuration
+            #   client = ::Google::Cloud::Dialogflow::V2::Documents::Client.new
             #
-            #     client = ::Google::Cloud::Dialogflow::V2::Documents::Client.new do |config|
-            #       config.timeout = 10.0
-            #     end
+            #   # Create a client using a custom configuration
+            #   client = ::Google::Cloud::Dialogflow::V2::Documents::Client.new do |config|
+            #     config.timeout = 10.0
+            #   end
             #
             # @yield [config] Configure the Documents client.
             # @yieldparam config [Client::Configuration]
@@ -131,10 +126,9 @@ module Google
 
               # Create credentials
               credentials = @config.credentials
-              # Use self-signed JWT if the scope and endpoint are unchanged from default,
+              # Use self-signed JWT if the endpoint is unchanged from default,
               # but only if the default endpoint does not have a region prefix.
-              enable_self_signed_jwt = @config.scope == Client.configure.scope &&
-                                       @config.endpoint == Client.configure.endpoint &&
+              enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
                                        !@config.endpoint.split(".").first.include?("-")
               credentials ||= Credentials.default scope: @config.scope,
                                                   enable_self_signed_jwt: enable_self_signed_jwt
@@ -229,7 +223,9 @@ module Google
               options.apply_defaults timeout:      @config.rpcs.list_documents.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.list_documents.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @documents_stub.call_rpc :list_documents, request, options: options do |response, operation|
@@ -298,7 +294,9 @@ module Google
               options.apply_defaults timeout:      @config.rpcs.get_document.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.get_document.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @documents_stub.call_rpc :get_document, request, options: options do |response, operation|
@@ -312,8 +310,12 @@ module Google
             ##
             # Creates a new document.
             #
-            # Operation <response: {::Google::Cloud::Dialogflow::V2::Document Document},
-            #            metadata: {::Google::Cloud::Dialogflow::V2::KnowledgeOperationMetadata KnowledgeOperationMetadata}>
+            # This method is a [long-running
+            # operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
+            # The returned `Operation` type has the following method-specific fields:
+            #
+            # - `metadata`: {::Google::Cloud::Dialogflow::V2::KnowledgeOperationMetadata KnowledgeOperationMetadata}
+            # - `response`: {::Google::Cloud::Dialogflow::V2::Document Document}
             #
             # @overload create_document(request, options = nil)
             #   Pass arguments to `create_document` via a request object, either of type
@@ -371,7 +373,9 @@ module Google
               options.apply_defaults timeout:      @config.rpcs.create_document.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.create_document.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @documents_stub.call_rpc :create_document, request, options: options do |response, operation|
@@ -386,8 +390,13 @@ module Google
             ##
             # Deletes the specified document.
             #
-            # Operation <response: {::Google::Protobuf::Empty google.protobuf.Empty},
-            #            metadata: {::Google::Cloud::Dialogflow::V2::KnowledgeOperationMetadata KnowledgeOperationMetadata}>
+            # This method is a [long-running
+            # operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
+            # The returned `Operation` type has the following method-specific fields:
+            #
+            # - `metadata`: {::Google::Cloud::Dialogflow::V2::KnowledgeOperationMetadata KnowledgeOperationMetadata}
+            # - `response`: An [Empty
+            #   message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
             #
             # @overload delete_document(request, options = nil)
             #   Pass arguments to `delete_document` via a request object, either of type
@@ -443,7 +452,9 @@ module Google
               options.apply_defaults timeout:      @config.rpcs.delete_document.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.delete_document.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @documents_stub.call_rpc :delete_document, request, options: options do |response, operation|
@@ -458,8 +469,12 @@ module Google
             ##
             # Updates the specified document.
             #
-            # Operation <response: {::Google::Cloud::Dialogflow::V2::Document Document},
-            #            metadata: {::Google::Cloud::Dialogflow::V2::KnowledgeOperationMetadata KnowledgeOperationMetadata}>
+            # This method is a [long-running
+            # operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
+            # The returned `Operation` type has the following method-specific fields:
+            #
+            # - `metadata`: {::Google::Cloud::Dialogflow::V2::KnowledgeOperationMetadata KnowledgeOperationMetadata}
+            # - `response`: {::Google::Cloud::Dialogflow::V2::Document Document}
             #
             # @overload update_document(request, options = nil)
             #   Pass arguments to `update_document` via a request object, either of type
@@ -517,7 +532,9 @@ module Google
               options.apply_defaults timeout:      @config.rpcs.update_document.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.update_document.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @documents_stub.call_rpc :update_document, request, options: options do |response, operation|
@@ -535,12 +552,16 @@ module Google
             # Note: Even when the content of the document has not changed, there still
             # may be side effects because of internal implementation changes.
             #
+            # This method is a [long-running
+            # operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
+            # The returned `Operation` type has the following method-specific fields:
+            #
+            # - `metadata`: {::Google::Cloud::Dialogflow::V2::KnowledgeOperationMetadata KnowledgeOperationMetadata}
+            # - `response`: {::Google::Cloud::Dialogflow::V2::Document Document}
+            #
             # Note: The `projects.agent.knowledgeBases.documents` resource is deprecated;
             # only use `projects.knowledgeBases.documents`.
             #
-            # Operation <response: {::Google::Cloud::Dialogflow::V2::Document Document},
-            #            metadata: {::Google::Cloud::Dialogflow::V2::KnowledgeOperationMetadata KnowledgeOperationMetadata}>
-            #
             # @overload reload_document(request, options = nil)
             #   Pass arguments to `reload_document` via a request object, either of type
             #   {::Google::Cloud::Dialogflow::V2::ReloadDocumentRequest} or an equivalent Hash.
@@ -601,7 +622,9 @@ module Google
               options.apply_defaults timeout:      @config.rpcs.reload_document.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.reload_document.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @documents_stub.call_rpc :reload_document, request, options: options do |response, operation|
@@ -626,22 +649,21 @@ module Google
             # Configuration can be applied globally to all clients, or to a single client
             # on construction.
             #
-            # # Examples
-            #
-            # To modify the global config, setting the timeout for list_documents
-            # to 20 seconds, and all remaining timeouts to 10 seconds:
-            #
-            #     ::Google::Cloud::Dialogflow::V2::Documents::Client.configure do |config|
-            #       config.timeout = 10.0
-            #       config.rpcs.list_documents.timeout = 20.0
-            #     end
-            #
-            # To apply the above configuration only to a new client:
-            #
-            #     client = ::Google::Cloud::Dialogflow::V2::Documents::Client.new do |config|
-            #       config.timeout = 10.0
-            #       config.rpcs.list_documents.timeout = 20.0
-            #     end
+            # @example
+            #
+            #   # Modify the global config, setting the timeout for
+            #   # list_documents to 20 seconds,
+            #   # and all remaining timeouts to 10 seconds.
+            #   ::Google::Cloud::Dialogflow::V2::Documents::Client.configure do |config|
+            #     config.timeout = 10.0
+            #     config.rpcs.list_documents.timeout = 20.0
+            #   end
+            #
+            #   # Apply the above configuration only to a new client.
+            #   client = ::Google::Cloud::Dialogflow::V2::Documents::Client.new do |config|
+            #     config.timeout = 10.0
+            #     config.rpcs.list_documents.timeout = 20.0
+            #   end
             #
             # @!attribute [rw] endpoint
             #   The hostname or hostname:port of the service endpoint.

data/lib/google/cloud/dialogflow/v2/documents/operations.rb

@@ -169,7 +169,9 @@ module Google
               options.apply_defaults timeout:      @config.rpcs.list_operations.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.list_operations.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @operations_stub.call_rpc :list_operations, request, options: options do |response, operation|
@@ -239,7 +241,9 @@ module Google
               options.apply_defaults timeout:      @config.rpcs.get_operation.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.get_operation.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @operations_stub.call_rpc :get_operation, request, options: options do |response, operation|
@@ -309,7 +313,9 @@ module Google
               options.apply_defaults timeout:      @config.rpcs.delete_operation.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.delete_operation.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @operations_stub.call_rpc :delete_operation, request, options: options do |response, operation|
@@ -384,7 +390,9 @@ module Google
               options.apply_defaults timeout:      @config.rpcs.cancel_operation.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.cancel_operation.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @operations_stub.call_rpc :cancel_operation, request, options: options do |response, operation|
@@ -456,7 +464,9 @@ module Google
               options.apply_defaults timeout:      @config.rpcs.wait_operation.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.wait_operation.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @operations_stub.call_rpc :wait_operation, request, options: options do |response, operation|
@@ -481,22 +491,21 @@ module Google
             # Configuration can be applied globally to all clients, or to a single client
             # on construction.
             #
-            # # Examples
-            #
-            # To modify the global config, setting the timeout for list_operations
-            # to 20 seconds, and all remaining timeouts to 10 seconds:
-            #
-            #     ::Google::Longrunning::Operations::Client.configure do |config|
-            #       config.timeout = 10.0
-            #       config.rpcs.list_operations.timeout = 20.0
-            #     end
-            #
-            # To apply the above configuration only to a new client:
-            #
-            #     client = ::Google::Longrunning::Operations::Client.new do |config|
-            #       config.timeout = 10.0
-            #       config.rpcs.list_operations.timeout = 20.0
-            #     end
+            # @example
+            #
+            #   # Modify the global config, setting the timeout for
+            #   # list_operations to 20 seconds,
+            #   # and all remaining timeouts to 10 seconds.
+            #   ::Google::Longrunning::Operations::Client.configure do |config|
+            #     config.timeout = 10.0
+            #     config.rpcs.list_operations.timeout = 20.0
+            #   end
+            #
+            #   # Apply the above configuration only to a new client.
+            #   client = ::Google::Longrunning::Operations::Client.new do |config|
+            #     config.timeout = 10.0
+            #     config.rpcs.list_operations.timeout = 20.0
+            #   end
             #
             # @!attribute [rw] endpoint
             #   The hostname or hostname:port of the service endpoint.

data/lib/google/cloud/dialogflow/v2/entity_type_pb.rb

@@ -1,8 +1,6 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/dialogflow/v2/entity_type.proto
 
-require 'google/protobuf'
-
 require 'google/api/annotations_pb'
 require 'google/api/client_pb'
 require 'google/api/field_behavior_pb'
@@ -10,6 +8,8 @@ require 'google/api/resource_pb'
 require 'google/longrunning/operations_pb'
 require 'google/protobuf/empty_pb'
 require 'google/protobuf/field_mask_pb'
+require 'google/protobuf'
+
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/cloud/dialogflow/v2/entity_type.proto", :syntax => :proto3) do
     add_message "google.cloud.dialogflow.v2.EntityType" do

data/lib/google/cloud/dialogflow/v2/entity_type_services_pb.rb

@@ -27,7 +27,7 @@ module Google
           # Service for managing [EntityTypes][google.cloud.dialogflow.v2.EntityType].
           class Service
 
-            include GRPC::GenericService
+            include ::GRPC::GenericService
 
             self.marshal_class_method = :encode
             self.unmarshal_class_method = :decode
@@ -57,6 +57,13 @@ module Google
             rpc :DeleteEntityType, ::Google::Cloud::Dialogflow::V2::DeleteEntityTypeRequest, ::Google::Protobuf::Empty
             # Updates/Creates multiple entity types in the specified agent.
             #
+            # This method is a [long-running
+            # operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations).
+            # The returned `Operation` type has the following method-specific fields:
+            #
+            # - `metadata`: An empty [Struct
+            #   message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
+            # - `response`: [BatchUpdateEntityTypesResponse][google.cloud.dialogflow.v2.BatchUpdateEntityTypesResponse]
             #
             # Note: You should always train an agent prior to sending it queries. See the
             # [training
@@ -64,12 +71,30 @@ module Google
             rpc :BatchUpdateEntityTypes, ::Google::Cloud::Dialogflow::V2::BatchUpdateEntityTypesRequest, ::Google::Longrunning::Operation
             # Deletes entity types in the specified agent.
             #
+            # This method is a [long-running
+            # operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations).
+            # The returned `Operation` type has the following method-specific fields:
+            #
+            # - `metadata`: An empty [Struct
+            #   message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
+            # - `response`: An [Empty
+            #   message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
+            #
             # Note: You should always train an agent prior to sending it queries. See the
             # [training
             # documentation](https://cloud.google.com/dialogflow/es/docs/training).
             rpc :BatchDeleteEntityTypes, ::Google::Cloud::Dialogflow::V2::BatchDeleteEntityTypesRequest, ::Google::Longrunning::Operation
             # Creates multiple new entities in the specified entity type.
             #
+            # This method is a [long-running
+            # operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations).
+            # The returned `Operation` type has the following method-specific fields:
+            #
+            # - `metadata`: An empty [Struct
+            #   message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
+            # - `response`: An [Empty
+            #   message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
+            #
             # Note: You should always train an agent prior to sending it queries. See the
             # [training
             # documentation](https://cloud.google.com/dialogflow/es/docs/training).
@@ -78,12 +103,31 @@ module Google
             # method does not affect entities in the entity type that aren't explicitly
             # specified in the request.
             #
+            # This method is a [long-running
+            # operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations).
+            # The returned `Operation` type has the following method-specific fields:
+            #
+            # - `metadata`: An empty [Struct
+            #   message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
+            # - `response`: An [Empty
+            #   message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
+            #
             # Note: You should always train an agent prior to sending it queries. See the
             # [training
             # documentation](https://cloud.google.com/dialogflow/es/docs/training).
+            #
             rpc :BatchUpdateEntities, ::Google::Cloud::Dialogflow::V2::BatchUpdateEntitiesRequest, ::Google::Longrunning::Operation
             # Deletes entities in the specified entity type.
             #
+            # This method is a [long-running
+            # operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations).
+            # The returned `Operation` type has the following method-specific fields:
+            #
+            # - `metadata`: An empty [Struct
+            #   message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
+            # - `response`: An [Empty
+            #   message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
+            #
             # Note: You should always train an agent prior to sending it queries. See the
             # [training
             # documentation](https://cloud.google.com/dialogflow/es/docs/training).