google-cloud-discovery_engine-v1beta 0.6.0 → 0.7.1
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 +72 -99
- data/lib/google/cloud/discovery_engine/v1beta/completion_service/client.rb +38 -14
- data/lib/google/cloud/discovery_engine/v1beta/completion_service/rest/client.rb +36 -9
- data/lib/google/cloud/discovery_engine/v1beta/completion_service/rest/service_stub.rb +23 -2
- data/lib/google/cloud/discovery_engine/v1beta/conversational_search_service/client.rb +38 -14
- data/lib/google/cloud/discovery_engine/v1beta/conversational_search_service/rest/client.rb +36 -9
- data/lib/google/cloud/discovery_engine/v1beta/conversational_search_service/rest/service_stub.rb +23 -2
- data/lib/google/cloud/discovery_engine/v1beta/document_service/client.rb +39 -14
- data/lib/google/cloud/discovery_engine/v1beta/document_service/operations.rb +28 -6
- data/lib/google/cloud/discovery_engine/v1beta/document_service/rest/client.rb +37 -9
- data/lib/google/cloud/discovery_engine/v1beta/document_service/rest/operations.rb +33 -8
- data/lib/google/cloud/discovery_engine/v1beta/document_service/rest/service_stub.rb +23 -2
- data/lib/google/cloud/discovery_engine/v1beta/recommendation_service/client.rb +38 -14
- data/lib/google/cloud/discovery_engine/v1beta/recommendation_service/rest/client.rb +36 -9
- data/lib/google/cloud/discovery_engine/v1beta/recommendation_service/rest/service_stub.rb +23 -2
- data/lib/google/cloud/discovery_engine/v1beta/schema_service/client.rb +39 -14
- data/lib/google/cloud/discovery_engine/v1beta/schema_service/operations.rb +28 -6
- data/lib/google/cloud/discovery_engine/v1beta/schema_service/rest/client.rb +37 -9
- data/lib/google/cloud/discovery_engine/v1beta/schema_service/rest/operations.rb +33 -8
- data/lib/google/cloud/discovery_engine/v1beta/schema_service/rest/service_stub.rb +23 -2
- data/lib/google/cloud/discovery_engine/v1beta/search_service/client.rb +38 -14
- data/lib/google/cloud/discovery_engine/v1beta/search_service/rest/client.rb +36 -9
- data/lib/google/cloud/discovery_engine/v1beta/search_service/rest/service_stub.rb +23 -2
- data/lib/google/cloud/discovery_engine/v1beta/user_event_service/client.rb +39 -14
- data/lib/google/cloud/discovery_engine/v1beta/user_event_service/operations.rb +28 -6
- data/lib/google/cloud/discovery_engine/v1beta/user_event_service/rest/client.rb +37 -9
- data/lib/google/cloud/discovery_engine/v1beta/user_event_service/rest/operations.rb +33 -8
- data/lib/google/cloud/discovery_engine/v1beta/user_event_service/rest/service_stub.rb +23 -2
- data/lib/google/cloud/discovery_engine/v1beta/version.rb +1 -1
- data/proto_docs/google/api/client.rb +14 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/conversation.rb +3 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/search_service.rb +2 -0
- metadata +7 -7
| @@ -26,6 +26,9 @@ module Google | |
| 26 26 | 
             
                      module Rest
         | 
| 27 27 | 
             
                        # Service that implements Longrunning Operations API.
         | 
| 28 28 | 
             
                        class Operations
         | 
| 29 | 
            +
                          # @private
         | 
| 30 | 
            +
                          DEFAULT_ENDPOINT_TEMPLATE = "discoveryengine.$UNIVERSE_DOMAIN$"
         | 
| 31 | 
            +
             | 
| 29 32 | 
             
                          # @private
         | 
| 30 33 | 
             
                          attr_reader :operations_stub
         | 
| 31 34 |  | 
| @@ -60,6 +63,15 @@ module Google | |
| 60 63 | 
             
                            @config
         | 
| 61 64 | 
             
                          end
         | 
| 62 65 |  | 
| 66 | 
            +
                          ##
         | 
| 67 | 
            +
                          # The effective universe domain
         | 
