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
    
        checksums.yaml
    CHANGED
    
    | @@ -1,7 +1,7 @@ | |
| 1 1 | 
             
            ---
         | 
| 2 2 | 
             
            SHA256:
         | 
| 3 | 
            -
              metadata.gz:  | 
| 4 | 
            -
              data.tar.gz:  | 
| 3 | 
            +
              metadata.gz: fb5167a6336c67e891727543b235edcf5d70adbce6ee384256e4eaa92d75b1f1
         | 
| 4 | 
            +
              data.tar.gz: e91ebfb511b45b35b6a237e4f7d68578987c8148f58aafa4632216fa7550185b
         | 
| 5 5 | 
             
            SHA512:
         | 
| 6 | 
            -
              metadata.gz:  | 
| 7 | 
            -
              data.tar.gz:  | 
| 6 | 
            +
              metadata.gz: 2963da6a22e0721e27aa7948208ecb92a4480884f04f2616be1fbc258a325d6e980ab56abd77f489b67e0a129d06266b19d6fe617ca0e456fd976b5a21489288
         | 
| 7 | 
            +
              data.tar.gz: f5dad916aefea6abb018e28b1d32cc6a1929649bcd46f851dca1a0aacc808b6a0f070de9ef1ab413161bc8205dd430249aaccb89f804221022c86e409cbadeb6
         | 
    
        data/AUTHENTICATION.md
    CHANGED
    
    | @@ -1,149 +1,122 @@ | |
| 1 1 | 
             
            # Authentication
         | 
| 2 2 |  | 
| 3 | 
            -
             | 
