google-apis-cloudsearch_v1 0.15.0 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8c7f4be8d6e02cd206541311fa5738c5054bba28f4a079a7cad87518ed49f2da
-  data.tar.gz: 5faf4550880e7e9bf868ef4556c1025e1ca26a54d8693c788ef70177a9aeb302
+  metadata.gz: c57320b014e306c4b0165aba6a7c72c5cc25f1f12a934094ad6f72a16c5b9366
+  data.tar.gz: 4b155df366324283e0d33c725c3285a99ea6aff654f8848d6a2b4911b578f153
 SHA512:
-  metadata.gz: 130a1cd8b3c57b603886b326e0e26c2e7b8aa09b00c2eafb47bbe68056d4d53abd773e7e035c35c579ab5361c2c129a21d97634ca584d3a95226965674b79a72
-  data.tar.gz: bae1c843b26895122481171ae7a294fdc6267bcbbc83d0cc70f833ab9fc18f8c8af77ad1501517e73ee9eb87a2a27df6647ce5d85c9c5be0aa3001deec073ec1
+  metadata.gz: 80219370b37da3241ae536cff2aab286c1112638f0f20ad4b7c1f61fbd122fa96c46a3b07b82a592d94addae02365999f683fbc2dd655b760edf1a72092e7c58
+  data.tar.gz: a439ea4ff2819bd35a9a41f0c4f3efa57b51ff22fcdf8afa2558cd445bbea87d0ebf1600c4c1c3b8551df267e93ea69de5f74ae679f29c99cfd194f9ec6e12bc

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Release history for google-apis-cloudsearch_v1
 
+### v0.16.0 (2021-12-16)
+
+* Regenerated from discovery document revision 20211208
+
 ### v0.15.0 (2021-12-01)
 
 * Regenerated from discovery document revision 20211123

data/OVERVIEW.md

@@ -51,7 +51,7 @@ require "google/apis/cloudsearch_v1"
 client = Google::Apis::CloudsearchV1::CloudSearchService.new
 
 # Authenticate calls
