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.



3809
3810
3811
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 3809

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) 


3769
3770
3771
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 3769

def content_hash
  @content_hash
end

#metadata_hash ⇒ String

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) 


3776
3777
3778
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 3776

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) 


3783
3784
3785
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 3783

def payload
  @payload
end

#queue ⇒ String

Queue to which this item belongs to. 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) 


3789
3790
3791
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 3789

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:



3794
3795
3796
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 3794

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) 


3802
3803
3804
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 3802

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) 


3807
3808
3809
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 3807

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3814
3815
3816
3817
3818
3819
3820
3821
3822
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 3814

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