| 68 | 
            +
                          #
         | 
| 69 | 
            +
                          # @return [String]
         | 
| 70 | 
            +
                          #
         | 
| 71 | 
            +
                          def universe_domain
         | 
| 72 | 
            +
                            @operations_stub.universe_domain
         | 
| 73 | 
            +
                          end
         | 
| 74 | 
            +
             | 
| 63 75 | 
             
                          ##
         | 
| 64 76 | 
             
                          # Create a new Operations client object.
         | 
| 65 77 | 
             
                          #
         | 
| @@ -84,8 +96,10 @@ module Google | |
| 84 96 | 
             
                            @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
         | 
| 85 97 |  | 
| 86 98 | 
             
                            @operations_stub = OperationsServiceStub.new(
         | 
| 87 | 
            -
                              endpoint: | 
| 88 | 
            -
                               | 
| 99 | 
            +
                              endpoint: @config.endpoint,
         | 
| 100 | 
            +
                              endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
         | 
| 101 | 
            +
                              universe_domain: @config.universe_domain,
         | 
| 102 | 
            +
                              credentials: credentials
         | 
| 89 103 | 
             
                            )
         | 
| 90 104 |  | 
| 91 105 | 
             
                            # Used by an LRO wrapper for some methods of this service
         | 
| @@ -478,9 +492,9 @@ module Google | |
| 478 492 | 
             
                          #   end
         | 
| 479 493 | 
             
                          #
         | 
| 480 494 | 
             
                          # @!attribute [rw] endpoint
         | 
| 481 | 
            -
                          #    | 
| 482 | 
            -
                          #    | 
| 483 | 
            -
                          #   @return [::String]
         | 
| 495 | 
            +
                          #   A custom service endpoint, as a hostname or hostname:port. The default is
         | 
| 496 | 
            +
                          #   nil, indicating to use the default endpoint in the current universe domain.
         | 
| 497 | 
            +
                          #   @return [::String,nil]
         | 
| 484 498 | 
             
                          # @!attribute [rw] credentials
         | 
| 485 499 | 
             
                          #   Credentials to send with calls. You may provide any of the following types:
         | 
| 486 500 | 
             
                          #    *  (`String`) The path to a service account key file in JSON format
         | 
| @@ -517,13 +531,20 @@ module Google | |
| 517 531 | 
             
                          # @!attribute [rw] quota_project
         | 
| 518 532 | 
             
                          #   A separate project against which to charge quota.
         | 
| 519 533 | 
             
                          #   @return [::String]
         | 
| 534 | 
            +
                          # @!attribute [rw] universe_domain
         | 
| 535 | 
            +
                          #   The universe domain within which to make requests. This determines the
         | 
| 536 | 
            +
                          #   default endpoint URL. The default value of nil uses the environment
         | 
| 537 | 
            +
                          #   universe (usually the default "googleapis.com" universe).
         | 
| 538 | 
            +
                          #   @return [::String,nil]
         | 
| 520 539 | 
             
                          #
         | 
| 521 540 | 
             
                          class Configuration
         | 
| 522 541 | 
             
                            extend ::Gapic::Config
         | 
| 523 542 |  | 
| 543 | 
            +
                            # @private
         | 
| 544 | 
            +
                            # The endpoint specific to the default "googleapis.com" universe. Deprecated.
         | 
| 524 545 | 
             
                            DEFAULT_ENDPOINT = "discoveryengine.googleapis.com"
         | 
| 525 546 |  | 
| 526 | 
            -
                            config_attr :endpoint,       | 
| 547 | 
            +
                            config_attr :endpoint,      nil, ::String, nil
         | 
| 527 548 | 
             
                            config_attr :credentials,   nil do |value|
         | 
| 528 549 | 
             
                              allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
         | 
| 529 550 | 
             
                              allowed.any? { |klass| klass === value }
         | 
| @@ -535,6 +556,7 @@ module Google | |
| 535 556 | 
             
                            config_attr :metadata,      nil, ::Hash, nil
         | 
| 536 557 | 
             
                            config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
         | 
| 537 558 | 
             
                            config_attr :quota_project, nil, ::String, nil
         | 
