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.



1840
1841
1842
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 1840

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:



1783
1784
1785
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 1783

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:



1790
1791
1792
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 1790

def content
  @content
end

#item_type ⇒ String

Type for this item. Corresponds to the JSON property itemType

Returns:

  • (String) 


1795
1796
1797
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 1795

def item_type
  @item_type
end

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

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

Returns:



1800
1801
1802
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 1800

def metadata
  @metadata
end

#name ⇒ String

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) 


1806
1807
1808
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 1806

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) 


1813
1814
1815
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 1813

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) 


1818
1819
1820
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 1818

def queue
  @queue
end

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

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

Returns:



1823
1824
1825
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 1823

def status
  @status
end

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

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

Returns:



1828
1829
1830
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 1828

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. Corresponds to the JSON property version NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String) 


1838
1839
1840
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 1838

def version
  @version
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 1845

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