Class: Google::Apis::CloudsearchV1::PushItem

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 an item to be pushed to the indexing queue.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ PushItem

Returns a new instance of PushItem.



15751
15752
15753
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 15751

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#content_hash ⇒ String

Content hash of the item according to the repository. If specified, this is used to determine how to modify this item's status. Setting this field and the type field results in argument error. The maximum length is 2048 characters. Corresponds to the JSON property contentHash

Returns:

  • (String) 


15710
15711
15712
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 15710

def content_hash
  @content_hash
end

#metadata_hash ⇒ String

The metadata hash of the item according to the repository. If specified, this is used to determine how to modify this item's status. Setting this field and the type field results in argument error. The maximum length is 2048 characters. Corresponds to the JSON property metadataHash

Returns:

  • (String) 


15718
15719
15720
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 15718

def metadata_hash
  @metadata_hash
end

#payload ⇒ String

Provides additional document state information for the connector, such as an alternate repository ID and other metadata. The maximum length is 8192 bytes. Corresponds to the JSON property payload NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String) 


15725
15726
15727
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 15725

def payload
  @payload
end

#queue ⇒ String

Queue to which this item belongs. The default queue is chosen if this field is not specified. The maximum length is 512 characters. Corresponds to the JSON property queue

Returns:

  • (String) 


15731
15732
15733
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 15731

def queue
  @queue
end

#repository_error ⇒ Google::Apis::CloudsearchV1::RepositoryError

Errors when the connector is communicating to the source repository. Corresponds to the JSON property repositoryError

Returns:



15736
15737
15738
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 15736

def repository_error
  @repository_error
end

#structured_data_hash ⇒ String

Structured data hash of the item according to the repository. If specified, this is used to determine how to modify this item's status. Setting this field and the type field results in argument error. The maximum length is 2048 characters. Corresponds to the JSON property structuredDataHash

Returns:

  • (String) 


15744
15745
15746
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 15744

def structured_data_hash
  @structured_data_hash
end

#type ⇒ String

The type of the push operation that defines the push behavior. Corresponds to the JSON property type

Returns:

  • (String) 


15749
15750
15751
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 15749

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



15756
15757
15758
15759
15760
15761
15762
15763
15764
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 15756

def update!(**args)
  @content_hash = args[:content_hash] if args.key?(:content_hash)
  @metadata_hash = args[:metadata_hash] if args.key?(:metadata_hash)
  @payload = args[:payload] if args.key?(:payload)
  @queue = args[:queue] if args.key?(:queue)
  @repository_error = args[:repository_error] if args.key?(:repository_error)
  @structured_data_hash = args[:structured_data_hash] if args.key?(:structured_data_hash)
  @type = args[:type] if args.key?(:type)
end