google-apis-discoveryengine_v1beta 0.7.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d37cf165849d4f72d43e908be2c50186e09b73be6f5de6445c0496d0a860fe0c
-  data.tar.gz: '08da430eda93c0fe33ab198ae098c34ab2a77e58c95ff9cf9a522e50b07474ef'
+  metadata.gz: 8a7dc238ff88d80936633fd34c32f9e36da3c26408355b5d28d04967a583b04d
+  data.tar.gz: bba354739717a7723cf850719e4485a77f275c44b23a084ef568e700d0ce48b9
 SHA512:
-  metadata.gz: 3d06594cd2a23fd1c464b51ab4f6bf71c40a7a074c036548ab9c62013264f3343bfb9448495beedf39eb805406fe815e2c357d4729411fe664ef9be67ef95e94
-  data.tar.gz: e5bf97cdeb3c02160810960174199b1a3ddf538516bbfcb1e45e1be62b0d4d28cd3a5c2c637e41f924d882af563c057f0f97c93949439d3020076a3f1e5a3da1
+  metadata.gz: 3ffced84126a60497b7f37ddabb1d6625bc3b7dcf7058b508e4592d5d387a0f8e4702a5b2d15ee0cd8d96b3db900f02e75b8fcaf0cdf411dfc3b5b4df76a4463
+  data.tar.gz: 2bdfd155a9318a5991ee07ca86162800fc559e3ed13f99d8b7adc53bb665e2d6a94b27c7ca4953a0a84313a49eeac705bdbd82faabb286ea119766cae26f7968

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Release history for google-apis-discoveryengine_v1beta
 
+### v0.9.0 (2023-03-12)
+
+* Regenerated from discovery document revision 20230306
+
+### v0.8.0 (2023-03-05)
+
+* Regenerated from discovery document revision 20230227
+
 ### v0.7.0 (2023-02-26)
 
 * Regenerated from discovery document revision 20230209

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

@@ -105,9 +105,10 @@ module Google
         # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineLoggingErrorContext]
         attr_accessor :context
       
-        # The error payload that is populated on LRO import APIs. Including: "google.
-        # cloud.discoveryengine.v1alpha.DocumentService.ImportDocuments" "google.cloud.
-        # discoveryengine.v1alpha.UserEventService.ImportUserEvents"
+        # The error payload that is populated on LRO import APIs, including the
+        # following: * `google.cloud.discoveryengine.v1alpha.DocumentService.
+        # ImportDocuments` * `google.cloud.discoveryengine.v1alpha.UserEventService.
+        # ImportUserEvents`
         # Corresponds to the JSON property `importPayload`
         # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineLoggingImportErrorContext]
         attr_accessor :import_payload
@@ -117,26 +118,6 @@ module Google
         # @return [String]
         attr_accessor :message
       
-        # The API request payload, represented as a protocol buffer. Most API request
-        # types are supported. For example: "type.googleapis.com/google.cloud.
-        # discoveryengine.v1alpha.DocumentService.CreateDocumentRequest" "type.
-        # googleapis.com/google.cloud.discoveryengine.v1alpha.UserEventService.
-        # WriteUserEventRequest"
-        # Corresponds to the JSON property `requestPayload`
-        # @return [Hash<String,Object>]
-        attr_accessor :request_payload
-      
-        # The API response payload, represented as a protocol buffer. This is used to
-        # log some "soft errors", where the response is valid but we consider there are
-        # some quality issues like unjoined events. The following API responses are
-        # supported and no PII is included: "google.cloud.discoveryengine.v1alpha.
-        # RecommendationService.Recommend" "google.cloud.discoveryengine.v1alpha.
-        # UserEventService.WriteUserEvent" "google.cloud.discoveryengine.v1alpha.
-        # UserEventService.CollectUserEvent"
-        # Corresponds to the JSON property `responsePayload`
-        # @return [Hash<String,Object>]
-        attr_accessor :response_payload
-      
         # Describes a running service that sends errors.
         # Corresponds to the JSON property `serviceContext`
         # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineLoggingServiceContext]
@@ -161,8 +142,6 @@ module Google
           @context = args[:context] if args.key?(:context)
           @import_payload = args[:import_payload] if args.key?(:import_payload)
           @message = args[:message] if args.key?(:message)
