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

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
generated/google/apis/cloudsearch_v1/classes.rb,
generated/google/apis/cloudsearch_v1/representations.rb,
generated/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.



1721
1722
1723
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 1721

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:



1664
1665
1666
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 1664

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:



1671
1672
1673
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 1671

def content
  @content
end

#item_type ⇒ String

Type for this item. Corresponds to the JSON property itemType

Returns:

  • (String) 


1676
1677
1678
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 1676

def item_type
  @item_type
end

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

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

Returns:



1681
1682
1683
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 1681

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) 


1687
1688
1689
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 1687

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) 


1694
1695
1696
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 1694

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) 


1699
1700
1701
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 1699

def queue
  @queue
end

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

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

Returns:



1704
1705
1706
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 1704

def status
  @status
end

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

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

Returns:



1709
1710
1711
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 1709

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) 


1719
1720
1721
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 1719

def version
  @version
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 1726

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