| 559 | 
            +
                            config_attr :universe_domain, nil, ::String, nil
         | 
| 538 560 |  | 
| 539 561 | 
             
                            # @private
         | 
| 540 562 | 
             
                            def initialize parent_config = nil
         | 
| @@ -617,12 +639,15 @@ module Google | |
| 617 639 | 
             
                        # Service stub contains baseline method implementations
         | 
| 618 640 | 
             
                        # including transcoding, making the REST call, and deserialing the response.
         | 
| 619 641 | 
             
                        class OperationsServiceStub
         | 
| 620 | 
            -
                          def initialize endpoint:, credentials:
         | 
| 642 | 
            +
                          def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
         | 
| 621 643 | 
             
                            # These require statements are intentionally placed here to initialize
         | 
| 622 644 | 
             
                            # the REST modules only when it's required.
         | 
| 623 645 | 
             
                            require "gapic/rest"
         | 
| 624 646 |  | 
| 625 | 
            -
                            @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint, | 
| 647 | 
            +
                            @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
         | 
| 648 | 
            +
                                                                         endpoint_template: endpoint_template,
         | 
| 649 | 
            +
                                                                         universe_domain: universe_domain,
         | 
| 650 | 
            +
                                                                         credentials: credentials
         | 
| 626 651 | 
             
                          end
         | 
| 627 652 |  | 
| 628 653 | 
             
                          ##
         | 
| @@ -30,16 +30,37 @@ module Google | |
| 30 30 | 
             
                        # including transcoding, making the REST call, and deserialing the response.
         | 
| 31 31 | 
             
                        #
         | 
| 32 32 | 
             
                        class ServiceStub
         | 
| 33 | 
            -
                          def initialize endpoint:, credentials:
         | 
| 33 | 
            +
                          def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
         | 
| 34 34 | 
             
                            # These require statements are intentionally placed here to initialize
         | 
| 35 35 | 
             
                            # the REST modules only when it's required.
         | 
| 36 36 | 
             
                            require "gapic/rest"
         | 
| 37 37 |  | 
| 38 | 
            -
                            @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint, | 
| 38 | 
            +
                            @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
         | 
| 39 | 
            +
                                                                         endpoint_template: endpoint_template,
         | 
| 40 | 
            +
                                                                         universe_domain: universe_domain,
         | 
| 41 | 
            +
                                                                         credentials: credentials,
         | 
| 39 42 | 
             
                                                                         numeric_enums: true,
         | 
| 40 43 | 
             
                                                                         raise_faraday_errors: false
         | 
| 41 44 | 
             
                          end
         | 
| 42 45 |  | 
| 46 | 
            +
                          ##
         | 
| 47 | 
            +
                          # The effective universe domain
         | 
| 48 | 
            +
                          #
         | 
| 49 | 
            +
                          # @return [String]
         | 
| 50 | 
            +
                          #
         | 
| 51 | 
            +
                          def universe_domain
         | 
| 52 | 
            +
                            @client_stub.universe_domain
         | 
| 53 | 
            +
                          end
         | 
| 54 | 
            +
             | 
| 55 | 
            +
                          ##
         | 
| 56 | 
            +
                          # The effective endpoint
         | 
| 57 | 
            +
                          #
         | 
| 58 | 
            +
                          # @return [String]
         | 
| 59 | 
            +
                          #
         | 
| 60 | 
            +
                          def endpoint
         | 
| 61 | 
            +
                            @client_stub.endpoint
         | 
| 62 | 
            +
                          end
         | 
| 63 | 
            +
             | 
| 43 64 | 
             
                          ##
         | 
| 44 65 | 
             
                          # Baseline implementation for the write_user_event REST call
         | 
| 45 66 | 
             
                          #
         | 
| @@ -21,6 +21,7 @@ module Google | |
| 21 21 | 
             
              module Api
         | 
| 22 22 | 
             
                # Required information for every language.
         | 
| 23 23 | 
             
                # @!attribute [rw] reference_docs_uri
         | 
| 24 | 
            +
                #   @deprecated This field is deprecated and may be removed in the next major version update.
         | 
| 24 25 | 
             
                #   @return [::String]
         | 
