google-cloud-discovery_engine-v1 2.13.0 → 2.14.0

data/lib/google/cloud/discovery_engine/v1/user_license_service/client.rb

@@ -226,18 +226,19 @@ module Google
             #   @param options [::Gapic::CallOptions, ::Hash]
             #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
             #
-            # @overload list_user_licenses(parent: nil, page_size: nil, page_token: nil, filter: nil)
+            # @overload list_user_licenses(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil)
             #   Pass arguments to `list_user_licenses` via keyword arguments. Note that at
             #   least one keyword argument is required. To specify no parameters, or to keep all
             #   the default parameter values, pass an empty Hash as a request object (see above).
             #
             #   @param parent [::String]
-            #     Required. The parent [UserStore][] resource name, format:
+            #     Required. The parent {::Google::Cloud::DiscoveryEngine::V1::UserStore UserStore}
+            #     resource name, format:
             #     `projects/{project}/locations/{location}/userStores/{user_store_id}`.
             #   @param page_size [::Integer]
             #     Optional. Requested page size. Server may return fewer items than
-            #     requested. If unspecified, defaults to 10. The maximum value is 50; values
-            #     above 50 will be coerced to 50.
+            #     requested. If unspecified, defaults to 100. The maximum value is 1000;
+            #     values above 1000 will be coerced to 1000.
             #
             #     If this field is negative, an INVALID_ARGUMENT error is returned.
             #   @param page_token [::String]
@@ -252,7 +253,8 @@ module Google
             #     Supported fields:
             #
             #     * `license_assignment_state`
-            #
+            #     * `user_principal`
+            #     *
             #     Examples:
             #
             #     * `license_assignment_state = ASSIGNED` to list assigned user licenses.
@@ -261,6 +263,25 @@ module Google
             #     who attempted login but no license assigned.
             #     * `license_assignment_state != NO_LICENSE_ATTEMPTED_LOGIN` to filter
             #     out users who attempted login but no license assigned.
+            #     * `user_principal = user1@example.com` to list user license for
+            #     `user1@example.com`.
+            #   @param order_by [::String]
+            #     Optional. The order in which the
+            #     {::Google::Cloud::DiscoveryEngine::V1::UserLicense UserLicense}s are listed. The
+            #     value must be a comma-separated list of fields. Default sorting order is
+            #     ascending. To specify descending order for a field, append a " desc"
+            #     suffix. Redundant space characters in the syntax are insignificant.
+            #
+            #     Supported fields (only `user_principal` is supported for now):
+            #
+            #     * `user_principal`
+            #
+            #     If not set, the default ordering is by `user_principal`.
+            #
+            #     Examples:
+            #
+            #     * `user_principal` to order by `user_principal` in ascending order.
+            #     * `user_principal desc` to order by `user_principal` in descending order.
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::DiscoveryEngine::V1::UserLicense>]
@@ -332,6 +353,94 @@ module Google
               raise ::Google::Cloud::Error.from_error(e)
             end
 
