lib/google/apis/cloudsearch_v1/classes.rb in google-apis-cloudsearch_v1-0.27.0 vs lib/google/apis/cloudsearch_v1/classes.rb in google-apis-cloudsearch_v1-0.28.0

- old
+ new

@@ -178,11 +178,11 @@ def update!(**args) @operator_name = args[:operator_name] if args.key?(:operator_name) end end - # Options for boolean properties. + # The options for boolean properties. class BooleanPropertyOptions include Google::Apis::Core::Hashable # Used to provide a search operator for boolean properties. This is optional. # Search operators let users restrict the query to specific fields relevant to @@ -277,11 +277,11 @@ end end # Proto representation of a custom emoji. May be used in both APIs and in # Spanner, but certain fields should be restricted to one or the other. See the - # per-field documentation for details. NEXT_TAG: 13 + # per-field documentation for details. NEXT_TAG: 14 class CustomEmoji include Google::Apis::Core::Hashable # ID for the underlying image data in Blobstore. This field should *only* be # present in Spanner or within the server, but should not be exposed in public @@ -305,10 +305,17 @@ # Primary key for User resource. # Corresponds to the JSON property `creatorUserId` # @return [Google::Apis::CloudsearchV1::UserId] attr_accessor :creator_user_id + # Time when the emoji was deleted, in microseconds. This field may be present in + # Spanner, within the server, or in public APIs. Only present if the emoji has + # been deleted. + # Corresponds to the JSON property `deleteTimeMicros` + # @return [Fixnum] + attr_accessor :delete_time_micros + # Output only. A short-lived URL clients can use for directly accessing a custom # emoji image. This field is intended for API consumption, and should *never* be # persisted to Spanner. # Corresponds to the JSON property `ephemeralUrl` # @return [String] @@ -360,10 +367,11 @@ def update!(**args) @blob_id = args[:blob_id] if args.key?(:blob_id) @content_type = args[:content_type] if args.key?(:content_type) @create_time_micros = args[:create_time_micros] if args.key?(:create_time_micros) @creator_user_id = args[:creator_user_id] if args.key?(:creator_user_id) + @delete_time_micros = args[:delete_time_micros] if args.key?(:delete_time_micros) @ephemeral_url = args[:ephemeral_url] if args.key?(:ephemeral_url) @owner_customer_id = args[:owner_customer_id] if args.key?(:owner_customer_id) @read_token = args[:read_token] if args.key?(:read_token) @shortcode = args[:shortcode] if args.key?(:shortcode) @state = args[:state] if args.key?(:state) @@ -613,12 +621,12 @@ # shared outside this visibility. # Corresponds to the JSON property `itemsVisibility` # @return [Array<Google::Apis::CloudsearchV1::GSuitePrincipal>] attr_accessor :items_visibility - # Name of the datasource resource. Format: datasources/`source_id`. The name is - # ignored when creating a datasource. + # The name of the datasource resource. Format: datasources/`source_id`. 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. @@ -804,11 +812,11 @@ @less_than_operator_name = args[:less_than_operator_name] if args.key?(:less_than_operator_name) @operator_name = args[:operator_name] if args.key?(:operator_name) end end - # Options for date properties. + # The options for date properties. class DatePropertyOptions include Google::Apis::Core::Hashable # Optional. Provides a search operator for date properties. Search operators let # users restrict the query to specific fields relevant to the type of item being @@ -869,22 +877,22 @@ # class DeleteQueueItemsRequest include Google::Apis::Core::Hashable - # Name of connector making this call. Format: datasources/`source_id`/connectors/ - # `ID` + # The name of connector making this call. Format: datasources/`source_id`/ + # connectors/`ID` # Corresponds to the JSON property `connectorName` # @return [String] attr_accessor :connector_name # Shared request debug options for all cloudsearch RPC methods. # Corresponds to the JSON property `debugOptions` # @return [Google::Apis::CloudsearchV1::DebugOptions] attr_accessor :debug_options - # Name of a queue to delete items from. + # The name of a queue to delete items from. # Corresponds to the JSON property `queue` # @return [String] attr_accessor :queue def initialize(**args) @@ -963,11 +971,11 @@ def update!(**args) @operator_name = args[:operator_name] if args.key?(:operator_name) end end - # Options for double properties. + # The options for double properties. class DoublePropertyOptions include Google::Apis::Core::Hashable # Used to provide a search operator for double properties. This is optional. # Search operators let users restrict the query to specific fields relevant to @@ -1214,11 +1222,11 @@ class Emoji include Google::Apis::Core::Hashable # Proto representation of a custom emoji. May be used in both APIs and in # Spanner, but certain fields should be restricted to one or the other. See the - # per-field documentation for details. NEXT_TAG: 13 + # per-field documentation for details. NEXT_TAG: 14 # Corresponds to the JSON property `customEmoji` # @return [Google::Apis::CloudsearchV1::CustomEmoji] attr_accessor :custom_emoji # A basic emoji represented by a unicode string. @@ -1269,11 +1277,11 @@ def update!(**args) @operator_name = args[:operator_name] if args.key?(:operator_name) end end - # Options for enum properties, which allow you to define a restricted set of + # The options for enum properties, which allow you to define a restricted set of # strings to match user queries, set rankings for those string values, and # define an operator name to be paired with those strings so that users can # narrow results to only items with a specific value. For example, for items in # a request tracking system with priority information, you could define *p0* as # an allowable enum value and tie this enum to the operator name *priority* so @@ -1485,11 +1493,11 @@ # facets. If empty, then all objects will be used to compute facets. # Corresponds to the JSON property `objectType` # @return [String] attr_accessor :object_type - # Name of the operator chosen for faceting. @see cloudsearch. + # The name of the operator chosen for faceting. @see cloudsearch. # SchemaPropertyOptions # Corresponds to the JSON property `operatorName` # @return [String] attr_accessor :operator_name @@ -1514,21 +1522,22 @@ # Source specific facet response class FacetResult include Google::Apis::Core::Hashable - # FacetBuckets for values in response containing at least a single result. + # FacetBuckets for values in response containing at least a single result with + # the corresponding filter. # Corresponds to the JSON property `buckets` # @return [Array<Google::Apis::CloudsearchV1::FacetBucket>] attr_accessor :buckets # Object type for which facet results are returned. Can be empty. # Corresponds to the JSON property `objectType` # @return [String] attr_accessor :object_type - # Name of the operator chosen for faceting. @see cloudsearch. + # The name of the operator chosen for faceting. @see cloudsearch. # SchemaPropertyOptions # Corresponds to the JSON property `operatorName` # @return [String] attr_accessor :operator_name @@ -1552,11 +1561,11 @@ # class FieldViolation include Google::Apis::Core::Hashable - # Description of the error. + # The description of the error. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # Path of field with violation. @@ -2073,11 +2082,11 @@ def update!(**args) @operator_name = args[:operator_name] if args.key?(:operator_name) end end - # Options for html properties. + # The options for html properties. class HtmlPropertyOptions include Google::Apis::Core::Hashable # Used to provide a search operator for html properties. This is optional. # Search operators let users restrict the query to specific fields relevant to @@ -2187,12 +2196,12 @@ # class IndexItemRequest include Google::Apis::Core::Hashable - # Name of connector making this call. Format: datasources/`source_id`/connectors/ - # `ID` + # The name of connector making this call. Format: datasources/`source_id`/ + # connectors/`ID` # Corresponds to the JSON property `connectorName` # @return [String] attr_accessor :connector_name # Shared request debug options for all cloudsearch RPC methods. @@ -2293,11 +2302,11 @@ @less_than_operator_name = args[:less_than_operator_name] if args.key?(:less_than_operator_name) @operator_name = args[:operator_name] if args.key?(:operator_name) end end - # Options for integer properties. + # The options for integer properties. class IntegerPropertyOptions include Google::Apis::Core::Hashable # The maximum value of the property. The minimum and maximum values for the # property are used to rank results according to the ordered ranking. Indexing @@ -2396,11 +2405,11 @@ # folder, or a database record. class Item include Google::Apis::Core::Hashable # Access control list information for the item. For more information see [Map - # ACLs](/cloud-search/docs/guides/acls). + # ACLs](https://developers.google.com/cloud-search/docs/guides/acls). # Corresponds to the JSON property `acl` # @return [Google::Apis::CloudsearchV1::ItemAcl] attr_accessor :acl # Content of an item to be indexed and surfaced by Cloud Search. Only UTF-8 @@ -2408,22 +2417,22 @@ # not binary, it must be UTF-8 encoded. # Corresponds to the JSON property `content` # @return [Google::Apis::CloudsearchV1::ItemContent] attr_accessor :content - # Type for this item. + # The type for this item. # Corresponds to the JSON property `itemType` # @return [String] attr_accessor :item_type # Available metadata fields for the item. # Corresponds to the JSON property `metadata` # @return [Google::Apis::CloudsearchV1::ItemMetadata] attr_accessor :metadata - # Name of the Item. Format: datasources/`source_id`/items/`item_id` This is a - # required field. The maximum length is 1536 characters. + # The name of the Item. Format: datasources/`source_id`/items/`item_id` This is + # a required field. The maximum length is 1536 characters. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Additional state connector can store for this item. The maximum length is @@ -2479,11 +2488,11 @@ @version = args[:version] if args.key?(:version) end end # Access control list information for the item. For more information see [Map - # ACLs](/cloud-search/docs/guides/acls). + # ACLs](https://developers.google.com/cloud-search/docs/guides/acls). class ItemAcl include Google::Apis::Core::Hashable # Sets the type of access rules to apply when an item inherits its ACL from a # parent. This should always be set in tandem with the inheritAclFrom field. @@ -2499,12 +2508,12 @@ # elements is 100. # Corresponds to the JSON property `deniedReaders` # @return [Array<Google::Apis::CloudsearchV1::Principal>] attr_accessor :denied_readers - # Name of the item to inherit the Access Permission List (ACL) from. Note: ACL - # inheritance *only* provides access permissions to child items and does not + # The name of the item to inherit the Access Permission List (ACL) from. Note: + # ACL inheritance *only* provides access permissions to child items and does not # define structural relationships, nor does it provide convenient ways to delete # large groups of items. Deleting an ACL parent from the index only alters the # access permissions of child items that reference the parent in the # inheritAclFrom field. The item is still in the index, but may not visible in # search results. By contrast, deletion of a container item also deletes all @@ -3107,11 +3116,11 @@ # A person's name. class Name include Google::Apis::Core::Hashable # The read-only display name formatted according to the locale specified by the - # viewer's account or the Accept-Language HTTP header. + # viewer's account or the `Accept-Language` HTTP header. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name def initialize(**args) @@ -3204,11 +3213,11 @@ # The definition for an object within a data source. class ObjectDefinition include Google::Apis::Core::Hashable - # Name for the object, which then defines its type. Item indexing requests + # The name for the object, which then defines its type. Item indexing requests # should set the objectType field equal to this value. For example, if *name* is # *Document*, then indexing requests for items of type Document should set # objectType equal to *Document*. Each object definition must be uniquely named # within a schema. The name must start with a letter and can only contain # letters (A-Z, a-z) or numbers (0-9). The maximum length is 256 characters. @@ -3301,11 +3310,11 @@ @display_options = args[:display_options] if args.key?(:display_options) @freshness_options = args[:freshness_options] if args.key?(:freshness_options) end end - # Options for object properties. + # The options for object properties. class ObjectPropertyOptions include Google::Apis::Core::Hashable # The properties of the sub-object. These properties represent a nested object. # For example, if this property represents a postal address, the @@ -3432,12 +3441,13 @@ # The person's email addresses # Corresponds to the JSON property `emailAddresses` # @return [Array<Google::Apis::CloudsearchV1::EmailAddress>] attr_accessor :email_addresses - # The resource name of the person to provide information about. See People.get - # from Google People API. + # The resource name of the person to provide information about. See [`People.get` + # ](https://developers.google.com/people/api/rest/v1/people/get) from the Google + # People API. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Obfuscated ID of a person. @@ -3491,12 +3501,12 @@ # class PollItemsRequest include Google::Apis::Core::Hashable - # Name of connector making this call. Format: datasources/`source_id`/connectors/ - # `ID` + # The name of connector making this call. Format: datasources/`source_id`/ + # connectors/`ID` # Corresponds to the JSON property `connectorName` # @return [String] attr_accessor :connector_name # Shared request debug options for all cloudsearch RPC methods. @@ -3598,11 +3608,11 @@ # Error code indicating the nature of the error. # Corresponds to the JSON property `code` # @return [String] attr_accessor :code - # Description of the error. + # The description of the error. # Corresponds to the JSON property `errorMessage` # @return [String] attr_accessor :error_message # In case the item fields are invalid, this field contains the details about the @@ -3625,31 +3635,31 @@ # The definition of a property within an object. class PropertyDefinition include Google::Apis::Core::Hashable - # Options for boolean properties. + # The options for boolean properties. # Corresponds to the JSON property `booleanPropertyOptions` # @return [Google::Apis::CloudsearchV1::BooleanPropertyOptions] attr_accessor :boolean_property_options - # Options for date properties. + # The options for date properties. # Corresponds to the JSON property `datePropertyOptions` # @return [Google::Apis::CloudsearchV1::DatePropertyOptions] attr_accessor :date_property_options # The display options for a property. # Corresponds to the JSON property `displayOptions` # @return [Google::Apis::CloudsearchV1::PropertyDisplayOptions] attr_accessor :display_options - # Options for double properties. + # The options for double properties. # Corresponds to the JSON property `doublePropertyOptions` # @return [Google::Apis::CloudsearchV1::DoublePropertyOptions] attr_accessor :double_property_options - # Options for enum properties, which allow you to define a restricted set of + # The options for enum properties, which allow you to define a restricted set of # strings to match user queries, set rankings for those string values, and # define an operator name to be paired with those strings so that users can # narrow results to only items with a specific value. For example, for items in # a request tracking system with priority information, you could define *p0* as # an allowable enum value and tie this enum to the operator name *priority* so @@ -3657,23 +3667,23 @@ # of results to only those items indexed with the value *p0*. # Corresponds to the JSON property `enumPropertyOptions` # @return [Google::Apis::CloudsearchV1::EnumPropertyOptions] attr_accessor :enum_property_options - # Options for html properties. + # The options for html properties. # Corresponds to the JSON property `htmlPropertyOptions` # @return [Google::Apis::CloudsearchV1::HtmlPropertyOptions] attr_accessor :html_property_options - # Options for integer properties. + # The options for integer properties. # Corresponds to the JSON property `integerPropertyOptions` # @return [Google::Apis::CloudsearchV1::IntegerPropertyOptions] attr_accessor :integer_property_options # Indicates that the property can be used for generating facets. Cannot be true # for properties whose type is object. IsReturnable must be true to set this - # option. Only supported for Boolean, Enum, and Text properties. + # option. Only supported for boolean, enum, and text properties. # Corresponds to the JSON property `isFacetable` # @return [Boolean] attr_accessor :is_facetable alias_method :is_facetable?, :is_facetable @@ -3700,11 +3710,11 @@ alias_method :is_returnable?, :is_returnable # Indicates that the property can be used for sorting. Cannot be true for # properties that are repeatable. Cannot be true for properties whose type is # object. IsReturnable must be true to set this option. Only supported for - # Boolean, Date, Double, Integer, and Timestamp properties. + # boolean, date, double, integer, and timestamp properties. # Corresponds to the JSON property `isSortable` # @return [Boolean] attr_accessor :is_sortable alias_method :is_sortable?, :is_sortable @@ -3733,21 +3743,21 @@ # numbers (0-9). The maximum length is 256 characters. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Options for object properties. + # The options for object properties. # Corresponds to the JSON property `objectPropertyOptions` # @return [Google::Apis::CloudsearchV1::ObjectPropertyOptions] attr_accessor :object_property_options - # Options for text properties. + # The options for text properties. # Corresponds to the JSON property `textPropertyOptions` # @return [Google::Apis::CloudsearchV1::TextPropertyOptions] attr_accessor :text_property_options - # Options for timestamp properties. + # The options for timestamp properties. # Corresponds to the JSON property `timestampPropertyOptions` # @return [Google::Apis::CloudsearchV1::TimestampPropertyOptions] attr_accessor :timestamp_property_options def initialize(**args) @@ -3811,13 +3821,14 @@ # type field results in argument error. The maximum length is 2048 characters. # Corresponds to the JSON property `contentHash` # @return [String] attr_accessor :content_hash - # Metadata hash of the item according to the repository. If specified, this is - # used to determine how to modify this item's status. Setting this field and the - # type field results in argument error. The maximum length is 2048 characters. + # The metadata hash of the item according to the repository. If specified, this + # is used to determine how to modify this item's status. Setting this field and + # the type field results in argument error. The maximum length is 2048 + # characters. # Corresponds to the JSON property `metadataHash` # @return [String] attr_accessor :metadata_hash # Provides additional document state information for the connector, such as an @@ -3825,11 +3836,11 @@ # Corresponds to the JSON property `payload` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :payload - # Queue to which this item belongs to. The default queue is chosen if this field + # Queue to which this item belongs. The `default` queue is chosen if this field # is not specified. The maximum length is 512 characters. # Corresponds to the JSON property `queue` # @return [String] attr_accessor :queue @@ -3869,12 +3880,12 @@ # class PushItemRequest include Google::Apis::Core::Hashable - # Name of connector making this call. Format: datasources/`source_id`/connectors/ - # `ID` + # The name of connector making this call. Format: datasources/`source_id`/ + # connectors/`ID` # Corresponds to the JSON property `connectorName` # @return [String] attr_accessor :connector_name # Shared request debug options for all cloudsearch RPC methods. @@ -4111,22 +4122,22 @@ # less-than operator. # Corresponds to the JSON property `lessThanOperatorName` # @return [String] attr_accessor :less_than_operator_name - # Name of the object corresponding to the operator. This field is only filled - # for schema-specific operators, and is unset for common operators. + # The name of the object corresponding to the operator. This field is only + # filled for schema-specific operators, and is unset for common operators. # Corresponds to the JSON property `objectType` # @return [String] attr_accessor :object_type # The name of the operator. # Corresponds to the JSON property `operatorName` # @return [String] attr_accessor :operator_name - # Type of the operator. + # The type of the operator. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type def initialize(**args) @@ -4215,11 +4226,11 @@ # Error codes. Matches the definition of HTTP status codes. # Corresponds to the JSON property `httpStatusCode` # @return [Fixnum] attr_accessor :http_status_code - # Type of error. + # The type of error. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type def initialize(**args) @@ -4589,11 +4600,12 @@ # Corresponds to the JSON property `enableAuditLog` # @return [Boolean] attr_accessor :enable_audit_log alias_method :enable_audit_log?, :enable_audit_log - # Name of the Search Application. Format: searchapplications/`application_id`. + # The name of the Search Application. Format: searchapplications/`application_id` + # . # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Output only. IDs of the Long Running Operations (LROs) currently running for @@ -5084,12 +5096,12 @@ # class SortOptions include Google::Apis::Core::Hashable - # Name of the operator corresponding to the field to sort on. The corresponding - # property must be marked as sortable. + # The name of the operator corresponding to the field to sort on. The + # corresponding property must be marked as sortable. # Corresponds to the JSON property `operatorName` # @return [String] attr_accessor :operator_name # Ascending is the default sort order @@ -5371,12 +5383,12 @@ # Start upload file request. class StartUploadItemRequest include Google::Apis::Core::Hashable - # Name of connector making this call. Format: datasources/`source_id`/connectors/ - # `ID` + # The name of connector making this call. Format: datasources/`source_id`/ + # connectors/`ID` # Corresponds to the JSON property `connectorName` # @return [String] attr_accessor :connector_name # Shared request debug options for all cloudsearch RPC methods. @@ -5573,12 +5585,12 @@ include Google::Apis::Core::Hashable # If true, the text value is tokenized as one atomic value in operator searches # and facet matches. For example, if the operator name is "genre" and the value # is "science-fiction" the query restrictions "genre:science" and "genre:fiction" - # doesn't match the item; "genre:science-fiction" does. Value matching is case- - # sensitive and does not remove special characters. If false, the text is + # doesn't match the item; "genre:science-fiction" does. Text value matching is + # case-sensitive and does not remove special characters. If false, the text is # tokenized. For example, if the value is "science-fiction" the queries "genre: # science" and "genre:fiction" matches the item. # Corresponds to the JSON property `exactMatchWithOperator` # @return [Boolean] attr_accessor :exact_match_with_operator @@ -5605,11 +5617,11 @@ @exact_match_with_operator = args[:exact_match_with_operator] if args.key?(:exact_match_with_operator) @operator_name = args[:operator_name] if args.key?(:operator_name) end end - # Options for text properties. + # The options for text properties. class TextPropertyOptions include Google::Apis::Core::Hashable # Used to provide a search operator for text properties. This is optional. # Search operators let users restrict the query to specific fields relevant to @@ -5702,11 +5714,11 @@ @less_than_operator_name = args[:less_than_operator_name] if args.key?(:less_than_operator_name) @operator_name = args[:operator_name] if args.key?(:operator_name) end end - # Options for timestamp properties. + # The options for timestamp properties. class TimestampPropertyOptions include Google::Apis::Core::Hashable # Used to provide a search operator for timestamp properties. This is optional. # Search operators let users restrict the query to specific fields relevant to @@ -5790,22 +5802,22 @@ # class UnreserveItemsRequest include Google::Apis::Core::Hashable - # Name of connector making this call. Format: datasources/`source_id`/connectors/ - # `ID` + # The name of connector making this call. Format: datasources/`source_id`/ + # connectors/`ID` # Corresponds to the JSON property `connectorName` # @return [String] attr_accessor :connector_name # Shared request debug options for all cloudsearch RPC methods. # Corresponds to the JSON property `debugOptions` # @return [Google::Apis::CloudsearchV1::DebugOptions] attr_accessor :debug_options - # Name of a queue to unreserve items from. + # The name of a queue to unreserve items from. # Corresponds to the JSON property `queue` # @return [String] attr_accessor :queue def initialize(**args) @@ -5884,10 +5896,10 @@ # method. This reference is valid for 30 days after its creation. Updating of # item content may refer to this uploaded content via contentDataRef. class UploadItemRef include Google::Apis::Core::Hashable - # Name of the content reference. The maximum length is 2048 characters. + # The name of the content reference. The maximum length is 2048 characters. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name def initialize(**args)