Class: Google::Apis::CloudsearchV1::ObjectDefinition

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

Overview

The definition for an object within a data source.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ ObjectDefinition

Returns a new instance of ObjectDefinition.



5030
5031
5032
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 5030

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

Instance Attribute Details

#name ⇒ String

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

Returns:

  • (String) 


5017
5018
5019
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 5017

def name
  @name
end

#options ⇒ Google::Apis::CloudsearchV1::ObjectOptions

The options for an object. Corresponds to the JSON property options

Returns:



5022
5023
5024
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 5022

def options
  @options
end

#property_definitions ⇒ Array<Google::Apis::CloudsearchV1::PropertyDefinition>

The property definitions for the object. The maximum number of elements is 1000. Corresponds to the JSON property propertyDefinitions

Returns:



5028
5029
5030
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 5028

def property_definitions
  @property_definitions
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5035
5036
5037
5038
5039
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 5035

def update!(**args)
  @name = args[:name] if args.key?(:name)
  @options = args[:options] if args.key?(:options)
  @property_definitions = args[:property_definitions] if args.key?(:property_definitions)
end