+            ##
+            # Lists all the
+            # {::Google::Cloud::DiscoveryEngine::V1::LicenseConfigUsageStats LicenseConfigUsageStats}s
+            # associated with the project.
+            #
+            # @overload list_license_configs_usage_stats(request, options = nil)
+            #   Pass arguments to `list_license_configs_usage_stats` via a request object, either of type
+            #   {::Google::Cloud::DiscoveryEngine::V1::ListLicenseConfigsUsageStatsRequest} or an equivalent Hash.
+            #
+            #   @param request [::Google::Cloud::DiscoveryEngine::V1::ListLicenseConfigsUsageStatsRequest, ::Hash]
+            #     A request object representing the call parameters. Required. To specify no
+            #     parameters, or to keep all the default parameter values, pass an empty Hash.
+            #   @param options [::Gapic::CallOptions, ::Hash]
+            #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
+            #
+            # @overload list_license_configs_usage_stats(parent: nil)
+            #   Pass arguments to `list_license_configs_usage_stats` via keyword arguments. Note that at
+            #   least one keyword argument is required. To specify no parameters, or to keep all
+            #   the default parameter values, pass an empty Hash as a request object (see above).
+            #
+            #   @param parent [::String]
+            #     Required. The parent branch resource name, such as
+            #     `projects/{project}/locations/{location}/userStores/{user_store_id}`.
+            #
+            # @yield [response, operation] Access the result along with the RPC operation
+            # @yieldparam response [::Google::Cloud::DiscoveryEngine::V1::ListLicenseConfigsUsageStatsResponse]
+            # @yieldparam operation [::GRPC::ActiveCall::Operation]
+            #
+            # @return [::Google::Cloud::DiscoveryEngine::V1::ListLicenseConfigsUsageStatsResponse]
+            #
+            # @raise [::Google::Cloud::Error] if the RPC is aborted.
+            #
+            # @example Basic example
+            #   require "google/cloud/discovery_engine/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::DiscoveryEngine::V1::UserLicenseService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::DiscoveryEngine::V1::ListLicenseConfigsUsageStatsRequest.new
+            #
+            #   # Call the list_license_configs_usage_stats method.
+            #   result = client.list_license_configs_usage_stats request
+            #
+            #   # The returned object is of type Google::Cloud::DiscoveryEngine::V1::ListLicenseConfigsUsageStatsResponse.
+            #   p result
+            #
+            def list_license_configs_usage_stats request, options = nil
+              raise ::ArgumentError, "request must be provided" if request.nil?
+
+              request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DiscoveryEngine::V1::ListLicenseConfigsUsageStatsRequest
+
+              # Converts hash and nil to an options object
+              options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
+
+              # Customize the options with defaults
+              metadata = @config.rpcs.list_license_configs_usage_stats.metadata.to_h
+
+              # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
+              metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
+                lib_name: @config.lib_name, lib_version: @config.lib_version,
+                gapic_version: ::Google::Cloud::DiscoveryEngine::V1::VERSION
+              metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
+              metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+              header_params = {}
+              if request.parent
+                header_params["parent"] = request.parent
+              end
+
+              request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
+              metadata[:"x-goog-request-params"] ||= request_params_header
+
+              options.apply_defaults timeout:      @config.rpcs.list_license_configs_usage_stats.timeout,
+                                     metadata:     metadata,
+                                     retry_policy: @config.rpcs.list_license_configs_usage_stats.retry_policy
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
+                                     retry_policy: @config.retry_policy
+
+              @user_license_service_stub.call_rpc :list_license_configs_usage_stats, request, options: options do |response, operation|
+                yield response, operation if block_given?
+              end
+            rescue ::GRPC::BadStatus => e
+              raise ::Google::Cloud::Error.from_error(e)
+            end
+
             ##
             # Updates the User License.
             # This method is used for batch assign/unassign licenses to users.
@@ -352,9 +461,10 @@ module Google
             #   the default parameter values, pass an empty Hash as a request object (see above).
             #
             #   @param inline_source [::Google::Cloud::DiscoveryEngine::V1::BatchUpdateUserLicensesRequest::InlineSource, ::Hash]
-            #     The inline source for the input content for document embeddings.
+            #     The inline source for the input content for license assignment.
             #   @param parent [::String]
-            #     Required. The parent [UserStore][] resource name, format:
+            #     Required. The parent {::Google::Cloud::DiscoveryEngine::V1::UserStore UserStore}
+            #     resource name, format:
             #     `projects/{project}/locations/{location}/userStores/{user_store_id}`.
             #   @param delete_unassigned_user_licenses [::Boolean]
             #     Optional. If true, if user licenses removed associated license config, the
@@ -625,6 +735,11 @@ module Google
                 #
                 attr_reader :list_user_licenses
                 ##
+                # RPC-specific configuration for `list_license_configs_usage_stats`
+                # @return [::Gapic::Config::Method]
+                #
+                attr_reader :list_license_configs_usage_stats
+                ##
                 # RPC-specific configuration for `batch_update_user_licenses`
                 # @return [::Gapic::Config::Method]
                 #
@@ -634,6 +749,8 @@ module Google
                 def initialize parent_rpcs = nil
                   list_user_licenses_config = parent_rpcs.list_user_licenses if parent_rpcs.respond_to? :list_user_licenses
                   @list_user_licenses = ::Gapic::Config::Method.new list_user_licenses_config
+                  list_license_configs_usage_stats_config = parent_rpcs.list_license_configs_usage_stats if parent_rpcs.respond_to? :list_license_configs_usage_stats
+                  @list_license_configs_usage_stats = ::Gapic::Config::Method.new list_license_configs_usage_stats_config
                   batch_update_user_licenses_config = parent_rpcs.batch_update_user_licenses if parent_rpcs.respond_to? :batch_update_user_licenses
                   @batch_update_user_licenses = ::Gapic::Config::Method.new batch_update_user_licenses_config
 