-          @request_payload = args[:request_payload] if args.key?(:request_payload)
-          @response_payload = args[:response_payload] if args.key?(:response_payload)
           @service_context = args[:service_context] if args.key?(:service_context)
           @status = args[:status] if args.key?(:status)
         end
@@ -187,9 +166,10 @@ module Google
         end
       end
       
-      # The error payload that is populated on LRO import APIs. Including: "google.
-      # cloud.discoveryengine.v1alpha.DocumentService.ImportDocuments" "google.cloud.
-      # discoveryengine.v1alpha.UserEventService.ImportUserEvents"
+      # The error payload that is populated on LRO import APIs, including the
+      # following: * `google.cloud.discoveryengine.v1alpha.DocumentService.
+      # ImportDocuments` * `google.cloud.discoveryengine.v1alpha.UserEventService.
+      # ImportUserEvents`
       class GoogleCloudDiscoveryengineLoggingImportErrorContext
         include Google::Apis::Core::Hashable
       
@@ -238,7 +218,7 @@ module Google
       class GoogleCloudDiscoveryengineLoggingServiceContext
         include Google::Apis::Core::Hashable
       
-        # An identifier of the service. For example, "discoveryengine.googleapis.com".
+        # An identifier of the service—for example, `discoveryengine.googleapis.com`.
         # Corresponds to the JSON property `service`
         # @return [String]
         attr_accessor :service
@@ -258,8 +238,8 @@ module Google
       class GoogleCloudDiscoveryengineLoggingSourceLocation
         include Google::Apis::Core::Hashable
       
-        # Human-readable name of a function or method. For example, " google.cloud.
-        # discoveryengine.v1alpha.RecommendationService.Recommend".
+        # Human-readable name of a function or method—for example, `google.cloud.
+        # discoveryengine.v1alpha.RecommendationService.Recommend`.
         # Corresponds to the JSON property `functionName`
         # @return [String]
         attr_accessor :function_name
@@ -274,6 +254,209 @@ module Google
         end
       end
       
