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

Methods included from Google::Apis::Core::JsonObjectSupport

#to_json

Methods included from Google::Apis::Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ PropertyDefinition

Returns a new instance of PropertyDefinition.



3062
3063
3064
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3062

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

Instance Attribute Details

#boolean_property_options ⇒ Google::Apis::CloudsearchV1::BooleanPropertyOptions

Options for boolean properties. Corresponds to the JSON property booleanPropertyOptions

Returns:



2936
2937
2938
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2936

def boolean_property_options
  @boolean_property_options
end

#date_property_options ⇒ Google::Apis::CloudsearchV1::DatePropertyOptions

Options for date properties. Corresponds to the JSON property datePropertyOptions

Returns:



2941
2942
2943
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2941

def date_property_options
  @date_property_options
end

#display_options ⇒ Google::Apis::CloudsearchV1::PropertyDisplayOptions

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

Returns:



2946
2947
2948
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2946

def display_options
  @display_options
end

#double_property_options ⇒ Google::Apis::CloudsearchV1::DoublePropertyOptions

Options for double properties. Corresponds to the JSON property doublePropertyOptions

Returns:



2951
2952
2953
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2951

def double_property_options
  @double_property_options
end

#enum_property_options ⇒ Google::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

Returns:



2963
2964
2965
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2963

def enum_property_options
  @enum_property_options
end

#html_property_options ⇒ Google::Apis::CloudsearchV1::HtmlPropertyOptions

Options for html properties. Corresponds to the JSON property htmlPropertyOptions

Returns:



2968
2969
2970
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2968

def html_property_options
  @html_property_options
end

#integer_property_options ⇒ Google::Apis::CloudsearchV1::IntegerPropertyOptions

Options for integer properties. Corresponds to the JSON property integerPropertyOptions

Returns:



2973
2974
2975
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2973

def integer_property_options
  @integer_property_options
end

#is_facetable ⇒ Boolean 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) 


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

def is_facetable
  @is_facetable
end

#is_repeatable ⇒ Boolean 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 will cause the indexing request for that item to be rejected. Corresponds to the JSON property isRepeatable

Returns:

  • (Boolean) 


2991
2992
2993
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2991

def is_repeatable
  @is_repeatable
end

#is_returnable ⇒ Boolean 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) 


3003
3004
3005
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3003

def is_returnable
  @is_returnable
end

#is_sortable ⇒ Boolean 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) 


3013
3014
3015
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3013

def is_sortable
  @is_sortable
end

#is_suggestable ⇒ Boolean Also known as: is_suggestable?

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

Returns:

  • (Boolean) 


3019
3020
3021
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3019

def is_suggestable
  @is_suggestable
end

#is_wildcard_searchable ⇒ Boolean 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. Note: This is an alpha feature and is enabled for whitelisted users only. Corresponds to the JSON property isWildcardSearchable

Returns:

  • (Boolean) 


3029
3030
3031
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3029

def is_wildcard_searchable
  @is_wildcard_searchable
end

#name ⇒ String

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) 


3045
3046
3047
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3045

def name
  @name
end

#object_property_options ⇒ Google::Apis::CloudsearchV1::ObjectPropertyOptions

Options for object properties. Corresponds to the JSON property objectPropertyOptions

Returns:



3050
3051
3052
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3050

def object_property_options
  @object_property_options
end

#text_property_options ⇒ Google::Apis::CloudsearchV1::TextPropertyOptions

Options for text properties. Corresponds to the JSON property textPropertyOptions

Returns:



3055
3056
3057
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3055

def text_property_options
  @text_property_options
end

#timestamp_property_options ⇒ Google::Apis::CloudsearchV1::TimestampPropertyOptions

Options for timestamp properties. Corresponds to the JSON property timestampPropertyOptions

Returns:



3060
3061
3062
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3060

def timestamp_property_options
  @timestamp_property_options
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 3067

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