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.



10693
10694
10695
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 10693

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:



10633
10634
10635
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 10633

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:



10640
10641
10642
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 10640

def content
  @content
end

#item_type ⇒ String

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

Returns:

  • (String) 


10645
10646
10647
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 10645

def item_type
  @item_type
end

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

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

Returns:



10650
10651
10652
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 10650

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) 


10656
10657
10658
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 10656

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) 


10663
10664
10665
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 10663

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) 


10668
10669
10670
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 10668

def queue
  @queue
end

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

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

Returns:



10673
10674
10675
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 10673

def status
  @status
end

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

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

Returns:



10678
10679
10680
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 10678

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) 


10691
10692
10693
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 10691

def version
  @version
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



10698
10699
10700
10701
10702
10703
10704
10705
10706
10707
10708
10709
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 10698

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