+      # Defines circumstances to be checked before allowing a behavior
+      class GoogleCloudDiscoveryengineV1alphaCondition
+        include Google::Apis::Core::Hashable
+      
+        # Optional. Range of time(s) specifying when condition is active. Maximum of 10
+        # time ranges.
+        # Corresponds to the JSON property `activeTimeRange`
+        # @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaConditionTimeRange>]
+        attr_accessor :active_time_range
+      
+        # Optional. Search only A list of terms to match the query on. Maximum of 10
+        # query terms.
+        # Corresponds to the JSON property `queryTerms`
+        # @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaConditionQueryTerm>]
+        attr_accessor :query_terms
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @active_time_range = args[:active_time_range] if args.key?(:active_time_range)
+          @query_terms = args[:query_terms] if args.key?(:query_terms)
+        end
+      end
+      
+      # Matcher for search request query
+      class GoogleCloudDiscoveryengineV1alphaConditionQueryTerm
+        include Google::Apis::Core::Hashable
+      
+        # Whether the search query needs to exactly match the query term.
+        # Corresponds to the JSON property `fullMatch`
+        # @return [Boolean]
+        attr_accessor :full_match
+        alias_method :full_match?, :full_match
+      
+        # The specific query value to match against Must be lowercase, must be UTF-8.
+        # Can have at most 3 space separated terms if full_match is true. Cannot be an
+        # empty string. Maximum length of 5000 characters.
+        # Corresponds to the JSON property `value`
+        # @return [String]
+        attr_accessor :value
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @full_match = args[:full_match] if args.key?(:full_match)
+          @value = args[:value] if args.key?(:value)
+        end
+      end
+      
+      # Used for time-dependent conditions.
+      class GoogleCloudDiscoveryengineV1alphaConditionTimeRange
+        include Google::Apis::Core::Hashable
+      
+        # End of time range. Range is inclusive. Must be in the future.
+        # Corresponds to the JSON property `endTime`
+        # @return [String]
+        attr_accessor :end_time
+      
+        # Start of time range. Range is inclusive.
+        # Corresponds to the JSON property `startTime`
+        # @return [String]
+        attr_accessor :start_time
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @end_time = args[:end_time] if args.key?(:end_time)
+          @start_time = args[:start_time] if args.key?(:start_time)
+        end
+      end
+      
+      # Defines a conditioned behavior to employ during serving. Must be attached to a
+      # [ServingConfig] to be considered at serving time. Permitted actions dependent
+      # on Solution Type.
+      class GoogleCloudDiscoveryengineV1alphaControl
+        include Google::Apis::Core::Hashable
+      
+        # Output only. List of all [ServingConfig] ids this control is attached to. May
+        # take up to 10 minutes to update after changes.
+        # Corresponds to the JSON property `associatedServingConfigIds`
+        # @return [Array<String>]
+        attr_accessor :associated_serving_config_ids
+      
+        # Adjusts order of products in returned list.
+        # Corresponds to the JSON property `boostAction`
+        # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaControlBoostAction]
+        attr_accessor :boost_action
+      
+        # Determines when the associated action will trigger. Omit to always apply the
+        # action. Currently only a single condition may be specified. Otherwise an
+        # INVALID ARGUMENT error is thrown.
+        # Corresponds to the JSON property `conditions`
+        # @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaCondition>]
+        attr_accessor :conditions
+      
+        # Required. Human readable name. The identifier used in UI views. Must be UTF-8
+        # encoded string. Length limit is 128 characters. Otherwise an INVALID ARGUMENT
+        # error is thrown.
+        # Corresponds to the JSON property `displayName`
+        # @return [String]
+        attr_accessor :display_name
+      
+        # Specified which products may be included in results. Uses same filter as boost.
+        # Corresponds to the JSON property `filterAction`
+        # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaControlFilterAction]
+        attr_accessor :filter_action
+      
+        # Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/
+        # controls/*`
+        # Corresponds to the JSON property `name`
+        # @return [String]
+        attr_accessor :name
+      
+        # Required. What solution the control belongs to. Must be compatible with
+        # vertical of resource. Otherwise an INVALID ARGUMENT error is thrown.
+        # Corresponds to the JSON property `solutionType`
+        # @return [String]
+        attr_accessor :solution_type
+      
+        # Specifies the use case for the control. Affects what condition fields can be
+        # set. Only applies to SOLUTION_TYPE_SEARCH. Currently only allow one use case
+        # per control. Must be set when solution_type is SolutionType.
+        # SOLUTION_TYPE_SEARCH.
+        # Corresponds to the JSON property `useCases`
+        # @return [Array<String>]
+        attr_accessor :use_cases
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @associated_serving_config_ids = args[:associated_serving_config_ids] if args.key?(:associated_serving_config_ids)
+          @boost_action = args[:boost_action] if args.key?(:boost_action)
+          @conditions = args[:conditions] if args.key?(:conditions)
+          @display_name = args[:display_name] if args.key?(:display_name)
+          @filter_action = args[:filter_action] if args.key?(:filter_action)
+          @name = args[:name] if args.key?(:name)
+          @solution_type = args[:solution_type] if args.key?(:solution_type)
+          @use_cases = args[:use_cases] if args.key?(:use_cases)
+        end
+      end
+      
+      # Adjusts order of products in returned list.
+      class GoogleCloudDiscoveryengineV1alphaControlBoostAction
+        include Google::Apis::Core::Hashable
+      
+        # Required. Strength of the boost, which should be in [-1, 1]. Negative boost
+        # means demotion. Default is 0.0 (No-op).
+        # Corresponds to the JSON property `boost`
+        # @return [Float]
+        attr_accessor :boost
+      
+        # Required. Specifies which products to apply the boost to. If no filter is
+        # provided all products will be boosted (No-op). Syntax documentation: https://
+        # cloud.google.com/retail/docs/filter-and-order Maximum length is 5000
+        # characters. Otherwise an INVALID ARGUMENT error is thrown.
+        # Corresponds to the JSON property `filter`
+        # @return [String]
+        attr_accessor :filter
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @boost = args[:boost] if args.key?(:boost)
+          @filter = args[:filter] if args.key?(:filter)
+        end
+      end
+      
+      # Specified which products may be included in results. Uses same filter as boost.
+      class GoogleCloudDiscoveryengineV1alphaControlFilterAction
+        include Google::Apis::Core::Hashable
+      
+        # Required. A filter to apply on the matching condition results. Required Syntax
+        # documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum
+        # length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.
+        # Corresponds to the JSON property `filter`
+        # @return [String]
+        attr_accessor :filter
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @filter = args[:filter] if args.key?(:filter)
+        end
+      end
+      
       # Metadata related to the progress of the ImportDocuments operation. This will
       # be returned by the google.longrunning.Operation.metadata field.
       class GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata
