class Google::Apis::CloudsearchV1::Item

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

Attributes

acl[RW]

Access control list information for the item. For more information see [Map ACLs](/cloud-search/docs/guides/acls). Corresponds to the JSON property `acl` @return [Google::Apis::CloudsearchV1::ItemAcl]

content[RW]

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` @return [Google::Apis::CloudsearchV1::ItemContent]

item_type[RW]

Type for this item. Corresponds to the JSON property `itemType` @return [String]

metadata[RW]

Available metadata fields for the item. Corresponds to the JSON property `metadata` @return [Google::Apis::CloudsearchV1::ItemMetadata]

name[RW]

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` @return [String]

payload[RW]

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. @return [String]

queue[RW]

Queue this item belongs to. The maximum length is 100 characters. Corresponds to the JSON property `queue` @return [String]

status[RW]

This contains item's status and any errors. Corresponds to the JSON property `status` @return [Google::Apis::CloudsearchV1::ItemStatus]

structured_data[RW]

Available structured data fields for the item. Corresponds to the JSON property `structuredData` @return [Google::Apis::CloudsearchV1::ItemStructuredData]

version[RW]

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. @return [String]

Public Class Methods

new(**args) click to toggle source
# File lib/google/apis/cloudsearch_v1/classes.rb, line 1826
def initialize(**args)
   update!(**args)
end

Public Instance Methods

update!(**args) click to toggle source

Update properties of this object

# File lib/google/apis/cloudsearch_v1/classes.rb, line 1831
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