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

Methods included from Google::Apis::Core::JsonObjectSupport

#to_json

Methods included from Google::Apis::Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Item

Returns a new instance of Item



1520
1521
1522
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 1520

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 https://developers.google.com/cloud-search/docs/guides/index-your-data#acls Corresponds to the JSON property acl

Returns:



1459
1460
1461
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 1459

def acl
  @acl
end

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

Content of an item to be indexed and surfaced by Cloud Search. Corresponds to the JSON property content

Returns:



1464
1465
1466
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 1464

def content
  @content
end

#item_type ⇒ String

Type for this item. Corresponds to the JSON property itemType

Returns:

  • (String) 


1469
1470
1471
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 1469

def item_type
  @item_type
end

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

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

Returns:



1474
1475
1476
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 1474

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) 


1482
1483
1484
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 1482

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) 


1489
1490
1491
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 1489

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) 


1495
1496
1497
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 1495

def queue
  @queue
end

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

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

Returns:



1500
1501
1502
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 1500

def status
  @status
end

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

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

Returns:



1505
1506
1507
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 1505

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) 


1518
1519
1520
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 1518

def version
  @version
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 1525

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