@@ -582,9 +765,9 @@ module Google
         attr_accessor :json_data
       
         # Immutable. The full resource name of the document. Format: `projects/`project`/
-        # locations/`location`/dataStores/`data_store`/branches/`branch`/documents/`
-        # document_id``. This field must be a UTF-8 encoded string with a length limit
-        # of 1024 characters.
+        # locations/`location`/collections/`collection`/dataStores/`data_store`/branches/
+        # `branch`/documents/`document_id``. This field must be a UTF-8 encoded string
+        # with a length limit of 1024 characters.
         # Corresponds to the JSON property `name`
         # @return [String]
         attr_accessor :name
@@ -632,8 +815,8 @@ module Google
         attr_accessor :id
       
         # Required. The Document resource full name, of the form: projects/`project\_id`/
-        # locations/`location`/dataStores/`data\_store\_id`/branches/`branch\_id`/
-        # documents/`document\_id`
+        # locations/`location`/collections/`collection\_id`/dataStores/`data\_store\_id`/
+        # branches/`branch\_id`/documents/`document\_id`
         # Corresponds to the JSON property `name`
         # @return [String]
         attr_accessor :name

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

@@ -16,13 +16,13 @@ module Google
   module Apis
     module DiscoveryengineV1beta
       # Version of the google-apis-discoveryengine_v1beta gem
-      GEM_VERSION = "0.7.0"
+      GEM_VERSION = "0.9.0"
 
       # Version of the code generator used to generate this client
       GENERATOR_VERSION = "0.12.0"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20230209"
+      REVISION = "20230306"
     end
   end
 end

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

@@ -64,6 +64,42 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleCloudDiscoveryengineV1alphaCondition
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudDiscoveryengineV1alphaConditionQueryTerm
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudDiscoveryengineV1alphaConditionTimeRange
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudDiscoveryengineV1alphaControl
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudDiscoveryengineV1alphaControlBoostAction
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudDiscoveryengineV1alphaControlFilterAction
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -307,8 +343,6 @@ module Google
           property :import_payload, as: 'importPayload', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineLoggingImportErrorContext, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineLoggingImportErrorContext::Representation
       
           property :message, as: 'message'
-          hash :request_payload, as: 'requestPayload'
-          hash :response_payload, as: 'responsePayload'
           property :service_context, as: 'serviceContext', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineLoggingServiceContext, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineLoggingServiceContext::Representation
       
           property :status, as: 'status', class: Google::Apis::DiscoveryengineV1beta::GoogleRpcStatus, decorator: Google::Apis::DiscoveryengineV1beta::GoogleRpcStatus::Representation
@@ -348,6 +382,64 @@ module Google
         end
       end
       
+      class GoogleCloudDiscoveryengineV1alphaCondition
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :active_time_range, as: 'activeTimeRange', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaConditionTimeRange, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaConditionTimeRange::Representation
+      
+          collection :query_terms, as: 'queryTerms', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaConditionQueryTerm, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaConditionQueryTerm::Representation
+      
+        end
+      end
+      
+      class GoogleCloudDiscoveryengineV1alphaConditionQueryTerm
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :full_match, as: 'fullMatch'
+          property :value, as: 'value'
+        end
+      end
+      
+      class GoogleCloudDiscoveryengineV1alphaConditionTimeRange
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :end_time, as: 'endTime'
+          property :start_time, as: 'startTime'
+        end
+      end
+      
+      class GoogleCloudDiscoveryengineV1alphaControl
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :associated_serving_config_ids, as: 'associatedServingConfigIds'
+          property :boost_action, as: 'boostAction', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaControlBoostAction, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaControlBoostAction::Representation
+      
+          collection :conditions, as: 'conditions', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaCondition, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaCondition::Representation
+      
+          property :display_name, as: 'displayName'
+          property :filter_action, as: 'filterAction', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaControlFilterAction, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaControlFilterAction::Representation
+      
+          property :name, as: 'name'
+          property :solution_type, as: 'solutionType'
+          collection :use_cases, as: 'useCases'
+        end
+      end
+      
+      class GoogleCloudDiscoveryengineV1alphaControlBoostAction
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :boost, as: 'boost'
+          property :filter, as: 'filter'
+        end
+      end
+      
+      class GoogleCloudDiscoveryengineV1alphaControlFilterAction
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :filter, as: 'filter'
+        end
+      end
+      
       class GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation