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.



2579
2580
2581
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2579

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

Instance Attribute Details

#name ⇒ String

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) 


2566
2567
2568
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2566

def name
  @name
end

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

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

Returns:



2571
2572
2573
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2571

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:



2577
2578
2579
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2577

def property_definitions
  @property_definitions
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2584
2585
2586
2587
2588
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2584

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