data/lib/google/cloud/discovery_engine/v1/user_license_service/credentials.rb

@@ -26,7 +26,9 @@ module Google
           # Credentials for the UserLicenseService API.
           class Credentials < ::Google::Auth::Credentials
             self.scope = [
-              "https://www.googleapis.com/auth/cloud-platform"
+              "https://www.googleapis.com/auth/cloud-platform",
+              "https://www.googleapis.com/auth/discoveryengine.readwrite",
+              "https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
             ]
             self.env_vars = [
               "GOOGLE_CLOUD_CREDENTIALS",

data/lib/google/cloud/discovery_engine/v1/user_license_service/rest/client.rb

@@ -219,18 +219,19 @@ module Google
               #   @param options [::Gapic::CallOptions, ::Hash]
               #     Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
               #
-              # @overload list_user_licenses(parent: nil, page_size: nil, page_token: nil, filter: nil)
+              # @overload list_user_licenses(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil)
               #   Pass arguments to `list_user_licenses` via keyword arguments. Note that at
               #   least one keyword argument is required. To specify no parameters, or to keep all
               #   the default parameter values, pass an empty Hash as a request object (see above).
               #
               #   @param parent [::String]
-              #     Required. The parent [UserStore][] resource name, format:
+              #     Required. The parent {::Google::Cloud::DiscoveryEngine::V1::UserStore UserStore}
+              #     resource name, format:
               #     `projects/{project}/locations/{location}/userStores/{user_store_id}`.
               #   @param page_size [::Integer]
               #     Optional. Requested page size. Server may return fewer items than
-              #     requested. If unspecified, defaults to 10. The maximum value is 50; values
-              #     above 50 will be coerced to 50.
+              #     requested. If unspecified, defaults to 100. The maximum value is 1000;
+              #     values above 1000 will be coerced to 1000.
               #
               #     If this field is negative, an INVALID_ARGUMENT error is returned.
               #   @param page_token [::String]
@@ -245,7 +246,8 @@ module Google
               #     Supported fields:
               #
               #     * `license_assignment_state`
-              #
+              #     * `user_principal`
+              #     *
               #     Examples:
               #
               #     * `license_assignment_state = ASSIGNED` to list assigned user licenses.
@@ -254,6 +256,25 @@ module Google
               #     who attempted login but no license assigned.
               #     * `license_assignment_state != NO_LICENSE_ATTEMPTED_LOGIN` to filter
               #     out users who attempted login but no license assigned.
+              #     * `user_principal = user1@example.com` to list user license for
+              #     `user1@example.com`.
+              #   @param order_by [::String]
+              #     Optional. The order in which the
+              #     {::Google::Cloud::DiscoveryEngine::V1::UserLicense UserLicense}s are listed. The
+              #     value must be a comma-separated list of fields. Default sorting order is
+              #     ascending. To specify descending order for a field, append a " desc"
+              #     suffix. Redundant space characters in the syntax are insignificant.
+              #
+              #     Supported fields (only `user_principal` is supported for now):
+              #
+              #     * `user_principal`
+              #
+              #     If not set, the default ordering is by `user_principal`.
+              #
+              #     Examples:
+              #
+              #     * `user_principal` to order by `user_principal` in ascending order.
+              #     * `user_principal desc` to order by `user_principal` in descending order.
               # @yield [result, operation] Access the result along with the TransportOperation object
               # @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Cloud::DiscoveryEngine::V1::UserLicense>]
               # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -318,6 +339,87 @@ module Google
                 raise ::Google::Cloud::Error.from_error(e)
               end
 
+              ##
+              # Lists all the
+              # {::Google::Cloud::DiscoveryEngine::V1::LicenseConfigUsageStats LicenseConfigUsageStats}s
+              # associated with the project.
+              #
+              # @overload list_license_configs_usage_stats(request, options = nil)
+              #   Pass arguments to `list_license_configs_usage_stats` via a request object, either of type
+              #   {::Google::Cloud::DiscoveryEngine::V1::ListLicenseConfigsUsageStatsRequest} or an equivalent Hash.
+              #
+              #   @param request [::Google::Cloud::DiscoveryEngine::V1::ListLicenseConfigsUsageStatsRequest, ::Hash]
+              #     A request object representing the call parameters. Required. To specify no
+              #     parameters, or to keep all the default parameter values, pass an empty Hash.
+              #   @param options [::Gapic::CallOptions, ::Hash]
+              #     Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
+              #
+              # @overload list_license_configs_usage_stats(parent: nil)
+              #   Pass arguments to `list_license_configs_usage_stats` via keyword arguments. Note that at
+              #   least one keyword argument is required. To specify no parameters, or to keep all
+              #   the default parameter values, pass an empty Hash as a request object (see above).
+              #
+              #   @param parent [::String]
+              #     Required. The parent branch resource name, such as
+              #     `projects/{project}/locations/{location}/userStores/{user_store_id}`.
+              # @yield [result, operation] Access the result along with the TransportOperation object
+              # @yieldparam result [::Google::Cloud::DiscoveryEngine::V1::ListLicenseConfigsUsageStatsResponse]
+              # @yieldparam operation [::Gapic::Rest::TransportOperation]
+              #
+              # @return [::Google::Cloud::DiscoveryEngine::V1::ListLicenseConfigsUsageStatsResponse]
+              #
+              # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/discovery_engine/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::DiscoveryEngine::V1::UserLicenseService::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::DiscoveryEngine::V1::ListLicenseConfigsUsageStatsRequest.new
+              #
+              #   # Call the list_license_configs_usage_stats method.
+              #   result = client.list_license_configs_usage_stats request
+              #
+              #   # The returned object is of type Google::Cloud::DiscoveryEngine::V1::ListLicenseConfigsUsageStatsResponse.
+              #   p result
+              #
+              def list_license_configs_usage_stats request, options = nil
+                raise ::ArgumentError, "request must be provided" if request.nil?
+
+                request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DiscoveryEngine::V1::ListLicenseConfigsUsageStatsRequest
+
+                # Converts hash and nil to an options object
+                options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
+
+                # Customize the options with defaults
+                call_metadata = @config.rpcs.list_license_configs_usage_stats.metadata.to_h
+
+                # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
+                call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
+                  lib_name: @config.lib_name, lib_version: @config.lib_version,
+                  gapic_version: ::Google::Cloud::DiscoveryEngine::V1::VERSION,
+                  transports_version_send: [:rest]
+
+                call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
+                call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+                options.apply_defaults timeout:      @config.rpcs.list_license_configs_usage_stats.timeout,
+                                       metadata:     call_metadata,
+                                       retry_policy: @config.rpcs.list_license_configs_usage_stats.retry_policy
+
+                options.apply_defaults timeout:      @config.timeout,
+                                       metadata:     @config.metadata,
+                                       retry_policy: @config.retry_policy
+
+                @user_license_service_stub.list_license_configs_usage_stats request, options do |result, operation|
+                  yield result, operation if block_given?
+                end
+              rescue ::Gapic::Rest::Error => e
+                raise ::Google::Cloud::Error.from_error(e)
+              end
+
               ##
               # Updates the User License.
               # This method is used for batch assign/unassign licenses to users.
@@ -338,9 +440,10 @@ module Google
               #   the default parameter values, pass an empty Hash as a request object (see above).
               #
               #   @param inline_source [::Google::Cloud::DiscoveryEngine::V1::BatchUpdateUserLicensesRequest::InlineSource, ::Hash]
-              #     The inline source for the input content for document embeddings.
+              #     The inline source for the input content for license assignment.
               #   @param parent [::String]
-              #     Required. The parent [UserStore][] resource name, format:
+              #     Required. The parent {::Google::Cloud::DiscoveryEngine::V1::UserStore UserStore}
+              #     resource name, format:
               #     `projects/{project}/locations/{location}/userStores/{user_store_id}`.
               #   @param delete_unassigned_user_licenses [::Boolean]
               #     Optional. If true, if user licenses removed associated license config, the
@@ -567,6 +670,11 @@ module Google
                   #
                   attr_reader :list_user_licenses
                   ##
+                  # RPC-specific configuration for `list_license_configs_usage_stats`
+                  # @return [::Gapic::Config::Method]
+                  #
+                  attr_reader :list_license_configs_usage_stats
+                  ##
                   # RPC-specific configuration for `batch_update_user_licenses`
                   # @return [::Gapic::Config::Method]
                   #
@@ -576,6 +684,8 @@ module Google
                   def initialize parent_rpcs = nil
                     list_user_licenses_config = parent_rpcs.list_user_licenses if parent_rpcs.respond_to? :list_user_licenses
                     @list_user_licenses = ::Gapic::Config::Method.new list_user_licenses_config
+                    list_license_configs_usage_stats_config = parent_rpcs.list_license_configs_usage_stats if parent_rpcs.respond_to? :list_license_configs_usage_stats
+                    @list_license_configs_usage_stats = ::Gapic::Config::Method.new list_license_configs_usage_stats_config
                     batch_update_user_licenses_config = parent_rpcs.batch_update_user_licenses if parent_rpcs.respond_to? :batch_update_user_licenses
                     @batch_update_user_licenses = ::Gapic::Config::Method.new batch_update_user_licenses_config
 

data/lib/google/cloud/discovery_engine/v1/user_license_service/rest/operations.rb

@@ -1027,6 +1027,13 @@ module Google
                                                             ["name", %r{^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine/targetSites/operations/[^/]+/?$}, false]
                                                           ]
                                                         )
