Class: Google::Apis::CloudsearchV1::Item

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

Represents a single object that is an item in the search index, such as a file, folder, or a database record.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Item

Returns a new instance of Item.



12208
12209
12210
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 12208

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

Instance Attribute Details

#acl ⇒ Google::Apis::CloudsearchV1::ItemAcl

Access control list information for the item. For more information see Map ACLs. Corresponds to the JSON property acl

Returns:



12148
12149
12150
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 12148

def acl
  @acl
end

#content ⇒ Google::Apis::CloudsearchV1::ItemContent

Content of an item to be indexed and surfaced by Cloud Search. Only UTF-8 encoded strings are allowed as inlineContent. If the content is uploaded and not binary, it must be UTF-8 encoded. Corresponds to the JSON property content

Returns:



12155
12156
12157
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 12155

def content
  @content
end

#item_type ⇒ String

The type for this item. Corresponds to the JSON property itemType

Returns:

  • (String) 


12160
12161
12162
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 12160

def item_type
  @item_type
end

#metadata ⇒ Google::Apis::CloudsearchV1::ItemMetadata

Available metadata fields for the item. Corresponds to the JSON property metadata

Returns:



12165
12166
12167
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 12165

def metadata
  @metadata
end

#name ⇒ String

The name of the Item. Format: datasources/source_id/items/item_id This is a required field. The maximum length is 1536 characters. Corresponds to the JSON property name

Returns:

  • (String) 


12171
12172
12173
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 12171

def name
  @name
end

#payload ⇒ String

Additional state connector can store for this item. The maximum length is 10000 bytes. Corresponds to the JSON property payload NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String) 


12178
12179
12180
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 12178

def payload
  @payload
end

#queue ⇒ String

Queue this item belongs to. The maximum length is 100 characters. Corresponds to the JSON property queue

Returns:

  • (String) 


12183
12184
12185
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 12183

def queue
  @queue
end

#status ⇒ Google::Apis::CloudsearchV1::ItemStatus

This contains item's status and any errors. Corresponds to the JSON property status

Returns:



12188
12189
12190
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 12188

def status
  @status
end

#structured_data ⇒ Google::Apis::CloudsearchV1::ItemStructuredData

Available structured data fields for the item. Corresponds to the JSON property structuredData

Returns:



12193
12194
12195
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 12193

def structured_data
  @structured_data
end

#version ⇒ String

Required. The indexing system stores the version from the datasource as a byte string and compares the Item version in the index to the version of the queued Item using lexical ordering. Cloud Search Indexing won't index or delete any queued item with a version value that is less than or equal to the version of the currently indexed item. The maximum length for this field is 1024 bytes. For information on how item version affects the deletion process, refer to Handle revisions after manual deletes. Corresponds to the JSON property version NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String) 


12206
12207
12208
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 12206

def version
  @version
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



12213
12214
12215
12216
12217
12218
12219
12220
12221
12222
12223
12224
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 12213

def update!(**args)
  @acl = args[:acl] if args.key?(:acl)
  @content = args[:content] if args.key?(:content)
  @item_type = args[:item_type] if args.key?(:item_type)
  @metadata = args[:metadata] if args.key?(:metadata)
  @name = args[:name] if args.key?(:name)
  @payload = args[:payload] if args.key?(:payload)
  @queue = args[:queue] if args.key?(:queue)
  @status = args[:status] if args.key?(:status)
  @structured_data = args[:structured_data] if args.key?(:structured_data)
  @version = args[:version] if args.key?(:version)
end