google-api-client 0.28.4 → 0.29.2

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

@@ -147,13 +147,13 @@ module Google
         end
       end
       
-      # Data source is a logical namespace for items to be indexed.
-      # All items must belong to a data source.  This is the prerequisite before
+      # Datasource is a logical namespace for items to be indexed.
+      # All items must belong to a datasource.  This is the prerequisite before
       # items can be indexed into Cloud Search.
       class DataSource
         include Google::Apis::Core::Hashable
       
-        # If true, Indexing API rejects any modification calls to this data source
+        # If true, Indexing API rejects any modification calls to this datasource
         # such as create, update, and delete.
         # Disabling this does not imply halting process of previously
         # accepted data.
@@ -168,7 +168,7 @@ module Google
         attr_accessor :disable_serving
         alias_method :disable_serving?, :disable_serving
       
-        # Required. Display name of the data source
+        # Required. Display name of the datasource
         # The maximum length is 300 characters.
         # Corresponds to the JSON property `displayName`
         # @return [String]
@@ -179,24 +179,25 @@ module Google
         # @return [Array<String>]
         attr_accessor :indexing_service_accounts
       
-        # This restricts visibility to items at a data source level to the
-        # disjunction of users/groups mentioned with the field. Note that, this
-        # does not ensure access to a specific item, as users need to have ACL
-        # permissions on the contained items. This ensures a high level access
-        # on the entire data source, and that the individual items are not shared
-        # outside this visibility.
+        # This field restricts visibility to items at the datasource level. Items
+        # within the datasource are restricted to the union of users and groups
+        # included in this field. Note that, this does not ensure access to a
+        # specific item, as users need to have ACL permissions on the contained
+        # items. This ensures a high level access on the entire datasource, and
+        # that the individual items are not shared outside this visibility.
         # Corresponds to the JSON property `itemsVisibility`
         # @return [Array<Google::Apis::CloudsearchV1::GSuitePrincipal>]
         attr_accessor :items_visibility
       
-        # Name of the data source resource.
+        # Name of the datasource resource.
         # Format: datasources/`source_id`.
-        # <br />The name is ignored when creating a data source.
+        # <br />The name is ignored when creating a datasource.
         # Corresponds to the JSON property `name`
         # @return [String]
         attr_accessor :name
       
-        # IDs of the Long Running Operations (LROs) currently running for this schema.
+        # IDs of the Long Running Operations (LROs) currently running for this
+        # schema.
         # Corresponds to the JSON property `operationIds`
         # @return [Array<String>]
         attr_accessor :operation_ids
@@ -204,7 +205,7 @@ module Google
         # 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 *&lt;value&gt;* then
         # queries like *source:&lt;value&gt;* will only return results for this
-        # source. The value must be unique across all data sources. The value must
+        # source. The value must be unique across all datasources. The value must
         # only contain alphanumeric characters (a-zA-Z0-9). The value cannot start
         # with 'google' and cannot be one of the following: mail, gmail, docs, drive,
         # groups, sites, calendar, hangouts, gplus, keep, people, teams.
@@ -268,6 +269,9 @@ module Google
         # Filters with the same object type are joined conjunctively, then
         # the resulting expressions are joined disjunctively.
         # The maximum number of elements is 20.
+        # NOTE: Suggest API supports only few filters at the moment:
+        # "objecttype", "type" and "mimetype".
+        # For now, schema specific filters cannot be used to filter suggestions.
         # Corresponds to the JSON property `filterOptions`
         # @return [Array<Google::Apis::CloudsearchV1::FilterOptions>]
         attr_accessor :filter_options
@@ -424,8 +428,8 @@ module Google
       class DebugOptions
         include Google::Apis::Core::Hashable
       
-        # If set, the request will enable debugging features of Cloud Search.
-        # Only turn on this field, if asked by Google to help with debugging.
+        # If you are asked by Google to help with debugging, set this field.
+        # Otherwise, ignore this field.
         # Corresponds to the JSON property `enableDebugging`
         # @return [Boolean]
         attr_accessor :enable_debugging