| 25 26 | 
             
                #     Link to automatically generated reference documentation.  Example:
         | 
| 26 27 | 
             
                #     https://cloud.google.com/nodejs/docs/reference/asset/latest
         | 
| @@ -304,6 +305,19 @@ module Google | |
| 304 305 | 
             
                #                seconds: 360 # 6 minutes
         | 
| 305 306 | 
             
                #              total_poll_timeout:
         | 
| 306 307 | 
             
                #                 seconds: 54000 # 90 minutes
         | 
| 308 | 
            +
                # @!attribute [rw] auto_populated_fields
         | 
| 309 | 
            +
                #   @return [::Array<::String>]
         | 
| 310 | 
            +
                #     List of top-level fields of the request message, that should be
         | 
| 311 | 
            +
                #     automatically populated by the client libraries based on their
         | 
| 312 | 
            +
                #     (google.api.field_info).format. Currently supported format: UUID4.
         | 
| 313 | 
            +
                #
         | 
| 314 | 
            +
                #     Example of a YAML configuration:
         | 
| 315 | 
            +
                #
         | 
| 316 | 
            +
                #      publishing:
         | 
| 317 | 
            +
                #        method_settings:
         | 
| 318 | 
            +
                #          - selector: google.example.v1.ExampleService.CreateExample
         | 
| 319 | 
            +
                #            auto_populated_fields:
         | 
| 320 | 
            +
                #            - request_id
         | 
| 307 321 | 
             
                class MethodSettings
         | 
| 308 322 | 
             
                  include ::Google::Protobuf::MessageExts
         | 
| 309 323 | 
             
                  extend ::Google::Protobuf::MessageExts::ClassMethods
         | 
| @@ -60,10 +60,12 @@ module Google | |
| 60 60 |  | 
| 61 61 | 
             
                    # Defines a reply message to user.
         | 
| 62 62 | 
             
                    # @!attribute [rw] reply
         | 
| 63 | 
            +
                    #   @deprecated This field is deprecated and may be removed in the next major version update.
         | 
| 63 64 | 
             
                    #   @return [::String]
         | 
| 64 65 | 
             
                    #     DEPRECATED: use `summary` instead.
         | 
| 65 66 | 
             
                    #     Text reply.
         | 
| 66 67 | 
             
                    # @!attribute [rw] references
         | 
| 68 | 
            +
                    #   @deprecated This field is deprecated and may be removed in the next major version update.
         | 
| 67 69 | 
             
                    #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::Reply::Reference>]
         | 
| 68 70 | 
             
                    #     References in the reply.
         | 
| 69 71 | 
             
                    # @!attribute [rw] summary
         | 
| @@ -74,6 +76,7 @@ module Google | |
| 74 76 | 
             
                      extend ::Google::Protobuf::MessageExts::ClassMethods
         | 
| 75 77 |  | 
| 76 78 | 
             
                      # Defines reference in reply.
         | 
| 79 | 
            +
                      # @deprecated This message is deprecated and may be removed in the next major version update.
         | 
| 77 80 | 
             
                      # @!attribute [rw] uri
         | 
| 78 81 | 
             
                      #   @return [::String]
         | 
| 79 82 | 
             
                      #     URI link reference.
         | 
| @@ -473,11 +473,13 @@ module Google | |
| 473 473 |  | 
| 474 474 | 
             
                        # A specification for configuring snippets in a search response.
         | 
| 475 475 | 
             
                        # @!attribute [rw] max_snippet_count
         | 
| 476 | 
            +
                        #   @deprecated This field is deprecated and may be removed in the next major version update.
         | 
| 476 477 | 
             
                        #   @return [::Integer]
         | 
| 477 478 | 
             
                        #     [DEPRECATED] This field is deprecated. To control snippet return, use
         | 
| 478 479 | 
             
                        #     `return_snippet` field. For backwards compatibility, we will return
         | 
| 479 480 | 
             
                        #     snippet if max_snippet_count > 0.
         | 
| 480 481 | 
             
                        # @!attribute [rw] reference_only
         | 
| 482 | 
            +
                        #   @deprecated This field is deprecated and may be removed in the next major version update.
         | 