-client.authentication = # ... use the googleauth gem to create credentials
+client.authorization = # ... use the googleauth gem to create credentials
 ```
 
 See the class reference docs for information on the methods you can call from a client.

data/lib/google/apis/cloudsearch_v1/classes.rb

@@ -250,6 +250,35 @@ module Google
         end
       end
       
+      # Search application stats for a customer for the given date.
+      class CustomerSearchApplicationStats
+        include Google::Apis::Core::Hashable
+      
+        # The count of search applications for the date.
+        # Corresponds to the JSON property `count`
+        # @return [Fixnum]
+        attr_accessor :count
+      
+        # Represents a whole calendar date, for example a date of birth. The time of day
+        # and time zone are either specified elsewhere or are not significant. The date
+        # is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/
+        # wiki/Proleptic_Gregorian_calendar). The date must be a valid calendar date
+        # between the year 1 and 9999.
+        # Corresponds to the JSON property `date`
+        # @return [Google::Apis::CloudsearchV1::Date]
+        attr_accessor :date
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @count = args[:count] if args.key?(:count)
+          @date = args[:date] if args.key?(:date)
+        end
+      end
+      
       # 
       class CustomerSessionStats
         include Google::Apis::Core::Hashable
@@ -398,6 +427,12 @@ module Google
         # @return [Array<String>]
         attr_accessor :operation_ids
       
+        # Can a user request to get thumbnail URI for Items indexed in this data source.
+        # Corresponds to the JSON property `returnThumbnailUrls`
+        # @return [Boolean]
+        attr_accessor :return_thumbnail_urls
+        alias_method :return_thumbnail_urls?, :return_thumbnail_urls
+      
         # A short name or alias for the source. This value will be used to match the '
         # source' operator. For example, if the short name is *<value>* then queries
         # like *source:<value>* will only return results for this source. The value must
@@ -422,6 +457,7 @@ module Google
           @items_visibility = args[:items_visibility] if args.key?(:items_visibility)
           @name = args[:name] if args.key?(:name)
           @operation_ids = args[:operation_ids] if args.key?(:operation_ids)
+          @return_thumbnail_urls = args[:return_thumbnail_urls] if args.key?(:return_thumbnail_urls)
           @short_name = args[:short_name] if args.key?(:short_name)
         end
       end
@@ -1319,6 +1355,11 @@ module Google
       class GetCustomerIndexStatsResponse
         include Google::Apis::Core::Hashable
       
+        # Average item count for the given date range for which billing is done.
+        # Corresponds to the JSON property `averageIndexedItemCount`
+        # @return [Fixnum]
+        attr_accessor :average_indexed_item_count
+      
         # Summary of indexed item counts, one for each day in the requested range.
         # Corresponds to the JSON property `stats`
         # @return [Array<Google::Apis::CloudsearchV1::CustomerIndexStats>]
@@ -1330,6 +1371,7 @@ module Google
       
         # Update properties of this object
         def update!(**args)
+          @average_indexed_item_count = args[:average_indexed_item_count] if args.key?(:average_indexed_item_count)
           @stats = args[:stats] if args.key?(:stats)
         end
       end
@@ -1343,6 +1385,11 @@ module Google
         # @return [Array<Google::Apis::CloudsearchV1::CustomerQueryStats>]
         attr_accessor :stats
       
+        # Total successful query count (status code 200) for the given date range.
+        # Corresponds to the JSON property `totalQueryCount`
+        # @return [Fixnum]
+        attr_accessor :total_query_count
+      
         def initialize(**args)
            update!(**args)
         end
@@ -1350,6 +1397,32 @@ module Google
         # Update properties of this object
         def update!(**args)
           @stats = args[:stats] if args.key?(:stats)
+          @total_query_count = args[:total_query_count] if args.key?(:total_query_count)
+        end
+      end
+      
+      # Response format for search application stats for a customer.
+      class GetCustomerSearchApplicationStatsResponse
+        include Google::Apis::Core::Hashable
+      
+        # Average search application count for the given date range.
+        # Corresponds to the JSON property `averageSearchApplicationCount`
+        # @return [Fixnum]
+        attr_accessor :average_search_application_count
+      
+        # Search application stats by date.
+        # Corresponds to the JSON property `stats`
+        # @return [Array<Google::Apis::CloudsearchV1::CustomerSearchApplicationStats>]
+        attr_accessor :stats
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @average_search_application_count = args[:average_search_application_count] if args.key?(:average_search_application_count)
+          @stats = args[:stats] if args.key?(:stats)
         end
       end
       
@@ -1395,6 +1468,11 @@ module Google
       class GetDataSourceIndexStatsResponse
         include Google::Apis::Core::Hashable
       
+        # Average item count for the given date range for which billing is done.
+        # Corresponds to the JSON property `averageIndexedItemCount`
+        # @return [Fixnum]
+        attr_accessor :average_indexed_item_count
+      
         # Summary of indexed item counts, one for each day in the requested range.
         # Corresponds to the JSON property `stats`
         # @return [Array<Google::Apis::CloudsearchV1::DataSourceIndexStats>]
@@ -1406,6 +1484,7 @@ module Google
       
         # Update properties of this object
         def update!(**args)
+          @average_indexed_item_count = args[:average_indexed_item_count] if args.key?(:average_indexed_item_count)
           @stats = args[:stats] if args.key?(:stats)
         end
       end
@@ -1420,6 +1499,11 @@ module Google
         # @return [Array<Google::Apis::CloudsearchV1::SearchApplicationQueryStats>]
         attr_accessor :stats
       
+        # Total successful query count (status code 200) for the given date range.
+        # Corresponds to the JSON property `totalQueryCount`
+        # @return [Fixnum]
+        attr_accessor :total_query_count
+      
         def initialize(**args)
            update!(**args)
         end
@@ -1427,6 +1511,7 @@ module Google
         # Update properties of this object
         def update!(**args)
           @stats = args[:stats] if args.key?(:stats)
+          @total_query_count = args[:total_query_count] if args.key?(:total_query_count)
         end
       end
       
@@ -1832,6 +1917,9 @@ module Google
         # Item using lexical ordering. Cloud Search Indexing won't index or delete any
         # queued item with a version value that is less than or equal to the version of
         # the currently indexed item. The maximum length for this field is 1024 bytes.
+        # See [this guide](https://developers.devsite.corp.google.com/cloud-search/docs/
+        # guides/operations) to understand how item version affects reindexing after
+        # delete item.
         # Corresponds to the JSON property `version`
         # NOTE: Values are automatically base64 encoded/decoded in the client library.
         # @return [String]
@@ -1972,6 +2060,13 @@ module Google
         # @return [Fixnum]
         attr_accessor :count
       
+        # Number of items matching the status code for which billing is done. This
+        # excludes virtual container items from the total count. This count would not be
+        # applicable for items with ERROR or NEW_ITEM status code.
+        # Corresponds to the JSON property `indexedItemsCount`
+        # @return [Fixnum]
+        attr_accessor :indexed_items_count
+      
         # Status of the items.
         # Corresponds to the JSON property `statusCode`
         # @return [String]
@@ -1984,6 +2079,7 @@ module Google
         # Update properties of this object
         def update!(**args)
           @count = args[:count] if args.key?(:count)
+          @indexed_items_count = args[:indexed_items_count] if args.key?(:indexed_items_count)
           @status_code = args[:status_code] if args.key?(:status_code)
         end
       end
@@ -2420,6 +2516,11 @@ module Google
         # @return [Google::Apis::CloudsearchV1::Source]
         attr_accessor :source
       
+        # The thumbnail URL of the result.
+        # Corresponds to the JSON property `thumbnailUrl`
+        # @return [String]
+        attr_accessor :thumbnail_url
+      
         # The last modified date for the object in the search result. If not set in the
         # item, the value returned here is empty. When `updateTime` is used for
         # calculating freshness and is not set, this value defaults to 2 years from the
@@ -2441,6 +2542,7 @@ module Google
           @object_type = args[:object_type] if args.key?(:object_type)
           @owner = args[:owner] if args.key?(:owner)
           @source = args[:source] if args.key?(:source)
+          @thumbnail_url = args[:thumbnail_url] if args.key?(:thumbnail_url)
           @update_time = args[:update_time] if args.key?(:update_time)
         end
       end
@@ -3969,6 +4071,12 @@ module Google
         # @return [Google::Apis::CloudsearchV1::QueryInterpretationConfig]
         attr_accessor :query_interpretation_config
       
+        # With each result we should return the URI for its thumbnail (when applicable)
+        # Corresponds to the JSON property `returnResultThumbnailUrls`
+        # @return [Boolean]
+        attr_accessor :return_result_thumbnail_urls
+        alias_method :return_result_thumbnail_urls?, :return_result_thumbnail_urls
+      
         # Scoring configurations for a source while processing a Search or Suggest
         # request.
         # Corresponds to the JSON property `scoringConfig`
@@ -3994,6 +4102,7 @@ module Google
           @name = args[:name] if args.key?(:name)
           @operation_ids = args[:operation_ids] if args.key?(:operation_ids)
           @query_interpretation_config = args[:query_interpretation_config] if args.key?(:query_interpretation_config)
+          @return_result_thumbnail_urls = args[:return_result_thumbnail_urls] if args.key?(:return_result_thumbnail_urls)
           @scoring_config = args[:scoring_config] if args.key?(:scoring_config)
           @source_config = args[:source_config] if args.key?(:source_config)
         end

data/lib/google/apis/cloudsearch_v1/gem_version.rb

@@ -16,13 +16,13 @@ module Google
   module Apis
     module CloudsearchV1
       # Version of the google-apis-cloudsearch_v1 gem
-      GEM_VERSION = "0.15.0"
+      GEM_VERSION = "0.16.0"
 
       # Version of the code generator used to generate this client
       GENERATOR_VERSION = "0.4.0"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20211123"
+      REVISION = "20211208"
     end
   end
 end

data/lib/google/apis/cloudsearch_v1/representations.rb

@@ -70,6 +70,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class CustomerSearchApplicationStats
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class CustomerSessionStats
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -292,6 +298,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GetCustomerSearchApplicationStatsResponse
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GetCustomerSessionStatsResponse
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -1039,6 +1051,15 @@ module Google
         end
       end
       
+      class CustomerSearchApplicationStats
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :count, :numeric_string => true, as: 'count'
+          property :date, as: 'date', class: Google::Apis::CloudsearchV1::Date, decorator: Google::Apis::CloudsearchV1::Date::Representation
+      
+        end
+      end
+      
       class CustomerSessionStats
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -1080,6 +1101,7 @@ module Google
       
           property :name, as: 'name'
           collection :operation_ids, as: 'operationIds'
+          property :return_thumbnail_urls, as: 'returnThumbnailUrls'
           property :short_name, as: 'shortName'
         end
       end
@@ -1347,6 +1369,7 @@ module Google
       class GetCustomerIndexStatsResponse
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
+          property :average_indexed_item_count, :numeric_string => true, as: 'averageIndexedItemCount'
           collection :stats, as: 'stats', class: Google::Apis::CloudsearchV1::CustomerIndexStats, decorator: Google::Apis::CloudsearchV1::CustomerIndexStats::Representation
       
         end
@@ -1357,6 +1380,16 @@ module Google
         class Representation < Google::Apis::Core::JsonRepresentation
           collection :stats, as: 'stats', class: Google::Apis::CloudsearchV1::CustomerQueryStats, decorator: Google::Apis::CloudsearchV1::CustomerQueryStats::Representation
       
+          property :total_query_count, :numeric_string => true, as: 'totalQueryCount'
+        end
+      end
+      
+      class GetCustomerSearchApplicationStatsResponse
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :average_search_application_count, :numeric_string => true, as: 'averageSearchApplicationCount'
+          collection :stats, as: 'stats', class: Google::Apis::CloudsearchV1::CustomerSearchApplicationStats, decorator: Google::Apis::CloudsearchV1::CustomerSearchApplicationStats::Representation
+      
         end
       end
       
@@ -1379,6 +1412,7 @@ module Google
       class GetDataSourceIndexStatsResponse
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
+          property :average_indexed_item_count, :numeric_string => true, as: 'averageIndexedItemCount'
           collection :stats, as: 'stats', class: Google::Apis::CloudsearchV1::DataSourceIndexStats, decorator: Google::Apis::CloudsearchV1::DataSourceIndexStats::Representation
       
         end
@@ -1389,6 +1423,7 @@ module Google
         class Representation < Google::Apis::Core::JsonRepresentation
           collection :stats, as: 'stats', class: Google::Apis::CloudsearchV1::SearchApplicationQueryStats, decorator: Google::Apis::CloudsearchV1::SearchApplicationQueryStats::Representation
       
+          property :total_query_count, :numeric_string => true, as: 'totalQueryCount'
         end
       end
       
@@ -1546,6 +1581,7 @@ module Google
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
           property :count, :numeric_string => true, as: 'count'
+          property :indexed_items_count, :numeric_string => true, as: 'indexedItemsCount'
           property :status_code, as: 'statusCode'
         end
       end
@@ -1683,6 +1719,7 @@ module Google
       
           property :source, as: 'source', class: Google::Apis::CloudsearchV1::Source, decorator: Google::Apis::CloudsearchV1::Source::Representation
       
+          property :thumbnail_url, as: 'thumbnailUrl'
           property :update_time, as: 'updateTime'
         end
       end
@@ -2126,6 +2163,7 @@ module Google
           collection :operation_ids, as: 'operationIds'
           property :query_interpretation_config, as: 'queryInterpretationConfig', class: Google::Apis::CloudsearchV1::QueryInterpretationConfig, decorator: Google::Apis::CloudsearchV1::QueryInterpretationConfig::Representation
       
+          property :return_result_thumbnail_urls, as: 'returnResultThumbnailUrls'
           property :scoring_config, as: 'scoringConfig', class: Google::Apis::CloudsearchV1::ScoringConfig, decorator: Google::Apis::CloudsearchV1::ScoringConfig::Representation
       
           collection :source_config, as: 'sourceConfig', class: Google::Apis::CloudsearchV1::SourceConfig, decorator: Google::Apis::CloudsearchV1::SourceConfig::Representation

data/lib/google/apis/cloudsearch_v1/service.rb

@@ -382,7 +382,10 @@ module Google
         #   compares the Item version in the index to the version of the queued Item using
         #   lexical ordering. Cloud Search Indexing won't delete any queued item with a
         #   version value that is less than or equal to the version of the currently
-        #   indexed item. The maximum length for this field is 1024 bytes.
+        #   indexed item. The maximum length for this field is 1024 bytes. See [this guide]
+        #   (https://developers.devsite.corp.google.com/cloud-search/docs/guides/
+        #   operations) to understand how item version affects reindexing after delete
+        #   item.
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user
@@ -1537,6 +1540,52 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Get search application stats for customer. **Note:** This API requires a
+        # standard end user account to execute.
+        # @param [Fixnum] end_date_day
+        #   Day of month. Must be from 1 to 31 and valid for the year and month.
+        # @param [Fixnum] end_date_month
+        #   Month of date. Must be from 1 to 12.
+        # @param [Fixnum] end_date_year
+        #   Year of date. Must be from 1 to 9999.
+        # @param [Fixnum] start_date_day
+        #   Day of month. Must be from 1 to 31 and valid for the year and month.
+        # @param [Fixnum] start_date_month
+        #   Month of date. Must be from 1 to 12.
+        # @param [Fixnum] start_date_year
+        #   Year of date. Must be from 1 to 9999.
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::CloudsearchV1::GetCustomerSearchApplicationStatsResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::CloudsearchV1::GetCustomerSearchApplicationStatsResponse]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def get_stat_searchapplication(end_date_day: nil, end_date_month: nil, end_date_year: nil, start_date_day: nil, start_date_month: nil, start_date_year: nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:get, 'v1/stats/searchapplication', options)
+          command.response_representation = Google::Apis::CloudsearchV1::GetCustomerSearchApplicationStatsResponse::Representation
+          command.response_class = Google::Apis::CloudsearchV1::GetCustomerSearchApplicationStatsResponse
+          command.query['endDate.day'] = end_date_day unless end_date_day.nil?
+          command.query['endDate.month'] = end_date_month unless end_date_month.nil?
+          command.query['endDate.year'] = end_date_year unless end_date_year.nil?
+          command.query['startDate.day'] = start_date_day unless start_date_day.nil?
+          command.query['startDate.month'] = start_date_month unless start_date_month.nil?
+          command.query['startDate.year'] = start_date_year unless start_date_year.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
         # Get the # of search sessions, % of successful sessions with a click query
         # statistics for customer. **Note:** This API requires a standard end user
         # account to execute.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-cloudsearch_v1
 version: !ruby/object:Gem::Version
-  version: 0.15.0
+  version: 0.16.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-06 00:00:00.000000000 Z
+date: 2022-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
   changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-cloudsearch_v1/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-cloudsearch_v1/v0.15.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-cloudsearch_v1/v0.16.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-cloudsearch_v1
 post_install_message: 
 rdoc_options: []
@@ -75,7 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.17
+rubygems_version: 3.3.4
 signing_key: 
 specification_version: 4
 summary: Simple REST client for Cloud Search API V1