@@ -865,14 +869,16 @@ module Google
       class FacetBucket
         include Google::Apis::Core::Hashable
       
-        # Number of results that match the bucket value.
+        # Number of results that match the bucket value. Counts are only returned
+        # for searches when count accuracy is ensured. Can be empty.
         # Corresponds to the JSON property `count`
         # @return [Fixnum]
         attr_accessor :count
       
         # Percent of results that match the bucket value. This value is between
-        # (0-100].
-        # This may not be accurate and is a best effort estimate.
+        # (0-100]. Percentages are returned for all searches, but are an estimate.
+        # Because percentages are always returned, you should render percentages
+        # instead of counts.
         # Corresponds to the JSON property `percentage`
         # @return [Fixnum]
         attr_accessor :percentage
@@ -899,6 +905,13 @@ module Google
       class FacetOptions
         include Google::Apis::Core::Hashable
       
+        # Maximum number of facet buckets that should be returned for this facet.
+        # Defaults to 10.
+        # Maximum value is 100.
+        # Corresponds to the JSON property `numFacetBuckets`
+        # @return [Fixnum]
+        attr_accessor :num_facet_buckets
+      
         # If object_type is set, only those objects of that type will be used to
         # compute facets. If empty, then all objects will be used to compute facets.
         # Corresponds to the JSON property `objectType`
@@ -923,6 +936,7 @@ module Google
       
         # Update properties of this object
         def update!(**args)
+          @num_facet_buckets = args[:num_facet_buckets] if args.key?(:num_facet_buckets)
           @object_type = args[:object_type] if args.key?(:object_type)
           @operator_name = args[:operator_name] if args.key?(:operator_name)
           @source_name = args[:source_name] if args.key?(:source_name)
@@ -933,7 +947,7 @@ module Google
       class FacetResult
         include Google::Apis::Core::Hashable
       
-        # FacetBuckets for values in response containing atleast a single result.
+        # FacetBuckets for values in response containing at least a single result.
         # Corresponds to the JSON property `buckets`
         # @return [Array<Google::Apis::CloudsearchV1::FacetBucket>]
         attr_accessor :buckets
@@ -1070,8 +1084,8 @@ module Google
       class FreshnessOptions
         include Google::Apis::Core::Hashable
       
-        # The duration (in seconds) after which an object should be considered
-        # stale.
+        # The duration after which an object should be considered
+        # stale. The default value is 180 days (in seconds).
         # Corresponds to the JSON property `freshnessDuration`
         # @return [String]
         attr_accessor :freshness_duration
@@ -1087,6 +1101,8 @@ module Google
         # updateTime
         # as the freshness indicator.
         # The maximum length is 256 characters.
+        # When a property is used to calculate fresheness, the value defaults
+        # to 2 years from the current time.
         # Corresponds to the JSON property `freshnessProperty`
         # @return [String]
         attr_accessor :freshness_property
@@ -1173,6 +1189,101 @@ module Google
         end
       end
       
+      # Gmail Action restricts (i.e. read/replied/snoozed).
+      class GmailActionRestrict
+        include Google::Apis::Core::Hashable
+      
+        # 
+        # Corresponds to the JSON property `type`
+        # @return [String]
+        attr_accessor :type
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @type = args[:type] if args.key?(:type)
+        end
+      end
+      
+      # Gmail Attachment restricts (i.e. has:attachment, has:drive, filename:pdf).
+      class GmailAttachmentRestrict
+        include Google::Apis::Core::Hashable
+      
+        # 
+        # Corresponds to the JSON property `type`
+        # @return [String]
+        attr_accessor :type
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @type = args[:type] if args.key?(:type)
+        end
+      end
+      
+      # Gmail Folder restricts (i.e. in Drafts/Sent/Chats/User Generated Labels).
+      class GmailFolderRestrict
+        include Google::Apis::Core::Hashable
+      
+        # 
+        # Corresponds to the JSON property `type`
+        # @return [String]
+        attr_accessor :type
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @type = args[:type] if args.key?(:type)
+        end
+      end
+      
+      # Gmail Intelligent restricts (i.e. smartlabels, important).
+      class GmailIntelligentRestrict
+        include Google::Apis::Core::Hashable
+      
+        # 
+        # Corresponds to the JSON property `type`
+        # @return [String]
+        attr_accessor :type
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @type = args[:type] if args.key?(:type)
+        end
+      end
+      
+      # Gmail Time restricts (i.e. received today, this week).
+      class GmailTimeRestrict
+        include Google::Apis::Core::Hashable
+      
+        # 
+        # Corresponds to the JSON property `type`
+        # @return [String]
+        attr_accessor :type
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @type = args[:type] if args.key?(:type)
+        end
+      end
+      
       # Used to provide a search operator for html properties. This is optional.
       # Search operators let users restrict the query to specific fields relevant
       # to the type of item being searched.