| 481 483 | 
             
                        #   @return [::Boolean]
         | 
| 482 484 | 
             
                        #     [DEPRECATED] This field is deprecated and will have no affect on the
         | 
| 483 485 | 
             
                        #     snippet.
         | 
    
        metadata
    CHANGED
    
    | @@ -1,14 +1,14 @@ | |
| 1 1 | 
             
            --- !ruby/object:Gem::Specification
         | 
| 2 2 | 
             
            name: google-cloud-discovery_engine-v1beta
         | 
| 3 3 | 
             
            version: !ruby/object:Gem::Version
         | 
| 4 | 
            -
              version: 0. | 
| 4 | 
            +
              version: 0.7.1
         | 
| 5 5 | 
             
            platform: ruby
         | 
| 6 6 | 
             
            authors:
         | 
| 7 7 | 
             
            - Google LLC
         | 
| 8 8 | 
             
            autorequire: 
         | 
| 9 9 | 
             
            bindir: bin
         | 
| 10 10 | 
             
            cert_chain: []
         | 
| 11 | 
            -
            date:  | 
| 11 | 
            +
            date: 2024-01-12 00:00:00.000000000 Z
         | 
| 12 12 | 
             
            dependencies:
         | 
| 13 13 | 
             
            - !ruby/object:Gem::Dependency
         | 
| 14 14 | 
             
              name: gapic-common
         | 
| @@ -16,7 +16,7 @@ dependencies: | |
| 16 16 | 
             
                requirements:
         | 
| 17 17 | 
             
                - - ">="
         | 
| 18 18 | 
             
                  - !ruby/object:Gem::Version
         | 
| 19 | 
            -
                    version: 0. | 
| 19 | 
            +
                    version: 0.21.1
         | 
| 20 20 | 
             
                - - "<"
         | 
| 21 21 | 
             
                  - !ruby/object:Gem::Version
         | 
| 22 22 | 
             
                    version: 2.a
         | 
| @@ -26,7 +26,7 @@ dependencies: | |
| 26 26 | 
             
                requirements:
         | 
| 27 27 | 
             
                - - ">="
         | 
| 28 28 | 
             
                  - !ruby/object:Gem::Version
         | 
| 29 | 
            -
                    version: 0. | 
| 29 | 
            +
                    version: 0.21.1
         | 
| 30 30 | 
             
                - - "<"
         | 
| 31 31 | 
             
                  - !ruby/object:Gem::Version
         | 
| 32 32 | 
             
                    version: 2.a
         | 
| @@ -50,7 +50,7 @@ dependencies: | |
| 50 50 | 
             
                requirements:
         | 
| 51 51 | 
             
                - - ">="
         | 
| 52 52 | 
             
                  - !ruby/object:Gem::Version
         | 
| 53 | 
            -
                    version: '0. | 
| 53 | 
            +
                    version: '0.7'
         | 
| 54 54 | 
             
                - - "<"
         | 
| 55 55 | 
             
                  - !ruby/object:Gem::Version
         | 
| 56 56 | 
             
                    version: 2.a
         | 
| @@ -60,7 +60,7 @@ dependencies: | |
| 60 60 | 
             
                requirements:
         | 
| 61 61 | 
             
                - - ">="
         | 
| 62 62 | 
             
                  - !ruby/object:Gem::Version
         | 
| 63 | 
            -
                    version: '0. | 
| 63 | 
            +
                    version: '0.7'
         | 
| 64 64 | 
             
                - - "<"
         | 
| 65 65 | 
             
                  - !ruby/object:Gem::Version
         | 
| 66 66 | 
             
                    version: 2.a
         | 
| @@ -317,7 +317,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement | |
| 317 317 | 
             
                - !ruby/object:Gem::Version
         | 
| 318 318 | 
             
                  version: '0'
         | 
| 319 319 | 
             
            requirements: []
         | 
| 320 | 
            -
            rubygems_version: 3. | 
| 320 | 
            +
            rubygems_version: 3.5.3
         | 
| 321 321 | 
             
            signing_key: 
         | 
| 322 322 | 
             
            specification_version: 4
         | 
| 323 323 | 
             
            summary: Discovery Engine API.
         |