| 4 | 
            -
            [ | 
| 5 | 
            -
             | 
| 6 | 
            -
            [Google Cloud Platform environments](#google-cloud-platform-environments) the
         | 
| 7 | 
            -
            credentials will be discovered automatically. When running on other
         | 
| 8 | 
            -
            environments, the Service Account credentials can be specified by providing the
         | 
| 9 | 
            -
            path to the
         | 
| 10 | 
            -
            [JSON keyfile](https://cloud.google.com/iam/docs/managing-service-account-keys)
         | 
| 11 | 
            -
            for the account (or the JSON itself) in
         | 
| 12 | 
            -
            [environment variables](#environment-variables). Additionally, Cloud SDK
         | 
| 13 | 
            -
            credentials can also be discovered automatically, but this is only recommended
         | 
| 14 | 
            -
            during development.
         | 
| 3 | 
            +
            The recommended way to authenticate to the google-cloud-discovery_engine-v1beta library is to use
         | 
| 4 | 
            +
            [Application Default Credentials (ADC)](https://cloud.google.com/docs/authentication/application-default-credentials).
         | 
| 5 | 
            +
            To review all of your authentication options, see [Credentials lookup](#credential-lookup).
         | 
| 15 6 |  | 
| 16 7 | 
             
            ## Quickstart
         | 
| 17 8 |  | 
| 18 | 
            -
             | 
| 19 | 
            -
             | 
| 9 | 
            +
            The following example shows how to set up authentication for a local development
         | 
| 10 | 
            +
            environment with your user credentials. 
         | 
| 20 11 |  | 
| 21 | 
            -
             | 
| 22 | 
            -
             | 
| 23 | 
            -
            ```
         | 
| 24 | 
            -
             | 
| 25 | 
            -
            3. Initialize the client.
         | 
| 12 | 
            +
            **NOTE:** This method is _not_ recommended for running in production. User credentials
         | 
| 13 | 
            +
            should be used only during development.
         | 
| 26 14 |  | 
| 27 | 
            -
             | 
| 28 | 
            -
             | 
| 15 | 
            +
            1. [Download and install the Google Cloud CLI](https://cloud.google.com/sdk).
         | 
| 16 | 
            +
            2. Set up a local ADC file with your user credentials:
         | 
| 29 17 |  | 
| 30 | 
            -
             | 
| 18 | 
            +
            ```sh
         | 
| 19 | 
            +
            gcloud auth application-default login
         | 
| 31 20 | 
             
            ```
         | 
| 32 21 |  | 
| 33 | 
            -
             | 
| 34 | 
            -
             | 
| 35 | 
            -
            The google-cloud-discovery_engine-v1beta library aims to make authentication
         | 
| 36 | 
            -
            as simple as possible, and provides several mechanisms to configure your system
         | 
| 37 | 
            -
            without requiring **Service Account Credentials** directly in code.
         | 
| 38 | 
            -
             | 
| 39 | 
            -
            **Credentials** are discovered in the following order:
         | 
| 40 | 
            -
             | 
| 41 | 
            -
            1. Specify credentials in method arguments
         | 
| 42 | 
            -
            2. Specify credentials in configuration
         | 
| 43 | 
            -
            3. Discover credentials path in environment variables
         | 
| 44 | 
            -
            4. Discover credentials JSON in environment variables
         | 
| 45 | 
            -
            5. Discover credentials file in the Cloud SDK's path
         | 
| 46 | 
            -
            6. Discover GCP credentials
         | 
| 47 | 
            -
             | 
| 48 | 
            -
            ### Google Cloud Platform environments
         | 
| 22 | 
            +
            3. Write code as if already authenticated.
         | 
| 49 23 |  | 
| 50 | 
            -
             | 
| 51 | 
            -
             | 
| 52 | 
            -
            Functions (GCF) and Cloud Run, **Credentials** are discovered automatically.
         | 
| 53 | 
            -
            Code should be written as if already authenticated.
         | 
| 24 | 
            +
            For more information about setting up authentication for a local development environment, see
         | 
| 25 | 
            +
            [Set up Application Default Credentials](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-dev).
         | 
| 54 26 |  | 
| 55 | 
            -
             | 
| 27 | 
            +
            ## Credential Lookup
         | 
| 56 28 |  | 
| 57 | 
            -
            The  | 
| 58 | 
            -
             | 
| 59 | 
            -
             | 
| 60 | 
            -
             | 
| 61 | 
            -
            **Credentials JSON** file can be stored in the environment variable, or the
         | 
| 62 | 
            -
            **Credentials JSON** itself can be stored for environments such as Docker
         | 
| 63 | 
            -
            containers where writing files is difficult or not encouraged.
         | 
| 29 | 
            +
            The google-cloud-discovery_engine-v1beta library provides several mechanisms to configure your system.
         | 
| 30 | 
            +
            Generally, using Application Default Credentials to facilitate automatic 
         | 
| 31 | 
            +
            credentials discovery is the easist method. But if you need to explicitly specify
         | 
| 32 | 
            +
            credentials, there are several methods available to you.
         | 
| 64 33 |  | 
| 65 | 
            -
             | 
| 66 | 
            -
            checks for credentials are configured on the service Credentials class (such as
         | 
| 67 | 
            -
            {::Google::Cloud::DiscoveryEngine::V1beta::CompletionService::Credentials}):
         | 
| 34 | 
            +
            Credentials are accepted in the following ways, in the following order or precedence:
         | 
| 68 35 |  | 
| 69 | 
            -
             | 
| 70 | 
            -
             | 
| 71 | 
            -
             | 
| 36 | 
            +
            1. Credentials specified in method arguments
         | 
| 37 | 
            +
            2. Credentials specified in configuration
         | 
| 38 | 
            +
            3. Credentials pointed to or included in environment variables
         | 
| 39 | 
            +
            4. Credentials found in local ADC file
         | 
| 40 | 
            +
            5. Credentials returned by the metadata server for the attached service account (GCP)
         | 
| 72 41 |  | 
| 73 | 
            -
             | 
| 74 | 
            -
            require "google/cloud/discovery_engine/v1beta"
         | 
| 75 | 
            -
             | 
| 76 | 
            -
            ENV["GOOGLE_CLOUD_CREDENTIALS"] = "path/to/keyfile.json"
         | 
| 42 | 
            +
            ### Configuration
         | 
| 77 43 |  | 
| 78 | 
            -
            client  | 
| 79 | 
            -
             | 
| 44 | 
            +
            You can configure a path to a JSON credentials file, either for an individual client object or
         | 
| 45 | 
            +
            globally, for all client objects. The JSON file can contain credentials created for
         | 
| 46 | 
            +
            [workload identity federation](https://cloud.google.com/iam/docs/workload-identity-federation),
         | 
| 47 | 
            +
            [workforce identity federation](https://cloud.google.com/iam/docs/workforce-identity-federation), or a
         | 
| 48 | 
            +
            [service account key](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-key).
         | 
| 80 49 |  | 
| 81 | 
            -
             | 
| 50 | 
            +
            Note: Service account keys are a security risk if not managed correctly. You should
         | 
| 51 | 
            +
            [choose a more secure alternative to service account keys](https://cloud.google.com/docs/authentication#auth-decision-tree)
         | 
| 52 | 
            +
            whenever possible.
         | 
| 82 53 |  | 
| 83 | 
            -
             | 
| 84 | 
            -
            it in an environment variable. Either on an individual client initialization:
         | 
| 54 | 
            +
            To configure a credentials file for an individual client initialization:
         | 
| 85 55 |  | 
| 86 56 | 
             
            ```ruby
         | 
| 87 57 | 
             
            require "google/cloud/discovery_engine/v1beta"
         | 
| 88 58 |  | 
| 89 59 | 
             
            client = ::Google::Cloud::DiscoveryEngine::V1beta::CompletionService::Client.new do |config|
         | 
| 90 | 
            -
              config.credentials = "path/to/ | 
| 60 | 
            +
              config.credentials = "path/to/credentialfile.json"
         | 
| 91 61 | 
             
            end
         | 
| 92 62 | 
             
            ```
         | 
| 93 63 |  | 
| 94 | 
            -
             | 
| 64 | 
            +
            To configure a credentials file globally for all clients:
         | 
| 95 65 |  | 
| 96 66 | 
             
            ```ruby
         | 
| 97 67 | 
             
            require "google/cloud/discovery_engine/v1beta"
         | 
| 98 68 |  | 
| 99 69 | 
             
            ::Google::Cloud::DiscoveryEngine::V1beta::CompletionService::Client.configure do |config|
         | 
| 100 | 
            -
              config.credentials = "path/to/ | 
| 70 | 
            +
              config.credentials = "path/to/credentialfile.json"
         | 
| 101 71 | 
             
            end
         | 
| 102 72 |  | 
| 103 73 | 
             
            client = ::Google::Cloud::DiscoveryEngine::V1beta::CompletionService::Client.new
         | 
| 104 74 | 
             
            ```
         | 
| 105 75 |  | 
| 106 | 
            -
            ###  | 
| 76 | 
            +
            ### Environment Variables
         | 
| 107 77 |  | 
| 108 | 
            -
             | 
| 109 | 
            -
             | 
| 110 | 
            -
             | 
| 78 | 
            +
            You can also use an environment variable to provide a JSON credentials file.
         | 
| 79 | 
            +
            The environment variable can contain a path to the credentials file or, for
         | 
| 80 | 
            +
            environments such as Docker containers where writing files is not encouraged,
         | 
| 81 | 
            +
            you can include the credentials file itself.
         | 
| 111 82 |  | 
| 112 | 
            -
             | 
| 83 | 
            +
            The JSON file can contain credentials created for
         | 
| 84 | 
            +
            [workload identity federation](https://cloud.google.com/iam/docs/workload-identity-federation),
         | 
| 85 | 
            +
            [workforce identity federation](https://cloud.google.com/iam/docs/workforce-identity-federation), or a
         | 
| 86 | 
            +
            [service account key](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-key).
         | 
| 113 87 |  | 
| 114 | 
            -
             | 
| 115 | 
            -
             | 
| 116 | 
            -
             | 
| 88 | 
            +
            Note: Service account keys are a security risk if not managed correctly. You should
         | 
| 89 | 
            +
            [choose a more secure alternative to service account keys](https://cloud.google.com/docs/authentication#auth-decision-tree)
         | 
| 90 | 
            +
            whenever possible.
         | 
| 91 | 
            +
             | 
| 92 | 
            +
            The environment variables that google-cloud-discovery_engine-v1beta
         | 
| 93 | 
            +
            checks for credentials are:
         | 
| 117 94 |  | 
| 118 | 
            -
             | 
| 119 | 
            -
            * | 
| 95 | 
            +
            * `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
         | 
| 96 | 
            +
            * `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
         | 
| 120 97 |  | 
| 121 | 
            -
             | 
| 98 | 
            +
            ```ruby
         | 
| 99 | 
            +
            require "google/cloud/discovery_engine/v1beta"
         | 
| 122 100 |  | 
| 123 | 
            -
             | 
| 124 | 
            -
            connect to the APIs. You will use the **JSON key file** to
         | 
| 125 | 
            -
            connect to most services with google-cloud-discovery_engine-v1beta.
         | 
| 101 | 
            +
            ENV["GOOGLE_APPLICATION_CREDENTIALS"] = "path/to/credentialfile.json"
         | 
| 126 102 |  | 
| 127 | 
            -
             | 
| 128 | 
            -
             | 
| 129 | 
            -
            need a Google Developers service account.
         | 
| 103 | 
            +
            client = ::Google::Cloud::DiscoveryEngine::V1beta::CompletionService::Client.new
         | 
| 104 | 
            +
            ```
         | 
| 130 105 |  | 
| 131 | 
            -
             | 
| 132 | 
            -
            2. Create a new project or click on an existing project.
         | 
| 133 | 
            -
            3. Activate the menu in the upper left and select **APIs & Services**. From
         | 
| 134 | 
            -
               here, you will enable the APIs that your application requires.
         | 
| 106 | 
            +
            ### Local ADC file
         | 
| 135 107 |  | 
| 136 | 
            -
             | 
| 108 | 
            +
            You can set up a local ADC file with your user credentials for authentication during
         | 
| 109 | 
            +
            development. If credentials are not provided in code or in environment variables,
         | 
| 110 | 
            +
            then the local ADC credentials are discovered.
         | 
| 137 111 |  | 
| 138 | 
            -
             | 
| 112 | 
            +
            Follow the steps in [Quickstart](#quickstart) to set up a local ADC file.
         | 
| 139 113 |  | 
| 140 | 
            -
             | 
| 141 | 
            -
               "Service account" to be guided through downloading a new JSON key file.
         | 
| 114 | 
            +
            ### Google Cloud Platform environments
         | 
| 142 115 |  | 
| 143 | 
            -
             | 
| 144 | 
            -
             | 
| 145 | 
            -
             | 
| 146 | 
            -
             | 
| 116 | 
            +
            When running on Google Cloud Platform (GCP), including Google Compute Engine
         | 
| 117 | 
            +
            (GCE), Google Kubernetes Engine (GKE), Google App Engine (GAE), Google Cloud
         | 
| 118 | 
            +
            Functions (GCF) and Cloud Run, credentials are retrieved from the attached
         | 
| 119 | 
            +
            service account automatically. Code should be written as if already authenticated.
         | 
| 147 120 |  | 
| 148 | 
            -
             | 
| 149 | 
            -
             | 
| 121 | 
            +
            For more information, see
         | 
| 122 | 
            +
            [Set up ADC for Google Cloud services](https://cloud.google.com/docs/authentication/provide-credentials-adc#attached-sa).
         | 
| @@ -31,6 +31,9 @@ module Google | |
| 31 31 | 
             
                      # Service for Auto-Completion.
         | 
| 32 32 | 
             
                      #
         | 
| 33 33 | 
             
                      class Client
         | 
| 34 | 
            +
                        # @private
         | 
| 35 | 
            +
                        DEFAULT_ENDPOINT_TEMPLATE = "discoveryengine.$UNIVERSE_DOMAIN$"
         | 
| 36 | 
            +
             | 
| 34 37 | 
             
                        include Paths
         | 
| 35 38 |  | 
| 36 39 | 
             
                        # @private
         | 
| @@ -96,6 +99,15 @@ module Google | |
| 96 99 | 
             
                          @config
         | 
| 97 100 | 
             
                        end
         | 
| 98 101 |  | 
| 102 | 
            +
                        ##
         | 
| 103 | 
            +
                        # The effective universe domain
         | 
| 104 | 
            +
                        #
         | 
| 105 | 
            +
                        # @return [String]
         | 
| 106 | 
            +
                        #
         | 
| 107 | 
            +
                        def universe_domain
         | 
| 108 | 
            +
                          @completion_service_stub.universe_domain
         | 
| 109 | 
            +
                        end
         | 
| 110 | 
            +
             | 
| 99 111 | 
             
                        ##
         | 
| 100 112 | 
             
                        # Create a new CompletionService client object.
         | 
| 101 113 | 
             
                        #
         | 
| @@ -129,8 +141,9 @@ module Google | |
| 129 141 | 
             
                          credentials = @config.credentials
         | 
| 130 142 | 
             
                          # Use self-signed JWT if the endpoint is unchanged from default,
         | 
| 131 143 | 
             
                          # but only if the default endpoint does not have a region prefix.
         | 
| 132 | 
            -
                          enable_self_signed_jwt = @config.endpoint  | 
| 133 | 
            -
                                                    | 
| 144 | 
            +
                          enable_self_signed_jwt = @config.endpoint.nil? ||
         | 
| 145 | 
            +
                                                   (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
         | 
| 146 | 
            +
                                                   !@config.endpoint.split(".").first.include?("-"))
         | 
| 134 147 | 
             
                          credentials ||= Credentials.default scope: @config.scope,
         | 
| 135 148 | 
             
                                                              enable_self_signed_jwt: enable_self_signed_jwt
         | 
| 136 149 | 
             
                          if credentials.is_a?(::String) || credentials.is_a?(::Hash)
         | 
| @@ -139,20 +152,23 @@ module Google | |
| 139 152 | 
             
                          @quota_project_id = @config.quota_project
         | 
| 140 153 | 
             
                          @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
         | 
| 141 154 |  | 
| 142 | 
            -
                          @location_client = Google::Cloud::Location::Locations::Client.new do |config|
         | 
| 143 | 
            -
                            config.credentials = credentials
         | 
| 144 | 
            -
                            config.quota_project = @quota_project_id
         | 
| 145 | 
            -
                            config.endpoint = @config.endpoint
         | 
| 146 | 
            -
                          end
         | 
| 147 | 
            -
             | 
| 148 155 | 
             
                          @completion_service_stub = ::Gapic::ServiceStub.new(
         | 
| 149 156 | 
             
                            ::Google::Cloud::DiscoveryEngine::V1beta::CompletionService::Stub,
         | 
| 150 | 
            -
                            credentials: | 
| 151 | 
            -
                            endpoint: | 
| 157 | 
            +
                            credentials: credentials,
         | 
| 158 | 
            +
                            endpoint: @config.endpoint,
         | 
| 159 | 
            +
                            endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
         | 
| 160 | 
            +
                            universe_domain: @config.universe_domain,
         | 
| 152 161 | 
             
                            channel_args: @config.channel_args,
         | 
| 153 162 | 
             
                            interceptors: @config.interceptors,
         | 
| 154 163 | 
             
                            channel_pool_config: @config.channel_pool
         | 
| 155 164 | 
             
                          )
         | 
| 165 | 
            +
             | 
| 166 | 
            +
                          @location_client = Google::Cloud::Location::Locations::Client.new do |config|
         | 
| 167 | 
            +
                            config.credentials = credentials
         | 
| 168 | 
            +
                            config.quota_project = @quota_project_id
         | 
| 169 | 
            +
                            config.endpoint = @completion_service_stub.endpoint
         | 
| 170 | 
            +
                            config.universe_domain = @completion_service_stub.universe_domain
         | 
| 171 | 
            +
                          end
         | 
| 156 172 | 
             
                        end
         | 
| 157 173 |  | 
| 158 174 | 
             
                        ##
         | 
| @@ -322,9 +338,9 @@ module Google | |
| 322 338 | 
             
                        #   end
         | 
| 323 339 | 
             
                        #
         | 
| 324 340 | 
             
                        # @!attribute [rw] endpoint
         | 
| 325 | 
            -
                        #    | 
| 326 | 
            -
                        #    | 
| 327 | 
            -
                        #   @return [::String]
         | 
| 341 | 
            +
                        #   A custom service endpoint, as a hostname or hostname:port. The default is
         | 
| 342 | 
            +
                        #   nil, indicating to use the default endpoint in the current universe domain.
         | 
| 343 | 
            +
                        #   @return [::String,nil]
         | 
| 328 344 | 
             
                        # @!attribute [rw] credentials
         | 
| 329 345 | 
             
                        #   Credentials to send with calls. You may provide any of the following types:
         | 
| 330 346 | 
             
                        #    *  (`String`) The path to a service account key file in JSON format
         | 
| @@ -370,13 +386,20 @@ module Google | |
| 370 386 | 
             
                        # @!attribute [rw] quota_project
         | 
| 371 387 | 
             
                        #   A separate project against which to charge quota.
         | 
| 372 388 | 
             
                        #   @return [::String]
         | 
| 389 | 
            +
                        # @!attribute [rw] universe_domain
         | 
| 390 | 
            +
                        #   The universe domain within which to make requests. This determines the
         | 
| 391 | 
            +
                        #   default endpoint URL. The default value of nil uses the environment
         | 
| 392 | 
            +
                        #   universe (usually the default "googleapis.com" universe).
         | 
| 393 | 
            +
                        #   @return [::String,nil]
         | 
| 373 394 | 
             
                        #
         | 
| 374 395 | 
             
                        class Configuration
         | 
| 375 396 | 
             
                          extend ::Gapic::Config
         | 
| 376 397 |  | 
| 398 | 
            +
                          # @private
         | 
| 399 | 
            +
                          # The endpoint specific to the default "googleapis.com" universe. Deprecated.
         | 
| 377 400 | 
             
                          DEFAULT_ENDPOINT = "discoveryengine.googleapis.com"
         | 
| 378 401 |  | 
| 379 | 
            -
                          config_attr :endpoint,       | 
| 402 | 
            +
                          config_attr :endpoint,      nil, ::String, nil
         | 
| 380 403 | 
             
                          config_attr :credentials,   nil do |value|
         | 
| 381 404 | 
             
                            allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
         | 
| 382 405 | 
             
                            allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
         | 
| @@ -391,6 +414,7 @@ module Google | |
| 391 414 | 
             
                          config_attr :metadata,      nil, ::Hash, nil
         | 
| 392 415 | 
             
                          config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
         | 
| 393 416 | 
             
                          config_attr :quota_project, nil, ::String, nil
         | 
| 417 | 
            +
                          config_attr :universe_domain, nil, ::String, nil
         | 
| 394 418 |  | 
| 395 419 | 
             
                          # @private
         | 
| 396 420 | 
             
                          def initialize parent_config = nil
         | 
| @@ -33,6 +33,9 @@ module Google | |
| 33 33 | 
             
                        # Service for Auto-Completion.
         | 
| 34 34 | 
             
                        #
         | 
| 35 35 | 
             
                        class Client
         | 
| 36 | 
            +
                          # @private
         | 
| 37 | 
            +
                          DEFAULT_ENDPOINT_TEMPLATE = "discoveryengine.$UNIVERSE_DOMAIN$"
         | 
| 38 | 
            +
             | 
| 36 39 | 
             
                          include Paths
         | 
| 37 40 |  | 
| 38 41 | 
             
                          # @private
         | 
| @@ -98,6 +101,15 @@ module Google | |
| 98 101 | 
             
                            @config
         | 
| 99 102 | 
             
                          end
         | 
| 100 103 |  | 
| 104 | 
            +
                          ##
         | 
| 105 | 
            +
                          # The effective universe domain
         | 
| 106 | 
            +
                          #
         | 
| 107 | 
            +
                          # @return [String]
         | 
| 108 | 
            +
                          #
         | 
| 109 | 
            +
                          def universe_domain
         | 
| 110 | 
            +
                            @completion_service_stub.universe_domain
         | 
| 111 | 
            +
                          end
         | 
| 112 | 
            +
             | 
| 101 113 | 
             
                          ##
         | 
| 102 114 | 
             
                          # Create a new CompletionService REST client object.
         | 
| 103 115 | 
             
                          #
         | 
| @@ -125,8 +137,9 @@ module Google | |
| 125 137 | 
             
                            credentials = @config.credentials
         | 
| 126 138 | 
             
                            # Use self-signed JWT if the endpoint is unchanged from default,
         | 
| 127 139 | 
             
                            # but only if the default endpoint does not have a region prefix.
         | 
| 128 | 
            -
                            enable_self_signed_jwt = @config.endpoint  | 
| 129 | 
            -
                                                      | 
| 140 | 
            +
                            enable_self_signed_jwt = @config.endpoint.nil? ||
         | 
| 141 | 
            +
                                                     (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
         | 
| 142 | 
            +
                                                     !@config.endpoint.split(".").first.include?("-"))
         | 
| 130 143 | 
             
                            credentials ||= Credentials.default scope: @config.scope,
         | 
| 131 144 | 
             
                                                                enable_self_signed_jwt: enable_self_signed_jwt
         | 
| 132 145 | 
             
                            if credentials.is_a?(::String) || credentials.is_a?(::Hash)
         | 
| @@ -136,13 +149,19 @@ module Google | |
| 136 149 | 
             
                            @quota_project_id = @config.quota_project
         | 
| 137 150 | 
             
                            @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
         | 
| 138 151 |  | 
| 152 | 
            +
                            @completion_service_stub = ::Google::Cloud::DiscoveryEngine::V1beta::CompletionService::Rest::ServiceStub.new(
         | 
| 153 | 
            +
                              endpoint: @config.endpoint,
         | 
| 154 | 
            +
                              endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
         | 
| 155 | 
            +
                              universe_domain: @config.universe_domain,
         | 
| 156 | 
            +
                              credentials: credentials
         | 
| 157 | 
            +
                            )
         | 
| 158 | 
            +
             | 
| 139 159 | 
             
                            @location_client = Google::Cloud::Location::Locations::Rest::Client.new do |config|
         | 
| 140 160 | 
             
                              config.credentials = credentials
         | 
| 141 161 | 
             
                              config.quota_project = @quota_project_id
         | 
| 142 | 
            -
                              config.endpoint = @ | 
| 162 | 
            +
                              config.endpoint = @completion_service_stub.endpoint
         | 
| 163 | 
            +
                              config.universe_domain = @completion_service_stub.universe_domain
         | 
| 143 164 | 
             
                            end
         | 
| 144 | 
            -
             | 
| 145 | 
            -
                            @completion_service_stub = ::Google::Cloud::DiscoveryEngine::V1beta::CompletionService::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials
         | 
| 146 165 | 
             
                          end
         | 
| 147 166 |  | 
| 148 167 | 
             
                          ##
         | 
| @@ -305,9 +324,9 @@ module Google | |
| 305 324 | 
             
                          #   end
         | 
| 306 325 | 
             
                          #
         | 
| 307 326 | 
             
                          # @!attribute [rw] endpoint
         | 
| 308 | 
            -
                          #    | 
| 309 | 
            -
                          #    | 
| 310 | 
            -
                          #   @return [::String]
         | 
| 327 | 
            +
                          #   A custom service endpoint, as a hostname or hostname:port. The default is
         | 
| 328 | 
            +
                          #   nil, indicating to use the default endpoint in the current universe domain.
         | 
| 329 | 
            +
                          #   @return [::String,nil]
         | 
| 311 330 | 
             
                          # @!attribute [rw] credentials
         | 
| 312 331 | 
             
                          #   Credentials to send with calls. You may provide any of the following types:
         | 
| 313 332 | 
             
                          #    *  (`String`) The path to a service account key file in JSON format
         | 
| @@ -344,13 +363,20 @@ module Google | |
| 344 363 | 
             
                          # @!attribute [rw] quota_project
         | 
| 345 364 | 
             
                          #   A separate project against which to charge quota.
         | 
| 346 365 | 
             
                          #   @return [::String]
         | 
| 366 | 
            +
                          # @!attribute [rw] universe_domain
         | 
| 367 | 
            +
                          #   The universe domain within which to make requests. This determines the
         | 
| 368 | 
            +
                          #   default endpoint URL. The default value of nil uses the environment
         | 
| 369 | 
            +
                          #   universe (usually the default "googleapis.com" universe).
         | 
| 370 | 
            +
                          #   @return [::String,nil]
         | 
| 347 371 | 
             
                          #
         | 
| 348 372 | 
             
                          class Configuration
         | 
| 349 373 | 
             
                            extend ::Gapic::Config
         | 
| 350 374 |  | 
| 375 | 
            +
                            # @private
         | 
| 376 | 
            +
                            # The endpoint specific to the default "googleapis.com" universe. Deprecated.
         | 
| 351 377 | 
             
                            DEFAULT_ENDPOINT = "discoveryengine.googleapis.com"
         | 
| 352 378 |  | 
| 353 | 
            -
                            config_attr :endpoint,       | 
| 379 | 
            +
                            config_attr :endpoint,      nil, ::String, nil
         | 
| 354 380 | 
             
                            config_attr :credentials,   nil do |value|
         | 
| 355 381 | 
             
                              allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
         | 
| 356 382 | 
             
                              allowed.any? { |klass| klass === value }
         | 
| @@ -362,6 +388,7 @@ module Google | |
| 362 388 | 
             
                            config_attr :metadata,      nil, ::Hash, nil
         | 
| 363 389 | 
             
                            config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
         | 
| 364 390 | 
             
                            config_attr :quota_project, nil, ::String, nil
         | 
| 391 | 
            +
                            config_attr :universe_domain, nil, ::String, nil
         | 
| 365 392 |  | 
| 366 393 | 
             
                            # @private
         | 
| 367 394 | 
             
                            def initialize parent_config = nil
         | 
| @@ -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 complete_query REST call
         | 
| 45 66 | 
             
                          #
         | 
| @@ -31,6 +31,9 @@ module Google | |
| 31 31 | 
             
                      # Service for conversational search.
         | 
| 32 32 | 
             
                      #
         | 
| 33 33 | 
             
                      class Client
         | 
| 34 | 
            +
                        # @private
         | 
| 35 | 
            +
                        DEFAULT_ENDPOINT_TEMPLATE = "discoveryengine.$UNIVERSE_DOMAIN$"
         | 
| 36 | 
            +
             | 
| 34 37 | 
             
                        include Paths
         | 
| 35 38 |  | 
| 36 39 | 
             
                        # @private
         | 
| @@ -96,6 +99,15 @@ module Google | |
| 96 99 | 
             
                          @config
         | 
| 97 100 | 
             
                        end
         | 
| 98 101 |  | 
| 102 | 
            +
                        ##
         | 
| 103 | 
            +
                        # The effective universe domain
         | 
| 104 | 
            +
                        #
         | 
| 105 | 
            +
                        # @return [String]
         | 
| 106 | 
            +
                        #
         | 
| 107 | 
            +
                        def universe_domain
         | 
| 108 | 
            +
                          @conversational_search_service_stub.universe_domain
         | 
| 109 | 
            +
                        end
         | 
| 110 | 
            +
             | 
| 99 111 | 
             
                        ##
         | 
| 100 112 | 
             
                        # Create a new ConversationalSearchService client object.
         | 
| 101 113 | 
             
                        #
         | 
| @@ -129,8 +141,9 @@ module Google | |
| 129 141 | 
             
                          credentials = @config.credentials
         | 
| 130 142 | 
             
                          # Use self-signed JWT if the endpoint is unchanged from default,
         | 
| 131 143 | 
             
                          # but only if the default endpoint does not have a region prefix.
         | 
| 132 | 
            -
                          enable_self_signed_jwt = @config.endpoint  | 
| 133 | 
            -
                                                    | 
| 144 | 
            +
                          enable_self_signed_jwt = @config.endpoint.nil? ||
         | 
| 145 | 
            +
                                                   (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
         | 
| 146 | 
            +
                                                   !@config.endpoint.split(".").first.include?("-"))
         | 
| 134 147 | 
             
                          credentials ||= Credentials.default scope: @config.scope,
         | 
| 135 148 | 
             
                                                              enable_self_signed_jwt: enable_self_signed_jwt
         | 
| 136 149 | 
             
                          if credentials.is_a?(::String) || credentials.is_a?(::Hash)
         | 
| @@ -139,20 +152,23 @@ module Google | |
| 139 152 | 
             
                          @quota_project_id = @config.quota_project
         | 
| 140 153 | 
             
                          @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
         | 
| 141 154 |  | 
| 142 | 
            -
                          @location_client = Google::Cloud::Location::Locations::Client.new do |config|
         | 
| 143 | 
            -
                            config.credentials = credentials
         | 
| 144 | 
            -
                            config.quota_project = @quota_project_id
         | 
| 145 | 
            -
                            config.endpoint = @config.endpoint
         | 
| 146 | 
            -
                          end
         | 
| 147 | 
            -
             | 
| 148 155 | 
             
                          @conversational_search_service_stub = ::Gapic::ServiceStub.new(
         | 
| 149 156 | 
             
                            ::Google::Cloud::DiscoveryEngine::V1beta::ConversationalSearchService::Stub,
         | 
| 150 | 
            -
                            credentials: | 
| 151 | 
            -
                            endpoint: | 
| 157 | 
            +
                            credentials: credentials,
         | 
| 158 | 
            +
                            endpoint: @config.endpoint,
         | 
| 159 | 
            +
                            endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
         | 
| 160 | 
            +
                            universe_domain: @config.universe_domain,
         | 
| 152 161 | 
             
                            channel_args: @config.channel_args,
         | 
| 153 162 | 
             
                            interceptors: @config.interceptors,
         | 
| 154 163 | 
             
                            channel_pool_config: @config.channel_pool
         | 
| 155 164 | 
             
                          )
         | 
| 165 | 
            +
             | 
| 166 | 
            +
                          @location_client = Google::Cloud::Location::Locations::Client.new do |config|
         | 
| 167 | 
            +
                            config.credentials = credentials
         | 
| 168 | 
            +
                            config.quota_project = @quota_project_id
         | 
| 169 | 
            +
                            config.endpoint = @conversational_search_service_stub.endpoint
         | 
| 170 | 
            +
                            config.universe_domain = @conversational_search_service_stub.universe_domain
         | 
| 171 | 
            +
                          end
         | 
| 156 172 | 
             
                        end
         | 
| 157 173 |  | 
| 158 174 | 
             
                        ##
         | 
| @@ -795,9 +811,9 @@ module Google | |
| 795 811 | 
             
                        #   end
         | 
| 796 812 | 
             
                        #
         | 
| 797 813 | 
             
                        # @!attribute [rw] endpoint
         | 
| 798 | 
            -
                        #    | 
| 799 | 
            -
                        #    | 
| 800 | 
            -
                        #   @return [::String]
         | 
| 814 | 
            +
                        #   A custom service endpoint, as a hostname or hostname:port. The default is
         | 
| 815 | 
            +
                        #   nil, indicating to use the default endpoint in the current universe domain.
         | 
| 816 | 
            +
                        #   @return [::String,nil]
         | 
| 801 817 | 
             
                        # @!attribute [rw] credentials
         | 
| 802 818 | 
             
                        #   Credentials to send with calls. You may provide any of the following types:
         | 
| 803 819 | 
             
                        #    *  (`String`) The path to a service account key file in JSON format
         | 
| @@ -843,13 +859,20 @@ module Google | |
| 843 859 | 
             
                        # @!attribute [rw] quota_project
         | 
| 844 860 | 
             
                        #   A separate project against which to charge quota.
         | 
| 845 861 | 
             
                        #   @return [::String]
         | 
| 862 | 
            +
                        # @!attribute [rw] universe_domain
         | 
| 863 | 
            +
                        #   The universe domain within which to make requests. This determines the
         | 
| 864 | 
            +
                        #   default endpoint URL. The default value of nil uses the environment
         | 
| 865 | 
            +
                        #   universe (usually the default "googleapis.com" universe).
         | 
| 866 | 
            +
                        #   @return [::String,nil]
         | 
| 846 867 | 
             
                        #
         | 
| 847 868 | 
             
                        class Configuration
         | 
| 848 869 | 
             
                          extend ::Gapic::Config
         | 
| 849 870 |  | 
| 871 | 
            +
                          # @private
         | 
| 872 | 
            +
                          # The endpoint specific to the default "googleapis.com" universe. Deprecated.
         | 
| 850 873 | 
             
                          DEFAULT_ENDPOINT = "discoveryengine.googleapis.com"
         | 
| 851 874 |  | 
| 852 | 
            -
                          config_attr :endpoint,       | 
| 875 | 
            +
                          config_attr :endpoint,      nil, ::String, nil
         | 
| 853 876 | 
             
                          config_attr :credentials,   nil do |value|
         | 
| 854 877 | 
             
                            allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
         | 
| 855 878 | 
             
                            allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
         | 
| @@ -864,6 +887,7 @@ module Google | |
| 864 887 | 
             
                          config_attr :metadata,      nil, ::Hash, nil
         | 
| 865 888 | 
             
                          config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
         | 
| 866 889 | 
             
                          config_attr :quota_project, nil, ::String, nil
         | 
| 890 | 
            +
                          config_attr :universe_domain, nil, ::String, nil
         | 
| 867 891 |  | 
| 868 892 | 
             
                          # @private
         | 
| 869 893 | 
             
                          def initialize parent_config = nil
         |