@@ -1250,6 +1361,27 @@ module Google
         end
       end
       
+      # 
+      class IndexItemOptions
+        include Google::Apis::Core::Hashable
+      
+        # Specifies if the index request should allow gsuite principals that do not
+        # exist or are deleted in the index request.
+        # Corresponds to the JSON property `allowUnknownGsuitePrincipals`
+        # @return [Boolean]
+        attr_accessor :allow_unknown_gsuite_principals
+        alias_method :allow_unknown_gsuite_principals?, :allow_unknown_gsuite_principals
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @allow_unknown_gsuite_principals = args[:allow_unknown_gsuite_principals] if args.key?(:allow_unknown_gsuite_principals)
+        end
+      end
+      
       # 
       class IndexItemRequest
         include Google::Apis::Core::Hashable
@@ -1265,6 +1397,11 @@ module Google
         # @return [Google::Apis::CloudsearchV1::DebugOptions]
         attr_accessor :debug_options
       
+        # 
+        # Corresponds to the JSON property `indexItemOptions`
+        # @return [Google::Apis::CloudsearchV1::IndexItemOptions]
+        attr_accessor :index_item_options
+      
         # Represents a single object that is an item in the search index, such as a
         # file, folder, or a database record.
         # Corresponds to the JSON property `item`
@@ -1284,6 +1421,7 @@ module Google
         def update!(**args)
           @connector_name = args[:connector_name] if args.key?(:connector_name)
           @debug_options = args[:debug_options] if args.key?(:debug_options)
+          @index_item_options = args[:index_item_options] if args.key?(:index_item_options)
           @item = args[:item] if args.key?(:item)
           @mode = args[:mode] if args.key?(:mode)
         end
@@ -1585,7 +1723,8 @@ module Google
         # List of principals who are allowed to see the item in search results.
         # Optional if inheriting permissions from another item or if the item
         # is not intended to be visible, such as
-        # virtual containers.
+        # virtual
+        # containers.
         # The maximum number of elements is 1000.
         # Corresponds to the JSON property `readers`
         # @return [Array<Google::Apis::CloudsearchV1::Principal>]
@@ -2087,7 +2226,10 @@ module Google
         # @return [Google::Apis::CloudsearchV1::Source]
         attr_accessor :source
       
-        # The last modified date for the object in the search result.
+        # 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 current time.
         # Corresponds to the JSON property `updateTime`
         # @return [String]
         attr_accessor :update_time
@@ -2114,7 +2256,8 @@ module Google
       class Metaline
         include Google::Apis::Core::Hashable
       
-        # The list of displayed properties for the metaline.
+        # The list of displayed properties for the metaline. The maxiumum number of
+        # properties is 5.
         # Corresponds to the JSON property `properties`
         # @return [Array<Google::Apis::CloudsearchV1::DisplayedProperty>]
         attr_accessor :properties
@@ -2279,7 +2422,7 @@ module Google
         # to specify singular properties before repeated properties in this list. All
         # of the properties must set
         # is_returnable
