Class: Google::Apis::CloudsearchV1::PropertyDefinition

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
generated/google/apis/cloudsearch_v1/classes.rb,
generated/google/apis/cloudsearch_v1/representations.rb,
generated/google/apis/cloudsearch_v1/representations.rb

Overview

The definition of a property within an object.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ PropertyDefinition

Returns a new instance of PropertyDefinition.



2988
2989
2990
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2988

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#boolean_property_optionsGoogle::Apis::CloudsearchV1::BooleanPropertyOptions

Options for boolean properties. Corresponds to the JSON property booleanPropertyOptions



2868
2869
2870
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2868

def boolean_property_options
  @boolean_property_options
end

#date_property_optionsGoogle::Apis::CloudsearchV1::DatePropertyOptions

Options for date properties. Corresponds to the JSON property datePropertyOptions



2873
2874
2875
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2873

def date_property_options
  @date_property_options
end

#display_optionsGoogle::Apis::CloudsearchV1::PropertyDisplayOptions

The display options for a property. Corresponds to the JSON property displayOptions



2878
2879
2880
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2878

def display_options
  @display_options
end

#double_property_optionsGoogle::Apis::CloudsearchV1::DoublePropertyOptions

Options for double properties. Corresponds to the JSON property doublePropertyOptions



2883
2884
2885
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2883

def double_property_options
  @double_property_options
end

#enum_property_optionsGoogle::Apis::CloudsearchV1::EnumPropertyOptions

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 that search users could add priority:p0 to their query to restrict the set of results to only those items indexed with the value p0. Corresponds to the JSON property enumPropertyOptions



2895
2896
2897
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2895

def enum_property_options
  @enum_property_options
end

#html_property_optionsGoogle::Apis::CloudsearchV1::HtmlPropertyOptions

Options for html properties. Corresponds to the JSON property htmlPropertyOptions



2900
2901
2902
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2900

def html_property_options
  @html_property_options
end

#integer_property_optionsGoogle::Apis::CloudsearchV1::IntegerPropertyOptions

Options for integer properties. Corresponds to the JSON property integerPropertyOptions



2905
2906
2907
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2905

def integer_property_options
  @integer_property_options
end

#is_facetableBoolean Also known as: is_facetable?

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. Corresponds to the JSON property isFacetable

Returns:

  • (Boolean)


2912
2913
2914
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2912

def is_facetable
  @is_facetable
end

#is_repeatableBoolean Also known as: is_repeatable?

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. Corresponds to the JSON property isRepeatable

Returns:

  • (Boolean)


2922
2923
2924
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2922

def is_repeatable
  @is_repeatable
end

#is_returnableBoolean Also known as: is_returnable?

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

Returns:

  • (Boolean)


2934
2935
2936
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2934

def is_returnable
  @is_returnable
end

#is_sortableBoolean Also known as: is_sortable?

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. Corresponds to the JSON property isSortable

Returns:

  • (Boolean)


2943
2944
2945
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2943

def is_sortable
  @is_sortable
end

#is_suggestableBoolean Also known as: is_suggestable?

Indicates that the property can be used for generating query suggestions. Corresponds to the JSON property isSuggestable

Returns:

  • (Boolean)


2949
2950
2951
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2949

def is_suggestable
  @is_suggestable
end

#is_wildcard_searchableBoolean Also known as: is_wildcard_searchable?

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. Corresponds to the JSON property isWildcardSearchable

Returns:

  • (Boolean)


2958
2959
2960
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2958

def is_wildcard_searchable
  @is_wildcard_searchable
end

#nameString

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. Corresponds to the JSON property name

Returns:

  • (String)


2971
2972
2973
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2971

def name
  @name
end

#object_property_optionsGoogle::Apis::CloudsearchV1::ObjectPropertyOptions

Options for object properties. Corresponds to the JSON property objectPropertyOptions



2976
2977
2978
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2976

def object_property_options
  @object_property_options
end

#text_property_optionsGoogle::Apis::CloudsearchV1::TextPropertyOptions

Options for text properties. Corresponds to the JSON property textPropertyOptions



2981
2982
2983
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2981

def text_property_options
  @text_property_options
end

#timestamp_property_optionsGoogle::Apis::CloudsearchV1::TimestampPropertyOptions

Options for timestamp properties. Corresponds to the JSON property timestampPropertyOptions



2986
2987
2988
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2986

def timestamp_property_options
  @timestamp_property_options
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2993

def update!(**args)
  @boolean_property_options = args[:boolean_property_options] if args.key?(:boolean_property_options)
  @date_property_options = args[:date_property_options] if args.key?(:date_property_options)
  @display_options = args[:display_options] if args.key?(:display_options)
  @double_property_options = args[:double_property_options] if args.key?(:double_property_options)
  @enum_property_options = args[:enum_property_options] if args.key?(:enum_property_options)
  @html_property_options = args[:html_property_options] if args.key?(:html_property_options)
  @integer_property_options = args[:integer_property_options] if args.key?(:integer_property_options)
  @is_facetable = args[:is_facetable] if args.key?(:is_facetable)
  @is_repeatable = args[:is_repeatable] if args.key?(:is_repeatable)
  @is_returnable = args[:is_returnable] if args.key?(:is_returnable)
  @is_sortable = args[:is_sortable] if args.key?(:is_sortable)
  @is_suggestable = args[:is_suggestable] if args.key?(:is_suggestable)
  @is_wildcard_searchable = args[:is_wildcard_searchable] if args.key?(:is_wildcard_searchable)
  @name = args[:name] if args.key?(:name)
  @object_property_options = args[:object_property_options] if args.key?(:object_property_options)
  @text_property_options = args[:text_property_options] if args.key?(:text_property_options)
  @timestamp_property_options = args[:timestamp_property_options] if args.key?(:timestamp_property_options)
end