PropertyDefinition

import type { PropertyDefinition } from "https://googleapis.deno.dev/v1/cloudsearch:v1.ts";

The definition of a property within an object.

interface PropertyDefinition {

booleanPropertyOptions?: BooleanPropertyOptions;

datePropertyOptions?: DatePropertyOptions;

displayOptions?: PropertyDisplayOptions;

doublePropertyOptions?: DoublePropertyOptions;

enumPropertyOptions?: EnumPropertyOptions;

htmlPropertyOptions?: HtmlPropertyOptions;

integerPropertyOptions?: IntegerPropertyOptions;

isFacetable?: boolean;

isRepeatable?: boolean;

isReturnable?: boolean;

isSortable?: boolean;

isSuggestable?: boolean;

isWildcardSearchable?: boolean;

name?: string;

objectPropertyOptions?: ObjectPropertyOptions;

textPropertyOptions?: TextPropertyOptions;

timestampPropertyOptions?: TimestampPropertyOptions;

}

§Properties

booleanPropertyOptions?: BooleanPropertyOptions

[src]

datePropertyOptions?: DatePropertyOptions

[src]

displayOptions?: PropertyDisplayOptions

[src]

The options that determine how the property is displayed in the Cloud Search results page if it's specified to be displayed in the object's display options.

doublePropertyOptions?: DoublePropertyOptions

[src]

enumPropertyOptions?: EnumPropertyOptions

[src]

htmlPropertyOptions?: HtmlPropertyOptions

[src]

integerPropertyOptions?: IntegerPropertyOptions

[src]

isFacetable?: boolean

[src]

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, integer, and text properties.

isRepeatable?: boolean

[src]

Indicates that multiple values are allowed for the property. For example, a document only has one description but can have multiple comments. Cannot be true for properties whose type is a boolean. If set to false, properties that contain more than one value cause the indexing request for that item to be rejected.

isReturnable?: boolean

[src]

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.

isSortable?: boolean

[src]

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.

isSuggestable?: boolean

[src]

Indicates that the property can be used for generating query suggestions.

isWildcardSearchable?: boolean

[src]

Indicates that users can perform wildcard search for this property. Only supported for Text properties. IsReturnable must be true to set this option. In a given datasource maximum of 5 properties can be marked as is_wildcard_searchable. For more details, see Define object properties

name?: string

[src]

The name of the property. Item indexing requests sent to the Indexing API should set the property name equal to this value. For example, if name is subject_line, then indexing requests for document items with subject fields should set the name for that field equal to subject_line. Use the name as the identifier for the object property. Once registered as a property for an object, you cannot re-use this name for another property within that object. 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.

objectPropertyOptions?: ObjectPropertyOptions

[src]

textPropertyOptions?: TextPropertyOptions

[src]

timestampPropertyOptions?: TimestampPropertyOptions

[src]