-        # to true. The maximum number of elements is 3.
+        # to true. The maximum number of metalines is 3.
         # Corresponds to the JSON property `metalines`
         # @return [Array<Google::Apis::CloudsearchV1::Metaline>]
         attr_accessor :metalines
@@ -2388,14 +2531,14 @@ module Google
         attr_accessor :done
         alias_method :done?, :done
       
-        # The `Status` type defines a logical error model that is suitable for different
-        # programming environments, including REST APIs and RPC APIs. It is used by
-        # [gRPC](https://github.com/grpc). The error model is designed to be:
+        # The `Status` type defines a logical error model that is suitable for
+        # different programming environments, including REST APIs and RPC APIs. It is
+        # used by [gRPC](https://github.com/grpc). The error model is designed to be:
         # - Simple to use and understand for most users
         # - Flexible enough to meet unexpected needs
         # # Overview
-        # The `Status` message contains three pieces of data: error code, error message,
-        # and error details. The error code should be an enum value of
+        # The `Status` message contains three pieces of data: error code, error
+        # message, and error details. The error code should be an enum value of
         # google.rpc.Code, but it may accept additional error codes if needed.  The
         # error message should be a developer-facing English message that helps
         # developers *understand* and *resolve* the error. If a localized user-facing
@@ -2441,7 +2584,7 @@ module Google
       
         # The server-assigned name, which is only unique within the same service that
         # originally returns it. If you use the default HTTP mapping, the
-        # `name` should have the format of `operations/some/unique/name`.
+        # `name` should be a resource name ending with `operations/`unique_id``.
         # Corresponds to the JSON property `name`
         # @return [String]
         attr_accessor :name
@@ -2472,7 +2615,7 @@ module Google
         end
       end
       
-      # A people suggestion.
+      # This field contains information about the person being suggested.
       class PeopleSuggestion
         include Google::Apis::Core::Hashable
       
@@ -2762,13 +2905,13 @@ module Google
         attr_accessor :is_repeatable
         alias_method :is_repeatable?, :is_repeatable
       
-        # Indicates that the property identifies data that should be returned in search
-        # results via the Query API. If set to *true*, indicates that Query API
-        # users can use matching property fields in results. However, storing fields
-        # requires more space allocation and uses more bandwidth for search queries,
-        # which impacts performance over large datasets. Set to *true* here only if
-        # the field is needed for search results. Cannot be true for properties
-        # whose type is an object.
+        # Indicates that the property identifies data that should be returned in
+        # search results via the Query API. If set to *true*, indicates that Query
+        # API users can use matching property fields in results. However, storing
+        # fields requires more space allocation and uses more bandwidth for search
+        # queries, which impacts performance over large datasets. Set to *true* here
+        # only if the field is needed for search results. Cannot be true for
+        # properties whose type is an object.
         # Corresponds to the JSON property `isReturnable`
         # @return [Boolean]
         attr_accessor :is_returnable
@@ -3165,7 +3308,8 @@ module Google
         end
       end
       
-      # A completed query suggestion.
+      # This field does not contain anything as of now and is just used as an
+      # indicator that the suggest result was a phrase completion.
       class QuerySuggestion
         include Google::Apis::Core::Hashable
       
@@ -3223,6 +3367,10 @@ module Google
         # For more information, see
         # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
         # For translations.
+        # When specified, the documents in search results are biased towards the
+        # specified language.
+        # Suggest API does not use this parameter. It autocompletes only based on
+        # characters in the query.
         # Corresponds to the JSON property `languageCode`
         # @return [String]
         attr_accessor :language_code
@@ -3293,7 +3441,7 @@ module Google
       end
       
       # Information relevant only to a restrict entry.
-      # NextId: 7
+      # NextId: 12
       class RestrictItem
         include Google::Apis::Core::Hashable
       
@@ -3317,6 +3465,31 @@ module Google
         # @return [Google::Apis::CloudsearchV1::DriveTimeSpanRestrict]
         attr_accessor :drive_time_span_restrict
       