+                                                        .with_bindings(
+                                                          uri_method: :get,
+                                                          uri_template: "/v1/{name}",
+                                                          matches: [
+                                                            ["name", %r{^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/agents/[^/]+/operations/[^/]+/?$}, false]
+                                                          ]
+                                                        )
                                                         .with_bindings(
                                                           uri_method: :get,
                                                           uri_template: "/v1/{name}",

data/lib/google/cloud/discovery_engine/v1/user_license_service/rest/service_stub.rb

@@ -113,6 +113,46 @@ module Google
                 end
               end
 
+              ##
+              # Baseline implementation for the list_license_configs_usage_stats REST call
+              #
+              # @param request_pb [::Google::Cloud::DiscoveryEngine::V1::ListLicenseConfigsUsageStatsRequest]
+              #   A request object representing the call parameters. Required.
+              # @param options [::Gapic::CallOptions]
+              #   Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
+              #
+              # @yield [result, operation] Access the result along with the TransportOperation object
+              # @yieldparam result [::Google::Cloud::DiscoveryEngine::V1::ListLicenseConfigsUsageStatsResponse]
+              # @yieldparam operation [::Gapic::Rest::TransportOperation]
+              #
+              # @return [::Google::Cloud::DiscoveryEngine::V1::ListLicenseConfigsUsageStatsResponse]
+              #   A result object deserialized from the server's reply
+              def list_license_configs_usage_stats request_pb, options = nil
+                raise ::ArgumentError, "request must be provided" if request_pb.nil?
+
+                verb, uri, query_string_params, body = ServiceStub.transcode_list_license_configs_usage_stats_request request_pb
+                query_string_params = if query_string_params.any?
+                                        query_string_params.to_h { |p| p.split "=", 2 }
+                                      else
+                                        {}
+                                      end
+
+                response = @client_stub.make_http_request(
+                  verb,
+                  uri: uri,
+                  body: body || "",
+                  params: query_string_params,
+                  method_name: "list_license_configs_usage_stats",
+                  options: options
+                )
+                operation = ::Gapic::Rest::TransportOperation.new response
+                result = ::Google::Cloud::DiscoveryEngine::V1::ListLicenseConfigsUsageStatsResponse.decode_json response.body, ignore_unknown_fields: true
+                catch :response do
+                  yield result, operation if block_given?
+                  result
+                end
+              end
+
               ##
               # Baseline implementation for the batch_update_user_licenses REST call
               #
@@ -174,6 +214,27 @@ module Google
                 transcoder.transcode request_pb
               end
 
+              ##
+              # @private
+              #
+              # GRPC transcoding helper method for the list_license_configs_usage_stats REST call
+              #
+              # @param request_pb [::Google::Cloud::DiscoveryEngine::V1::ListLicenseConfigsUsageStatsRequest]
+              #   A request object representing the call parameters. Required.
+              # @return [Array(String, [String, nil], Hash{String => String})]
+              #   Uri, Body, Query string parameters
+              def self.transcode_list_license_configs_usage_stats_request request_pb
+                transcoder = Gapic::Rest::GrpcTranscoder.new
+                                                        .with_bindings(
+                                                          uri_method: :get,
+                                                          uri_template: "/v1/{parent}/licenseConfigsUsageStats",
+                                                          matches: [
+                                                            ["parent", %r{^projects/[^/]+/locations/[^/]+/userStores/[^/]+/?$}, false]
+                                                          ]
+                                                        )
+                transcoder.transcode request_pb
+              end
+
               ##
               # @private
               #