Class PropertyDefinition
The definition of a property within an object.
Inheritance
System.Object
PropertyDefinition
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Assembly: Google.Apis.CloudSearch.v1.dll
Syntax
public class PropertyDefinition : IDirectResponseSchema
Properties
BooleanPropertyOptions
Declaration
[JsonProperty("booleanPropertyOptions")]
public virtual BooleanPropertyOptions BooleanPropertyOptions { get; set; }
Property Value
DatePropertyOptions
Declaration
[JsonProperty("datePropertyOptions")]
public virtual DatePropertyOptions DatePropertyOptions { get; set; }
Property Value
DisplayOptions
Options that determine how the property is displayed in the Cloud Search results page if it is
specified to be displayed in the object's display options .
Declaration
[JsonProperty("displayOptions")]
public virtual PropertyDisplayOptions DisplayOptions { get; set; }
Property Value
DoublePropertyOptions
Declaration
[JsonProperty("doublePropertyOptions")]
public virtual DoublePropertyOptions DoublePropertyOptions { get; set; }
Property Value
EnumPropertyOptions
Declaration
[JsonProperty("enumPropertyOptions")]
public virtual EnumPropertyOptions EnumPropertyOptions { get; set; }
Property Value
ETag
Declaration
public virtual string ETag { get; set; }
Property Value
| Type |
Description |
| System.String |
|
HtmlPropertyOptions
Declaration
[JsonProperty("htmlPropertyOptions")]
public virtual HtmlPropertyOptions HtmlPropertyOptions { get; set; }
Property Value
IntegerPropertyOptions
Declaration
[JsonProperty("integerPropertyOptions")]
public virtual IntegerPropertyOptions IntegerPropertyOptions { get; set; }
Property Value
IsFacetable
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.
Declaration
[JsonProperty("isFacetable")]
public virtual bool? IsFacetable { get; set; }
Property Value
| Type |
Description |
| System.Nullable<System.Boolean> |
|
IsRepeatable
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.
Declaration
[JsonProperty("isRepeatable")]
public virtual bool? IsRepeatable { get; set; }
Property Value
| Type |
Description |
| System.Nullable<System.Boolean> |
|
IsReturnable
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.
Declaration
[JsonProperty("isReturnable")]
public virtual bool? IsReturnable { get; set; }
Property Value
| Type |
Description |
| System.Nullable<System.Boolean> |
|
IsSortable
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 or user identifier. IsReturnable must be true
to set this option. Only supported for Boolean, Date, Double, Integer, and Timestamp properties.
Declaration
[JsonProperty("isSortable")]
public virtual bool? IsSortable { get; set; }
Property Value
| Type |
Description |
| System.Nullable<System.Boolean> |
|
IsSuggestable
Indicates that the property can be used for generating query suggestions.
Declaration
[JsonProperty("isSuggestable")]
public virtual bool? IsSuggestable { get; set; }
Property Value
| Type |
Description |
| System.Nullable<System.Boolean> |
|
IsWildcardSearchable
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.
Declaration
[JsonProperty("isWildcardSearchable")]
public virtual bool? IsWildcardSearchable { get; set; }
Property Value
| Type |
Description |
| System.Nullable<System.Boolean> |
|
Name
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.
Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
| Type |
Description |
| System.String |
|
ObjectPropertyOptions
Declaration
[JsonProperty("objectPropertyOptions")]
public virtual ObjectPropertyOptions ObjectPropertyOptions { get; set; }
Property Value
TextPropertyOptions
Declaration
[JsonProperty("textPropertyOptions")]
public virtual TextPropertyOptions TextPropertyOptions { get; set; }
Property Value
TimestampPropertyOptions
Declaration
[JsonProperty("timestampPropertyOptions")]
public virtual TimestampPropertyOptions TimestampPropertyOptions { get; set; }
Property Value
Implements