+        # Gmail Action restricts (i.e. read/replied/snoozed).
+        # Corresponds to the JSON property `gmailActionRestrict`
+        # @return [Google::Apis::CloudsearchV1::GmailActionRestrict]
+        attr_accessor :gmail_action_restrict
+      
+        # Gmail Attachment restricts (i.e. has:attachment, has:drive, filename:pdf).
+        # Corresponds to the JSON property `gmailAttachmentRestrict`
+        # @return [Google::Apis::CloudsearchV1::GmailAttachmentRestrict]
+        attr_accessor :gmail_attachment_restrict
+      
+        # Gmail Folder restricts (i.e. in Drafts/Sent/Chats/User Generated Labels).
+        # Corresponds to the JSON property `gmailFolderRestrict`
+        # @return [Google::Apis::CloudsearchV1::GmailFolderRestrict]
+        attr_accessor :gmail_folder_restrict
+      
+        # Gmail Intelligent restricts (i.e. smartlabels, important).
+        # Corresponds to the JSON property `gmailIntelligentRestrict`
+        # @return [Google::Apis::CloudsearchV1::GmailIntelligentRestrict]
+        attr_accessor :gmail_intelligent_restrict
+      
+        # Gmail Time restricts (i.e. received today, this week).
+        # Corresponds to the JSON property `gmailTimeRestrict`
+        # @return [Google::Apis::CloudsearchV1::GmailTimeRestrict]
+        attr_accessor :gmail_time_restrict
+      
         # The search restrict (e.g. "after:2017-09-11 before:2017-09-12").
         # Corresponds to the JSON property `searchOperator`
         # @return [String]
@@ -3332,6 +3505,11 @@ module Google
           @drive_location_restrict = args[:drive_location_restrict] if args.key?(:drive_location_restrict)
           @drive_mime_type_restrict = args[:drive_mime_type_restrict] if args.key?(:drive_mime_type_restrict)
           @drive_time_span_restrict = args[:drive_time_span_restrict] if args.key?(:drive_time_span_restrict)
+          @gmail_action_restrict = args[:gmail_action_restrict] if args.key?(:gmail_action_restrict)
+          @gmail_attachment_restrict = args[:gmail_attachment_restrict] if args.key?(:gmail_attachment_restrict)
+          @gmail_folder_restrict = args[:gmail_folder_restrict] if args.key?(:gmail_folder_restrict)
+          @gmail_intelligent_restrict = args[:gmail_intelligent_restrict] if args.key?(:gmail_intelligent_restrict)
+          @gmail_time_restrict = args[:gmail_time_restrict] if args.key?(:gmail_time_restrict)
           @search_operator = args[:search_operator] if args.key?(:search_operator)
         end
       end
@@ -3483,7 +3661,7 @@ module Google
         attr_accessor :object_definitions
       
         # IDs of the Long Running Operations (LROs) currently running for this
-        # schema. After modifying the schema, wait for opeations to complete
+        # schema. After modifying the schema, wait for operations to complete
         # before indexing additional content.
         # Corresponds to the JSON property `operationIds`
         # @return [Array<String>]
@@ -3507,7 +3685,8 @@ module Google
         include Google::Apis::Core::Hashable
       
         # Whether to use freshness as a ranking signal. By default, freshness is used
-        # as a ranking signal.
+        # as a ranking signal. Note that this setting is not available in the Admin
+        # UI.
         # Corresponds to the JSON property `disableFreshness`
         # @return [Boolean]
         attr_accessor :disable_freshness
@@ -3566,8 +3745,8 @@ module Google
         # @return [String]
         attr_accessor :name
       
-        # IDs of the Long Running Operations (LROs) currently running for this schema.
-        # Output only field.
+        # IDs of the Long Running Operations (LROs) currently running for this
+        # schema. Output only field.
         # Corresponds to the JSON property `operationIds`
         # @return [Array<String>]
         attr_accessor :operation_ids
@@ -3664,7 +3843,8 @@ module Google
         include Google::Apis::Core::Hashable
       
         # An indication of the quality of the item, used to influence search quality.
-        # Value should be between 0.0 (lowest quality) and 1.0 (highest quality).
+        # Value should be between 0.0 (lowest quality) and 1.0 (highest quality). The
+        # default value is 0.0.
         # Corresponds to the JSON property `quality`
         # @return [Float]
         attr_accessor :quality
@@ -3861,7 +4041,8 @@ module Google
         # @return [String]
         attr_accessor :title
       
-        # The URL of the result.
+        # The URL of the search result. The URL contains a Google redirect to the
+        # actual item. This URL is signed and shouldn't be changed.
         # Corresponds to the JSON property `url`
         # @return [String]
         attr_accessor :url
@@ -4152,14 +4333,14 @@ module Google
         end
       end
       
-      # The `Status` type defines a logical error model that is suitable for different
-      # programming environments, including REST APIs and RPC APIs. It is used by
-      # [gRPC](https://github.com/grpc). The error model is designed to be:
+      # The `Status` type defines a logical error model that is suitable for
+      # different programming environments, including REST APIs and RPC APIs. It is
+      # used by [gRPC](https://github.com/grpc). The error model is designed to be:
       # - Simple to use and understand for most users
       # - Flexible enough to meet unexpected needs
       # # Overview
-      # The `Status` message contains three pieces of data: error code, error message,
-      # and error details. The error code should be an enum value of
+      # The `Status` message contains three pieces of data: error code, error
+      # message, and error details. The error code should be an enum value of
       # google.rpc.Code, but it may accept additional error codes if needed.  The
       # error message should be a developer-facing English message that helps
       # developers *understand* and *resolve* the error. If a localized user-facing
@@ -4269,11 +4450,15 @@ module Google
       
         # The sources to use for suggestions. If not specified, all data sources
         # from the current search application are used.
+        # Suggestions are based on Gmail titles. Suggestions from third party sources
+        # are not available.
         # Corresponds to the JSON property `dataSourceRestrictions`
         # @return [Array<Google::Apis::CloudsearchV1::DataSourceRestriction>]
         attr_accessor :data_source_restrictions
       
-        # Partial query for the completion suggestion.
+        # Partial query for which autocomplete suggestions will be shown.
+        # For example, if the query is "sea", then the server might return
+        # "season", "search", "seagull" and so on.
         # Corresponds to the JSON property `query`
         # @return [String]
         attr_accessor :query
@@ -4299,7 +4484,7 @@ module Google
       class SuggestResponse
         include Google::Apis::Core::Hashable
       
-        # List of suggestion results.
+        # List of suggestions.
         # Corresponds to the JSON property `suggestResults`
         # @return [Array<Google::Apis::CloudsearchV1::SuggestResult>]
         attr_accessor :suggest_results
@@ -4318,12 +4503,13 @@ module Google
       class SuggestResult
         include Google::Apis::Core::Hashable
       
-        # A people suggestion.
+        # This field contains information about the person being suggested.
         # Corresponds to the JSON property `peopleSuggestion`
         # @return [Google::Apis::CloudsearchV1::PeopleSuggestion]
         attr_accessor :people_suggestion
       
-        # A completed query suggestion.
+        # This field does not contain anything as of now and is just used as an
+        # indicator that the suggest result was a phrase completion.
         # Corresponds to the JSON property `querySuggestion`
         # @return [Google::Apis::CloudsearchV1::QuerySuggestion]
         attr_accessor :query_suggestion
@@ -4606,8 +4792,8 @@ module Google
         # @return [Google::Apis::CloudsearchV1::DebugOptions]
         attr_accessor :debug_options
       
-        # Data source is a logical namespace for items to be indexed.
-        # All items must belong to a data source.  This is the prerequisite before
+        # Datasource is a logical namespace for items to be indexed.
+        # All items must belong to a datasource.  This is the prerequisite before
         # items can be indexed into Cloud Search.
         # Corresponds to the JSON property `source`
         # @return [Google::Apis::CloudsearchV1::DataSource]